OpenE2K
/
gcc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

run_doxygen: Adjust. 

2010-03-12  Benjamin Kosnik  <bkoz@redhat.com>

	* scripts/run_doxygen: Adjust.
	* doc/doxygen/user.cfg.in: Adjust latex, xml prefs.
	* doc/xml/api.xml: Update.
	* doc/Makefile.am: Re-do stamp rules.
	* doc/Makefile.in: Regenerate.

From-SVN: r157409
This commit is contained in:
Benjamin Kosnik 2010-03-12 17:35:19 +00:00 committed by Benjamin Kosnik
parent 08f9d72574
commit 60f8b2e2ff
6 changed files with 288 additions and 288 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libstdc++-v3/ChangeLog
View File

@ -1,3 +1,11 @@
2010-03-12 Benjamin Kosnik <bkoz@redhat.com>
* scripts/run_doxygen: Adjust.
* doc/doxygen/user.cfg.in: Adjust latex, xml prefs.
* doc/xml/api.xml: Update.
* doc/Makefile.am: Re-do stamp rules.
* doc/Makefile.in: Regenerate.
2010-03-10 Paolo Carlini <paolo.carlini@oracle.com>
* include/bits/hashtable_policy.h (_Rehash_base<_Prime_rehash_policy,

33
libstdc++-v3/doc/Makefile.am
View File

@ -34,7 +34,7 @@ include $(top_srcdir)/fragment.am
doc-man: doc-man-doxygen
# PDF
doc-pdf: doc-pdf-dblatex-docbook
doc-pdf: doc-pdf-docbook
# HTML
doc-html: doc-html-docbook
@ -44,6 +44,8 @@ doc-html: doc-html-docbook
# Assumes doxygen, graphviz (with dot), pdflatex installed
doxygen_script=${top_srcdir}/scripts/run_doxygen
doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
doc-html-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
@ -62,7 +64,7 @@ doc-xml-doxygen:
${SHELL} ${doxygen_script} \
--host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
doc-xml-single-doxygen: doc-xml-doxygen
doc-xml-single-doxygen:
@echo "Generating doxygen xml single file..."
$(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
${doxygen_outdir}/xml/index.xml > ${doxygen_outdir}/xml/api-spine.xml;
@ -73,9 +75,7 @@ doc-latex-doxygen:
${SHELL} ${doxygen_script} \
--host_alias=${host_alias} --mode=latex $${srcdir} $${builddir} NO)
# Chance of loooooonnggg wait time when creating this file.
doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
# Chance of loooooonnggg creation time on this rule.
doc-pdf-doxygen: stamp-latex-doxygen
-(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
echo "Generating doxygen pdf file...";
@ -86,8 +86,15 @@ doc-pdf-doxygen: stamp-latex-doxygen
exit 12; \
fi
stamp-pdf-doxygen:
@if [ ! -f stamp-pdf-doxygen ]; then \
$(MAKE) doc-pdf-doxygen; \
fi
$(STAMP) stamp-pdf-doxygen
stamp-xml-doxygen:
@if [ ! -f stamp-xml-doxygen ]; then \
$(MAKE) doc-xml-doxygen; \
$(MAKE) doc-xml-single-doxygen; \
fi
$(STAMP) stamp-xml-doxygen
@ -165,7 +172,8 @@ xml_sources_manual = \
xml_sources_extra = \
${xml_dir}/gnu/fdl-1.2.xml \
${xml_dir}/gnu/gpl-2.0.xml
${xml_dir}/gnu/gpl-2.0.xml \
${xml_dir}/gnu/gpl-3.0.xml
xml_sources = \
${xml_sources_basic} \
@ -175,11 +183,7 @@ xml_sources = \
xml_noinst = \
${xml_dir}/book.txml \
${xml_dir}/chapter.txml \
${xml_dir}/class.txml \
${xsl_dir}/doxygen2boostbook.xsl \
${xsl_dir}/boostbook2docbook.xsl \
${xsl_dir}/lookup.xsl
${xml_dir}/class.txml
XSLTPROC = xsltproc
XSLTPROC_FLAGS = --nonet --xinclude
@ -206,8 +210,8 @@ XMLLINT = xmllint
#LINT_FLAGS = --debug --nonet --xinclude --nsclean --postvalid --nowarning
#LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent
LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout
VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS)
DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS)
doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
@ -281,6 +285,8 @@ doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-docbook: doc-pdf-dblatex-docbook
# Performance doc and graph configuration.
# Assumes pychart, beautiful soup installed.
@ -293,6 +299,7 @@ doc-html-performance:
${top_srcdir}/testsuite/data/make_graph_htmls.xml \
${top_srcdir}/testsuite/data/make_graph_test_infos.xml local g++)
.PHONY: doc-doxygen-html doc-doxygen-man doc-performance
# By adding these files here, automake will remove them for 'make clean'

