OSDN Git Service

4d5bd155582965cea3da5785df20409b740e00fb
[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 and Source Level Documentation</title>
13   <copyright>
14     <year>
15       2008
16     </year>
17     <holder>
18       <ulink url="http://www.fsf.org/">FSF
19       </ulink>
20     </holder>
21   </copyright>
22   <legalnotice>
23     <para>
24       <link linkend="manual.intro.status.license">License 
25       </link>
26     </para>
27   </legalnotice>
28 </articleinfo>
29  
30 <para>
31 The GNU C++ library sources have been specially formatted so that with the
32 proper invocation of another tool (Doxygen), a set of HTML pages
33 are generated from the sources files themselves. The resultant
34 documentation is referred to as Source Level Documentation, and is
35 useful for examining the signatures of public member functions for
36 the library classes, finding out what is in a particular include
37 file, looking at inheritance diagrams, etc.
38 </para>
39
40 <para>
41 The source-level documentation for the most recent releases can be
42 viewed online:
43 </para>
44
45 <itemizedlist>
46   <listitem>
47     <para>
48       <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-3.4/index.html">for the 3.4 release
49       </ulink>
50     </para>
51   </listitem>
52   <listitem>
53     <para>
54       <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.1/index.html">for the 4.1 release
55       </ulink>
56     </para>
57   </listitem>
58   <listitem>
59     <para>
60       <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.2/index.html">for the 4.2 release
61       </ulink>
62     </para>
63   </listitem>
64   <listitem>
65     <para>
66       <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.3/index.html">for the 4.3 release
67       </ulink>
68     </para>
69   </listitem>
70   <listitem>
71     <para>
72       <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/libstdc++-html-USERS-4.4/index.html">for the 4.4 release
73       </ulink>
74     </para>
75   </listitem>
76   <listitem>
77     <para>
78       <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html">&quot;the latest collection&quot;
79       </ulink>
80       (For the main development tree; see the date on the first page.)
81     </para>
82   </listitem>
83 </itemizedlist>
84
85 <para>
86 This generated HTML collection, as above, is also available for download in the libstdc++ snapshots directory at
87    <literal>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</literal>.
88    You will almost certainly need to use one of the
89    <ulink url="http://gcc.gnu.org/mirrors.html">mirror sites</ulink> to download
90    the tarball.  After unpacking, simply load libstdc++-html-*/index.html
91    into a browser.
92 </para>
93
94 <para>
95 Documentation for older releases is available for download only, not
96 online viewing.
97 </para>
98
99 <para>
100 In addition, an initial set of man pages are also available in the
101 same place as the HTML collections.  Start with C++Intro(3).
102 </para>
103
104 </article>
105
106 </book>