diff options
author | bkoz <bkoz@138bc75d-0d04-0410-961f-82ee72b054a4> | 2008-02-11 00:01:33 +0000 |
---|---|---|
committer | bkoz <bkoz@138bc75d-0d04-0410-961f-82ee72b054a4> | 2008-02-11 00:01:33 +0000 |
commit | 2aad0282e79bee5d49dfd0f76d5c72f6c6912156 (patch) | |
tree | 9c37bc44363d015d83f53e9ff733daf4affc1973 /libstdc++-v3/doc/xml/api.xml | |
parent | 90a6366aaa90e4e3c7bf9af1b57df621241589a0 (diff) | |
download | gcc-2aad0282e79bee5d49dfd0f76d5c72f6c6912156.tar.gz |
2008-02-10 Benjamin Kosnik <bkoz@redhat.com>
Convert documentation to DocBook.
* doc/Makefile.am (doc-doxygen-html): Changed to doc-html-doxygen.
(doc-doxygen-man): Changed to doc-man-doxygen.
(doc-performance): Changed to doc-html-performance.
(doc-xml-doxygen): New.
(doc-xml-single): New.
(doc-xml-validate): New.
(doc-html): New.
(doc-html-single): New.
(doc-fo): New.
(doc-pdf): New.
(doc-pdf-fop-xml): New.
(doc-pdf-fop-fo): New.
(doc-pdf-xmlto): New.
(doc-pdf-xmlroff): New.
(doc-pdf-prince): New.
* doc/xml: New directory.
* doc/xml/authors.xml: New.
* doc/xml/images: New directory.
* doc/xml/images/confdeps.png: Add.
* doc/xml/images/confdeps.dot: Add.
* doc/xml/faq.xml: New.
* doc/xml/api.xml: New.
* doc/xml/gnu: New directory.
* doc/xml/gnu/gpl-3.0.xml: New.
* doc/xml/gnu/fdl-1.2.xml: New.
* doc/xml/gnu/gpl-2.0.xml: New.
* doc/xml/manual: New directory.
* doc/xml/manual/mt_allocator.xml: New.
* doc/xml/manual/allocator.xml: New.
* doc/xml/manual/ctype.xml: New.
* doc/xml/manual/numerics.xml: New.
* doc/xml/manual/codecvt.xml: New.
* doc/xml/manual/concurrency.xml: New.
* doc/xml/manual/backwards_compatibility.xml: New.
* doc/xml/manual/intro.xml: New.
* doc/xml/manual/shared_ptr.xml: New.
* doc/xml/manual/abi.xml: New.
* doc/xml/manual/status_cxxtr1.xml: New.
* doc/xml/manual/auto_ptr.xml: New.
* doc/xml/manual/build.xml: New.
* doc/xml/manual/internals.xml: New.
* doc/xml/manual/parallel_mode.xml: New.
* doc/xml/manual/status_cxx1998.xml: New.
* doc/xml/manual/containers.xml: New.
* doc/xml/manual/io.xml: New.
* doc/xml/manual/appendix_porting.xml: New.
* doc/xml/manual/utilities.xml: New.
* doc/xml/manual/bitmap_allocator.xml: New.
* doc/xml/manual/support.xml: New.
* doc/xml/manual/configure.xml: New.
* doc/xml/manual/build_hacking.xml: New.
* doc/xml/manual/evolution.xml: New.
* doc/xml/manual/using.xml: New.
* doc/xml/manual/debug.xml: New.
* doc/xml/manual/localization.xml: New.
* doc/xml/manual/strings.xml: New.
* doc/xml/manual/debug_mode.xml: New.
* doc/xml/manual/locale.xml: New.
* doc/xml/manual/extensions.xml: New.
* doc/xml/manual/appendix_contributing.xml: New.
* doc/xml/manual/messages.xml: New.
* doc/xml/manual/diagnostics.xml: New.
* doc/xml/manual/appendix_free.xml: New.
* doc/xml/manual/algorithms.xml: New.
* doc/xml/manual/iterators.xml: New.
* doc/xml/manual/spine.xml: New.
* doc/xml/manual/test.xml: New.
* doc/xml/manual/status_cxx200x.xml: New.
* doc/xml/spine.xml: New.
* doc/xml/book.txml: New. Template file.
* doc/xml/chapter.txml: Same.
* doc/xml/class.txml: Same.
* doc/doxygen/guide.html: Removed, integrated into other docs.
* doc/doxygen/user.cfg.in: Clean up XML generation.
* doc/doxygen/run_doxygen: Move to..
* scripts/run_doxygen: ...here.
* configure: Regenerate.
* Makefile.in: Regenerate.
* src/Makefile.in: Regenerate.
* doc/Makefile.in: Regenerate.
* po/Makefile.in: Regenerate.
* libmath/Makefile.in: Regenerate.
* include/Makefile.in: Regenerate.
* libsupc++/Makefile.in: Regenerate.
* testsuite/Makefile.in: Regenerate.
* aclocal.m4: Regenerate.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@132226 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libstdc++-v3/doc/xml/api.xml')
-rw-r--r-- | libstdc++-v3/doc/xml/api.xml | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/libstdc++-v3/doc/xml/api.xml b/libstdc++-v3/doc/xml/api.xml new file mode 100644 index 00000000000..bd38e8392cc --- /dev/null +++ b/libstdc++-v3/doc/xml/api.xml @@ -0,0 +1,94 @@ +<?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://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="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> |