mainpage.html: Clarify links.

2004-07-21  Benjamin Kosnik  <bkoz@redhat.com>

	* docs/doxygen/mainpage.html: Clarify links.
	* docs/doxygen/stdheader.cc: Add files.
	* docs/doxygen/style.css: Remove bolds, add h2, h3 styles.
	* docs/doxygen/user.cfg.in: New options, wrap.

From-SVN: r85015
This commit is contained in:
Benjamin Kosnik 2004-07-21 18:54:52 +00:00 committed by Benjamin Kosnik
parent 54419590e8
commit d917fa8798
5 changed files with 260 additions and 208 deletions

View File

@ -1,3 +1,10 @@
2004-07-21 Benjamin Kosnik <bkoz@redhat.com>
* docs/doxygen/mainpage.html: Clarify links.
* docs/doxygen/stdheader.cc: Add files.
* docs/doxygen/style.css: Remove bolds, add h2, h3 styles.
* docs/doxygen/user.cfg.in: New options, wrap.
2004-07-20 Danny Smith <dannysmith@users.sourceforge.net>
* include/c_std/std_cwchar.h (wcsstr): Correct signature.

View File

@ -44,13 +44,12 @@
<p>Here are entry points to all the pages generated by Doxygen:
<ul>
<li><a href="index.html">Main Page</a>
<li><a href="modules.html">Modules</a>
<li><a href="namespaces.html">Namespace List</a>
<li><a href="hierarchy.html">Class Hierarchy</a>
<li><a href="annotated.html">Compound List</a>
<li><a href="classes.html">Alphabetical List</a>
<li><a href="files.html">File List</a>
<li><a href="hierarchy.html">Class List</a>
<li><a href="annotated.html">Class Annotated List</a>
<li><a href="classes.html">Class Alphabetical Index</a>
<li><a href="files.html">Source File List</a>
<li><a href="todo.html">TODO List</a> (This is incomplete... how ironic.)
</ul>
</p>

View File

