OSDN Git Service

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