Skip to content

R
riscv-gcc-1
Commit 5bca11c4 by Benjamin Kosnik Committed by Benjamin Kosnik
Options

Makefile.am: Edit pdf rules. 

2010-07-13  Benjamin Kosnik  <bkoz@redhat.com>

	* doc/Makefile.am: Edit pdf rules.
	(doc-man, doc-pdf, doc-html): Expand default rules.
	* doc/Makefile.in: Regenerate.
	* doc/doxygen/user.cfg.in: Update to Doxygen 1.7.1.

From-SVN: r162151
parent d1465187
Showing with 461 additions and 419 deletions
libstdc++-v3/ChangeLog
2010-07-13 Benjamin Kosnik <bkoz@redhat.com>
* doc/Makefile.am: Edit pdf rules.
(doc-man, doc-pdf, doc-html): Expand default rules.
* doc/Makefile.in: Regenerate.
* doc/doxygen/user.cfg.in: Update to Doxygen 1.7.1.
2010-07-11 Paolo Carlini <paolo.carlini@oracle.com> 2010-07-11 Paolo Carlini <paolo.carlini@oracle.com>
* include/std/type_traits (is_convertible): Use SFINAE. * include/std/type_traits (is_convertible): Use SFINAE.
......
libstdc++-v3/doc/Makefile.am
...@@ -25,20 +25,32 @@ include $(top_srcdir)/fragment.am ...@@ -25,20 +25,32 @@ include $(top_srcdir)/fragment.am
# Documentation Overview # Documentation Overview
# #
# There are two main source materials for libstdc++ documentation. # There are two main source materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources. And the second # The first is the doxygen markup in libstdc++ sources, which is a
# is the docbook markup in doc/xml/. A third and more obscure option # reference to the API. And the second is the docbook markup in
# deals with charting performance tests. # doc/xml/.
#
# A third and more obscure option deals with charting
# performance tests, and should be considered experimental.
# Default rules.
#
# Point to best sub-rule for the requested documentation target,
# create, and then copy into toplevel directory with standardized names
# and layouts.
# Default, points to current best sub-rule that is the best conversion.
# MAN # MAN
doc-man: doc-man-doxygen doc-man: doc-man-doxygen
cp -R ${doxygen_outdir}/man ./libstdc++-api.man
# PDF # PDF
doc-pdf: doc-pdf-docbook doc-pdf: doc-pdf-docbook doc-pdf-doxygen
cp ${docbook_outdir}/pdf/libstdc++-manual.pdf .
cp ${doxygen_outdir}/pdf/libstdc++-api.pdf .
# HTML # HTML
doc-html: doc-html-docbook doc-html: doc-html-docbook doc-html-doxygen
cp -R ${docbook_outdir}/html ./libstdc++-manual.html
cp -R ${doxygen_outdir}/html ./libstdc++-api.html
# Doxygen configuration # Doxygen configuration
# Assumes doxygen, graphviz (with dot), pdflatex installed # Assumes doxygen, graphviz (with dot), pdflatex installed
...@@ -227,11 +239,11 @@ doc-xml-validate-docbook: $(xml_sources) ...@@ -227,11 +239,11 @@ doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..." @echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml $(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml
doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..." @echo "Generating XML single..."
$(XMLLINT) --xinclude --noent --noblanks \ $(XMLLINT) --xinclude --noent --noblanks \
-o ${docbook_outdir}/xml/spine-single.xml \ -o ${manual_xml} ${top_srcdir}/doc/xml/spine.xml
${top_srcdir}/doc/xml/spine.xml
# HTML, index plus chapters # HTML, index plus chapters
doc-html-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
...@@ -240,9 +252,10 @@ doc-html-docbook: $(xml_sources) ${docbook_outdir}/html ...@@ -240,9 +252,10 @@ doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
# HTML, all one page # HTML, all one page
manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html single file..." @echo "Generating html single file..."
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${manual_html} \
$(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
# FO # FO
...@@ -251,53 +264,16 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo ...@@ -251,53 +264,16 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
# PDF 1 # PDF, via dblatex
# fop manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
FOP = fop DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
FOP_FLAGS = -d -r
doc-pdf-fop-xml-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-pdf-docbook: doc-pdf-dblatex-docbook
@echo "Generating pdf fop files from xml..."
$(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
-xsl $(XSL_FO_STYLE) -pdf ${docbook_outdir}/pdf/spine.pdf
doc-pdf-fop-fo-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
@echo "Generating pdf fop files from fo..."
$(FOP) $(FOP_FLAGS) -fo ${docbook_outdir}/fo/spine.fo \
-pdf ${docbook_outdir}/pdf/spine.pdf
# PDF 2
# xmlto
XML2PDF = xmlto
XML2PDF_FLAGS = -v pdf --skip-validation -o pdf
doc-pdf-xmlto-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf xmlto files..."
$(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
# PDF 3
# xmlroff
XMLROFF = xmlroff
XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
doc-pdf-xmlroff-docbook: $(xml_sources) doc-fo
@echo "Generating pdf xmlroff files..."
$(XMLROFF) $(XMLROFF_FLAGS) ${docbook_outdir}/fo/spine.fo
# PDF 4
# prince
PRINCE = prince
PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
doc-pdf-prince-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf prince files..."
$(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/xml/spine.xml
# PDF 5
# dblatex
DBLATEX_FLAGS = --dump --verbose --pdf -o ${docbook_outdir}/pdf/manual.pdf
doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..." @echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-docbook: doc-pdf-dblatex-docbook
# Performance doc and graph configuration. # Performance doc and graph configuration.
# Assumes pychart, beautiful soup installed. # Assumes pychart, beautiful soup installed.
...@@ -318,4 +294,4 @@ CLEANFILES = *.log ...@@ -318,4 +294,4 @@ CLEANFILES = *.log
# To remove directories. # To remove directories.
clean-local: clean-local:
rm -rf man html pdf fo xml doxygen docbook stamp* rm -rf man html pdf fo xml doxygen docbook stamp* ./libstdc++-* db2t*
libstdc++-v3/doc/Makefile.in
...@@ -371,30 +371,14 @@ XMLLINT = xmllint ...@@ -371,30 +371,14 @@ XMLLINT = xmllint
LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout
DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS) XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS)
manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml
# PDF 1 # HTML, all one page
# fop manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
FOP = fop
FOP_FLAGS = -d -r
# PDF 2
# xmlto
XML2PDF = xmlto
XML2PDF_FLAGS = -v pdf --skip-validation -o pdf
# PDF 3
# xmlroff
XMLROFF = xmlroff
XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
# PDF 4
# prince
PRINCE = prince
PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
# PDF 5 # PDF, via dblatex
# dblatex manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
DBLATEX_FLAGS = --dump --verbose --pdf -o ${docbook_outdir}/pdf/manual.pdf DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
# Performance doc and graph configuration. # Performance doc and graph configuration.
# Assumes pychart, beautiful soup installed. # Assumes pychart, beautiful soup installed.
...@@ -561,19 +545,32 @@ uninstall-am: ...@@ -561,19 +545,32 @@ uninstall-am:
# Documentation Overview # Documentation Overview
# #
# There are two main source materials for libstdc++ documentation. # There are two main source materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources. And the second # The first is the doxygen markup in libstdc++ sources, which is a
# is the docbook markup in doc/xml/. A third and more obscure option # reference to the API. And the second is the docbook markup in
# deals with charting performance tests. # doc/xml/.
#
# A third and more obscure option deals with charting
# performance tests, and should be considered experimental.
# Default rules.
#
# Point to best sub-rule for the requested documentation target,
# create, and then copy into toplevel directory with standardized names
# and layouts.
# Default, points to current best sub-rule that is the best conversion.
# MAN # MAN
doc-man: doc-man-doxygen doc-man: doc-man-doxygen
cp -R ${doxygen_outdir}/man ./libstdc++-api.man
# PDF # PDF
doc-pdf: doc-pdf-docbook doc-pdf: doc-pdf-docbook doc-pdf-doxygen
cp ${docbook_outdir}/pdf/libstdc++-manual.pdf .
cp ${doxygen_outdir}/pdf/libstdc++-api.pdf .
# HTML # HTML
doc-html: doc-html-docbook doc-html: doc-html-docbook doc-html-doxygen
cp -R ${docbook_outdir}/html ./libstdc++-manual.html
cp -R ${doxygen_outdir}/html ./libstdc++-api.html
doc-html-doxygen: doc-html-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \ -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
...@@ -651,23 +648,19 @@ ${docbook_outdir}/xml: ...@@ -651,23 +648,19 @@ ${docbook_outdir}/xml:
doc-xml-validate-docbook: $(xml_sources) doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..." @echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml $(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..." @echo "Generating XML single..."
$(XMLLINT) --xinclude --noent --noblanks \ $(XMLLINT) --xinclude --noent --noblanks \
-o ${docbook_outdir}/xml/spine-single.xml \ -o ${manual_xml} ${top_srcdir}/doc/xml/spine.xml
${top_srcdir}/doc/xml/spine.xml
# HTML, index plus chapters # HTML, index plus chapters
doc-html-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html files..." @echo "Generating html files..."
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
# HTML, all one page
doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html single file..." @echo "Generating html single file..."
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${manual_html} \
$(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
# FO # FO
...@@ -675,29 +668,12 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo ...@@ -675,29 +668,12 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
@echo "Generating FO files..." @echo "Generating FO files..."
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-fop-xml-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf
@echo "Generating pdf fop files from xml..." doc-pdf-docbook: doc-pdf-dblatex-docbook
$(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
-xsl $(XSL_FO_STYLE) -pdf ${docbook_outdir}/pdf/spine.pdf
doc-pdf-fop-fo-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
@echo "Generating pdf fop files from fo..."
$(FOP) $(FOP_FLAGS) -fo ${docbook_outdir}/fo/spine.fo \
-pdf ${docbook_outdir}/pdf/spine.pdf
doc-pdf-xmlto-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf xmlto files..."
$(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-xmlroff-docbook: $(xml_sources) doc-fo
@echo "Generating pdf xmlroff files..."
$(XMLROFF) $(XMLROFF_FLAGS) ${docbook_outdir}/fo/spine.fo
doc-pdf-prince-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf prince files..."
$(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/xml/spine.xml
doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..." @echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-docbook: doc-pdf-dblatex-docbook
doc-html-performance: doc-html-performance:
-@(chmod + ${doc_performance_script}; \ -@(chmod + ${doc_performance_script}; \
${doc_performance_script} ${top_srcdir} \ ${doc_performance_script} ${top_srcdir} \
...@@ -709,7 +685,7 @@ doc-html-performance: ...@@ -709,7 +685,7 @@ doc-html-performance:
# To remove directories. # To remove directories.
clean-local: clean-local:
rm -rf man html pdf fo xml doxygen docbook stamp* rm -rf man html pdf fo xml doxygen docbook stamp* ./libstdc++-* db2t*
# Tell versions [3.59,3.63) of GNU make to not export all variables. # Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded. # Otherwise a system limit (for SysV at least) may be exceeded.
......
libstdc++-v3/doc/doxygen/user.cfg.in
# Doxyfile 1.6.1 # Doxyfile 1.7.1
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project
...@@ -180,7 +180,7 @@ TAB_SIZE = 4 ...@@ -180,7 +180,7 @@ TAB_SIZE = 4
# You can put \n's in the value part of an alias to insert newlines. # 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. " \ 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 io I/O @endlink typedefs" "isiosfwd=One of the @link io I/O @endlink typedefs"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # 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. # sources only. Doxygen will then generate output that is more tailored for C.
...@@ -208,17 +208,15 @@ OPTIMIZE_FOR_FORTRAN = NO ...@@ -208,17 +208,15 @@ OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the # Doxygen selects the parser to use depending on the extension of the files it
# files it parses. With this tag you can assign which parser to use # parses. With this tag you can assign which parser to use for a given extension.
# for a given extension. Doxygen has a built-in mapping, but you can # Doxygen has a built-in mapping, but you can override or extend it using this
# override or extend it using this tag. The format is ext=language, # tag. The format is ext=language, where ext is a file extension, and language
# where ext is a file extension, and language is one of the parsers # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
# supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# doxygen treat .inc files as Fortran files (default is PHP), and .f # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
# files as C (default is Fortran), use: inc=Fortran f=C. Note that for # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
# custom extensions you also need to set FILE_PATTERNS otherwise the
# files are not read by doxygen.
EXTENSION_MAPPING = EXTENSION_MAPPING =
...@@ -236,63 +234,57 @@ BUILTIN_STL_SUPPORT = NO ...@@ -236,63 +234,57 @@ BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# sources only. Doxygen will parse them like normal C++ but will # Doxygen will parse them like normal C++ but will assume all classes use public
# assume all classes use public instead of private inheritance when no # instead of private inheritance when no explicit protection keyword is present.
# explicit protection keyword is present.
SIP_SUPPORT = NO SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to # For Microsoft's IDL there are propget and propput attributes to indicate getter
# indicate getter and setter methods for a property. Setting this # and setter methods for a property. Setting this option to YES (the default)
# option to YES (the default) will make doxygen to replace the get and # will make doxygen to replace the get and set methods by a property in the
# set methods by a property in the documentation. This will only work # documentation. This will only work if the methods are indeed getting or
# if the methods are indeed getting or setting a simple type. If this # setting a simple type. If this is not the case, or you want to show the
# is not the case, or you want to show the methods anyway, you should # methods anyway, you should set this option to NO.
# set this option to NO.
IDL_PROPERTY_SUPPORT = YES IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the # tag is set to YES, then doxygen will reuse the documentation of the first
# documentation of the first member in the group (if any) for the # member in the group (if any) for the other members of the group. By default
# other members of the group. By default all members of a group must # all members of a group must be documented explicitly.
# be documented explicitly.
DISTRIBUTE_GROUP_DOC = YES DISTRIBUTE_GROUP_DOC = YES
# Set the SUBGROUPING tag to YES (the default) to allow class member # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# groups of the same type (for instance a group of public functions) # the same type (for instance a group of public functions) to be put as a
# to be put as a subgroup of that type (e.g. under the Public # subgroup of that type (e.g. under the Public Functions section). Set it to
# Functions section). Set it to NO to prevent # NO to prevent subgrouping. Alternatively, this can be done per class using
# subgrouping. Alternatively, this can be done per class using the # the \nosubgrouping command.
# \nosubgrouping command.
SUBGROUPING = YES SUBGROUPING = YES
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# or enum is documented as struct, union, or enum with the name of the # is documented as struct, union, or enum with the name of the typedef. So
# typedef. So typedef struct TypeS {} TypeT, will appear in the # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# documentation as a struct with name TypeT. When disabled the typedef # with name TypeT. When disabled the typedef will appear as a member of a file,
# will appear as a member of a file, namespace, or class. And the # namespace, or class. And the struct will be named TypeS. This can typically
# struct will be named TypeS. This can typically be useful for C code # be useful for C code in case the coding convention dictates that all compound
# in case the coding convention dictates that all compound types are # types are typedef'ed and only the typedef is referenced, never the tag name.
# typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# to determine which symbols to keep in memory and which to flush to # determine which symbols to keep in memory and which to flush to disk.
# disk. When the cache is full, less often used symbols will be # When the cache is full, less often used symbols will be written to disk.
# written to disk. For small to medium size projects (<1000 input # For small to medium size projects (<1000 input files) the default value is
# files) the default value is probably good enough. For larger # probably good enough. For larger projects a too small cache size can cause
# projects a too small cache size can cause doxygen to be busy # doxygen to be busy swapping symbols to and from disk most of the time
# swapping symbols to and from disk most of the time causing a # causing a significant performance penality.
# significant performance penality. If the system has enough physical # If the system has enough physical memory increasing the cache will improve the
# memory increasing the cache will improve the performance by keeping # performance by keeping more symbols in memory. Note that the value works on
# more symbols in memory. Note that the value works on a logarithmic # a logarithmic scale so increasing the size by one will rougly double the
# scale so increasing the size by one will rougly double the memory # memory usage. The cache size is given by this formula:
# usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols # corresponding to a cache size of 2^16 = 65536 symbols
...@@ -396,6 +388,12 @@ HIDE_SCOPE_NAMES = NO ...@@ -396,6 +388,12 @@ HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = NO SHOW_INCLUDE_FILES = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members. # is inserted in the documentation for inline members.
...@@ -415,13 +413,13 @@ SORT_MEMBER_DOCS = YES ...@@ -415,13 +413,13 @@ SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = YES SORT_BRIEF_DOCS = YES
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# sort the (brief and detailed) documentation of class members so that # will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the # constructors and destructors are listed first. If set to NO (the default)
# default) the constructors will appear in the respective orders # the constructors will appear in the respective orders defined by
# defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
# for detailed docs if SORT_MEMBER_DOCS is set to NO. # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
SORT_MEMBERS_CTORS_1ST = YES SORT_MEMBERS_CTORS_1ST = YES
...@@ -505,24 +503,22 @@ SHOW_FILES = YES ...@@ -505,24 +503,22 @@ SHOW_FILES = YES
SHOW_NAMESPACES = YES SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or # The FILE_VERSION_FILTER tag can be used to specify a program or script that
# script that doxygen should invoke to get the current version for # doxygen should invoke to get the current version for each file (typically from
# each file (typically from the version control system). Doxygen will # the version control system). Doxygen will invoke the program by executing (via
# invoke the program by executing (via popen()) the command <command> # popen()) the command <command> <input-file>, where <command> is the value of
# <input-file>, where <command> is the value of the # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# FILE_VERSION_FILTER tag, and <input-file> is the name of an input # provided by doxygen. Whatever the program writes to standard output
# file provided by doxygen. Whatever the program writes to standard # is used as the file version. See the manual for examples.
# output is used as the file version. See the manual for examples.
FILE_VERSION_FILTER = FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# be parsed by doxygen. The layout file controls the global structure # by doxygen. The layout file controls the global structure of the generated
# of the generated output files in an output format independent # output files in an output format independent way. The create the layout file
# way. The create the layout file that represents doxygen's defaults, # that represents doxygen's defaults, run doxygen with the -l option.
# run doxygen with the -l option. You can optionally specify a file # You can optionally specify a file name after the option, if omitted
# name after the option, if omitted DoxygenLayout.xml will be used as # DoxygenLayout.xml will be used as the name of the layout file.
# the name of the layout file.
LAYOUT_FILE = LAYOUT_FILE =
...@@ -581,161 +577,161 @@ WARN_LOGFILE = ...@@ -581,161 +577,161 @@ WARN_LOGFILE =
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories # The INPUT tag can be used to specify the files and/or directories that contain
# that contain documented source files. You may enter file names like # documented source files. You may enter file names like "myfile.cpp" or
# "myfile.cpp" or directories like "/usr/src/myproject". Separate the # directories like "/usr/src/myproject". Separate the files or directories
# files or directories with spaces. # with spaces.
INPUT = @srcdir@/doc/doxygen/doxygroups.cc \ INPUT = @srcdir@/doc/doxygen/doxygroups.cc \
@srcdir@/libsupc++/cxxabi.h \ @srcdir@/libsupc++/cxxabi.h \
@srcdir@/libsupc++/cxxabi-forced.h \ @srcdir@/libsupc++/cxxabi-forced.h \
@srcdir@/libsupc++/exception \ @srcdir@/libsupc++/exception \
@srcdir@/libsupc++/exception_ptr.h \ @srcdir@/libsupc++/exception_ptr.h \
@srcdir@/libsupc++/initializer_list \ @srcdir@/libsupc++/initializer_list \
@srcdir@/libsupc++/nested_exception.h \ @srcdir@/libsupc++/nested_exception.h \
@srcdir@/libsupc++/new \ @srcdir@/libsupc++/new \
@srcdir@/libsupc++/typeinfo \ @srcdir@/libsupc++/typeinfo \
include/algorithm \ include/algorithm \
include/array \ include/array \
include/atomic \ include/atomic \
include/bitset \ include/bitset \
include/chrono \ include/chrono \
include/complex \ include/complex \
include/condition_variable \ include/condition_variable \
include/deque \ include/deque \
include/fstream \ include/fstream \
include/functional \ include/functional \
include/future \ include/future \
include/iomanip \ include/iomanip \
include/ios \ include/ios \
include/iosfwd \ include/iosfwd \
include/iostream \ include/iostream \
include/istream \ include/istream \
include/iterator \ include/iterator \
include/limits \ include/limits \
include/list \ include/list \
include/locale \ include/locale \
include/map \ include/map \
include/memory \ include/memory \
include/mutex \ include/mutex \
include/numeric \ include/numeric \
include/ostream \ include/ostream \
include/queue \ include/queue \
include/random \ include/random \
include/ratio \ include/ratio \
include/regex \ include/regex \
include/set \ include/set \
include/sstream \ include/sstream \
include/stack \ include/stack \
include/stdexcept \ include/stdexcept \
include/streambuf \ include/streambuf \
include/string \ include/string \
include/system_error \ include/system_error \
include/thread \ include/thread \
include/tuple \ include/tuple \
include/type_traits \ include/type_traits \
include/unordered_map \ include/unordered_map \
include/unordered_set \ include/unordered_set \
include/utility \ include/utility \
include/valarray \ include/valarray \
include/vector \ include/vector \
include/cassert \ include/cassert \
include/ccomplex \ include/ccomplex \
include/cctype \ include/cctype \
include/cerrno \ include/cerrno \
include/cfenv \ include/cfenv \
include/cfloat \ include/cfloat \
include/cinttypes \ include/cinttypes \
include/ciso646 \ include/ciso646 \
include/climits \ include/climits \
include/clocale \ include/clocale \
include/cmath \ include/cmath \
include/csetjmp \ include/csetjmp \
include/csignal \ include/csignal \
include/cstdarg \ include/cstdarg \
include/cstdbool \ include/cstdbool \
include/cstddef \ include/cstddef \
include/cstdint \ include/cstdint \
include/cstdio \ include/cstdio \
include/cstdlib \ include/cstdlib \
include/cstring \ include/cstring \
include/ctgmath \ include/ctgmath \
include/ctime \ include/ctime \
include/cwchar \ include/cwchar \
include/cwctype \ include/cwctype \
include/backward/hash_map \ include/backward/hash_map \
include/backward/hash_set \ include/backward/hash_set \
include/backward/strstream \ include/backward/strstream \
include/debug/bitset \ include/debug/bitset \
include/debug/deque \ include/debug/deque \
include/debug/list \ include/debug/list \
include/debug/map \ include/debug/map \
include/debug/set \ include/debug/set \
include/debug/string \ include/debug/string \
include/debug/unordered_map \ include/debug/unordered_map \
include/debug/unordered_set \ include/debug/unordered_set \
include/debug/vector \ include/debug/vector \
include/profile/bitset \ include/profile/bitset \
include/profile/deque \ include/profile/deque \
include/profile/list \ include/profile/list \
include/profile/map \ include/profile/map \
include/profile/set \ include/profile/set \
include/profile/unordered_map \ include/profile/unordered_map \
include/profile/unordered_set \ include/profile/unordered_set \
include/profile/vector \ include/profile/vector \
include/ext/algorithm \ include/ext/algorithm \
include/ext/functional \ include/ext/functional \
include/ext/iterator \ include/ext/iterator \
include/ext/memory \ include/ext/memory \
include/ext/numeric \ include/ext/numeric \
include/ext/rb_tree \ include/ext/rb_tree \
include/ext/rope \ include/ext/rope \
include/ext/slist \ include/ext/slist \
include/parallel/algorithm \ include/parallel/algorithm \
include/parallel/numeric \ include/parallel/numeric \
include/tr1/ccomplex \ include/tr1/ccomplex \
include/tr1/cctype \ include/tr1/cctype \
include/tr1/cfenv \ include/tr1/cfenv \
include/tr1/cfloat \ include/tr1/cfloat \
include/tr1/cinttypes \ include/tr1/cinttypes \
include/tr1/climits \ include/tr1/climits \
include/tr1/cmath \ include/tr1/cmath \
include/tr1/complex \ include/tr1/complex \
include/tr1/cstdarg \ include/tr1/cstdarg \
include/tr1/cstdbool \ include/tr1/cstdbool \
include/tr1/cstdint \ include/tr1/cstdint \
include/tr1/cstdio \ include/tr1/cstdio \
include/tr1/cstdlib \ include/tr1/cstdlib \
include/tr1/ctgmath \ include/tr1/ctgmath \
include/tr1/ctime \ include/tr1/ctime \
include/tr1/cwchar \ include/tr1/cwchar \
include/tr1/cwctype \ include/tr1/cwctype \
include/tr1_impl/array \ include/tr1_impl/array \
include/tr1_impl/cctype \ include/tr1_impl/cctype \
include/tr1_impl/cfenv \ include/tr1_impl/cfenv \
include/tr1_impl/cinttypes \ include/tr1_impl/cinttypes \
include/tr1_impl/cmath \ include/tr1_impl/cmath \
include/tr1_impl/complex \ include/tr1_impl/complex \
include/tr1_impl/cstdint \ include/tr1_impl/cstdint \
include/tr1_impl/cstdio \ include/tr1_impl/cstdio \
include/tr1_impl/cstdlib \ include/tr1_impl/cstdlib \
include/tr1_impl/cwchar \ include/tr1_impl/cwchar \
include/tr1_impl/cwctype \ include/tr1_impl/cwctype \
include/tr1_impl/type_traits \ include/tr1_impl/type_traits \
include/tr1_impl/utility \ include/tr1_impl/utility \
include/tr1_impl \ include/tr1_impl \
include/decimal/decimal \ include/decimal/decimal \
include/ \ include/ \
include/@host_alias@/bits \ include/@host_alias@/bits \
include/backward \ include/backward \
include/bits \ include/bits \
include/debug \ include/debug \
include/parallel \ include/parallel \
include/profile \ include/profile \
include/profile/impl \ include/profile/impl \
include/ext \ include/ext \
include/ext/pb_ds \ include/ext/pb_ds \
include/ext/pb_ds/detail include/ext/pb_ds/detail
# This tag can be used to specify the character encoding of the source files # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
...@@ -753,8 +749,8 @@ INPUT_ENCODING = UTF-8 ...@@ -753,8 +749,8 @@ INPUT_ENCODING = UTF-8
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.h \ FILE_PATTERNS = *.h \
*.hpp \ *.hpp \
*.tcc *.tcc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories # 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. # should be searched for input files as well. Possible values are YES and NO.
...@@ -781,10 +777,10 @@ EXCLUDE_SYMLINKS = NO ...@@ -781,10 +777,10 @@ EXCLUDE_SYMLINKS = NO
# for example use the pattern */test/* # for example use the pattern */test/*
EXCLUDE_PATTERNS = stamp-* \ EXCLUDE_PATTERNS = stamp-* \
*stdc++.h* \ *stdc++.h* \
*stdtr1c++.h* \ *stdtr1c++.h* \
*extc++.h* \ *extc++.h* \
*/.svn/* */.svn/*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the # (namespaces, classes, functions, etc.) that should be excluded from the
...@@ -960,11 +956,6 @@ HTML_HEADER = ...@@ -960,11 +956,6 @@ HTML_HEADER =
HTML_FOOTER = HTML_FOOTER =
# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
# documentation will contain the timesstamp.
HTML_TIMESTAMP = NO
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to # style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen # fine-tune the look of the HTML output. If the tag is left blank doxygen
...@@ -974,6 +965,37 @@ HTML_TIMESTAMP = NO ...@@ -974,6 +965,37 @@ HTML_TIMESTAMP = NO
HTML_STYLESHEET = HTML_STYLESHEET =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images
# according to this color. Hue is specified as an angle on a colorwheel,
# see http://en.wikipedia.org/wiki/Hue for more information.
# For instance the value 0 represents red, 60 is yellow, 120 is green,
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
# The allowed range is 0 to 359.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
# the colors in the HTML output. For a value of 0 the output will use
# grayscales only. A value of 255 will produce the most vivid colors.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
# the luminance component of the colors in the HTML output. Values below
# 100 gradually make the output lighter, whereas values above 100 make
# the output darker. The value divided by 100 is the actual gamma applied,
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
# and 100 does not change the gamma.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
HTML_TIMESTAMP = NO
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to # files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used. # NO a bullet list will be used.
...@@ -990,14 +1012,14 @@ HTML_DYNAMIC_SECTIONS = NO ...@@ -990,14 +1012,14 @@ HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files # If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3 # will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 # integrated development environment, introduced with OSX 10.5 (Leopard).
# (Leopard). To create a documentation set, doxygen will generate a # To create a documentation set, doxygen will generate a Makefile in the
# Makefile in the HTML output directory. Running make will produce the # HTML output directory. Running make will produce the docset in that
# docset in that directory and running "make install" will install the # directory and running "make install" will install the docset in
# docset in ~/Library/Developer/Shared/Documentation/DocSets so that # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# Xcode will find it at startup. See # it at startup.
# http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# more information. # for more information.
GENERATE_DOCSET = NO GENERATE_DOCSET = NO
...@@ -1015,6 +1037,16 @@ DOCSET_FEEDNAME = "Doxygen generated docs" ...@@ -1015,6 +1037,16 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project DOCSET_BUNDLE_ID = org.doxygen.Project
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES, additional index files # If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the # will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
...@@ -1060,10 +1092,9 @@ BINARY_TOC = NO ...@@ -1060,10 +1092,9 @@ BINARY_TOC = NO
TOC_EXPAND = NO TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
# generated that can be used as input for Qt's qhelpgenerator to # that can be used as input for Qt's qhelpgenerator to generate a
# generate a Qt Compressed Help (.qch) of the generated HTML # Qt Compressed Help (.qch) of the generated HTML documentation.
# documentation.
GENERATE_QHP = NO GENERATE_QHP = NO
...@@ -1085,23 +1116,24 @@ QHP_NAMESPACE = org.doxygen.Project ...@@ -1085,23 +1116,24 @@ QHP_NAMESPACE = org.doxygen.Project
QHP_VIRTUAL_FOLDER = doc QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
# filter to add. For more information please see # add. For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters # http://doc.trolltech.com/qthelpproject.html#custom-filters
QHP_CUST_FILTER_NAME = QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
# the custom filter to add.For more information please see <a # custom filter to add. For more information please see
# href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
# Help Project / Custom Filters</a>. # Qt Help Project / Custom Filters</a>.
QHP_CUST_FILTER_ATTRS = QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# this project's filter section matches. <a # project's
# href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt # filter section matches.
# Help Project / Filter Attributes</a>. # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
# Qt Help Project / Filter Attributes</a>.
QHP_SECT_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS =
...@@ -1112,6 +1144,23 @@ QHP_SECT_FILTER_ATTRS = ...@@ -1112,6 +1144,23 @@ QHP_SECT_FILTER_ATTRS =
QHG_LOCATION = QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
# will be generated, which together with the HTML files, form an Eclipse help
# plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
# the help appears.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.
ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and # top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it. # the value YES disables it.
...@@ -1144,6 +1193,11 @@ USE_INLINE_TREES = NO ...@@ -1144,6 +1193,11 @@ USE_INLINE_TREES = NO
TREEVIEW_WIDTH = 250 TREEVIEW_WIDTH = 250
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
# links to external symbols imported via tag files in a separate window.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of Latex formulas included # Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that # as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need # when you change the font size after a successful doxygen run you need
...@@ -1152,15 +1206,34 @@ TREEVIEW_WIDTH = 250 ...@@ -1152,15 +1206,34 @@ TREEVIEW_WIDTH = 250
FORMULA_FONTSIZE = 10 FORMULA_FONTSIZE = 10
# When the SEARCHENGINE tag is enable doxygen will generate a search # Use the FORMULA_TRANPARENT tag to determine whether or not the images
# box for the HTML output. The underlying search engine uses # generated for formulas are transparent PNGs. Transparent PNGs are
# javascript and DHTML and should work on any modern browser. Note # not supported properly for IE 6.0, but are supported on all modern browsers.
# that when using HTML help (GENERATE_HTMLHELP) or Qt help # Note that when changing this option you need to delete any form_*.png files
# (GENERATE_QHP) there is already a search function so this one should # in the HTML output before the changes have effect.
# typically be disabled.
FORMULA_TRANSPARENT = YES
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
# (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
SEARCHENGINE = NO SEARCHENGINE = NO
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a PHP enabled web server instead of at the web client
# using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server
# based approach is that it scales better to large projects and allows
# full text search. The disadvances is that it is more difficult to setup
# and does not have live searching capabilities.
SERVER_BASED_SEARCH = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the LaTeX output # configuration options related to the LaTeX output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
...@@ -1178,6 +1251,9 @@ LATEX_OUTPUT = latex ...@@ -1178,6 +1251,9 @@ LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # 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. # invoked. If left blank `latex' will be used as the default command name.
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
LATEX_CMD_NAME = latex LATEX_CMD_NAME = latex
...@@ -1224,11 +1300,10 @@ PDF_HYPERLINKS = YES ...@@ -1224,11 +1300,10 @@ PDF_HYPERLINKS = YES
USE_PDFLATEX = YES USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# \\batchmode. command to the generated LaTeX files. This will # command to the generated LaTeX files. This will instruct LaTeX to keep
# instruct LaTeX to keep running if errors occur, instead of asking # running if errors occur, instead of asking the user for help.
# the user for help. This option is also used when generating # This option is also used when generating formulas in HTML.
# formulas in HTML.
LATEX_BATCHMODE = YES LATEX_BATCHMODE = YES
...@@ -1238,10 +1313,10 @@ LATEX_BATCHMODE = YES ...@@ -1238,10 +1313,10 @@ LATEX_BATCHMODE = YES
LATEX_HIDE_INDICES = YES LATEX_HIDE_INDICES = YES
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source # If LATEX_SOURCE_CODE is set to YES then doxygen will include
# code with syntax highlighting in the LaTeX output. Note that which # source code with syntax highlighting in the LaTeX output.
# sources are shown also depends on other settings such as # Note that which sources are shown also depends on other settings
# SOURCE_BROWSER. # such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO LATEX_SOURCE_CODE = NO
...@@ -1447,37 +1522,37 @@ INCLUDE_FILE_PATTERNS = ...@@ -1447,37 +1522,37 @@ INCLUDE_FILE_PATTERNS =
# instead of the = operator. # instead of the = operator.
PREDEFINED = __cplusplus \ PREDEFINED = __cplusplus \
__GTHREADS \ __GTHREADS \
_GLIBCXX_HAS_GTHREADS \ _GLIBCXX_HAS_GTHREADS \
__GXX_EXPERIMENTAL_CXX0X__ \ __GXX_EXPERIMENTAL_CXX0X__ \
_GLIBCXX_INCLUDE_AS_CXX0X \ _GLIBCXX_INCLUDE_AS_CXX0X \
"_GLIBCXX_STD_P= " \ "_GLIBCXX_STD_P= " \
"_GLIBCXX_STD_D= " \ "_GLIBCXX_STD_D= " \
_GLIBCXX_STD=std \ _GLIBCXX_STD=std \
"_GLIBCXX_TR1= " \ "_GLIBCXX_TR1= " \
"_GLIBCXX_BEGIN_NAMESPACE_TR1= " \ "_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
"_GLIBCXX_END_NAMESPACE_TR1= " \ "_GLIBCXX_END_NAMESPACE_TR1= " \
"_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name { " \ "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name { " \
"_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name { " \ "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name { " \
_GLIBCXX_END_NAMESPACE=} \ _GLIBCXX_END_NAMESPACE=} \
_GLIBCXX_END_NESTED_NAMESPACE=} \ _GLIBCXX_END_NESTED_NAMESPACE=} \
"_GLIBCXX_TEMPLATE_ARGS=... " \ "_GLIBCXX_TEMPLATE_ARGS=... " \
_GLIBCXX_DEPRECATED \ _GLIBCXX_DEPRECATED \
_GLIBCXX_USE_WCHAR_T \ _GLIBCXX_USE_WCHAR_T \
_GLIBCXX_USE_LONG_LONG \ _GLIBCXX_USE_LONG_LONG \
_GLIBCXX_USE_C99_STDINT_TR1 \ _GLIBCXX_USE_C99_STDINT_TR1 \
_GLIBCXX_ATOMIC_BUILTINS_1 \ _GLIBCXX_ATOMIC_BUILTINS_1 \
_GLIBCXX_ATOMIC_BUILTINS_2 \ _GLIBCXX_ATOMIC_BUILTINS_2 \
_GLIBCXX_ATOMIC_BUILTINS_4 \ _GLIBCXX_ATOMIC_BUILTINS_4 \
_GLIBCXX_ATOMIC_BUILTINS_8 \ _GLIBCXX_ATOMIC_BUILTINS_8 \
_GLIBCXX_USE_SCHED_YIELD \ _GLIBCXX_USE_SCHED_YIELD \
_GLIBCXX_USE_NANOSLEEP \ _GLIBCXX_USE_NANOSLEEP \
__GXX_RTTI \ __GXX_RTTI \
__glibcxx_function_requires=// \ __glibcxx_function_requires=// \
__glibcxx_class_requires=// \ __glibcxx_class_requires=// \
__glibcxx_class_requires2=// \ __glibcxx_class_requires2=// \
__glibcxx_class_requires3=// \ __glibcxx_class_requires3=// \
__glibcxx_class_requires4=// __glibcxx_class_requires4=//
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # 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. # this tag can be used to specify a list of macro names that should be expanded.
...@@ -1574,6 +1649,14 @@ HIDE_UNDOC_RELATIONS = NO ...@@ -1574,6 +1649,14 @@ HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = YES HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
# allowed to run in parallel. When set to 0 (the default) doxygen will
# base this on the number of processors available in the system. You can set it
# explicitly to a value larger than 0 to get control over the balance
# between CPU load and processing speed.
DOT_NUM_THREADS = 0
# By default doxygen will write a font called FreeSans.ttf to the # By default doxygen will write a font called FreeSans.ttf to the
# output directory and reference it in all dot files that doxygen # output directory and reference it in all dot files that doxygen
# generates. This font does not include all possible unicode # generates. This font does not include all possible unicode
...@@ -1589,7 +1672,7 @@ DOT_FONTNAME = FreeSans ...@@ -1589,7 +1672,7 @@ DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt. # The default size is 10pt.
DOT_FONTSIZE = 10 DOT_FONTSIZE = 9
# By default doxygen will tell dot to use the output directory to look for the # By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a # FreeSans.ttf font (which doxygen will put there itself). If you specify a
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment