summaryrefslogtreecommitdiff
path: root/libstdc++-v3/doc/xml/api.xml
diff options
context:
space:
mode:
authorupstream source tree <ports@midipix.org>2015-03-15 20:14:05 -0400
committerupstream source tree <ports@midipix.org>2015-03-15 20:14:05 -0400
commit554fd8c5195424bdbcabf5de30fdc183aba391bd (patch)
tree976dc5ab7fddf506dadce60ae936f43f58787092 /libstdc++-v3/doc/xml/api.xml
downloadcbb-gcc-4.6.4-554fd8c5195424bdbcabf5de30fdc183aba391bd.tar.bz2
cbb-gcc-4.6.4-554fd8c5195424bdbcabf5de30fdc183aba391bd.tar.xz
obtained gcc-4.6.4.tar.bz2 from upstream website;upstream
verified gcc-4.6.4.tar.bz2.sig; imported gcc-4.6.4 source tree from verified upstream tarball. downloading a git-generated archive based on the 'upstream' tag should provide you with a source tree that is binary identical to the one extracted from the above tarball. if you have obtained the source via the command 'git clone', however, do note that line-endings of files in your working directory might differ from line-endings of the respective files in the upstream repository.
Diffstat (limited to 'libstdc++-v3/doc/xml/api.xml')
-rw-r--r--libstdc++-v3/doc/xml/api.xml106
1 files changed, 106 insertions, 0 deletions
diff --git a/libstdc++-v3/doc/xml/api.xml b/libstdc++-v3/doc/xml/api.xml
new file mode 100644
index 000000000..dcd88d7e3
--- /dev/null
+++ b/libstdc++-v3/doc/xml/api.xml
@@ -0,0 +1,106 @@
+<book xmlns="http://docbook.org/ns/docbook" version="5.0">
+
+<article xml:id="api" xreflabel="API">
+<?dbhtml filename="api.html"?>
+
+<title>The GNU C++ Library API Reference</title>
+
+<info>
+ <copyright>
+ <year>
+ 2008
+ </year>
+ <year>
+ 2010
+ </year>
+ <holder>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.fsf.org/">FSF
+ </link>
+ </holder>
+ </copyright>
+ <legalnotice>
+ <para>
+ <link linkend="manual.intro.status.license">License
+ </link>
+ </para>
+ </legalnotice>
+</info>
+
+<para>
+ 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.
+</para>
+
+<para>
+ The API documentation, rendered into HTML, can be viewed online:
+</para>
+
+<itemizedlist>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-3.4/index.html">for the 3.4 release
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.1/index.html">for the 4.1 release
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.2/index.html">for the 4.2 release
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/index.html">for the 4.3 release
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/index.html">for the 4.4 release
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-api-4.5/index.html">for the 4.5 release
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html">"the latest collection"
+ </link>
+ (For the main development tree; see the date on the first page.)
+ </para>
+ </listitem>
+</itemizedlist>
+
+<para>
+ The rendered HTML, as above, is also available for download on the
+ gcc.org site in a directory located at
+ <literal>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</literal>.
+ You will almost certainly need to use one of the
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/mirrors.html">mirror sites</link> to download
+ the tarball. After unpacking, simply load libstdc++-html-*/index.html
+ into a browser.
+</para>
+
+<para>
+ In addition, a rendered set of man pages are available in the same
+ location specified above. Start with C++Intro(3).
+</para>
+
+</article>
+
+</book>