diff options
Diffstat (limited to 'libstdc++-v3/docs/doxygen/user.cfg.in')
| -rw-r--r-- | libstdc++-v3/docs/doxygen/user.cfg.in | 197 |
1 files changed, 133 insertions, 64 deletions
diff --git a/libstdc++-v3/docs/doxygen/user.cfg.in b/libstdc++-v3/docs/doxygen/user.cfg.in index 06df07b21cf..3b679b511a8 100644 --- a/libstdc++-v3/docs/doxygen/user.cfg.in +++ b/libstdc++-v3/docs/doxygen/user.cfg.in @@ -1,4 +1,4 @@ -# Doxyfile 1.4.4 +# Doxyfile 1.5.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -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++" +PROJECT_NAME = libstdc++ # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -45,11 +45,11 @@ CREATE_SUBDIRS = NO # 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. +# Afrikaans, Arabic, 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, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, +# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English @@ -97,10 +97,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 @@ -163,13 +164,6 @@ DETAILS_AT_TOP = YES INHERIT_DOCS = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = YES - # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. @@ -191,10 +185,10 @@ TAB_SIZE = 4 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 @@ -205,6 +199,23 @@ OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO +# If you use STL classes (i.e. std::string, std::vector, etc.) but do +# not want to include (a tag file for) the STL sources as input, then +# you should set this tag to YES in order to let doxygen match +# functions declarations and definitions whose arguments contain STL +# classes (e.g. func(std::string); v.s. func(std::string) {}). This +# also make the inheritance and collaboration diagrams that involve +# STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = YES + # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to @@ -289,13 +300,14 @@ INTERNAL_DOCS = NO # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. -CASE_SENSE_NAMES = 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 # documentation. If set to YES the scope will be hidden. -HIDE_SCOPE_NAMES = YES +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 @@ -330,6 +342,7 @@ SORT_BRIEF_DOCS = YES # 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 @@ -379,7 +392,7 @@ SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple # directories then setting the SHOW_DIRECTORIES tag to YES will show -# the directory hierarchy in the documentation. The default is YES. +# the directory hierarchy in the documentation. The default is NO. SHOW_DIRECTORIES = YES @@ -389,7 +402,7 @@ SHOW_DIRECTORIES = YES # invoke the program by executing (via popen()) the command <command> # <input-file>, where <command> is the value of the # FILE_VERSION_FILTER tag, and <input-file> is the name of an input -# file provided by doxygen. Whatever the progam writes to standard +# file provided by doxygen. Whatever the program writes to standard # output is used as the file version. See the manual for examples. FILE_VERSION_FILTER = @@ -455,14 +468,15 @@ WARN_LOGFILE = # files or directories with spaces. INPUT = @srcdir@/docs/doxygen/doxygroups.cc \ + @srcdir@/libsupc++ \ + @srcdir@/libsupc++/exception \ + @srcdir@/libsupc++/new \ + @srcdir@/libsupc++/typeinfo \ include/@host_alias@/bits \ include/bits \ + include/debug \ include/ext \ include/tr1 \ - @srcdir@/libsupc++/exception \ - @srcdir@/libsupc++/new \ - @srcdir@/libsupc++/typeinfo \ - @srcdir@/libsupc++/cxxabi.h \ include/algorithm \ include/bitset \ include/deque \ @@ -481,6 +495,7 @@ INPUT = @srcdir@/docs/doxygen/doxygroups.cc \ include/memory \ include/numeric \ include/ostream \ + include/queue \ include/set \ include/sstream \ include/stack \ @@ -490,18 +505,48 @@ INPUT = @srcdir@/docs/doxygen/doxygroups.cc \ include/utility \ include/valarray \ include/vector \ + include/debug/bitset \ + include/debug/deque \ + include/debug/hash_map \ + include/debug/hash_set \ + include/debug/list \ + include/debug/map \ + include/debug/set \ + include/debug/string \ + include/debug/vector \ include/ext/algorithm \ include/ext/functional \ include/ext/hash_map \ include/ext/hash_set \ + include/ext/iterator \ include/ext/memory \ include/ext/numeric \ + include/ext/rb_tree \ include/ext/rope \ include/ext/slist \ + include/ext/pb_ds \ + include/ext/pb_ds/detail \ include/tr1/array \ + 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/functional \ include/tr1/hashtable \ include/tr1/memory \ + include/tr1/random \ include/tr1/tuple \ include/tr1/type_traits \ include/tr1/unordered_map \ @@ -513,9 +558,10 @@ INPUT = @srcdir@/docs/doxygen/doxygroups.cc \ # *.cpp and *.h) to filter out the source-files in the directories. If # left blank the following patterns are tested: *.c *.cc *.cxx *.cpp # *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ -# *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm +# *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py FILE_PATTERNS = *.h \ + *.hpp \ *.tcc # The RECURSIVE tag can be used to turn specify whether or not subdirectories @@ -529,14 +575,11 @@ RECURSIVE = NO # 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 +EXCLUDE = Makefile -# 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 @@ -546,10 +589,10 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = CVS \ - stamp-* \ +EXCLUDE_PATTERNS = stamp-* \ Makefile \ - *gch* + *gch* \ + */.svn/* # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see @@ -577,13 +620,13 @@ EXAMPLE_RECURSIVE = NO IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen -# should invoke to filter for each input file. Doxygen will invoke the -# filter program by executing (via popen()) the command <filter> -# <input-file>, where <filter> is the value of the INPUT_FILTER tag, -# and <input-file> is the name of an input file. Doxygen will then use -# the output that the filter program writes to standard output. If -# FILTER_PATTERNS is specified, this tag will be ignored. +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. INPUT_FILTER = @@ -636,6 +679,13 @@ REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source @@ -671,10 +721,11 @@ COLS_IN_ALPHA_INDEX = 2 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = std \ - std::tr1 \ - __gnu_cxx \ - __gnu_debug +#IGNORE_PREFIX = std \ +# std::tr1 \ +# __gnu_cxx \ +# __gnu_debug +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output @@ -942,7 +993,7 @@ MAN_LINKS = NO # generate an XML file that captures the structure of # the code including all documentation. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -1028,14 +1079,15 @@ ENABLE_PREPROCESSING = YES # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. +# GLIBCXX NOTE: Necessary for namespaces to be sorted correctly. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_PREDEFINED tags. +# PREDEFINED and EXPAND_AS_DEFINED tags. -EXPAND_ONLY_PREDEF = YES +EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. @@ -1055,19 +1107,25 @@ INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. +# The PREDEFINED tag can be used to specify one or more macro names +# that are defined before the preprocessor is started (similar to the +# -D option of gcc). The argument of the tag is a list of macros of +# the form: name or name=definition (no spaces). If the definition and +# the = are omitted =1 is assumed. To prevent a macro definition from +# being undefined via #undef or recursively expanded use the := +# operator instead of the = operator. PREDEFINED = __GTHREADS \ _GLIBCXX_STD=std \ + "_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_function_requires=// \ __glibcxx_class_requires=// \ __glibcxx_class_requires2=// \ __glibcxx_class_requires3=// \ @@ -1187,7 +1245,8 @@ UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. -TEMPLATE_RELATIONS = YES +#TEMPLATE_RELATIONS = YES +TEMPLATE_RELATIONS = NO # 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 @@ -1212,6 +1271,15 @@ INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a caller 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 caller graphs for selected functions only using the +# \callergraph command. + +CALLER_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. @@ -1228,6 +1296,7 @@ DIRECTORY_GRAPH = YES # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. +#DOT_IMAGE_FORMAT = svg DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be @@ -1283,7 +1352,7 @@ DOT_TRANSPARENT = NO # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. -DOT_MULTI_TARGETS = NO +DOT_MULTI_TARGETS = YES # 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 |