939759fcc9
2008-03-25 Benjamin Kosnik <bkoz@redhat.com> * scripts/run_doxygen: Remove html_output_dir. Downgrade to Doxygen 1.5.1. * doc/doxygen/style.css: Delete. * doc/doxygen/user.cfg.in: Regenerate with Doxygen 1.5.1. (INPUT): Update. (PREDEFINED): Update. (HTML_OUTPUT): Remove html_output_dir, use html. (HTML_STYLESHEET): Remove style.css. * doc/doxygen/tables.html: Remove style.css use. * doc/doxygen/mainpage.html: Nested lists for Namespaces and Classes. * doc/doxygen/doxygroups.cc: Namespace edits. * doc/doxygen/Intro.3: Correct typo. * doc/xml/api.xml: Add gcc-4.3 links. * doc/html/api.html: Regenerate. * include/debug/debug.h: Document namepaces here. * include/parallel/base.h: Same. * include/ext/typelist.h: Same. * include/ext/pb_ds/tag_and_trait.hpp: Same. * include/tr1_impl/random: Adjust line break. * include/tr1_impl/unordered_map: Correct and or add markup. * include/tr1_impl/boost_shared_ptr.h: Correct and or add markup. * include/tr1_impl/functional_hash.h: Same. * include/tr1_impl/cmath: Same. * include/tr1_impl/functional: Same. * include/tr1_impl/unordered_set: Same. * include/tr1_impl/complex: Same. * include/tr1_impl/type_traits: Same. * include/tr1_impl/regex: Same. * include/tr1_impl/array: Same. * include/std/tuple: Same. * include/std/date_time: Same. * include/std/system_error: Same. * include/std/type_traits: Same. * include/ext/enc_filebuf.h: Same. * include/ext/throw_allocator.h: Same. * include/ext/pool_allocator.h: Same. * include/ext/bitmap_allocator.h: Same. * include/ext/concurrence.h: Same. * include/ext/codecvt_specializations.h: Same. * include/ext/stdio_sync_filebuf.h: Same. * include/ext/array_allocator.h: Same. * include/ext/mt_allocator.h: Same. * include/bits/locale_classes.h: Same. * include/bits/locale_facets.h: Same. * include/bits/codecvt.h: Same. * include/bits/char_traits.h: Same. * include/bits/allocator.h: Same. * include/bits/locale_facets_nonio.h: Same. * include/tr1/poly_laguerre.tcc: Same. * include/tr1/riemann_zeta.tcc: Same. * include/tr1/beta_function.tcc: Same. * include/tr1/tuple: Same. * include/tr1/exp_integral.tcc: Same. * include/tr1/gamma.tcc: Same. * include/tr1/hypergeometric.tcc: Same. * include/tr1/modified_bessel_func.tcc: Same. * include/tr1/legendre_function.tcc: Same. * include/tr1/type_traits: Same. * include/tr1/special_function_util.h: Same. * include/tr1/bessel_function.tcc: Same. * include/tr1/cmath: Same. * include/tr1/poly_hermite.tcc: Same. * include/tr1/ell_integral.tcc: Same. * config/abi/compatibility.h: Adjust file name. * testsuite/19_diagnostics/error_category/cons/copy_neg.cc: Adjust line numbers. * testsuite/20_util/make_signed/requirements/typedefs_neg.cc: Same. * testsuite/20_util/make_unsigned/requirements/typedefs_neg.cc: Same. From-SVN: r133544
101 lines
2.6 KiB
XML
101 lines
2.6 KiB
XML
<?xml version='1.0'?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
|
|
[ ]>
|
|
|
|
<book>
|
|
|
|
<article id="api" xreflabel="API">
|
|
<?dbhtml filename="api.html"?>
|
|
|
|
<articleinfo>
|
|
<title>API and Source Level Documentation</title>
|
|
<copyright>
|
|
<year>
|
|
2008
|
|
</year>
|
|
<holder>
|
|
<ulink url="http://www.fsf.org/">FSF
|
|
</ulink>
|
|
</holder>
|
|
</copyright>
|
|
<legalnotice>
|
|
<para>
|
|
<ulink url="17_intro/license.html">License
|
|
</ulink>
|
|
</para>
|
|
</legalnotice>
|
|
</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.
|
|
</para>
|
|
|
|
<para>
|
|
The source-level documentation for the most recent releases can be
|
|
viewed online:
|
|
</para>
|
|
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
<ulink url="libstdc++-html-USERS-3.4/index.html">for the 3.4 release
|
|
</ulink>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<ulink url="libstdc++-html-USERS-4.1/index.html">for the 4.1 release
|
|
</ulink>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<ulink url="libstdc++-html-USERS-4.2/index.html">for the 4.2 release
|
|
</ulink>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<ulink url="libstdc++-html-USERS-4.3/index.html">for the 4.3 release
|
|
</ulink>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<ulink url="latest-doxygen/index.html">"the latest collection"
|
|
</ulink>
|
|
(For the main development tree; see the date on the first page.)
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<para>
|
|
This generated HTML collection, as above, is also available for download in the libstdc++ snapshots directory at
|
|
<literal><URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/></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
|
|
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).
|
|
</para>
|
|
|
|
</article>
|
|
|
|
</book>
|