29
libstdc++-v3/doc/Makefile.in
View File

@ -267,8 +267,6 @@ AM_CPPFLAGS = $(GLIBCXX_INCLUDES)
# Assumes doxygen, graphviz (with dot), pdflatex installed
doxygen_script = ${top_srcdir}/scripts/run_doxygen
doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
# Chance of loooooonnggg wait time when creating this file.
doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
# Docbook configuration.
@ -337,7 +335,8 @@ xml_sources_manual = \
xml_sources_extra = \
${xml_dir}/gnu/fdl-1.2.xml \
${xml_dir}/gnu/gpl-2.0.xml
${xml_dir}/gnu/gpl-2.0.xml \
${xml_dir}/gnu/gpl-3.0.xml
xml_sources = \
${xml_sources_basic} \
@ -347,10 +346,7 @@ xml_sources = \
xml_noinst = \
${xml_dir}/book.txml \
${xml_dir}/chapter.txml \
${xml_dir}/class.txml \
${xsl_dir}/doxygen2boostbook.xsl \
${xsl_dir}/boostbook2docbook.xsl \
${xsl_dir}/lookup.xsl
${xml_dir}/class.txml
XSLTPROC = xsltproc
XSLTPROC_FLAGS = --nonet --xinclude
@ -365,8 +361,8 @@ XMLLINT = xmllint
#LINT_FLAGS = --debug --nonet --xinclude --nsclean --postvalid --nowarning
#LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent
LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout
VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS)
DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS)
# PDF 1
# fop
@ -598,10 +594,11 @@ uninstall-am:
doc-man: doc-man-doxygen
# PDF
doc-pdf: doc-pdf-dblatex-docbook
doc-pdf: doc-pdf-docbook
# HTML
doc-html: doc-html-docbook
doc-html-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
@ -620,7 +617,7 @@ doc-xml-doxygen:
${SHELL} ${doxygen_script} \
--host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
doc-xml-single-doxygen: doc-xml-doxygen
doc-xml-single-doxygen:
@echo "Generating doxygen xml single file..."
$(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
${doxygen_outdir}/xml/index.xml > ${doxygen_outdir}/xml/api-spine.xml;
@ -631,6 +628,7 @@ doc-latex-doxygen:
${SHELL} ${doxygen_script} \
--host_alias=${host_alias} --mode=latex $${srcdir} $${builddir} NO)
# Chance of loooooonnggg creation time on this rule.
doc-pdf-doxygen: stamp-latex-doxygen
-(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
echo "Generating doxygen pdf file...";
@ -641,8 +639,15 @@ doc-pdf-doxygen: stamp-latex-doxygen
exit 12; \
fi
stamp-pdf-doxygen:
@if [ ! -f stamp-pdf-doxygen ]; then \
$(MAKE) doc-pdf-doxygen; \
fi
$(STAMP) stamp-pdf-doxygen
stamp-xml-doxygen:
@if [ ! -f stamp-xml-doxygen ]; then \
$(MAKE) doc-xml-doxygen; \
$(MAKE) doc-xml-single-doxygen; \
fi
$(STAMP) stamp-xml-doxygen
@ -712,6 +717,8 @@ doc-pdf-prince-docbook: $(xml_sources) ${docbook_outdir}/pdf
doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-docbook: doc-pdf-dblatex-docbook
doc-html-performance:
-@(chmod + ${doc_performance_script}; \
${doc_performance_script} ${top_srcdir} \

380
libstdc++-v3/doc/doxygen/user.cfg.in
View File

@ -180,7 +180,7 @@ TAB_SIZE = 4
# You can put \n's in the value part of an alias to insert newlines.
ALIASES = "doctodo=@todo\nDoc me! See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more. " \
"isiosfwd=One of the @link ios I/O @endlink "
"isiosfwd=One of the @link ios I/O @endlink "
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
@ -587,156 +587,156 @@ WARN_LOGFILE =
# files or directories with spaces.
INPUT = @srcdir@/doc/doxygen/doxygroups.cc \
@srcdir@/libsupc++/cxxabi.h \
@srcdir@/libsupc++/cxxabi-forced.h \
@srcdir@/libsupc++/exception \
@srcdir@/libsupc++/exception_ptr.h \
@srcdir@/libsupc++/initializer_list \
@srcdir@/libsupc++/nested_exception.h \
@srcdir@/libsupc++/new \
@srcdir@/libsupc++/typeinfo \
include/algorithm \
include/array \
include/atomic \
include/bitset \
include/chrono \
include/complex \
include/condition_variable \
include/deque \
include/fstream \
include/functional \
include/future \
include/iomanip \
include/ios \
include/iosfwd \
include/iostream \
include/istream \
include/iterator \
include/limits \
include/list \
include/locale \
include/map \
include/memory \
include/mutex \
include/numeric \
include/ostream \
include/queue \
include/random \
include/ratio \
include/regex \
include/set \
include/sstream \
include/stack \
include/stdexcept \
include/streambuf \
include/string \
include/system_error \
include/thread \
include/tuple \
include/type_traits \
include/unordered_map \
include/unordered_set \
include/utility \
include/valarray \
include/vector \
include/cassert \
include/ccomplex \
include/cctype \
include/cerrno \
include/cfenv \
include/cfloat \
include/cinttypes \
include/ciso646 \
include/climits \
include/clocale \
include/cmath \
include/csetjmp \
include/csignal \
include/cstdarg \
include/cstdbool \
include/cstddef \
include/cstdint \
include/cstdio \
include/cstdlib \
include/cstring \
include/ctgmath \
include/ctime \
include/cwchar \
include/cwctype \
include/backward/hash_map \
include/backward/hash_set \
include/backward/strstream \
include/debug/bitset \
include/debug/deque \
include/debug/list \
include/debug/map \
include/debug/set \
include/debug/string \
include/debug/unordered_map \
include/debug/unordered_set \
include/debug/vector \
include/profile/bitset \
include/profile/deque \
include/profile/list \
include/profile/map \
include/profile/set \
include/profile/unordered_map \
include/profile/unordered_set \
include/profile/vector \
include/ext/algorithm \
include/ext/functional \
include/ext/iterator \
include/ext/memory \
include/ext/numeric \
include/ext/rb_tree \
include/ext/rope \
include/ext/slist \
include/parallel/algorithm \
include/parallel/numeric \
include/tr1/ccomplex \
include/tr1/cctype \
include/tr1/cfenv \
include/tr1/cfloat \
include/tr1/cinttypes \
include/tr1/climits \
include/tr1/cmath \
include/tr1/complex \
include/tr1/cstdarg \
include/tr1/cstdbool \
include/tr1/cstdint \
include/tr1/cstdio \
include/tr1/cstdlib \
include/tr1/ctgmath \
include/tr1/ctime \
include/tr1/cwchar \
include/tr1/cwctype \
include/tr1_impl/array \
include/tr1_impl/cctype \
include/tr1_impl/cfenv \
include/tr1_impl/cinttypes \
include/tr1_impl/cmath \
include/tr1_impl/complex \
include/tr1_impl/cstdint \
include/tr1_impl/cstdio \
include/tr1_impl/cstdlib \
include/tr1_impl/cwchar \
include/tr1_impl/cwctype \
include/tr1_impl/regex \
include/tr1_impl/type_traits \
include/tr1_impl/utility \
include/tr1_impl \
include/decimal/decimal \
include/ \
include/@host_alias@/bits \
include/backward \
include/bits \
include/debug \
include/parallel \
include/profile \
include/profile/impl \
include/ext \
include/ext/pb_ds \
include/ext/pb_ds/detail
@srcdir@/libsupc++/cxxabi.h \
@srcdir@/libsupc++/cxxabi-forced.h \
@srcdir@/libsupc++/exception \
@srcdir@/libsupc++/exception_ptr.h \
@srcdir@/libsupc++/initializer_list \
@srcdir@/libsupc++/nested_exception.h \
@srcdir@/libsupc++/new \
@srcdir@/libsupc++/typeinfo \
include/algorithm \
include/array \
include/atomic \
include/bitset \
include/chrono \
include/complex \
include/condition_variable \
include/deque \
include/fstream \
include/functional \
include/future \
include/iomanip \
include/ios \
include/iosfwd \
include/iostream \
include/istream \
include/iterator \
include/limits \
include/list \
include/locale \
include/map \
include/memory \
include/mutex \
include/numeric \
include/ostream \
include/queue \
include/random \
include/ratio \
include/regex \
include/set \
include/sstream \
include/stack \
include/stdexcept \
include/streambuf \
include/string \
include/system_error \
include/thread \
include/tuple \
include/type_traits \
include/unordered_map \
include/unordered_set \
include/utility \
include/valarray \
include/vector \
include/cassert \
include/ccomplex \
include/cctype \
include/cerrno \
include/cfenv \
include/cfloat \
include/cinttypes \
include/ciso646 \
include/climits \
include/clocale \
include/cmath \
include/csetjmp \
include/csignal \
include/cstdarg \
include/cstdbool \
include/cstddef \
include/cstdint \
include/cstdio \
include/cstdlib \
include/cstring \
include/ctgmath \
include/ctime \
include/cwchar \
include/cwctype \
include/backward/hash_map \
include/backward/hash_set \
include/backward/strstream \
include/debug/bitset \
include/debug/deque \
include/debug/list \
include/debug/map \
include/debug/set \
include/debug/string \
include/debug/unordered_map \
include/debug/unordered_set \
include/debug/vector \
include/profile/bitset \
include/profile/deque \
include/profile/list \
include/profile/map \
include/profile/set \
include/profile/unordered_map \
include/profile/unordered_set \
include/profile/vector \
include/ext/algorithm \
include/ext/functional \
include/ext/iterator \
include/ext/memory \
include/ext/numeric \
include/ext/rb_tree \
include/ext/rope \
include/ext/slist \
include/parallel/algorithm \
include/parallel/numeric \
include/tr1/ccomplex \
include/tr1/cctype \
include/tr1/cfenv \
include/tr1/cfloat \
include/tr1/cinttypes \
include/tr1/climits \
include/tr1/cmath \
include/tr1/complex \
include/tr1/cstdarg \
include/tr1/cstdbool \
include/tr1/cstdint \
include/tr1/cstdio \
include/tr1/cstdlib \
include/tr1/ctgmath \
include/tr1/ctime \
include/tr1/cwchar \
include/tr1/cwctype \
include/tr1_impl/array \
include/tr1_impl/cctype \
include/tr1_impl/cfenv \
include/tr1_impl/cinttypes \
include/tr1_impl/cmath \
include/tr1_impl/complex \
include/tr1_impl/cstdint \
include/tr1_impl/cstdio \
include/tr1_impl/cstdlib \
include/tr1_impl/cwchar \
include/tr1_impl/cwctype \
include/tr1_impl/regex \
include/tr1_impl/type_traits \
include/tr1_impl/utility \
include/tr1_impl \
include/decimal/decimal \
include/ \
include/@host_alias@/bits \
include/backward \
include/bits \
include/debug \
include/parallel \
include/profile \
include/profile/impl \
include/ext \
include/ext/pb_ds \
include/ext/pb_ds/detail
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -754,8 +754,8 @@ INPUT_ENCODING = UTF-8
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.h \
*.hpp \
*.tcc
*.hpp \
*.tcc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@ -782,10 +782,10 @@ EXCLUDE_SYMLINKS = NO
# for example use the pattern */test/*
EXCLUDE_PATTERNS = stamp-* \
*stdc++.h* \
*stdtr1c++.h* \
*extc++.h* \
*/.svn/*
*stdc++.h* \
*stdtr1c++.h* \
*extc++.h* \
*/.svn/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@ -1180,7 +1180,7 @@ LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
LATEX_CMD_NAME = pdflatex
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
@ -1349,7 +1349,7 @@ XML_DTD =
# and cross-referencing information) to the XML output. Note that
# enabling this will significantly increase the size of the XML output.
XML_PROGRAMLISTING = YES
XML_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
@ -1448,37 +1448,37 @@ INCLUDE_FILE_PATTERNS =
# instead of the = operator.
PREDEFINED = __cplusplus \
__GTHREADS \
_GLIBCXX_HAS_GTHREADS \
__GXX_EXPERIMENTAL_CXX0X__ \
_GLIBCXX_INCLUDE_AS_CXX0X \
"_GLIBCXX_STD_P= " \
"_GLIBCXX_STD_D= " \
_GLIBCXX_STD=std \
"_GLIBCXX_TR1= " \
"_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
"_GLIBCXX_END_NAMESPACE_TR1= " \
"_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name { " \
"_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name { " \
_GLIBCXX_END_NAMESPACE=} \
_GLIBCXX_END_NESTED_NAMESPACE=} \
"_GLIBCXX_TEMPLATE_ARGS=... " \
_GLIBCXX_DEPRECATED \
_GLIBCXX_USE_WCHAR_T \
_GLIBCXX_USE_LONG_LONG \
_GLIBCXX_USE_C99_STDINT_TR1 \
_GLIBCXX_ATOMIC_BUILTINS_1 \
_GLIBCXX_ATOMIC_BUILTINS_2 \
_GLIBCXX_ATOMIC_BUILTINS_4 \
_GLIBCXX_ATOMIC_BUILTINS_8 \
_GLIBCXX_USE_SCHED_YIELD \
_GLIBCXX_USE_NANOSLEEP \
__GXX_RTTI \
__glibcxx_function_requires=// \
__glibcxx_class_requires=// \
__glibcxx_class_requires2=// \
__glibcxx_class_requires3=// \
__glibcxx_class_requires4=//
__GTHREADS \
_GLIBCXX_HAS_GTHREADS \
__GXX_EXPERIMENTAL_CXX0X__ \
_GLIBCXX_INCLUDE_AS_CXX0X \
"_GLIBCXX_STD_P= " \
"_GLIBCXX_STD_D= " \
_GLIBCXX_STD=std \
"_GLIBCXX_TR1= " \
"_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
"_GLIBCXX_END_NAMESPACE_TR1= " \
"_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name { " \
"_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name { " \
_GLIBCXX_END_NAMESPACE=} \
_GLIBCXX_END_NESTED_NAMESPACE=} \
"_GLIBCXX_TEMPLATE_ARGS=... " \
_GLIBCXX_DEPRECATED \
_GLIBCXX_USE_WCHAR_T \
_GLIBCXX_USE_LONG_LONG \
_GLIBCXX_USE_C99_STDINT_TR1 \
_GLIBCXX_ATOMIC_BUILTINS_1 \
_GLIBCXX_ATOMIC_BUILTINS_2 \
_GLIBCXX_ATOMIC_BUILTINS_4 \
_GLIBCXX_ATOMIC_BUILTINS_8 \
_GLIBCXX_USE_SCHED_YIELD \
_GLIBCXX_USE_NANOSLEEP \
__GXX_RTTI \
__glibcxx_function_requires=// \
__glibcxx_class_requires=// \
__glibcxx_class_requires2=// \
__glibcxx_class_requires3=// \
__glibcxx_class_requires4=//
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.

36
libstdc++-v3/doc/xml/api.xml
View File

@ -9,11 +9,14 @@
<?dbhtml filename="api.html"?>
<articleinfo>
<title>API and Source Level Documentation</title>
<title>API Documentation</title>
<copyright>
<year>
2008
</year>
<year>
2010
</year>
<holder>
<ulink url="http://www.fsf.org/">FSF
</ulink>
@ -28,18 +31,17 @@
</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>
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>
@ -83,22 +85,18 @@ viewed online:
</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
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>
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>

90
libstdc++-v3/scripts/run_doxygen
View File

@ -162,69 +162,48 @@ esac
mkdir -p $outdir
chmod u+w $outdir
if $do_xml; then
mkdir -p $outdir/xml
fi
# Run it
(
set -e
cd $builddir
sed -e "s=@outdir@=${outdir}=g" \
-e "s=@srcdir@=${srcdir}=g" \
-e "s=@shortname@=${shortname}=g" \
-e "s=@builddir@=${builddir}=g" \
-e "s=@host_alias@=${host_alias}=g" \
-e "s=@enabled_sections@=${enabled_sections}=" \
-e "s=@do_html@=${do_html}=" \
-e "s=@do_latex@=${do_latex}=" \
-e "s=@do_man@=${do_man}=" \
-e "s=@do_xml@=${do_xml}=" \
-e "s=@generate_tagfile@=${generate_tagfile}=" \
${srcdir}/doc/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
echo :: NOTE that this may take some time...
echo doxygen ${outdir}/${mode}.cfg
doxygen ${outdir}/${mode}.cfg
echo :: Finished, exit code was $?
set -e
cd $builddir
sed -e "s=@outdir@=${outdir}=g" \
-e "s=@srcdir@=${srcdir}=g" \
-e "s=@shortname@=${shortname}=g" \
-e "s=@builddir@=${builddir}=g" \
-e "s=@host_alias@=${host_alias}=g" \
-e "s=@enabled_sections@=${enabled_sections}=" \
-e "s=@do_html@=${do_html}=" \
-e "s=@do_latex@=${do_latex}=" \
-e "s=@do_man@=${do_man}=" \
-e "s=@do_xml@=${do_xml}=" \
-e "s=@generate_tagfile@=${generate_tagfile}=" \
${srcdir}/doc/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
echo :: NOTE that this may take some time...
echo doxygen ${outdir}/${mode}.cfg
doxygen ${outdir}/${mode}.cfg
)
ret=$?
test $ret -ne 0 && exit $ret
if $do_xml; then
echo ::
echo :: XML pages begin with
echo :: ${outdir}/xml/index.xml
fi
if $do_latex; then
mkdir -p $outdir/latex
cd ${outdir}/${mode}
# Also drop in the header file and style sheet
doxygen -w latex header.tex doxygen.sty
echo ::
echo :: LaTeX pages begin with
echo :: ${outdir}/latex/refman.tex
fi
(
set -e
cd $builddir
sed -e "s=@outdir@=${outdir}=g" \
-e "s=@srcdir@=${srcdir}=g" \
-e "s=@shortname@=${shortname}=g" \
-e "s=@builddir@=${builddir}=g" \
-e "s=@host_alias@=${host_alias}=g" \
-e "s=@enabled_sections@=${enabled_sections}=" \
-e "s=@do_html@=${do_html}=" \
-e "s=@do_latex@=${do_latex}=" \
-e "s=@do_man@=${do_man}=" \
-e "s=@do_xml@=${do_xml}=" \
-e "s=@generate_tagfile@=${generate_tagfile}=" \
${srcdir}/doc/doxygen/user.cfg.in > ${outdir}/${mode}.cfg
echo :: NOTE that this may take some time...
echo doxygen ${outdir}/${mode}.cfg
doxygen ${outdir}/${mode}.cfg
# Also drop in the header file and style sheet
cd ${outdir}/${mode}
doxygen -w latex header.tex doxygen.sty
echo :: Finished, exit code was $?
echo ::
echo :: LaTeX pages begin with
echo :: ${outdir}/latex/refman.tex
)
ret=$?
test $ret -ne 0 && exit $ret
if $do_html; then
cd ${outdir}/html
cd ${outdir}/${mode}
#doxytag -t libstdc++.tag . > /dev/null 2>&1
sed -e '/<path>/d' libstdc++.tag > TEMP
@ -242,6 +221,7 @@ if $do_html; then
mv annstrip.html annotated.html
cp ${srcdir}/doc/doxygen/tables.html tables.html
echo ::
echo :: HTML pages begin with
echo :: ${outdir}/html/index.html