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