libstdc++-v3/doc/html/api.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>API Documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="spine.html" title="The GNU C++ Library Documentation" /><link rel="up" href="bk02.html" title="" /><link rel="prev" href="bk02.html" title="" /><link rel="next" href="bk03.html" title="" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">API Documentation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="bk02.html">Prev</a> </td><th width="60%" align="center"></th><td width="20%" align="right"> <a accesskey="n" href="bk03.html">Next</a></td></tr></table><hr /></div><div class="article" title="API Documentation"><div class="titlepage"><div><div><h2 class="title"><a id="api"></a>API Documentation</h2></div><div><p class="copyright">Copyright ©
   4       2008
   5     ,
   6       2010
   7
   8       <a class="ulink" href="http://www.fsf.org/" target="_top">FSF
   9       </a>
  10     </p></div><div><div class="legalnotice" title="Legal Notice"><a id="id491737"></a><p>
  11       <a class="link" href="manual/license.html" title="License">License
  12       </a>
  13     </p></div></div></div><hr /></div><p>
  14   The GNU C++ library sources have been specially formatted so that
  15   with the proper invocation of another tool (Doxygen), a set of
  16   indexed reference material can generated from the sources files
  17   themselves. The resultant documentation is referred to as the API
  18   documentation, and is useful for examining the signatures of public
  19   member functions for the library classes, finding out what is in a
  20   particular include file, looking at inheritance diagrams, etc.
  21 </p><p>
  22   The API documentation, rendered into HTML, can be viewed online:
  23 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
  24       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-3.4/index.html" target="_top">for the 3.4 release
  25       </a>
  26     </p></li><li class="listitem"><p>
  27       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.1/index.html" target="_top">for the 4.1 release
  28       </a>
  29     </p></li><li class="listitem"><p>
  30       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.2/index.html" target="_top">for the 4.2 release
  31       </a>
  32     </p></li><li class="listitem"><p>
  33       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/index.html" target="_top">for the 4.3 release
  34       </a>
  35     </p></li><li class="listitem"><p>
  36       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/index.html" target="_top">for the 4.4 release
  37       </a>
  38     </p></li><li class="listitem"><p>
  39       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">"the latest collection"
  40       </a>
  41       (For the main development tree; see the date on the first page.)
  42     </p></li></ul></div><p>
  43   The rendered HTML, as above, is also available for download on the
  44   gcc.org site in a directory located at
  45    <code class="literal">&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
  46    You will almost certainly need to use one of the
  47    <a class="ulink" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
  48    the tarball. After unpacking, simply load libstdc++-html-*/index.html
  49    into a browser.
  50 </p><p>
  51   In addition, a rendered set of man pages are available in the same
  52   location specified above. Start with C++Intro(3).
  53 </p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="bk02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="bk02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bk03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="spine.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>