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