@ -25,11 +25,8 @@ void init_map()
headers["algo.h"] = "algorithm";
headers["algobase.h"] = "algorithm";
headers["algorithm.h"] = "algorithm";
headers["allocator.h"] = "memory";
headers["basic_ios.h"] = "ios";
headers["basic_ios.tcc"] = "ios";
headers["heap.h"] = "algorithm";
headers["bitset.h"] = "bitset";
headers["bvector.h"] = "vector";
headers["complex.h"] = "complex";
//headers["construct.h"] stl_construct.h entirely internal
headers["deque.h"] = "deque";
@ -38,8 +35,9 @@ void init_map()
headers["fstream.tcc"] = "fstream";
headers["function.h"] = "functional";
headers["functional.h"] = "functional";
headers["heap.h"] = "algorithm";
headers["iomanip.h"] = "iomanip";
headers["basic_ios.h"] = "ios";
headers["basic_ios.tcc"] = "ios";
headers["ios.h"] = "ios";
headers["iosfwd.h"] = "iosfwd";
headers["iostream.h"] = "iostream";
@ -48,9 +46,11 @@ void init_map()
headers["iterator.h"] = "iterator";
headers["iterator_base_funcs.h"] = "iterator";
headers["iterator_base_types.h"] = "iterator";
headers["stream_iterator.h"] = "iterator";
headers["streambuf_iterator.h"] = "iterator";
headers["limits.h"] = "limits";
headers["list.h"] = "list";
headers["list.tcc"] = "list";
headers["list.tcc"] = "list";
headers["codecvt.h"] = "locale";
headers["locale.h"] = "locale";
headers["localefwd.h"] = "locale";
@ -58,24 +58,23 @@ void init_map()
headers["locale_facets.h"] = "locale";
headers["locale_facets.tcc"] = "locale";
headers["map.h"] = "map";
headers["memory.h"] = "memory";
headers["multimap.h"] = "map";
headers["multiset.h"] = "set";
headers["memory.h"] = "memory";
headers["allocator.h"] = "memory";
headers["raw_storage_iter.h"] = "memory";
headers["tempbuf.h"] = "memory";
headers["uninitialized.h"] = "memory";
headers["numeric.h"] = "numeric";
headers["ostream.h"] = "ostream";
headers["ostream.tcc"] = "ostream";
headers["pair.h"] = "utility";
headers["queue.h"] = "queue";
headers["raw_storage_iter.h"] = "memory";
headers["relops.h"] = "utility";
headers["set.h"] = "set";
headers["multiset.h"] = "set";
headers["sstream.h"] = "sstream";
headers["sstream.tcc"] = "sstream";
headers["stack.h"] = "stack";
headers["functexcept.h"] = "stdexcept";
headers["functexcept.h"] = "stdexcept";
headers["stdexcept.h"] = "stdexcept";
headers["stream_iterator.h"] = "iterator";
headers["streambuf_iterator.h"] = "iterator";
headers["streambuf.h"] = "streambuf";
headers["streambuf.tcc"] = "streambuf";
headers["string.h"] = "string";
@ -83,10 +82,10 @@ void init_map()
headers["postypes.h"] = "string";
headers["basic_string.h"] = "string";
headers["basic_string.tcc"] = "string";
headers["tempbuf.h"] = "memory";
headers["tree.h"] = "backward/tree.h";
headers["uninitialized.h"] = "memory";
headers["pair.h"] = "utility";
headers["utility.h"] = "utility";
headers["relops.h"] = "utility";
headers["gslice.h"] = "valarray";
headers["gslice_array.h"] = "valarray";
headers["indirect_array.h"] = "valarray";
@ -98,9 +97,10 @@ void init_map()
headers["valarray_array.h"] = "valarray";
headers["valarray_array.tcc"] = "valarray";
headers["valarray_meta.h"] = "valarray";
headers["bvector.h"] = "vector";
headers["vector.h"] = "vector";
headers["vector.tcc"] = "vector";
//headers["threads.h"] who knows
//headers["concurrence.h"] who knows
//headers["atomicity.h"] who knows

View File

