|
|
|
@ -1,14 +1,14 @@ |
|
|
|
|
# Doxyfile 1.5.5 |
|
|
|
|
# Doxyfile 1.7.4 |
|
|
|
|
|
|
|
|
|
# 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. |
|
|
|
|
# |
|
|
|
|
# All text after a hash (#) is considered a comment and will be ignored |
|
|
|
|
# All text after a hash (#) is considered a comment and will be ignored. |
|
|
|
|
# The format is: |
|
|
|
|
# TAG = value [value, ...] |
|
|
|
|
# For lists items can also be appended using: |
|
|
|
|
# TAG += value [value, ...] |
|
|
|
|
# Values that contain spaces should be placed between quotes (" ") |
|
|
|
|
# Values that contain spaces should be placed between quotes (" "). |
|
|
|
|
|
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
# Project related configuration options |
|
|
|
@ -33,6 +33,19 @@ PROJECT_NAME = "Projektdokumentation @PACKAGENAME@" |
|
|
|
|
|
|
|
|
|
PROJECT_NUMBER = "Version @MAJOR@.@MINOR@.@LEAST@" |
|
|
|
|
|
|
|
|
|
# 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 quick idea about the purpose of the project. Keep the description short. |
|
|
|
|
|
|
|
|
|
PROJECT_BRIEF = |
|
|
|
|
|
|
|
|
|
# With the PROJECT_LOGO tag one can specify an logo or icon that is |
|
|
|
|
# included in the documentation. The maximum height of the logo should not |
|
|
|
|
# exceed 55 pixels and the maximum width should not exceed 200 pixels. |
|
|
|
|
# Doxygen will copy the logo to the output directory. |
|
|
|
|
|
|
|
|
|
PROJECT_LOGO = |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
@ -54,11 +67,11 @@ CREATE_SUBDIRS = NO |
|
|
|
|
# information to generate all constant output in the proper language. |
|
|
|
|
# The default language is English, other supported languages are: |
|
|
|
|
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
|
|
|
|
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, |
|
|
|
|
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), |
|
|
|
|
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, |
|
|
|
|
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, |
|
|
|
|
# and Ukrainian. |
|
|
|
|
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
|
|
|
|
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
|
|
|
|
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
|
|
|
|
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, |
|
|
|
|
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
|
|
|
|
|
|
|
|
|
OUTPUT_LANGUAGE = German |
|
|
|
|
|
|
|
|
@ -126,7 +139,7 @@ STRIP_FROM_PATH = |
|
|
|
|
STRIP_FROM_INC_PATH = |
|
|
|
|
|
|
|
|
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
|
|
|
|
# (but less readable) file names. This can be useful is your file systems |
|
|
|
|
# (but less readable) file names. This can be useful if your file system |
|
|
|
|
# doesn't support long names like on DOS, Mac, or CD-ROM. |
|
|
|
|
|
|
|
|
|
SHORT_NAMES = NO |
|
|
|
@ -155,13 +168,6 @@ QT_AUTOBRIEF = NO |
|
|
|
|
|
|
|
|
|
MULTILINE_CPP_IS_BRIEF = YES |
|
|
|
|
|
|
|
|
|
# If the DETAILS_AT_TOP tag is set to YES then Doxygen |
|
|
|
|
# will output the detailed description near the top, like JavaDoc. |
|
|
|
|
# If set to NO, the detailed description appears after the member |
|
|
|
|
# documentation. |
|
|
|
|
|
|
|
|
|
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 |
|
|
|
|
# re-implements. |
|
|
|
@ -219,11 +225,23 @@ OPTIMIZE_FOR_FORTRAN = NO |
|
|
|
|
|
|
|
|
|
OPTIMIZE_OUTPUT_VHDL = NO |
|
|
|
|
|
|
|
|
|
# Doxygen selects the parser to use depending on the extension of the files it |
|
|
|
|
# parses. With this tag you can assign which parser to use for a given 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, CSharp, C, |
|
|
|
|
# C++, D, PHP, 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 |
|
|
|
|
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
|
|
|
|
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
|
|
|
|
|
|
|
|
|
EXTENSION_MAPPING = |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
# func(std::string) {}). This also makes the inheritance and collaboration |
|
|
|
|
# diagrams that involve STL classes more complete and accurate. |
|
|
|
|
|
|
|
|
|
BUILTIN_STL_SUPPORT = NO |
|
|
|
@ -239,6 +257,15 @@ CPP_CLI_SUPPORT = NO |
|
|
|
|
|
|
|
|
|
SIP_SUPPORT = NO |
|
|
|
|
|
|
|
|
|
# For Microsoft's IDL there are propget and propput attributes to indicate getter |
|
|
|
|
# and setter methods for a property. Setting this option to YES (the default) |
|
|
|
|
# will make doxygen replace the get and set methods by a property in the |
|
|
|
|
# documentation. This will only work if the methods are indeed getting or |
|
|
|
|
# setting a simple type. If this is not the case, or you want to show the |
|
|
|
|
# methods anyway, you should set this option to NO. |
|
|
|
|
|
|
|
|
|
IDL_PROPERTY_SUPPORT = 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 |
|
|
|
@ -254,6 +281,13 @@ DISTRIBUTE_GROUP_DOC = YES |
|
|
|
|
|
|
|
|
|
SUBGROUPING = YES |
|
|
|
|
|
|
|
|
|
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and |
|
|
|
|
# unions are shown inside the group in which they are included (e.g. using |
|
|
|
|
# @ingroup) instead of on a separate page (for HTML and Man pages) or |
|
|
|
|
# section (for LaTeX and RTF). |
|
|
|
|
|
|
|
|
|
INLINE_GROUPED_CLASSES = NO |
|
|
|
|
|
|
|
|
|
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
|
|
|
|
# is documented as struct, union, or enum with the name of the typedef. So |
|
|
|
|
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
|
|
|
@ -264,6 +298,22 @@ SUBGROUPING = YES |
|
|
|
|
|
|
|
|
|
TYPEDEF_HIDES_STRUCT = NO |
|
|
|
|
|
|
|
|
|
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
|
|
|
|
# determine which symbols to keep in memory and which to flush to disk. |
|
|
|
|
# When the cache is full, less often used symbols will be written to disk. |
|
|
|
|
# For small to medium size projects (<1000 input files) the default value is |
|
|
|
|
# probably good enough. For larger projects a too small cache size can cause |
|
|
|
|
# doxygen to be busy swapping symbols to and from disk most of the time |
|
|
|
|
# causing a significant performance penalty. |
|
|
|
|
# If the system has enough physical memory increasing the cache will improve the |
|
|
|
|
# performance by keeping more symbols in memory. Note that the value works on |
|
|
|
|
# a logarithmic scale so increasing the size by one will roughly double the |
|
|
|
|
# memory usage. The cache size is given by this formula: |
|
|
|
|
# 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 |
|
|
|
|
|
|
|
|
|
SYMBOL_CACHE_SIZE = 0 |
|
|
|
|
|
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
# Build related configuration options |
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
@ -302,7 +352,7 @@ EXTRACT_LOCAL_METHODS = NO |
|
|
|
|
# extracted and appear in the documentation as a namespace called |
|
|
|
|
# 'anonymous_namespace{file}', where file will be replaced with the base |
|
|
|
|
# name of the file that contains the anonymous namespace. By default |
|
|
|
|
# anonymous namespace are hidden. |
|
|
|
|
# anonymous namespaces are hidden. |
|
|
|
|
|
|
|
|
|
EXTRACT_ANON_NSPACES = NO |
|
|
|
|
|
|
|
|
@ -362,6 +412,12 @@ HIDE_SCOPE_NAMES = 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] |
|
|
|
|
# is inserted in the documentation for inline members. |
|
|
|
|
|
|
|
|
@ -379,13 +435,23 @@ SORT_MEMBER_DOCS = YES |
|
|
|
|
# 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_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
|
|
|
|
# will sort the (brief and detailed) documentation of class members so that |
|
|
|
|
# constructors and destructors are listed first. If set to NO (the default) |
|
|
|
|
# the constructors will appear in the respective orders defined by |
|
|
|
|
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
|
|
|
|
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
|
|
|
|
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
|
|
|
|
|
|
|
|
|
SORT_MEMBERS_CTORS_1ST = YES |
|
|
|
|
|
|
|
|
|
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
|
|
|
|
# hierarchy of group names into alphabetical order. If set to NO (the default) |
|
|
|
|
# the group names will appear in their defined order. |
|
|
|
|
|
|
|
|
|
SORT_GROUP_NAMES = NO |
|
|
|
|
SORT_GROUP_NAMES = 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 |
|
|
|
@ -397,6 +463,15 @@ SORT_GROUP_NAMES = NO |
|
|
|
|
|
|
|
|
|
SORT_BY_SCOPE_NAME = NO |
|
|
|
|
|
|
|
|
|
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to |
|
|
|
|
# do proper type resolution of all parameters of a function it will reject a |
|
|
|
|
# match between the prototype and the implementation of a member function even |
|
|
|
|
# if there is only one candidate or it is obvious which candidate to choose |
|
|
|
|
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen |
|
|
|
|
# will still accept a match between prototype and implementation in such cases. |
|
|
|
|
|
|
|
|
|
STRICT_PROTO_MATCHING = NO |
|
|
|
|
|
|
|
|
|
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
|
|
|
|
# disable (NO) the todo list. This list is created by putting \todo |
|
|
|
|
# commands in the documentation. |
|
|
|
@ -427,10 +502,10 @@ GENERATE_DEPRECATEDLIST= YES |
|
|
|
|
ENABLED_SECTIONS = |
|
|
|
|
|
|
|
|
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
|
|
|
|
# the initial value of a variable or define consists of for it to appear in |
|
|
|
|
# the initial value of a variable or macro consists of for it to appear in |
|
|
|
|
# the documentation. If the initializer consists of more lines than specified |
|
|
|
|
# here it will be hidden. Use a value of 0 to hide initializers completely. |
|
|
|
|
# The appearance of the initializer of individual variables and defines in the |
|
|
|
|
# The appearance of the initializer of individual variables and macros in the |
|
|
|
|
# documentation can be controlled using \showinitializer or \hideinitializer |
|
|
|
|
# command in the documentation regardless of this setting. |
|
|
|
|
|
|
|
|
@ -448,6 +523,19 @@ SHOW_USED_FILES = YES |
|
|
|
|
|
|
|
|
|
SHOW_DIRECTORIES = NO |
|
|
|
|
|
|
|
|
|
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
|
|
|
|
# This will remove the Files entry from the Quick Index and from the |
|
|
|
|
# Folder Tree View (if specified). The default is YES. |
|
|
|
|
|
|
|
|
|
SHOW_FILES = YES |
|
|
|
|
|
|
|
|
|
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
|
|
|
|
# Namespaces page. |
|
|
|
|
# This will remove the Namespaces entry from the Quick Index |
|
|
|
|
# and from the Folder Tree View (if specified). The default is YES. |
|
|
|
|
|
|
|
|
|
SHOW_NAMESPACES = YES |
|
|
|
|
|
|
|
|
|
# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
|
|
|
|
# doxygen should invoke to get the current version for each file (typically from |
|
|
|
|
# the version control system). Doxygen will invoke the program by executing (via |
|
|
|
@ -458,6 +546,15 @@ SHOW_DIRECTORIES = NO |
|
|
|
|
|
|
|
|
|
FILE_VERSION_FILTER = |
|
|
|
|
|
|
|
|
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
|
|
|
|
# by doxygen. The layout file controls the global structure of the generated |
|
|
|
|
# output files in an output format independent way. The create the layout file |
|
|
|
|
# that represents doxygen's defaults, run doxygen with the -l option. |
|
|
|
|
# You can optionally specify a file name after the option, if omitted |
|
|
|
|
# DoxygenLayout.xml will be used as the name of the layout file. |
|
|
|
|
|
|
|
|
|
LAYOUT_FILE = doxygenlayout.xml |
|
|
|
|
|
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
# configuration options related to warning and progress messages |
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
@ -486,7 +583,7 @@ WARN_IF_UNDOCUMENTED = NO |
|
|
|
|
|
|
|
|
|
WARN_IF_DOC_ERROR = YES |
|
|
|
|
|
|
|
|
|
# This WARN_NO_PARAMDOC option can be abled to get warnings for |
|
|
|
|
# The WARN_NO_PARAMDOC option can be enabled to get warnings for |
|
|
|
|
# functions that are documented, but have no documentation for their parameters |
|
|
|
|
# or return value. If set to NO (the default) doxygen will only warn about |
|
|
|
|
# wrong or incomplete parameter documentation, but not about the absence of |
|
|
|
@ -532,8 +629,9 @@ INPUT_ENCODING = UTF-8 |
|
|
|
|
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.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 *.py *.f90 |
|
|
|
|
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
|
|
|
|
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
|
|
|
|
# *.f90 *.f *.for *.vhd *.vhdl |
|
|
|
|
|
|
|
|
|
FILE_PATTERNS = *.[ch]xx \ |
|
|
|
|
*.doc |
|
|
|
@ -551,7 +649,7 @@ RECURSIVE = NO |
|
|
|
|
EXCLUDE = |
|
|
|
|
|
|
|
|
|
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
|
|
|
|
# directories that are symbolic links (a Unix filesystem feature) are excluded |
|
|
|
|
# directories that are symbolic links (a Unix file system feature) are excluded |
|
|
|
|
# from the input. |
|
|
|
|
|
|
|
|
|
EXCLUDE_SYMLINKS = NO |
|
|
|
@ -605,17 +703,20 @@ IMAGE_PATH = |
|
|
|
|
# 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 |
|
|
|
|
# to standard output. |
|
|
|
|
# If FILTER_PATTERNS is specified, this tag will be |
|
|
|
|
# ignored. |
|
|
|
|
|
|
|
|
|
INPUT_FILTER = |
|
|
|
|
|
|
|
|
|
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
|
|
|
|
# basis. Doxygen will compare the file name with each pattern and apply the |
|
|
|
|
# filter if there is a match. The filters are a list of the form: |
|
|
|
|
# basis. |
|
|
|
|
# Doxygen will compare the file name with each pattern and apply the |
|
|
|
|
# filter if there is a match. |
|
|
|
|
# The filters are a list of the form: |
|
|
|
|
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
|
|
|
|
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
|
|
|
|
# is applied to all files. |
|
|
|
|
# info on how filters are used. If FILTER_PATTERNS is empty or if |
|
|
|
|
# non of the patterns match the file name, INPUT_FILTER is applied. |
|
|
|
|
|
|
|
|
|
FILTER_PATTERNS = |
|
|
|
|
|
|
|
|
@ -625,6 +726,14 @@ FILTER_PATTERNS = |
|
|
|
|
|
|
|
|
|
FILTER_SOURCE_FILES = NO |
|
|
|
|
|
|
|
|
|
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file |
|
|
|
|
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) |
|
|
|
|
# and it is also possible to disable source filtering for a specific pattern |
|
|
|
|
# using *.ext= (so without naming a filter). This option only has effect when |
|
|
|
|
# FILTER_SOURCE_FILES is enabled. |
|
|
|
|
|
|
|
|
|
FILTER_SOURCE_PATTERNS = |
|
|
|
|
|
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
# configuration options related to source browsing |
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
@ -647,13 +756,13 @@ INLINE_SOURCES = YES |
|
|
|
|
|
|
|
|
|
STRIP_CODE_COMMENTS = YES |
|
|
|
|
|
|
|
|
|
# If the REFERENCED_BY_RELATION tag is set to YES (the default) |
|
|
|
|
# If the REFERENCED_BY_RELATION tag is set to YES |
|
|
|
|
# then for each documented function all documented |
|
|
|
|
# functions referencing it will be listed. |
|
|
|
|
|
|
|
|
|
REFERENCED_BY_RELATION = YES |
|
|
|
|
|
|
|
|
|
# If the REFERENCES_RELATION tag is set to YES (the default) |
|
|
|
|
# If the REFERENCES_RELATION tag is set to YES |
|
|
|
|
# then for each documented function all documented entities |
|
|
|
|
# called/used by that function will be listed. |
|
|
|
|
|
|
|
|
@ -662,7 +771,8 @@ 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. |
|
|
|
|
# link to the source code. |
|
|
|
|
# Otherwise they will link to the documentation. |
|
|
|
|
|
|
|
|
|
REFERENCES_LINK_SOURCE = YES |
|
|
|
|
|
|
|
|
@ -726,7 +836,13 @@ HTML_FILE_EXTENSION = .html |
|
|
|
|
|
|
|
|
|
# The HTML_HEADER tag can be used to specify a personal HTML header for |
|
|
|
|
# each generated HTML page. If it is left blank doxygen will generate a |
|
|
|
|
# standard header. |
|
|
|
|
# standard header. Note that when using a custom header you are responsible |
|
|
|
|
# for the proper inclusion of any scripts and style sheets that doxygen |
|
|
|
|
# needs, which is dependent on the configuration options used. |
|
|
|
|
# It is adviced to generate a default header using "doxygen -w html |
|
|
|
|
# header.html footer.html stylesheet.css YourConfigFile" and then modify |
|
|
|
|
# that header. Note that the header is subject to change so you typically |
|
|
|
|
# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW! |
|
|
|
|
|
|
|
|
|
HTML_HEADER = |
|
|
|
|
|
|
|
|
@ -745,18 +861,59 @@ HTML_FOOTER = |
|
|
|
|
|
|
|
|
|
HTML_STYLESHEET = |
|
|
|
|
|
|
|
|
|
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
|
|
|
|
# other source files which should be copied to the HTML output directory. Note |
|
|
|
|
# that these files will be copied to the base HTML output directory. Use the |
|
|
|
|
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these |
|
|
|
|
# files. In the HTML_STYLESHEET file, use the file name only. Also note that |
|
|
|
|
# the files will be copied as-is; there are no commands or markers available. |
|
|
|
|
|
|
|
|
|
HTML_EXTRA_FILES = |
|
|
|
|
|
|
|
|
|
# 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 = YES |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
# NO a bullet list will be used. |
|
|
|
|
|
|
|
|
|
HTML_ALIGN_MEMBERS = YES |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
|
|
|
|
# of the generated HTML documentation. |
|
|
|
|
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
|
|
|
|
# documentation will contain sections that can be hidden and shown after the |
|
|
|
|
# page has loaded. For this to work a browser that supports |
|
|
|
|
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
|
|
|
|
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
|
|
|
|
|
|
|
|
|
GENERATE_HTMLHELP = NO |
|
|
|
|
HTML_DYNAMIC_SECTIONS = YES |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
@ -766,6 +923,8 @@ GENERATE_HTMLHELP = NO |
|
|
|
|
# directory and running "make install" will install the docset in |
|
|
|
|
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
|
|
|
|
# it at startup. |
|
|
|
|
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
|
|
|
|
# for more information. |
|
|
|
|
|
|
|
|
|
GENERATE_DOCSET = NO |
|
|
|
|
|
|
|
|
@ -781,15 +940,24 @@ DOCSET_FEEDNAME = "Doxygen generated docs" |
|
|
|
|
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
|
|
|
|
# will append .docset to the name. |
|
|
|
|
|
|
|
|
|
DOCSET_BUNDLE_ID = org.doxygen.Project |
|
|
|
|
DOCSET_BUNDLE_ID = com.swisssign.dev |
|
|
|
|
|
|
|
|
|
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
|
|
|
|
# documentation will contain sections that can be hidden and shown after the |
|
|
|
|
# page has loaded. For this to work a browser that supports |
|
|
|
|
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
|
|
|
|
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
|
|
|
|
# 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 = com.swisssign.dev |
|
|
|
|
|
|
|
|
|
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. |
|
|
|
|
|
|
|
|
|
HTML_DYNAMIC_SECTIONS = NO |
|
|
|
|
DOCSET_PUBLISHER_NAME = "Marc Wäckerlin (SwissSign AG)" |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
|
|
|
|
# of the generated HTML documentation. |
|
|
|
|
|
|
|
|
|
GENERATE_HTMLHELP = NO |
|
|
|
|
|
|
|
|
|
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
|
|
|
|
# be used to specify the file name of the resulting .chm file. You |
|
|
|
@ -811,6 +979,12 @@ HHC_LOCATION = |
|
|
|
|
|
|
|
|
|
GENERATE_CHI = NO |
|
|
|
|
|
|
|
|
|
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
|
|
|
|
# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
|
|
|
|
# content. |
|
|
|
|
|
|
|
|
|
CHM_INDEX_ENCODING = |
|
|
|
|
|
|
|
|
|
# If the GENERATE_HTMLHELP tag is set to YES, 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. |
|
|
|
@ -822,25 +996,103 @@ BINARY_TOC = NO |
|
|
|
|
|
|
|
|
|
TOC_EXPAND = NO |
|
|
|
|
|
|
|
|
|
# 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 generated |
|
|
|
|
# that can be used as input for Qt's qhelpgenerator to generate a |
|
|
|
|
# Qt Compressed Help (.qch) of the generated HTML documentation. |
|
|
|
|
|
|
|
|
|
GENERATE_QHP = YES |
|
|
|
|
|
|
|
|
|
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
|
|
|
|
# be used to specify the file name of the resulting .qch file. |
|
|
|
|
# The path specified is relative to the HTML output folder. |
|
|
|
|
|
|
|
|
|
QCH_FILE = @PACKAGENAME@.qch |
|
|
|
|
|
|
|
|
|
# The QHP_NAMESPACE tag specifies the namespace to use when generating |
|
|
|
|
# Qt Help Project output. For more information please see |
|
|
|
|
# http://doc.trolltech.com/qthelpproject.html#namespace |
|
|
|
|
|
|
|
|
|
QHP_NAMESPACE = org.waweckerlin.marc.dev |
|
|
|
|
|
|
|
|
|
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
|
|
|
|
# Qt Help Project output. For more information please see |
|
|
|
|
# http://doc.trolltech.com/qthelpproject.html#virtual-folders |
|
|
|
|
|
|
|
|
|
QHP_VIRTUAL_FOLDER = doc |
|
|
|
|
|
|
|
|
|
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
|
|
|
|
# add. For more information please see |
|
|
|
|
# http://doc.trolltech.com/qthelpproject.html#custom-filters |
|
|
|
|
|
|
|
|
|
QHP_CUST_FILTER_NAME = |
|
|
|
|
|
|
|
|
|
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
|
|
|
|
# custom filter to add. For more information please see |
|
|
|
|
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
|
|
|
|
# Qt Help Project / Custom Filters</a>. |
|
|
|
|
|
|
|
|
|
QHP_CUST_FILTER_ATTRS = |
|
|
|
|
|
|
|
|
|
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
|
|
|
|
# project's |
|
|
|
|
# filter section matches. |
|
|
|
|
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
|
|
|
|
# Qt Help Project / Filter Attributes</a>. |
|
|
|
|
|
|
|
|
|
QHP_SECT_FILTER_ATTRS = |
|
|
|
|
|
|
|
|
|
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
|
|
|
|
# be used to specify the location of Qt's qhelpgenerator. |
|
|
|
|
# If non-empty doxygen will try to run qhelpgenerator on the generated |
|
|
|
|
# .qhp file. |
|
|
|
|
|
|
|
|
|
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 = com.swisssign.dev |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
# the value YES disables it. |
|
|
|
|
|
|
|
|
|
DISABLE_INDEX = NO |
|
|
|
|
|
|
|
|
|
# This tag can be used to set the number of enum values (range [1..20]) |
|
|
|
|
# that doxygen will group on one line in the generated HTML documentation. |
|
|
|
|
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values |
|
|
|
|
# (range [0,1..20]) that doxygen will group on one line in the generated HTML |
|
|
|
|
# documentation. Note that a value of 0 will completely suppress the enum |
|
|
|
|
# values from appearing in the overview section. |
|
|
|
|
|
|
|
|
|
ENUM_VALUES_PER_LINE = 4 |
|
|
|
|
|
|
|
|
|
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
|
|
|
|
# generated containing a tree-like index structure (just like the one that |
|
|
|
|
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
|
|
|
|
# structure should be generated to display hierarchical information. |
|
|
|
|
# If the tag value is set to YES, a side panel will be generated |
|
|
|
|
# containing a tree-like index structure (just like the one that |
|
|
|
|
# is generated for HTML Help). For this to work a browser that supports |
|
|
|
|
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
|
|
|
|
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
|
|
|
|
# probably better off using the HTML help feature. |
|
|
|
|
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
|
|
|
|
# Windows users are probably better off using the HTML help feature. |
|
|
|
|
|
|
|
|
|
GENERATE_TREEVIEW = YES |
|
|
|
|
|
|
|
|
|
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
|
|
|
|
# and Class Hierarchy pages using a tree view instead of an ordered list. |
|
|
|
|
|
|
|
|
|
GENERATE_TREEVIEW = NO |
|
|
|
|
USE_INLINE_TREES = 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 |
|
|
|
@ -848,6 +1100,67 @@ GENERATE_TREEVIEW = NO |
|
|
|
|
|
|
|
|
|
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 |
|
|
|
|
# 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 |
|
|
|
|
# to manually remove any form_*.png images from the HTML output directory |
|
|
|
|
# to force them to be regenerated. |
|
|
|
|
|
|
|
|
|
FORMULA_FONTSIZE = 10 |
|
|
|
|
|
|
|
|
|
# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
|
|
|
|
# generated for formulas are transparent PNGs. Transparent PNGs are |
|
|
|
|
# not supported properly for IE 6.0, but are supported on all modern browsers. |
|
|
|
|
# Note that when changing this option you need to delete any form_*.png files |
|
|
|
|
# in the HTML output before the changes have effect. |
|
|
|
|
|
|
|
|
|
FORMULA_TRANSPARENT = YES |
|
|
|
|
|
|
|
|
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax |
|
|
|
|
# (see http://www.mathjax.org) which uses client side Javascript for the |
|
|
|
|
# rendering instead of using prerendered bitmaps. Use this if you do not |
|
|
|
|
# have LaTeX installed or if you want to formulas look prettier in the HTML |
|
|
|
|
# output. When enabled you also need to install MathJax separately and |
|
|
|
|
# configure the path to it using the MATHJAX_RELPATH option. |
|
|
|
|
|
|
|
|
|
USE_MATHJAX = NO |
|
|
|
|
|
|
|
|
|
# When MathJax is enabled you need to specify the location relative to the |
|
|
|
|
# HTML output directory using the MATHJAX_RELPATH option. The destination |
|
|
|
|
# directory should contain the MathJax.js script. For instance, if the mathjax |
|
|
|
|
# directory is located at the same level as the HTML output directory, then |
|
|
|
|
# MATHJAX_RELPATH should be ../mathjax. The default value points to the |
|
|
|
|
# mathjax.org site, so you can quickly see the result without installing |
|
|
|
|
# MathJax, but it is strongly recommended to install a local copy of MathJax |
|
|
|
|
# before deployment. |
|
|
|
|
|
|
|
|
|
MATHJAX_RELPATH = http://www.mathjax.org/mathjax |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
|
|
|
|
|
# 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 disadvantages are 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 |
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
@ -865,6 +1178,9 @@ LATEX_OUTPUT = latex |
|
|
|
|
|
|
|
|
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
|
|
|
|
# invoked. If left blank `latex' will be used as the default command name. |
|
|
|
|
# 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 |
|
|
|
|
|
|
|
|
@ -878,10 +1194,10 @@ MAKEINDEX_CMD_NAME = makeindex |
|
|
|
|
# LaTeX documents. This may be useful for small projects and may help to |
|
|
|
|
# save some trees in general. |
|
|
|
|
|
|
|
|
|
COMPACT_LATEX = NO |
|
|
|
|
COMPACT_LATEX = YES |
|
|
|
|
|
|
|
|
|
# The PAPER_TYPE tag can be used to set the paper type that is used |
|
|
|
|
# by the printer. Possible values are: a4, a4wide, letter, legal and |
|
|
|
|
# by the printer. Possible values are: a4, letter, legal and |
|
|
|
|
# executive. If left blank a4wide will be used. |
|
|
|
|
|
|
|
|
|
PAPER_TYPE = a4 |
|
|
|
@ -898,6 +1214,13 @@ EXTRA_PACKAGES = |
|
|
|
|
|
|
|
|
|
LATEX_HEADER = |
|
|
|
|
|
|
|
|
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for |
|
|
|
|
# the generated latex document. The footer should contain everything after |
|
|
|
|
# the last chapter. If it is left blank doxygen will generate a |
|
|
|
|
# standard footer. Notice: only use this tag if you know what you are doing! |
|
|
|
|
|
|
|
|
|
LATEX_FOOTER = |
|
|
|
|
|
|
|
|
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
|
|
|
|
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
|
|
|
|
# contain links (just like the HTML output) instead of page references |
|
|
|
@ -916,7 +1239,7 @@ USE_PDFLATEX = YES |
|
|
|
|
# running if errors occur, instead of asking the user for help. |
|
|
|
|
# This option is also used when generating formulas in HTML. |
|
|
|
|
|
|
|
|
|
LATEX_BATCHMODE = NO |
|
|
|
|
LATEX_BATCHMODE = YES |
|
|
|
|
|
|
|
|
|
# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
|
|
|
|
# include the index chapters (such as File Index, Compound Index, etc.) |
|
|
|
@ -924,6 +1247,13 @@ LATEX_BATCHMODE = NO |
|
|
|
|
|
|
|
|
|
LATEX_HIDE_INDICES = YES |
|
|
|
|
|
|
|
|
|
# If LATEX_SOURCE_CODE is set to YES then doxygen will include |
|
|
|
|
# source code with syntax highlighting in the LaTeX output. |
|
|
|
|
# Note that which sources are shown also depends on other settings |
|
|
|
|
# such as SOURCE_BROWSER. |
|
|
|
|
|
|
|
|
|
LATEX_SOURCE_CODE = NO |
|
|
|
|
|
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
# configuration options related to the RTF output |
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
@ -1060,8 +1390,10 @@ GENERATE_PERLMOD = NO |
|
|
|
|
PERLMOD_LATEX = NO |
|
|
|
|
|
|
|
|
|
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
|
|
|
|
# nicely formatted so it can be parsed by a human reader. This is useful |
|
|
|
|
# if you want to understand what is going on. On the other hand, if this |
|
|
|
|
# nicely formatted so it can be parsed by a human reader. |
|
|
|
|
# This is useful |
|
|
|
|
# if you want to understand what is going on. |
|
|
|
|
# On the other hand, if this |
|
|
|
|
# tag is set to NO the size of the Perl module output will be much smaller |
|
|
|
|
# and Perl will parse it just the same. |
|
|
|
|
|
|
|
|
@ -1098,7 +1430,7 @@ MACRO_EXPANSION = NO |
|
|
|
|
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. |
|
|
|
|
# pointed to by INCLUDE_PATH will be searched when a #include is found. |
|
|
|
|
|
|
|
|
|
SEARCH_INCLUDES = YES |
|
|
|
|
|
|
|
|
@ -1128,15 +1460,15 @@ PREDEFINED = HAVE_STACKTRACE |
|
|
|
|
# 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. |
|
|
|
|
# Use the PREDEFINED tag if you want to use a different macro definition that |
|
|
|
|
# overrules the definition found in the source code. |
|
|
|
|
|
|
|
|
|
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. |
|
|
|
|
# doxygen's preprocessor will 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, because these will confuse the parser if not removed. |
|
|
|
|
|
|
|
|
|
SKIP_FUNCTION_MACROS = YES |
|
|
|
|
|
|
|
|
@ -1148,8 +1480,10 @@ SKIP_FUNCTION_MACROS = YES |
|
|
|
|
# Optionally an initial location of the external documentation |
|
|
|
|
# can be added for each tagfile. The format of a tag file without |
|
|
|
|
# this location is as follows: |
|
|
|
|
# |
|
|
|
|
# TAGFILES = file1 file2 ... |
|
|
|
|
# Adding location for the tag files is done as follows: |
|
|
|
|
# |
|
|
|
|
# TAGFILES = file1=loc1 "file2 = loc2" ... |
|
|
|
|
# where "loc1" and "loc2" can be relative or absolute paths or |
|
|
|
|
# URLs. If a location is present for each tag, the installdox tool |
|
|
|
@ -1190,9 +1524,8 @@ PERL_PATH = /usr/bin/perl |
|
|
|
|
# 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. |
|
|
|
|
# this option also works with HAVE_DOT disabled, but it is recommended to |
|
|
|
|
# install and use dot, since it yields more powerful graphs. |
|
|
|
|
|
|
|
|
|
CLASS_DIAGRAMS = YES |
|
|
|
|
|
|
|
|
@ -1218,6 +1551,36 @@ HIDE_UNDOC_RELATIONS = NO |
|
|
|
|
|
|
|
|
|
HAVE_DOT = @HAVE_DOT@ |
|
|
|
|
|
|
|
|
|
# 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 Helvetica to the output |
|
|
|
|
# directory and reference it in all dot files that doxygen generates. |
|
|
|
|
# When you want a differently looking font you can specify the font name |
|
|
|
|
# using DOT_FONTNAME. You need to make sure dot is able to find the font, |
|
|
|
|
# which can be done by putting it in a standard location or by setting the |
|
|
|
|
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
|
|
|
|
# containing the font. |
|
|
|
|
|
|
|
|
|
DOT_FONTNAME = Helvetica |
|
|
|
|
|
|
|
|
|
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
|
|
|
|
# The default size is 10pt. |
|
|
|
|
|
|
|
|
|
DOT_FONTSIZE = 10 |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
|
# different font using DOT_FONTNAME you can set the path where dot |
|
|
|
|
# can find it using this tag. |
|
|
|
|
|
|
|
|
|
DOT_FONTPATH = |
|
|
|
|
|
|
|
|
|
# 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 |
|
|
|
@ -1279,7 +1642,7 @@ CALL_GRAPH = NO |
|
|
|
|
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. |
|
|
|
|
# will generate a graphical hierarchy of all classes instead of a textual one. |
|
|
|
|
|
|
|
|
|
GRAPHICAL_HIERARCHY = YES |
|
|
|
|
|
|
|
|
@ -1291,7 +1654,7 @@ GRAPHICAL_HIERARCHY = YES |
|
|
|
|
DIRECTORY_GRAPH = 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 |
|
|
|
|
# generated by dot. Possible values are svg, png, jpg, or gif. |
|
|
|
|
# If left blank png will be used. |
|
|
|
|
|
|
|
|
|
DOT_IMAGE_FORMAT = png |
|
|
|
@ -1307,7 +1670,13 @@ DOT_PATH = |
|
|
|
|
|
|
|
|
|
DOTFILE_DIRS = |
|
|
|
|
|
|
|
|
|
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
|
|
|
|
# The MSCFILE_DIRS tag can be used to specify one or more directories that |
|
|
|
|
# contain msc files that are included in the documentation (see the |
|
|
|
|
# \mscfile command). |
|
|
|
|
|
|
|
|
|
MSCFILE_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 by representing a node as a red box. Note that doxygen if the |
|
|
|
@ -1328,10 +1697,10 @@ DOT_GRAPH_MAX_NODES = 50 |
|
|
|
|
MAX_DOT_GRAPH_DEPTH = 0 |
|
|
|
|
|
|
|
|
|
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
|
|
|
|
# background. This is enabled by default, which results in a transparent |
|
|
|
|
# background. Warning: Depending on the platform used, enabling this option |
|
|
|
|
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they |
|
|
|
|
# become hard to read). |
|
|
|
|
# background. This is disabled by default, because dot on Windows does not |
|
|
|
|
# seem to support this out of the box. Warning: Depending on the platform used, |
|
|
|
|
# enabling this option may lead to badly anti-aliased labels on the edges of |
|
|
|
|
# a graph (i.e. they become hard to read). |
|
|
|
|
|
|
|
|
|
DOT_TRANSPARENT = YES |
|
|
|
|
|
|
|
|
@ -1353,12 +1722,3 @@ GENERATE_LEGEND = YES |
|
|
|
|
# the various graphs. |
|
|
|
|
|
|
|
|
|
DOT_CLEANUP = YES |
|
|
|
|
|
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
# Configuration::additions related to the search engine |
|
|
|
|
#--------------------------------------------------------------------------- |
|
|
|
|
|
|
|
|
|
# The SEARCHENGINE tag specifies whether or not a search engine should be |
|
|
|
|
# used. If set to NO the values of all tags below this one will be ignored. |
|
|
|
|
|
|
|
|
|
SEARCHENGINE = NO |
|
|
|
|