libstdc++-v3/doc/doxygen/mainpage.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3 <head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   4 <title>libstdc++ Source: Main Index</title>
   5 </head>
   6
   7 <body bgcolor="#ffffff">
   8 <!--
   9      Originally generated by Doxygen 1.2.12.
  10
  11      This used to be surrounded by /* */ marks and tagged with @mainpage, so
  12      that Doxygen would create the index page from it.  HOWEVER, Doxygen
  13      ignores all but the most basic HTML tags, and even with those it strips
  14      all the attributes.  (See, the HTML you write for @mainpage isn't used
  15      directly; it all gets run through Doxygen and re-output.)  So lots of
  16      tags were all being mangled.
  17
  18      Funk 'dat.  Now we let Doxygen do whatever it feels like doing for the
  19      index page, and then we just flat copy this over top of it.  Voila!
  20      Tags actually work like they're supposed to in HTML.
  21 -->
  22
  23 <h1>libstdc++ Source Documentation</h1>
  24
  25 <h2>Documentation Overview</h2>
  26
  27 <p class="smallertext">Generated on @DATE@.</p>
  28
  29 <p>There are two types of documentation for libstdc++.  One is the
  30    distribution documentation, which can be read online
  31    <a href="http://gcc.gnu.org/onlinedocs/libstdc++/index.html">here</a>
  32    or offline from the file doc/html/index.html in the library source
  33    directory.
  34 </p>
  35
  36 <p>The other type is the source documentation, of which this is the first page.
  37 </p>
  38
  39 <p>Here are entry points to all the pages generated by Doxygen:
  40    <ul>
  41     <li><a href="modules.html">Modules</a></li>
  42
  43     <li>Namespaces
  44     <ul>
  45     <li><a href="namespaces.html">List</a></li>
  46     <li><a href="namespacemembers.html">Members</a></li>
  47     </ul>
  48     </li>
  49
  50     <li>Classes
  51     <ul>
  52     <li><a href="classes.html">List</a></li>
  53     <li><a href="hierarchy.html">Hierarchy</a></li>
  54     <li><a href="functions.html">Members</a></li>
  55     </ul>
  56     </li>
  57
  58     <li><a href="files.html">Source Files</a></li>
  59     <li><a href="todo.html">TODO List</a></li>
  60    </ul>
  61 </p>
  62
  63 <p>If you are using Doxygen for your own projects, you can use
  64    <a href="libstdc++.tag">a tag file for the appropriate version</a> and
  65    an entry such as
  66    <blockquote>
  67    TAGFILES = "libstdc++.tag =
  68    http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen"
  69    </blockquote>
  70    Be sure to adjust the URL for the right version.  If you download a
  71    local copy of the source documentation for faster viewing, you can use
  72    the doxytag/installdox programs (part of Doxygen) to adjust the links
  73    for you.
  74 </p>
  75
  76 <h2>Generating the documentation</h2>
  77 <p>These HTML pages are automatically generated, along with the man
  78    pages.  See the section "Documentation Style"
  79    in <code>doc/xml/manual/appendix_contributing.xml</code> in the
  80    source tree for how to create (and write) the doxygen markup.
  81   This style guide can also be viewed on the <a href="http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01apas04.html">web</a>.
  82
  83 <h2>License, Copyright, and Other Lawyerly Verbosity</h2>
  84 <p>The libstdc++ documentation is released under
  85    <a href="http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt01ch01s02.html">
  86    these terms</a>.
  87 </p>
  88 <p>Part of the generated documentation involved comments and notes from
  89    SGI, who says we gotta say this:
  90    <blockquote>
  91    Permission to use, copy, modify, distribute and sell this software and its
  92    documentation for any purpose is hereby granted without fee, provided
  93    that the below copyright notice appears in all copies and that both
  94    the copyright notice and this permission notice appear in supporting
  95    documentation. Silicon Graphics makes no representations about the
  96    suitability of this software for any purpose. It is provided "as is"
  97    without express or implied warranty.
  98    <br><br>
  99    Copyright &copy; 1994
 100    Hewlett-Packard Company
 101    </blockquote>
 102 </p>
 103 <p>Part of the generated documentation is quoted from the ISO C++ Standard,
 104    which is Copyright &copy; 1998 by Information Technology Industry Council.
 105 </p>
 106
 107 </body>
 108 </html>