@ -1,24 +1,48 @@
H1 { text-align: center; }
CAPTION { font-weight: bold }
BODY {
background: white;
font-size: small;
}
H1 { text-align: center; font-size: large }
H2 { text-align: left; font-size: medium; }
H3 { text-align: left; font-size: small; }
CODE { font-size: small; }
CAPTION { font-weight: normal }
A.qindex {}
A.qindexRef {}
A.el { text-decoration: none; font-weight: bold }
A.elRef { font-weight: bold }
A.el { text-decoration: none; font-size: small; font-weight: normal }
A.elRef { text-decoration: none; font-size: small; font-weight: normal }
A.code { text-decoration: none; font-weight: normal; color: #4444ee }
A.codeRef { font-weight: normal; color: #4444ee }
A:hover { text-decoration: none; background-color: #f2f2ff }
DL.el { margin-left: -1cm }
DIV.fragment { width: 100%; border: none; background-color: #eeeeee }
DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
TD.md { background-color: #f2f2ff; font-weight: bold; }
TD.mdname1 { background-color: #f2f2ff; font-weight: bold; color: #602020; }
TD.mdname { background-color: #f2f2ff; font-weight: bold; color: #602020; width: 600px; }
DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
BODY { background: white }
DIV.ah {
background-color: black;
font-weight: normal;
color: #ffffff;
margin-bottom: 3px;
margin-top: 3px
}
DIV.groupHeader {
margin-left: 16px;
margin-top: 12px;
margin-bottom: 6px;
font-weight: normal
}
DIV.groupText { margin-left: 16px; font-style: italic; font-size: small }
TD.md { background-color: #f2f2ff; font-size: small; }
TD.mdname1 { background-color: #f2f2ff; font-size: small; color: #602020; }
TD.mdname {
background-color: #f2f2ff;
font-weight: normal;
font-size: small;
color: #602020;
width: 600px
}
TD.indexkey {
background-color: #eeeeff;
font-weight: bold;
font-weight: normal;
font-size: small;
padding-right : 10px;
padding-top : 2px;
padding-left : 10px;
@ -31,6 +55,7 @@ TD.indexkey {
TD.indexvalue {
background-color: #eeeeff;
font-style: italic;
font-size: small;
padding-right : 10px;
padding-top : 2px;
padding-left : 10px;

View File

@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "libstdc++-v3 Source"
PROJECT_NAME = "libstdc++ source"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@ -25,40 +25,44 @@ PROJECT_NAME = "libstdc++-v3 Source"
PROJECT_NUMBER =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
# The OUTPUT_DIRECTORY tag is used to specify the (relative or
# absolute) base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will
# be used.
OUTPUT_DIRECTORY = @outdir@
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 2 levels of 10 sub-directories under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of source
# files, where putting all generated files in the same directory would otherwise
# cause performance problems for the file system.
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 2
# levels of 10 sub-directories under the output directory of each
# output format and will distribute the generated files over these
# directories. Enabling this option can be useful when feeding
# doxygen a huge amount of source files, where putting all generated
# files in the same directory would otherwise cause performance
# problems for the file system.
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech,
# Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian,
# Japanese, Japanese-en (Japanese with English messages), Korean,
# Korean-en, Norwegian, Polish, Portuguese, Romanian, Russian,
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
OUTPUT_LANGUAGE = English
# This tag can be used to specify the encoding used in the generated output.
# The encoding is not always determined by the language that is chosen,
# but also whether or not the output is meant for Windows or non-Windows users.
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
# forces the Windows encoding (this is the default for the Windows binary),
# whereas setting the tag to NO uses a Unix-style encoding (the default for
# all platforms other than Windows).
# This tag can be used to specify the encoding used in the generated
# output. The encoding is not always determined by the language that
# is chosen, but also whether or not the output is meant for Windows
# or non-Windows users. In case there is a difference, setting the
# USE_WINDOWS_ENCODING tag to YES forces the Windows encoding (this is
# the default for the Windows binary), whereas setting the tag to NO
# uses a Unix-style encoding (the default for all platforms other than
# Windows).
USE_WINDOWS_ENCODING = NO
@ -67,22 +71,24 @@ USE_WINDOWS_ENCODING = NO
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
BRIEF_MEMBER_DESC = NO
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will
# prepend the brief description of a member or function before the
# detailed description. Note: if both HIDE_UNDOC_MEMBERS and
# BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
# completely suppressed.
REPEAT_BRIEF = YES
REPEAT_BRIEF = NO
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is used
# as the annotated text. Otherwise, the brief description is used as-is. If left
# blank, the following values are used ("$name" is automatically replaced with the
# name of the entity): "The $name class" "The $name widget" "The $name file"
# This tag implements a quasi-intelligent brief description
# abbreviator that is used to form the text in various listings. Each
# string in this list, if found as the leading text of the brief
# description, will be stripped from the text and the result after
# processing the whole list, is used as the annotated text. Otherwise,
# the brief description is used as-is. If left blank, the following
# values are used ("$name" is automatically replaced with the name of
# the entity): "The $name class" "The $name widget" "The $name file"
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
ABBREVIATE_BRIEF =
@ -93,10 +99,11 @@ ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = YES
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
# members of a class in the documentation of that class as if those members were
# ordinary class members. Constructors, destructors and assignment operators of
# the base classes will not be shown.
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show
# all inherited members of a class in the documentation of that class
# as if those members were ordinary class members. Constructors,
# destructors and assignment operators of the base classes will not be
# shown.
INLINE_INHERITED_MEMB = YES
@ -151,7 +158,7 @@ MULTILINE_CPP_IS_BRIEF = YES
# If set to NO, the detailed description appears after the member
# documentation.
DETAILS_AT_TOP = NO
DETAILS_AT_TOP = YES
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
@ -171,27 +178,28 @@ DISTRIBUTE_GROUP_DOC = YES
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
# This tag can be used to specify a number of aliases that acts as
# commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you
# to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with
# heading "Side Effects:". You can put \n's in the value part of an
# alias to insert newlines.
ALIASES = "doctodo=@todo\nDoc me! See docs/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more." \
"isiosfwd=One of the @link s27_2_iosfwd I/O forward declarations @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.
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
# 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. For instance, some of the names that are used will
# be different. The list of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
# only. Doxygen will then generate output that is more tailored for Java.
# For instance, namespaces will be presented as packages, qualified scopes
# will look different, etc.
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of
# Java sources only. Doxygen will then generate output that is more
# tailored for Java. For instance, namespaces will be presented as
# packages, qualified scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
@ -217,7 +225,7 @@ EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = YES
EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
@ -243,7 +251,7 @@ EXTRACT_LOCAL_METHODS = NO
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
@ -266,30 +274,31 @@ HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
# The INTERNAL_DOCS tag determines if documentation that is typed
# after a \internal command is included. If the tag is set to NO (the
# default) then the documentation will be excluded. Set it to YES to
# include the internal documentation.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# users are advised to set this option to NO.
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only
# generate file names in lower-case letters. If set to YES upper-case
# letters are also allowed. This is useful if you have classes or
# files whose names only differ in case and if your file system
# supports case sensitive file names. Windows users are advised to set
# this option to NO.
CASE_SENSE_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
HIDE_SCOPE_NAMES = YES
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
# of that file.
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then
# Doxygen will put a list of the files that are included by a file in
# the documentation of that file.
SHOW_INCLUDE_FILES = YES
@ -298,19 +307,19 @@ SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear
# in declaration order.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
# declaration order.
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members
# alphabetically by member name. If set to NO (the default) the
# members will appear in declaration order.
SORT_BRIEF_DOCS = NO
SORT_BRIEF_DOCS = YES
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
@ -320,7 +329,7 @@ SORT_BRIEF_DOCS = NO
# Note: This option applies only to the class list, not to the
# alphabetical list.
SORT_BY_SCOPE_NAME = NO
SORT_BY_SCOPE_NAME = YES
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
@ -431,7 +440,7 @@ INPUT = @srcdir@/docs/doxygen/doxygroups.cc \
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
FILE_PATTERNS = *
FILE_PATTERNS = *.h *.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.
@ -439,17 +448,19 @@ FILE_PATTERNS = *
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
# The EXCLUDE tag can be used to specify files and/or directories that
# should excluded from the INPUT source files. This way you can easily
# exclude a subdirectory from a directory tree whose root is specified
# with the INPUT tag.
EXCLUDE = Makefile \
CVS \
include/bits/demangle.h \
stdc++.h.gch
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are
# excluded from the input.
EXCLUDE_SYMLINKS = NO
@ -557,14 +568,14 @@ ALPHABETICAL_INDEX = YES
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
COLS_IN_ALPHA_INDEX = 3
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
IGNORE_PREFIX =
IGNORE_PREFIX = std __gnu_cxx __gnu_debug
#---------------------------------------------------------------------------
# configuration options related to the HTML output
@ -612,7 +623,8 @@ HTML_STYLESHEET = @srcdir@/docs/doxygen/style.css
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
#HTML_ALIGN_MEMBERS = YES
HTML_ALIGN_MEMBERS = NO
# 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
@ -670,7 +682,7 @@ ENUM_VALUES_PER_LINE = 4
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature.
GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = YES
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
@ -959,18 +971,19 @@ PREDEFINED = _GLIBCXX_DEPRECATED \
__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.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
# 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. The macro definition that is found in the
# sources will be used. Use the PREDEFINED tag if you want to use a
# different macro definition.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse the
# parser if not removed.
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are
# alone on a line, have an all uppercase name, and do not end with a
# semicolon. Such function macros are typically used for boiler-plate
# code, and will confuse the parser if not removed.
SKIP_FUNCTION_MACROS = YES
@ -1021,44 +1034,47 @@ PERL_PATH = /usr/bin/perl
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
# super classes. Setting the tag to NO turns the diagrams off. Note that this
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
# recommended to install and use dot, since it yields more powerful graphs.
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes
# with base or super classes. Setting the tag to NO turns the diagrams
# off. Note that this option is superseded by the HAVE_DOT option
# below. This is only a fallback. It is recommended to install and use
# dot, since it yields more powerful graphs.
CLASS_DIAGRAMS = YES
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented or is
# not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot
# tool is available from the path. This tool is part of Graphviz, a
# graph visualization toolkit from AT&T and Lucent Bell Labs. The
# other options in this section have no effect if this option is set
# to NO (the default)
HAVE_DOT = YES
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct
# and indirect inheritance relations. Setting this tag to YES will
# force the the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a graph for each documented class showing the
# direct and indirect implementation dependencies (inheritance,
# containment, and class references variables) of the class with other
# documented classes.
COLLABORATION_GRAPH = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# If the UML_LOOK tag is set to YES doxygen will generate inheritance
# and collaboration diagrams in a style similar to the OMG's Unified
# Modeling Language.
UML_LOOK = NO
@ -1067,36 +1083,39 @@ UML_LOOK = NO
TEMPLATE_RELATIONS = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for
# each documented file showing the direct and indirect include
# dependencies of the file with other documented files.
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for
# each documented header file showing the documented files that
# directly or indirectly include this file.
INCLUDED_BY_GRAPH = YES
#INCLUDED_BY_GRAPH = YES
INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
# generate a call dependency graph for every global function or class method.
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command.
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
# generate a call dependency graph for every global function or class
# method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable
# call graphs for selected functions only using the \callgraph
# command.
CALL_GRAPH = NO
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then
# doxygen will graphical hierarchy of all classes instead of a textual
# one.
GRAPHICAL_HIERARCHY = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the
# images generated by dot. Possible values are png, jpg, or gif If
# left blank png will be used.
DOT_IMAGE_FORMAT = png
@ -1105,48 +1124,50 @@ DOT_IMAGE_FORMAT = png
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
# \dotfile command).
# The DOTFILE_DIRS tag can be used to specify one or more directories
# that contain dot files that are included in the documentation (see
# the \dotfile command).
DOTFILE_DIRS =
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed
# width (in pixels) of the graphs generated by dot. If a graph becomes
# larger than this value, doxygen will try to truncate the graph, so
# that it fits within the specified constraint. Beware that most
# browsers cannot cope with very large images.
MAX_DOT_GRAPH_WIDTH = 1024
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows
# height (in pixels) of the graphs generated by dot. If a graph
# becomes larger than this value, doxygen will try to truncate the
# graph, so that it fits within the specified constraint. Beware that
# most browsers cannot cope with very large images.
MAX_DOT_GRAPH_HEIGHT = 1024
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes that
# lay further from the root node will be omitted. Note that setting this option to
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
# note that a graph may be further truncated if the graph's image dimensions are
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of
# the graphs generated by dot. A depth value of 3 means that only
# nodes reachable from the root by following a path via at most 3
# edges will be shown. Nodes that lay further from the root node will
# be omitted. Note that setting this option to 1 or 2 may greatly
# reduce the computation time needed for large code bases. Also note
# that a graph may be further truncated if the graph's image
# dimensions are not sufficient to fit the graph (see
# MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the
# depth value (the default), the graph is not depth-constrained.
MAX_DOT_GRAPH_DEPTH = 0
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes
# and arrows in the dot generated graphs.
GENERATE_LEGEND = YES
GENERATE_LEGEND = NO
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
# the various graphs.
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate the
# various graphs.
DOT_CLEANUP = YES