xref: /netbsd-src/external/gpl3/gcc/dist/libstdc++-v3/doc/xml/api.xml (revision a24efa7dea9f1f56c3bdb15a927d3516792ace1c) 
1<book xmlns="http://docbook.org/ns/docbook" version="5.0">
2
3<article xml:id="api" xreflabel="API">
4<?dbhtml filename="api.html"?>
5
6<title>The GNU C++ Library API Reference</title>
7
8<info>
9  <copyright>
10    <year>
11      2008
12    </year>
13    <year>
14      2010
15    </year>
16    <year>
17      2014
18    </year>
19    <holder>
20      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.fsf.org/">FSF
21      </link>
22    </holder>
23  </copyright>
24  <legalnotice>
25    <para>
26      <link linkend="manual.intro.status.license">License
27      </link>
28    </para>
29  </legalnotice>
30</info>
31
32<para>
33  The GNU C++ library sources have been specially formatted so that
34  with the proper invocation of another tool (Doxygen), a set of
35  indexed reference material can generated from the sources files
36  themselves. The resultant documentation is referred to as the API
37  documentation, and is useful for examining the signatures of public
38  member functions for the library classes, finding out what is in a
39  particular include file, looking at inheritance diagrams, etc.
40</para>
41
42<para>
43  The API documentation, rendered into HTML, can be viewed online:
44</para>
45
46<itemizedlist>
47  <listitem>
48    <para>
49      <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
50      </link>
51    </para>
52  </listitem>
53  <listitem>
54    <para>
55      <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
56      </link>
57    </para>
58  </listitem>
59  <listitem>
60    <para>
61      <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
62      </link>
63    </para>
64  </listitem>
65  <listitem>
66    <para>
67      <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
68      </link>
69    </para>
70  </listitem>
71  <listitem>
72    <para>
73      <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
74      </link>
75    </para>
76  </listitem>
77  <listitem>
78    <para>
79      <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
80      </link>
81    </para>
82  </listitem>
83  <listitem>
84    <para>
85      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-api-4.6/index.html">for the 4.6 release
86      </link>
87    </para>
88  </listitem>
89  <listitem>
90    <para>
91      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/gcc-4.7.4/libstdc++/api/">for the 4.7.4 release
92      </link>
93    </para>
94  </listitem>
95  <listitem>
96    <para>
97      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/gcc-4.8.3/libstdc++/api/">for the 4.8.3 release
98      </link>
99    </para>
100  </listitem>
101  <listitem>
102    <para>
103      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/gcc-4.9.0/libstdc++/api/">for the 4.9.0 release
104      </link>
105    </para>
106  </listitem>
107  <listitem>
108    <para>
109      <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html">"the latest collection"
110      </link>
111      (For the main development tree; see the date on the first page.)
112    </para>
113  </listitem>
114</itemizedlist>
115
116<para>
117  The rendered HTML, as above, is also available for download on the
118  gcc.gnu.org site in a directory located at
119   <literal>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</literal>.
120   You will almost certainly need to use one of the
121   <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/mirrors.html">mirror sites</link> to download
122   the tarball. After unpacking, simply load libstdc++-html-*/index.html
123   into a browser.
124</para>
125
126<para>
127  In addition, a rendered set of man pages are available in the same
128  location specified above. Start with C++Intro(3).
129</para>
130
131</article>
132
133</book>
134