2008-02-11 01:01:33 +01:00
|
|
|
<?xml version='1.0'?>
|
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
|
|
|
|
[ ]>
|
|
|
|
|
|
|
|
<book>
|
|
|
|
|
|
|
|
<article id="api" xreflabel="API">
|
|
|
|
<?dbhtml filename="api.html"?>
|
|
|
|
|
|
|
|
<articleinfo>
|
2010-03-12 18:35:19 +01:00
|
|
|
<title>API Documentation</title>
|
2008-02-11 01:01:33 +01:00
|
|
|
<copyright>
|
|
|
|
<year>
|
|
|
|
2008
|
|
|
|
</year>
|
2010-03-12 18:35:19 +01:00
|
|
|
<year>
|
|
|
|
2010
|
|
|
|
</year>
|
2008-02-11 01:01:33 +01:00
|
|
|
<holder>
|
2008-03-23 20:19:05 +01:00
|
|
|
<ulink url="http://www.fsf.org/">FSF
|
2008-02-11 01:01:33 +01:00
|
|
|
</ulink>
|
|
|
|
</holder>
|
|
|
|
</copyright>
|
|
|
|
<legalnotice>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<link linkend="manual.intro.status.license">License
|
|
|
|
</link>
|
2008-02-11 01:01:33 +01:00
|
|
|
</para>
|
|
|
|
</legalnotice>
|
|
|
|
</articleinfo>
|
|
|
|
|
|
|
|
<para>
|
2010-03-12 18:35:19 +01:00
|
|
|
The GNU C++ library sources have been specially formatted so that
|
|
|
|
with the proper invocation of another tool (Doxygen), a set of
|
|
|
|
indexed reference material can generated from the sources files
|
|
|
|
themselves. The resultant documentation is referred to as the API
|
|
|
|
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.
|
2008-02-11 01:01:33 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2010-03-12 18:35:19 +01:00
|
|
|
The API documentation, rendered into HTML, can be viewed online:
|
2008-02-11 01:01:33 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-3.4/index.html">for the 3.4 release
|
2008-02-11 01:01:33 +01:00
|
|
|
</ulink>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.1/index.html">for the 4.1 release
|
2008-02-11 01:01:33 +01:00
|
|
|
</ulink>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.2/index.html">for the 4.2 release
|
2008-02-11 01:01:33 +01:00
|
|
|
</ulink>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2008-03-26 07:27:35 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/index.html">for the 4.3 release
|
2008-03-26 07:27:35 +01:00
|
|
|
</ulink>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2009-04-07 03:46:45 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/index.html">for the 4.4 release
|
2009-04-07 03:46:45 +02:00
|
|
|
</ulink>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2008-02-11 01:01:33 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2009-07-21 04:47:00 +02:00
|
|
|
<ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html">"the latest collection"
|
2008-02-11 01:01:33 +01:00
|
|
|
</ulink>
|
|
|
|
(For the main development tree; see the date on the first page.)
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
<para>
|
2010-03-12 18:35:19 +01:00
|
|
|
The rendered HTML, as above, is also available for download on the
|
|
|
|
gcc.org site in a directory located at
|
2008-02-11 01:01:33 +01:00
|
|
|
<literal><URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/></literal>.
|
|
|
|
You will almost certainly need to use one of the
|
|
|
|
<ulink url="http://gcc.gnu.org/mirrors.html">mirror sites</ulink> to download
|
2010-03-12 18:35:19 +01:00
|
|
|
the tarball. After unpacking, simply load libstdc++-html-*/index.html
|
2008-02-11 01:01:33 +01:00
|
|
|
into a browser.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2010-03-12 18:35:19 +01:00
|
|
|
In addition, a rendered set of man pages are available in the same
|
|
|
|
location specified above. Start with C++Intro(3).
|
2008-02-11 01:01:33 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
|
|
</book>
|