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