diff --git a/Doxyfile b/Doxyfile index 7bb874b8..f0aed496 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,7 +1,7 @@ #================================================================================================== # # Configfile file for the Blaze library -# Generated by doxygen version 1.8.5 +# Generated by doxygen version 1.8.7 # # Copyright (C) 2013 Klaus Iglberger - All Rights Reserved # @@ -33,9 +33,9 @@ #================================================================================================== -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Project related configuration options -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text @@ -58,7 +58,7 @@ PROJECT_NAME = "" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.1 +PROJECT_NUMBER = 2.2 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -90,15 +90,25 @@ OUTPUT_DIRECTORY = ./doc/ CREATE_SUBDIRS = YES +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = 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. -# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- -# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, -# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, -# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, -# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, -# Turkish, Ukrainian and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English @@ -279,9 +289,12 @@ OPTIMIZE_OUTPUT_VHDL = NO # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note For files without extension you can use no_extension as a placeholder. # @@ -404,9 +417,9 @@ TYPEDEF_HIDES_STRUCT = YES LOOKUP_CACHE_SIZE = 0 -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Build related configuration options -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private @@ -520,6 +533,13 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = 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. # The default value is: NO. @@ -541,7 +561,8 @@ SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO @@ -684,9 +705,9 @@ LAYOUT_FILE = CITE_BIB_FILES = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to warning and progress messages -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the @@ -743,9 +764,9 @@ WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the input files -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or @@ -895,9 +916,9 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to source browsing -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. @@ -981,9 +1002,9 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of @@ -1007,9 +1028,9 @@ COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the HTML output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output # The default value is: YES. @@ -1244,7 +1265,8 @@ GENERATE_CHI = NO CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1484,11 +1506,11 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There -# are two flavours of web server based searching depending on the -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for -# searching and an index file used by the script. When EXTERNAL_SEARCH is -# enabled the indexing and searching needs to be provided by external tools. See -# the section "External Indexing and Searching" for details. +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1547,9 +1569,9 @@ EXTERNAL_SEARCH_ID = EXTRA_SEARCH_MAPPINGS = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the LaTeX output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # The default value is: YES. @@ -1692,9 +1714,9 @@ LATEX_SOURCE_CODE = NO LATEX_BIB_STYLE = plain -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the RTF output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF @@ -1748,9 +1770,9 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the man page output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for # classes and files. @@ -1776,6 +1798,13 @@ MAN_OUTPUT = man MAN_EXTENSION = .3 +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without @@ -1785,9 +1814,9 @@ MAN_EXTENSION = .3 MAN_LINKS = NO -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the XML output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that # captures the structure of the code including all documentation. @@ -1803,18 +1832,6 @@ GENERATE_XML = NO XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify a XML DTD, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -XML_DTD = - # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size @@ -1824,9 +1841,9 @@ XML_DTD = XML_PROGRAMLISTING = YES -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files # that can be used to generate PDF. @@ -1842,9 +1859,9 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen # Definitions (see http://autogen.sf.net) file that captures the structure of @@ -1854,9 +1871,9 @@ DOCBOOK_OUTPUT = docbook GENERATE_AUTOGEN_DEF = NO -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the Perl module output -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module # file that captures the structure of the code including all documentation. @@ -1892,9 +1909,9 @@ PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the preprocessor -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all # C-preprocessor directives found in the sources and include files. @@ -1961,18 +1978,18 @@ PREDEFINED = EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all refrences to 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 +# remove all references to 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. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. SKIP_FUNCTION_MACROS = YES -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to external references -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # The TAGFILES tag can be used to specify one or more tag files. For each tag # file the location of the external documentation should be added. The format of @@ -1983,7 +2000,7 @@ SKIP_FUNCTION_MACROS = YES # where loc1 and loc2 can be relative or absolute paths or URLs. See the # section "Linking to external documentation" for more information about the use # of tag files. -# Note: Each tag file must have an unique name (where the name does NOT include +# Note: Each tag file must have a unique name (where the name does NOT include # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. @@ -2021,9 +2038,9 @@ EXTERNAL_PAGES = YES PERL_PATH = /usr/bin/perl -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # Configuration options related to the dot tool -#-------------------------------------------------------------------------------------------------- +#--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to @@ -2043,6 +2060,13 @@ CLASS_DIAGRAMS = NO MSCGEN_PATH = +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + # 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. # The default value is: YES. @@ -2243,6 +2267,12 @@ DOTFILE_DIRS = MSCFILE_DIRS = +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes # larger than this value, doxygen will truncate the graph, which is visualized