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

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>The GNU C++ Library API Reference</title><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"><meta name="keywords" content="
   2       ISO C++
   3     ,
   4       runtime
   5     ,
   6       library
   7     "><link rel="home" href="index.html" title="The GNU C++ Library"><link rel="up" href="bk02.html" title=""><link rel="prev" href="bk02.html" title=""><link rel="next" href="bk03.html" title=""></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The GNU C++ Library API Reference</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="The GNU C++ Library API Reference"><div class="titlepage"><div><div><h2 class="title"><a name="api"></a>The GNU C++ Library API Reference</h2></div><div><p class="copyright">Copyright ©
   8       2008
   9     ,
  10       2010
  11
  12       <a class="link" href="http://www.fsf.org/" target="_top">FSF
  13       </a>
  14     </p></div><div><div class="legalnotice" title="Legal Notice"><a name="id518764"></a><p>
  15       <a class="link" href="manual/license.html" title="License">License
  16       </a>
  17     </p></div></div></div><hr></div><p>
  18   The GNU C++ library sources have been specially formatted so that
  19   with the proper invocation of another tool (Doxygen), a set of
  20   indexed reference material can generated from the sources files
  21   themselves. The resultant documentation is referred to as the API
  22   documentation, and is useful for examining the signatures of public
  23   member functions for the library classes, finding out what is in a
  24   particular include file, looking at inheritance diagrams, etc.
  25 </p><p>
  26   The API documentation, rendered into HTML, can be viewed online:
  27 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
  28       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-3.4/index.html" target="_top">for the 3.4 release
  29       </a>
  30     </p></li><li class="listitem"><p>
  31       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.1/index.html" target="_top">for the 4.1 release
  32       </a>
  33     </p></li><li class="listitem"><p>
  34       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.2/index.html" target="_top">for the 4.2 release
  35       </a>
  36     </p></li><li class="listitem"><p>
  37       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/index.html" target="_top">for the 4.3 release
  38       </a>
  39     </p></li><li class="listitem"><p>
  40       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/index.html" target="_top">for the 4.4 release
  41       </a>
  42     </p></li><li class="listitem"><p>
  43       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-api-4.5/index.html" target="_top">for the 4.5 release
  44       </a>
  45     </p></li><li class="listitem"><p>
  46       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-api-4.6/index.html" target="_top">for the 4.6 release
  47       </a>
  48     </p></li><li class="listitem"><p>
  49       <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">"the latest collection"
  50       </a>
  51       (For the main development tree; see the date on the first page.)
  52     </p></li></ul></div><p>
  53   The rendered HTML, as above, is also available for download on the
  54   gcc.org site in a directory located at
  55    <code class="literal">&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
  56    You will almost certainly need to use one of the
  57    <a class="link" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
  58    the tarball. After unpacking, simply load libstdc++-html-*/index.html
  59    into a browser.
  60 </p><p>
  61   In addition, a rendered set of man pages are available in the same
  62   location specified above. Start with C++Intro(3).
  63 </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="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>