2008-02-12 03:39:33 +01:00
|
|
|
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
|
|
|
|
<!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>API and Source Level Documentation</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><link rel="start" 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" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="api"></a>API and Source Level Documentation</h2></div><div><p class="copyright">Copyright ©
|
|
|
|
|
|
2008
|
|
|
|
|
|
|
2008-03-23 20:19:05 +01:00
|
|
|
|
<a class="ulink" href="http://www.fsf.org/" target="_top">FSF
|
2008-02-12 03:39:33 +01:00
|
|
|
|
</a>
|
2008-03-23 20:19:05 +01:00
|
|
|
|
</p></div><div><div class="legalnotice"><a id="id375791"></a><p>
|
2008-02-12 03:39:33 +01:00
|
|
|
|
<a class="ulink" href="17_intro/license.html" target="_top">License
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</p></div></div></div><hr /></div><p>
|
|
|
|
|
|
The GNU C++ library sources have been specially formatted so that with the
|
|
|
|
|
|
proper invocation of another tool (Doxygen), a set of HTML pages
|
|
|
|
|
|
are generated from the sources files themselves. The resultant
|
|
|
|
|
|
documentation is referred to as Source Level Documentation, and is
|
|
|
|
|
|
useful for examining the signatures of public member functions for
|
|
|
|
|
|
the library classes, finding out what is in a particular include
|
|
|
|
|
|
file, looking at inheritance diagrams, etc.
|
|
|
|
|
|
</p><p>
|
|
|
|
|
|
The source-level documentation for the most recent releases can be
|
|
|
|
|
|
viewed online:
|
|
|
|
|
|
</p><div class="itemizedlist"><ul type="disc"><li><p>
|
|
|
|
|
|
<a class="ulink" href="libstdc++-html-USERS-3.4/index.html" target="_top">for the 3.4 release
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</p></li><li><p>
|
|
|
|
|
|
<a class="ulink" href="libstdc++-html-USERS-4.1/index.html" target="_top">for the 4.1 release
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</p></li><li><p>
|
|
|
|
|
|
<a class="ulink" href="libstdc++-html-USERS-4.2/index.html" target="_top">for the 4.2 release
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</p></li><li><p>
|
|
|
|
|
|
<a class="ulink" href="latest-doxygen/index.html" target="_top">"the latest collection"
|
|
|
|
|
|
</a>
|
|
|
|
|
|
(For the main development tree; see the date on the first page.)
|
|
|
|
|
|
</p></li></ul></div><p>
|
|
|
|
|
|
This generated HTML collection, as above, is also available for download in the libstdc++ snapshots directory at
|
|
|
|
|
|
<code class="literal"><URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/></code>.
|
|
|
|
|
|
You will almost certainly need to use one of the
|
|
|
|
|
|
<a class="ulink" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
|
|
|
|
|
|
the tarball. After unpacking, simply load libstdc++-html-*/index.html
|
|
|
|
|
|
into a browser.
|
|
|
|
|
|
</p><p>
|
|
|
|
|
|
Documentation for older releases is available for download only, not
|
|
|
|
|
|
online viewing.
|
|
|
|
|
|
</p><p>
|
|
|
|
|
|
In addition, an initial set of man pages are also available in the
|
|
|
|
|
|
same place as the HTML collections. Start with C++Intro(3).
|
|
|
|
|
|
</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>
|
