OSDN Git Service

4518f23d3dbb0f4b36c5a738c3af35e2d8de0270
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / doc / xml / api.xml
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 <info><title>API Documentation</title>
7   
8   <copyright>
9     <year>
10       2008
11     </year>
12     <year>
13       2010
14     </year>
15     <holder>
16       <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.fsf.org/">FSF
17       </link>
18     </holder>
19   </copyright>
20   <legalnotice>
21     <para>
22       <link linkend="manual.intro.status.license">License 
23       </link>
24     </para>
25   </legalnotice>
26 </info>
27  
28 <para>
29   The GNU C++ library sources have been specially formatted so that
30   with the proper invocation of another tool (Doxygen), a set of
31   indexed reference material can generated from the sources files
32   themselves. The resultant documentation is referred to as the API
33   documentation, and is useful for examining the signatures of public
34   member functions for the library classes, finding out what is in a
35   particular include file, looking at inheritance diagrams, etc.
36 </para>
37
38 <para>
39   The API documentation, rendered into HTML, can be viewed online:
40 </para>
41
42 <itemizedlist>
43   <listitem>
44     <para>
45       <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
46       </link>
47     </para>
48   </listitem>
49   <listitem>
50     <para>
51       <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
52       </link>
53     </para>
54   </listitem>
55   <listitem>
56     <para>
57       <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
58       </link>
59     </para>
60   </listitem>
61   <listitem>
62     <para>
63       <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
64       </link>
65     </para>
66   </listitem>
67   <listitem>
68     <para>
69       <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
70       </link>
71     </para>
72   </listitem>
73   <listitem>
74     <para>
75       <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html">"the latest collection"
76       </link>
77       (For the main development tree; see the date on the first page.)
78     </para>
79   </listitem>
80 </itemizedlist>
81
82 <para>
83   The rendered HTML, as above, is also available for download on the
84   gcc.org site in a directory located at
85    <literal>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</literal>.
86    You will almost certainly need to use one of the
87    <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/mirrors.html">mirror sites</link> to download
88    the tarball. After unpacking, simply load libstdc++-html-*/index.html
89    into a browser.
90 </para>
91
92 <para>
93   In addition, a rendered set of man pages are available in the same
94   location specified above. Start with C++Intro(3).
95 </para>
96
97 </article>
98
99 </book>