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 and Source Level 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 and Source Level 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 and Source Level Documentation"><div class="titlepage"><div><div><h2 class="title"><a id="api"></a>API and Source Level Documentation</h2></div><div><p class="copyright">Copyright ©
   4       2008
   5
   6       <a class="ulink" href="http://www.fsf.org/" target="_top">FSF
   7       </a>
   8     </p></div><div><div class="legalnotice" title="Legal Notice"><a id="id530139"></a><p>
   9       <a class="link" href="manual/license.html" title="License">License
  10       </a>
  11     </p></div></div></div><hr /></div><p>
  12 The GNU C++ library sources have been specially formatted so that with the
  13 proper invocation of another tool (Doxygen), a set of HTML pages
  14 are generated from the sources files themselves. The resultant
  15 documentation is referred to as Source Level Documentation, and is
  16 useful for examining the signatures of public member functions for
  17 the library classes, finding out what is in a particular include
  18 file, looking at inheritance diagrams, etc.
  19 </p><p>
  20 The source-level documentation for the most recent releases can be
  21 viewed online:
  22 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
  23       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-3.4/index.html" target="_top">for the 3.4 release
  24       </a>
  25     </p></li><li class="listitem"><p>
  26       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.1/index.html" target="_top">for the 4.1 release
  27       </a>
  28     </p></li><li class="listitem"><p>
  29       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.2/index.html" target="_top">for the 4.2 release
  30       </a>
  31     </p></li><li class="listitem"><p>
  32       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/index.html" target="_top">for the 4.3 release
  33       </a>
  34     </p></li><li class="listitem"><p>
  35       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/index.html" target="_top">for the 4.4 release
  36       </a>
  37     </p></li><li class="listitem"><p>
  38       <a class="ulink" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">"the latest collection"
  39       </a>
  40       (For the main development tree; see the date on the first page.)
  41     </p></li></ul></div><p>
  42 This generated HTML collection, as above, is also available for download in the libstdc++ snapshots directory at
  43    <code class="literal">&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
  44    You will almost certainly need to use one of the
  45    <a class="ulink" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
  46    the tarball.  After unpacking, simply load libstdc++-html-*/index.html
  47    into a browser.
  48 </p><p>
  49 Documentation for older releases is available for download only, not
  50 online viewing.
  51 </p><p>
  52 In addition, an initial set of man pages are also available in the
  53 same place as the HTML collections.  Start with C++Intro(3).
  54 </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>