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 <year> 17 2014 18 </year> 19 <holder> 20 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.fsf.org">FSF 21 </link> 22 </holder> 23 </copyright> 24 <legalnotice> 25 <para> 26 <link linkend="manual.intro.status.license">License 27 </link> 28 </para> 29 </legalnotice> 30</info> 31 32<para> 33 The GNU C++ library sources have been specially formatted so that 34 with the proper invocation of another tool (Doxygen), a set of 35 indexed reference material can generated from the sources files 36 themselves. The resultant documentation is referred to as the API 37 documentation, and is useful for examining the signatures of public 38 member functions for the library classes, finding out what is in a 39 particular include file, looking at inheritance diagrams, etc. 40</para> 41 42<para> 43 The API documentation, rendered into HTML, can be viewed online 44 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/">for each GCC release</link> 45 and 46 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html"> 47 for the main development tree 48 </link> 49 (see the date on the first page). 50</para> 51 52<para> 53 The rendered HTML, as above, is also available for download on the 54 gcc.gnu.org site in a directory located at 55 <literal><URL:https://gcc.gnu.org/pub/gcc/libstdc++/doxygen/></literal>. 56 You will almost certainly need to use one of the 57 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/mirrors.html">mirror sites</link> to download 58 the tarball. After unpacking, simply load libstdc++-html-*/index.html 59 into a browser. 60</para> 61 62<para> 63 In addition, a rendered set of man pages are available in the same 64 location specified above. Start with C++Intro(3). 65</para> 66 67</article> 68 69</book> 70