OSDN Git Service

2010-03-12 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / doc / xml / api.xml
index 4d5bd15..3073ed8 100644 (file)
@@ -9,11 +9,14 @@
 <?dbhtml filename="api.html"?>
 
 <articleinfo>
 <?dbhtml filename="api.html"?>
 
 <articleinfo>
-  <title>API and Source Level Documentation</title>
+  <title>API Documentation</title>
   <copyright>
     <year>
       2008
     </year>
   <copyright>
     <year>
       2008
     </year>
+    <year>
+      2010
+    </year>
     <holder>
       <ulink url="http://www.fsf.org/">FSF
       </ulink>
     <holder>
       <ulink url="http://www.fsf.org/">FSF
       </ulink>
 </articleinfo>
  
 <para>
 </articleinfo>
  
 <para>
-The GNU C++ library sources have been specially formatted so that with the
-proper invocation of another tool (Doxygen), a set of HTML pages
-are generated from the sources files themselves. The resultant
-documentation is referred to as Source Level 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.
+  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>
 </para>
 
 <para>
-The source-level documentation for the most recent releases can be
-viewed online:
+  The API documentation, rendered into HTML, can be viewed online:
 </para>
 
 <itemizedlist>
 </para>
 
 <itemizedlist>
@@ -83,22 +85,18 @@ viewed online:
 </itemizedlist>
 
 <para>
 </itemizedlist>
 
 <para>
-This generated HTML collection, as above, is also available for download in the libstdc++ snapshots directory at
+  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
    <ulink url="http://gcc.gnu.org/mirrors.html">mirror sites</ulink> to download
    <literal>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</literal>.
    You will almost certainly need to use one of the
    <ulink url="http://gcc.gnu.org/mirrors.html">mirror sites</ulink> to download
-   the tarball.  After unpacking, simply load libstdc++-html-*/index.html
+   the tarball. After unpacking, simply load libstdc++-html-*/index.html
    into a browser.
 </para>
 
 <para>
    into a browser.
 </para>
 
 <para>
-Documentation for older releases is available for download only, not
-online viewing.
-</para>
-
-<para>
-In addition, an initial set of man pages are also available in the
-same place as the HTML collections.  Start with C++Intro(3).
+  In addition, a rendered set of man pages are available in the same
+  location specified above. Start with C++Intro(3).
 </para>
 
 </article>
 </para>
 
 </article>