libstdc++-v3/docs/doxygen/mainpage.doxy

   1 /*! \mainpage
   2
   3 <h2> Documentation Overview </h2>
   4
   5 <p>There are two types of documentation for libstdc++-v3.  One is the
   6    distribution documentation, which can be read online at
   7    <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html</a>
   8    or offline from docs/html/documentation.html in the library source
   9    directory.
  10 </p>
  11
  12 <p>The other type is the source documentation, of which this is the first page.
  13    Here are quick links to the pages which we seem to use the most; a full
  14    index is at the bottom:
  15    <!-- Keep this in sync with below. -->
  16    <ul>
  17     <li><a href="annotated.html">Compound List</a>
  18     <li><a href="classes.html">Alphabetical List</a>
  19     <li><a href="files.html">File List</a>
  20     <li><a href="modules.html">Modules</a>
  21    </ul>
  22 </p>
  23
  24 <h2> Generating this file </h2>
  25 <p>These HTML pages are automatically generated, along with the man pages.
  26    The Makefile rule <code> 'make
  27    doxygen' </code> in the libstdc++-v3 build directory generates these pages
  28    using a tool called, appropriately enough, Doxygen.  To learn more about
  29    Doxygen, take a look at <a href="http://www.doxygen.org">the Doxygen
  30    webpage</a>.
  31 </p>
  32
  33 <p>The libstdc++-v3 configuration files needed to generate doxygen output
  34    are located:
  35    <ul><li><code>docs/doxygen/user.cfg.in</code>
  36        <li><code>docs/doxygen/run_doxygen</code>
  37    </ul>
  38 </p>
  39
  40 <h2> libstdc++-v3 doxygen style guide </h2>
  41 <p>In general, libstdc++-v3 files should be formatted according to the
  42    GNU C++ Coding Standard rules found in the file <a
  43 href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>.
  44    Before any doxygen-specific formatting tweaks are made, please try to
  45    make sure that the initial formatting is sound.
  46 </p>
  47
  48 <p>The formatting guidelines for using libstdc++-v3 with doxygen are still
  49    incomplete.  There seems to be a marginal preference for the use of
  50    Java-Doc style formatting, with the idea that the single-line style
  51    (triple-slash) is the least intrusive mechanism for getting libstdc++-v3
  52    documented and cross-referenced while at the same time minimizing
  53    disruption to the current formatting.  Full documentation of functions
  54    (parameter types, return values, etc) will require the slash-splat-splat
  55    &quot;extended C&quot; commenting style.
  56 </p>
  57
  58 <h2> Full page index </h2>
  59 <p>Here are entry points to all the pages generated by Doxygen:
  60    <ul>
  61     <li><a href="index.html">Main Page</a>
  62     <li><a href="modules.html">Modules</a>
  63     <li><a href="namespaces.html">Namespace List</a>
  64     <li><a href="hierarchy.html">Class Hierarchy</a>
  65     <li><a href="classes.html">Alphabetical List</a>
  66     <li><a href="annotated.html">Compound List</a>
  67     <li><a href="files.html">File List</a>
  68     <li><a href="namespacemembers.html">Namespace Members</a>
  69     <li><a href="functions.html">Compound Members</a>
  70     <li><a href="globals.html">File Members</a>
  71    </ul>
  72 </p>
  73
  74 */
  75
  76