xref: /netbsd-src/external/gpl3/gcc.old/dist/libstdc++-v3/doc/html/api.html (revision 946379e7b37692fc43f68eb0d1c10daa0a7f3b6c)
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-NS Stylesheets V1.78.1" /><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      <a class="link" href="http://www.fsf.org/" target="_top">FSF
8      </a>
9    </p></div><div><div class="legalnotice"><a id="idm270006235696"></a><p>
10      <a class="link" href="manual/license.html" title="License">License
11      </a>
12    </p></div></div></div><hr /></div><p>
13  The GNU C++ library sources have been specially formatted so that
14  with the proper invocation of another tool (Doxygen), a set of
15  indexed reference material can generated from the sources files
16  themselves. The resultant documentation is referred to as the API
17  documentation, and is useful for examining the signatures of public
18  member functions for the library classes, finding out what is in a
19  particular include file, looking at inheritance diagrams, etc.
20</p><p>
21  The API documentation, rendered into HTML, can be viewed online:
22</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
23      <a class="link" 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="link" 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="link" 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="link" 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="link" 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="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-api-4.5/index.html" target="_top">for the 4.5 release
39      </a>
40    </p></li><li class="listitem"><p>
41      <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-api-4.6/index.html" target="_top">for the 4.6 release
42      </a>
43    </p></li><li class="listitem"><p>
44      <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">"the latest collection"
45      </a>
46      (For the main development tree; see the date on the first page.)
47    </p></li></ul></div><p>
48  The rendered HTML, as above, is also available for download on the
49  gcc.org site in a directory located at
50   <code class="literal">&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
51   You will almost certainly need to use one of the
52   <a class="link" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
53   the tarball. After unpacking, simply load libstdc++-html-*/index.html
54   into a browser.
55</p><p>
56  In addition, a rendered set of man pages are available in the same
57  location specified above. Start with C++Intro(3).
58</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>