Home | History | Annotate | Line # | Download | only in 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"><html xmlns="http://www.w3.org/1999/xhtml"><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 Stylesheets Vsnapshot" /><meta name="keywords" content="ISO C++, runtime, library" /><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><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"><div class="titlepage"><div><div><h1 class="title"><a id="api"></a>The GNU C++ Library API Reference</h1></div><div><p class="copyright">Copyright  
      3       2008
      4     , 
      5       2010
      6     , 
      7       2014
      8      
      9       <a class="link" href="https://www.fsf.org" target="_top">FSF
     10       </a>
     11     </p></div><div><div class="legalnotice"><a id="id-1.4.1.2.2"></a><p>
     12       <a class="link" href="manual/license.html" title="License">License
     13       </a>
     14     </p></div></div></div><hr /></div><p>
     15   The GNU C++ library sources have been specially formatted so that
     16   with the proper invocation of another tool (Doxygen), a set of
     17   indexed reference material can generated from the sources files
     18   themselves. The resultant documentation is referred to as the API
     19   documentation, and is useful for examining the signatures of public
     20   member functions for the library classes, finding out what is in a
     21   particular include file, looking at inheritance diagrams, etc.
     22 </p><p>
     23   The API documentation, rendered into HTML, can be viewed online
     24   <a class="link" href="http://gcc.gnu.org/onlinedocs/" target="_top">for each GCC release</a>
     25   and
     26   <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">
     27   for the main development tree
     28   </a>
     29   (see the date on the first page).
     30 </p><p>
     31   The rendered HTML, as above, is also available for download on the
     32   gcc.gnu.org site in a directory located at
     33    <code class="literal">&lt;URL:https://gcc.gnu.org/pub/gcc/libstdc++/doxygen/>;</code>.
     34    You will almost certainly need to use one of the
     35    <a class="link" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
     36    the tarball. After unpacking, simply load libstdc++-html-*/index.html
     37    into a browser.
     38 </p><p>
     39   In addition, a rendered set of man pages are available in the same
     40   location specified above. Start with C++Intro(3).
     41 </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>