Changeset 243b53b608 in tspsg for Doxyfile


Ignore:
Timestamp:
Aug 29, 2013, 8:05:19 PM (11 years ago)
Author:
Oleksii Serdiuk
Branches:
appveyor, imgbot, master, readme
Children:
1241232377
Parents:
2940c14782
Message:

Updated Doxyfile to the latest doxygen format (1.8.5).

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Doxyfile

    r2940c14782 r243b53b608  
    1 # Doxyfile 1.8.1.2
     1# Doxyfile 1.8.5
    22
    33# This file describes the settings to be used by the documentation system
    44# doxygen (www.doxygen.org) for a project.
    55#
    6 # All text after a hash (#) is considered a comment and will be ignored.
     6# All text after a double hash (##) is considered a comment and is placed in
     7# front of the TAG it is preceding.
     8#
     9# All text after a single hash (#) is considered a comment and will be ignored.
    710# The format is:
    8 #       TAG = value [value, ...]
    9 # For lists items can also be appended using:
    10 #       TAG += value [value, ...]
    11 # Values that contain spaces should be placed between quotes (" ").
     11# TAG = value [value, ...]
     12# For lists, items can also be appended using:
     13# TAG += value [value, ...]
     14# Values that contain spaces should be placed between quotes (\" \").
    1215
    1316#---------------------------------------------------------------------------
     
    1619
    1720# This tag specifies the encoding used for all characters in the config file
    18 # that follow. The default is UTF-8 which is also the encoding used for all
    19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
    20 # iconv built into libc) for the transcoding. See
    21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
     21# that follow. The default is UTF-8 which is also the encoding used for all text
     22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
     23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
     24# for the list of possible encodings.
     25# The default value is: UTF-8.
    2226
    2327DOXYFILE_ENCODING      = UTF-8
    2428
    25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
    26 # identify the project. Note that if you do not use Doxywizard you need
    27 # to put quotes around the project name if it contains spaces.
     29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
     30# double-quotes, unless you are using Doxywizard) that should identify the
     31# project for which the documentation is generated. This name is used in the
     32# title of most generated pages and in a few other places.
     33# The default value is: My Project.
    2834
    2935PROJECT_NAME           = "TSP Solver and Generator"
    3036
    31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
    32 # This could be handy for archiving the generated documentation or
    33 # if some version control system is used.
     37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
     38# could be handy for archiving the generated documentation or if some version
     39# control system is used.
    3440
    3541PROJECT_NUMBER         =
    3642
    3743# Using the PROJECT_BRIEF tag one can provide an optional one line description
    38 # for a project that appears at the top of each page and should give viewer
    39 # a quick idea about the purpose of the project. Keep the description short.
     44# for a project that appears at the top of each page and should give viewer a
     45# quick idea about the purpose of the project. Keep the description short.
    4046
    4147PROJECT_BRIEF          =
    4248
    43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
    44 # included in the documentation. The maximum height of the logo should not
    45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
    46 # Doxygen will copy the logo to the output directory.
     49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
     50# the documentation. The maximum height of the logo should not exceed 55 pixels
     51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
     52# to the output directory.
    4753
    4854PROJECT_LOGO           =
    4955
    50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    51 # base path where the generated documentation will be put.
    52 # If a relative path is entered, it will be relative to the location
    53 # where doxygen was started. If left blank the current directory will be used.
     56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
     57# into which the generated documentation will be written. If a relative path is
     58# entered, it will be relative to the location where doxygen was started. If
     59# left blank the current directory will be used.
    5460
    5561OUTPUT_DIRECTORY       = doc
    5662
    57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    58 # 4096 sub-directories (in 2 levels) under the output directory of each output
    59 # format and will distribute the generated files over these directories.
    60 # Enabling this option can be useful when feeding doxygen a huge amount of
    61 # source files, where putting all generated files in the same directory would
    62 # otherwise cause performance problems for the file system.
     63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
     64# directories (in 2 levels) under the output directory of each output format and
     65# will distribute the generated files over these directories. Enabling this
     66# option can be useful when feeding doxygen a huge amount of source files, where
     67# putting all generated files in the same directory would otherwise causes
     68# performance problems for the file system.
     69# The default value is: NO.
    6370
    6471CREATE_SUBDIRS         = NO
     
    6774# documentation generated by doxygen is written. Doxygen will use this
    6875# information to generate all constant output in the proper language.
    69 # The default language is English, other supported languages are:
    70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
    72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
    73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
    74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
    75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
     76# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
     77# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
     78# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
     79# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
     80# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
     81# Turkish, Ukrainian and Vietnamese.
     82# The default value is: English.
    7683
    7784OUTPUT_LANGUAGE        = English
    7885
    79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    80 # include brief member descriptions after the members that are listed in
    81 # the file and class documentation (similar to JavaDoc).
    82 # Set to NO to disable this.
     86# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
     87# descriptions after the members that are listed in the file and class
     88# documentation (similar to Javadoc). Set to NO to disable this.
     89# The default value is: YES.
    8390
    8491BRIEF_MEMBER_DESC      = YES
    8592
    86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
    87 # the brief description of a member or function before the detailed description.
    88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
     93# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
     94# description of a member or function before the detailed description
     95#
     96# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    8997# brief descriptions will be completely suppressed.
     98# The default value is: YES.
    9099
    91100REPEAT_BRIEF           = YES
    92101
    93 # This tag implements a quasi-intelligent brief description abbreviator
    94 # that is used to form the text in various listings. Each string
    95 # in this list, if found as the leading text of the brief description, will be
    96 # stripped from the text and the result after processing the whole list, is
    97 # used as the annotated text. Otherwise, the brief description is used as-is.
    98 # If left blank, the following values are used ("$name" is automatically
    99 # replaced with the name of the entity): "The $name class" "The $name widget"
    100 # "The $name file" "is" "provides" "specifies" "contains"
    101 # "represents" "a" "an" "the"
     102# This tag implements a quasi-intelligent brief description abbreviator that is
     103# used to form the text in various listings. Each string in this list, if found
     104# as the leading text of the brief description, will be stripped from the text
     105# and the result, after processing the whole list, is used as the annotated
     106# text. Otherwise, the brief description is used as-is. If left blank, the
     107# following values are used ($name is automatically replaced with the name of
     108# the entity):The $name class, The $name widget, The $name file, is, provides,
     109# specifies, contains, represents, a, an and the.
    102110
    103111ABBREVIATE_BRIEF       = "The $name class" \
     
    114122
    115123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    116 # Doxygen will generate a detailed section even if there is only a brief
     124# doxygen will generate a detailed section even if there is only a brief
    117125# description.
     126# The default value is: NO.
    118127
    119128ALWAYS_DETAILED_SEC    = NO
     
    123132# members were ordinary class members. Constructors, destructors and assignment
    124133# operators of the base classes will not be shown.
     134# The default value is: NO.
    125135
    126136INLINE_INHERITED_MEMB  = NO
    127137
    128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    129 # path before files name in the file list and in the header files. If set
    130 # to NO the shortest path that makes the file name unique will be used.
     138# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
     139# before files name in the file list and in the header files. If set to NO the
     140# shortest path that makes the file name unique will be used
     141# The default value is: YES.
    131142
    132143FULL_PATH_NAMES        = YES
    133144
    134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    135 # can be used to strip a user-defined part of the path. Stripping is
    136 # only done if one of the specified strings matches the left-hand part of
    137 # the path. The tag can be used to show relative paths in the file list.
    138 # If left blank the directory from which doxygen is run is used as the
    139 # path to strip.
     145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
     146# Stripping is only done if one of the specified strings matches the left-hand
     147# part of the path. The tag can be used to show relative paths in the file list.
     148# If left blank the directory from which doxygen is run is used as the path to
     149# strip.
     150#
     151# Note that you can specify absolute paths here, but also relative paths, which
     152# will be relative from the directory where doxygen is started.
     153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
    140154
    141155STRIP_FROM_PATH        =
    142156
    143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    144 # the path mentioned in the documentation of a class, which tells
    145 # the reader which header file to include in order to use a class.
    146 # If left blank only the name of the header file containing the class
    147 # definition is used. Otherwise one should specify the include paths that
    148 # are normally passed to the compiler using the -I flag.
     157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
     158# path mentioned in the documentation of a class, which tells the reader which
     159# header file to include in order to use a class. If left blank only the name of
     160# the header file containing the class definition is used. Otherwise one should
     161# specify the list of include paths that are normally passed to the compiler
     162# using the -I flag.
    149163
    150164STRIP_FROM_INC_PATH    =
    151165
    152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    153 # (but less readable) file names. This can be useful if your file system
    154 # doesn't support long names like on DOS, Mac, or CD-ROM.
     166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
     167# less readable) file names. This can be useful is your file systems doesn't
     168# support long names like on DOS, Mac, or CD-ROM.
     169# The default value is: NO.
    155170
    156171SHORT_NAMES            = NO
    157172
    158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    159 # will interpret the first line (until the first dot) of a JavaDoc-style
    160 # comment as the brief description. If set to NO, the JavaDoc
    161 # comments will behave just like regular Qt-style comments
    162 # (thus requiring an explicit @brief command for a brief description.)
     173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
     174# first line (until the first dot) of a Javadoc-style comment as the brief
     175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
     176# style comments (thus requiring an explicit @brief command for a brief
     177# description.)
     178# The default value is: NO.
    163179
    164180JAVADOC_AUTOBRIEF      = NO
    165181
    166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
    167 # interpret the first line (until the first dot) of a Qt-style
    168 # comment as the brief description. If set to NO, the comments
    169 # will behave just like regular Qt-style comments (thus requiring
    170 # an explicit \brief command for a brief description.)
     182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
     183# line (until the first dot) of a Qt-style comment as the brief description. If
     184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
     185# requiring an explicit \brief command for a brief description.)
     186# The default value is: NO.
    171187
    172188QT_AUTOBRIEF           = YES
    173189
    174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    175 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    176 # comments) as a brief description. This used to be the default behaviour.
    177 # The new default is to treat a multi-line C++ comment block as a detailed
    178 # description. Set this tag to YES if you prefer the old behaviour instead.
     190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
     191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
     192# a brief description. This used to be the default behavior. The new default is
     193# to treat a multi-line C++ comment block as a detailed description. Set this
     194# tag to YES if you prefer the old behavior instead.
     195#
     196# Note that setting this tag to YES also means that rational rose comments are
     197# not recognized any more.
     198# The default value is: NO.
    179199
    180200MULTILINE_CPP_IS_BRIEF = NO
    181201
    182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    183 # member inherits the documentation from any documented member that it
    184 # re-implements.
     202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
     203# documentation from any documented member that it re-implements.
     204# The default value is: YES.
    185205
    186206INHERIT_DOCS           = YES
    187207
    188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    189 # a new page for each member. If set to NO, the documentation of a member will
    190 # be part of the file/class/namespace that contains it.
     208# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
     209# new page for each member. If set to NO, the documentation of a member will be
     210# part of the file/class/namespace that contains it.
     211# The default value is: NO.
    191212
    192213SEPARATE_MEMBER_PAGES  = NO
    193214
    194 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    195 # Doxygen uses this value to replace tabs by spaces in code fragments.
     215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
     216# uses this value to replace tabs by spaces in code fragments.
     217# Minimum value: 1, maximum value: 16, default value: 4.
    196218
    197219TAB_SIZE               = 4
    198220
    199 # This tag can be used to specify a number of aliases that acts
    200 # as commands in the documentation. An alias has the form "name=value".
    201 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    202 # put the command \sideeffect (or @sideeffect) in the documentation, which
    203 # will result in a user-defined paragraph with heading "Side Effects:".
    204 # You can put \n's in the value part of an alias to insert newlines.
     221# This tag can be used to specify a number of aliases that act as commands in
     222# the documentation. An alias has the form:
     223# name=value
     224# For example adding
     225# "sideeffect=@par Side Effects:\n"
     226# will allow you to put the command \sideeffect (or @sideeffect) in the
     227# documentation, which will result in a user-defined paragraph with heading
     228# "Side Effects:". You can put \n's in the value part of an alias to insert
     229# newlines.
    205230
    206231ALIASES                = "hack=\xrefitem hacks \"Hack\" \"Hack List\"" \
     
    208233
    209234# This tag can be used to specify a number of word-keyword mappings (TCL only).
    210 # A mapping has the form "name=value". For example adding
    211 # "class=itcl::class" will allow you to use the command class in the
    212 # itcl::class meaning.
     235# A mapping has the form "name=value". For example adding "class=itcl::class"
     236# will allow you to use the command class in the itcl::class meaning.
    213237
    214238TCL_SUBST              =
    215239
    216 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    217 # sources only. Doxygen will then generate output that is more tailored for C.
    218 # For instance, some of the names that are used will be different. The list
    219 # of all members will be omitted, etc.
     240# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     241# only. Doxygen will then generate output that is more tailored for C. For
     242# instance, some of the names that are used will be different. The list of all
     243# members will be omitted, etc.
     244# The default value is: NO.
    220245
    221246OPTIMIZE_OUTPUT_FOR_C  = NO
    222247
    223 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    224 # sources only. Doxygen will then generate output that is more tailored for
    225 # Java. For instance, namespaces will be presented as packages, qualified
    226 # scopes will look different, etc.
     248# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
     249# Python sources only. Doxygen will then generate output that is more tailored
     250# for that language. For instance, namespaces will be presented as packages,
     251# qualified scopes will look different, etc.
     252# The default value is: NO.
    227253
    228254OPTIMIZE_OUTPUT_JAVA   = NO
    229255
    230256# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
    231 # sources only. Doxygen will then generate output that is more tailored for
    232 # Fortran.
     257# sources. Doxygen will then generate output that is tailored for Fortran.
     258# The default value is: NO.
    233259
    234260OPTIMIZE_FOR_FORTRAN   = NO
    235261
    236262# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
    237 # sources. Doxygen will then generate output that is tailored for
    238 # VHDL.
     263# sources. Doxygen will then generate output that is tailored for VHDL.
     264# The default value is: NO.
    239265
    240266OPTIMIZE_OUTPUT_VHDL   = NO
    241267
    242268# Doxygen selects the parser to use depending on the extension of the files it
    243 # parses. With this tag you can assign which parser to use for a given extension.
    244 # Doxygen has a built-in mapping, but you can override or extend it using this
    245 # tag. The format is ext=language, where ext is a file extension, and language
    246 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
    247 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
     269# parses. With this tag you can assign which parser to use for a given
     270# extension. Doxygen has a built-in mapping, but you can override or extend it
     271# using this tag. The format is ext=language, where ext is a file extension, and
     272# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
     273# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
    248274# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
    249 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
    250 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     275# (default is Fortran), use: inc=Fortran f=C.
     276#
     277# Note For files without extension you can use no_extension as a placeholder.
     278#
     279# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
     280# the files are not read by doxygen.
    251281
    252282EXTENSION_MAPPING      =
    253283
    254 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
    255 # comments according to the Markdown format, which allows for more readable
     284# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
     285# according to the Markdown format, which allows for more readable
    256286# documentation. See http://daringfireball.net/projects/markdown/ for details.
    257 # The output of markdown processing is further processed by doxygen, so you
    258 # can mix doxygen, HTML, and XML commands with Markdown formatting.
    259 # Disable only in case of backward compatibilities issues.
     287# The output of markdown processing is further processed by doxygen, so you can
     288# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
     289# case of backward compatibilities issues.
     290# The default value is: YES.
    260291
    261292MARKDOWN_SUPPORT       = YES
    262293
     294# When enabled doxygen tries to link words that correspond to documented
     295# classes, or namespaces to their corresponding documentation. Such a link can
     296# be prevented in individual cases by by putting a % sign in front of the word
     297# or globally by setting AUTOLINK_SUPPORT to NO.
     298# The default value is: YES.
     299
     300AUTOLINK_SUPPORT       = YES
     301
    263302# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    264 # to include (a tag file for) the STL sources as input, then you should
    265 # set this tag to YES in order to let doxygen match functions declarations and
    266 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    267 # func(std::string) {}). This also makes the inheritance and collaboration
     303# to include (a tag file for) the STL sources as input, then you should set this
     304# tag to YES in order to let doxygen match functions declarations and
     305# definitions whose arguments contain STL classes (e.g. func(std::string);
     306# versus func(std::string) {}). This also make the inheritance and collaboration
    268307# diagrams that involve STL classes more complete and accurate.
     308# The default value is: NO.
    269309
    270310BUILTIN_STL_SUPPORT    = NO
     
    272312# If you use Microsoft's C++/CLI language, you should set this option to YES to
    273313# enable parsing support.
     314# The default value is: NO.
    274315
    275316CPP_CLI_SUPPORT        = NO
    276317
    277 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
    278 # Doxygen will parse them like normal C++ but will assume all classes use public
    279 # instead of private inheritance when no explicit protection keyword is present.
     318# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
     319# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
     320# will parse them like normal C++ but will assume all classes use public instead
     321# of private inheritance when no explicit protection keyword is present.
     322# The default value is: NO.
    280323
    281324SIP_SUPPORT            = NO
    282325
    283 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    284 # and setter methods for a property. Setting this option to YES (the default)
    285 # will make doxygen replace the get and set methods by a property in the
    286 # documentation. This will only work if the methods are indeed getting or
    287 # setting a simple type. If this is not the case, or you want to show the
    288 # methods anyway, you should set this option to NO.
     326# For Microsoft's IDL there are propget and propput attributes to indicate
     327# getter and setter methods for a property. Setting this option to YES will make
     328# doxygen to replace the get and set methods by a property in the documentation.
     329# This will only work if the methods are indeed getting or setting a simple
     330# type. If this is not the case, or you want to show the methods anyway, you
     331# should set this option to NO.
     332# The default value is: YES.
    289333
    290334IDL_PROPERTY_SUPPORT   = YES
     
    294338# member in the group (if any) for the other members of the group. By default
    295339# all members of a group must be documented explicitly.
     340# The default value is: NO.
    296341
    297342DISTRIBUTE_GROUP_DOC   = NO
    298343
    299 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    300 # the same type (for instance a group of public functions) to be put as a
    301 # subgroup of that type (e.g. under the Public Functions section). Set it to
    302 # NO to prevent subgrouping. Alternatively, this can be done per class using
    303 # the \nosubgrouping command.
     344# Set the SUBGROUPING tag to YES to allow class member groups of the same type
     345# (for instance a group of public functions) to be put as a subgroup of that
     346# type (e.g. under the Public Functions section). Set it to NO to prevent
     347# subgrouping. Alternatively, this can be done per class using the
     348# \nosubgrouping command.
     349# The default value is: YES.
    304350
    305351SUBGROUPING            = YES
    306352
    307 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
    308 # unions are shown inside the group in which they are included (e.g. using
    309 # @ingroup) instead of on a separate page (for HTML and Man pages) or
    310 # section (for LaTeX and RTF).
     353# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
     354# are shown inside the group in which they are included (e.g. using \ingroup)
     355# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
     356# and RTF).
     357#
     358# Note that this feature does not work in combination with
     359# SEPARATE_MEMBER_PAGES.
     360# The default value is: NO.
    311361
    312362INLINE_GROUPED_CLASSES = NO
    313363
    314 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
    315 # unions with only public data fields will be shown inline in the documentation
    316 # of the scope in which they are defined (i.e. file, namespace, or group
    317 # documentation), provided this scope is documented. If set to NO (the default),
    318 # structs, classes, and unions are shown on a separate page (for HTML and Man
    319 # pages) or section (for LaTeX and RTF).
     364# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
     365# with only public data fields or simple typedef fields will be shown inline in
     366# the documentation of the scope in which they are defined (i.e. file,
     367# namespace, or group documentation), provided this scope is documented. If set
     368# to NO, structs, classes, and unions are shown on a separate page (for HTML and
     369# Man pages) or section (for LaTeX and RTF).
     370# The default value is: NO.
    320371
    321372INLINE_SIMPLE_STRUCTS  = NO
    322373
    323 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    324 # is documented as struct, union, or enum with the name of the typedef. So
     374# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
     375# enum is documented as struct, union, or enum with the name of the typedef. So
    325376# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    326377# with name TypeT. When disabled the typedef will appear as a member of a file,
    327 # namespace, or class. And the struct will be named TypeS. This can typically
    328 # be useful for C code in case the coding convention dictates that all compound
     378# namespace, or class. And the struct will be named TypeS. This can typically be
     379# useful for C code in case the coding convention dictates that all compound
    329380# types are typedef'ed and only the typedef is referenced, never the tag name.
     381# The default value is: NO.
    330382
    331383TYPEDEF_HIDES_STRUCT   = NO
    332384
    333 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
    334 # determine which symbols to keep in memory and which to flush to disk.
    335 # When the cache is full, less often used symbols will be written to disk.
    336 # For small to medium size projects (<1000 input files) the default value is
    337 # probably good enough. For larger projects a too small cache size can cause
    338 # doxygen to be busy swapping symbols to and from disk most of the time
    339 # causing a significant performance penalty.
    340 # If the system has enough physical memory increasing the cache will improve the
    341 # performance by keeping more symbols in memory. Note that the value works on
    342 # a logarithmic scale so increasing the size by one will roughly double the
    343 # memory usage. The cache size is given by this formula:
    344 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    345 # corresponding to a cache size of 2^16 = 65536 symbols.
    346 
    347 SYMBOL_CACHE_SIZE      = 0
    348 
    349 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
    350 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
    351 # their name and scope. Since this can be an expensive process and often the
    352 # same symbol appear multiple times in the code, doxygen keeps a cache of
    353 # pre-resolved symbols. If the cache is too small doxygen will become slower.
    354 # If the cache is too large, memory is wasted. The cache size is given by this
    355 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
    356 # corresponding to a cache size of 2^16 = 65536 symbols.
     385# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
     386# cache is used to resolve symbols given their name and scope. Since this can be
     387# an expensive process and often the same symbol appears multiple times in the
     388# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
     389# doxygen will become slower. If the cache is too large, memory is wasted. The
     390# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
     391# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
     392# symbols. At the end of a run doxygen will report the cache usage and suggest
     393# the optimal cache size from a speed point of view.
     394# Minimum value: 0, maximum value: 9, default value: 0.
    357395
    358396LOOKUP_CACHE_SIZE      = 0
     
    363401
    364402# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    365 # documentation are documented, even if no documentation was available.
    366 # Private class members and static file members will be hidden unless
    367 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     403# documentation are documented, even if no documentation was available. Private
     404# class members and static file members will be hidden unless the
     405# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
     406# Note: This will also disable the warnings about undocumented members that are
     407# normally produced when WARNINGS is set to YES.
     408# The default value is: NO.
    368409
    369410EXTRACT_ALL            = NO
    370411
    371 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    372 # will be included in the documentation.
     412# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
     413# be included in the documentation.
     414# The default value is: NO.
    373415
    374416EXTRACT_PRIVATE        = NO
    375417
    376 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
     418# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
     419# scope will be included in the documentation.
     420# The default value is: NO.
    377421
    378422EXTRACT_PACKAGE        = NO
    379423
    380 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    381 # will be included in the documentation.
     424# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
     425# included in the documentation.
     426# The default value is: NO.
    382427
    383428EXTRACT_STATIC         = NO
    384429
    385 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    386 # defined locally in source files will be included in the documentation.
    387 # If set to NO only classes defined in header files are included.
     430# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
     431# locally in source files will be included in the documentation. If set to NO
     432# only classes defined in header files are included. Does not have any effect
     433# for Java sources.
     434# The default value is: YES.
    388435
    389436EXTRACT_LOCAL_CLASSES  = YES
    390437
    391 # This flag is only useful for Objective-C code. When set to YES local
    392 # methods, which are defined in the implementation section but not in
    393 # the interface are included in the documentation.
    394 # If set to NO (the default) only methods in the interface are included.
     438# This flag is only useful for Objective-C code. When set to YES local methods,
     439# which are defined in the implementation section but not in the interface are
     440# included in the documentation. If set to NO only methods in the interface are
     441# included.
     442# The default value is: NO.
    395443
    396444EXTRACT_LOCAL_METHODS  = NO
     
    398446# If this flag is set to YES, the members of anonymous namespaces will be
    399447# extracted and appear in the documentation as a namespace called
    400 # 'anonymous_namespace{file}', where file will be replaced with the base
    401 # name of the file that contains the anonymous namespace. By default
    402 # anonymous namespaces are hidden.
     448# 'anonymous_namespace{file}', where file will be replaced with the base name of
     449# the file that contains the anonymous namespace. By default anonymous namespace
     450# are hidden.
     451# The default value is: NO.
    403452
    404453EXTRACT_ANON_NSPACES   = NO
    405454
    406 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    407 # undocumented members of documented classes, files or namespaces.
    408 # If set to NO (the default) these members will be included in the
    409 # various overviews, but no documentation section is generated.
    410 # This option has no effect if EXTRACT_ALL is enabled.
     455# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
     456# undocumented members inside documented classes or files. If set to NO these
     457# members will be included in the various overviews, but no documentation
     458# section is generated. This option has no effect if EXTRACT_ALL is enabled.
     459# The default value is: NO.
    411460
    412461HIDE_UNDOC_MEMBERS     = NO
    413462
    414 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    415 # undocumented classes that are normally visible in the class hierarchy.
    416 # If set to NO (the default) these classes will be included in the various
    417 # overviews. This option has no effect if EXTRACT_ALL is enabled.
     463# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
     464# undocumented classes that are normally visible in the class hierarchy. If set
     465# to NO these classes will be included in the various overviews. This option has
     466# no effect if EXTRACT_ALL is enabled.
     467# The default value is: NO.
    418468
    419469HIDE_UNDOC_CLASSES     = NO
    420470
    421 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    422 # friend (class|struct|union) declarations.
    423 # If set to NO (the default) these declarations will be included in the
    424 # documentation.
     471# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
     472# (class|struct|union) declarations. If set to NO these declarations will be
     473# included in the documentation.
     474# The default value is: NO.
    425475
    426476HIDE_FRIEND_COMPOUNDS  = NO
    427477
    428 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    429 # documentation blocks found inside the body of a function.
    430 # If set to NO (the default) these blocks will be appended to the
    431 # function's detailed documentation block.
     478# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
     479# documentation blocks found inside the body of a function. If set to NO these
     480# blocks will be appended to the function's detailed documentation block.
     481# The default value is: NO.
    432482
    433483HIDE_IN_BODY_DOCS      = NO
    434484
    435 # The INTERNAL_DOCS tag determines if documentation
    436 # that is typed after a \internal command is included. If the tag is set
    437 # to NO (the default) then the documentation will be excluded.
    438 # Set it to YES to include the internal documentation.
     485# The INTERNAL_DOCS tag determines if documentation that is typed after a
     486# \internal command is included. If the tag is set to NO then the documentation
     487# will be excluded. Set it to YES to include the internal documentation.
     488# The default value is: NO.
    439489
    440490INTERNAL_DOCS          = YES
    441491
    442 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    443 # file names in lower-case letters. If set to YES upper-case letters are also
     492# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
     493# names in lower-case letters. If set to YES upper-case letters are also
    444494# allowed. This is useful if you have classes or files whose names only differ
    445495# in case and if your file system supports case sensitive file names. Windows
    446496# and Mac users are advised to set this option to NO.
     497# The default value is: system dependent.
    447498
    448499CASE_SENSE_NAMES       = NO
    449500
    450 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    451 # will show members with their full class and namespace scopes in the
    452 # documentation. If set to YES the scope will be hidden.
     501# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
     502# their full class and namespace scopes in the documentation. If set to YES the
     503# scope will be hidden.
     504# The default value is: NO.
    453505
    454506HIDE_SCOPE_NAMES       = NO
    455507
    456 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    457 # will put a list of the files that are included by a file in the documentation
    458 # of that file.
     508# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
     509# the files that are included by a file in the documentation of that file.
     510# The default value is: YES.
    459511
    460512SHOW_INCLUDE_FILES     = YES
    461513
    462 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
    463 # will list include files with double quotes in the documentation
    464 # rather than with sharp brackets.
     514# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
     515# files with double quotes in the documentation rather than with sharp brackets.
     516# The default value is: NO.
    465517
    466518FORCE_LOCAL_INCLUDES   = NO
    467519
    468 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    469 # is inserted in the documentation for inline members.
     520# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
     521# documentation for inline members.
     522# The default value is: YES.
    470523
    471524INLINE_INFO            = YES
    472525
    473 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    474 # will sort the (detailed) documentation of file and class members
    475 # alphabetically by member name. If set to NO the members will appear in
    476 # declaration order.
     526# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
     527# (detailed) documentation of file and class members alphabetically by member
     528# name. If set to NO the members will appear in declaration order.
     529# The default value is: YES.
    477530
    478531SORT_MEMBER_DOCS       = YES
    479532
    480 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
    481 # brief documentation of file, namespace and class members alphabetically
    482 # by member name. If set to NO (the default) the members will appear in
    483 # declaration order.
     533# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
     534# descriptions of file, namespace and class members alphabetically by member
     535# name. If set to NO the members will appear in declaration order.
     536# The default value is: NO.
    484537
    485538SORT_BRIEF_DOCS        = NO
    486539
    487 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
    488 # will sort the (brief and detailed) documentation of class members so that
    489 # constructors and destructors are listed first. If set to NO (the default)
    490 # the constructors will appear in the respective orders defined by
    491 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
    492 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
    493 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     540# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
     541# (brief and detailed) documentation of class members so that constructors and
     542# destructors are listed first. If set to NO the constructors will appear in the
     543# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
     544# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
     545# member documentation.
     546# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
     547# detailed member documentation.
     548# The default value is: NO.
    494549
    495550SORT_MEMBERS_CTORS_1ST = NO
    496551
    497 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
    498 # hierarchy of group names into alphabetical order. If set to NO (the default)
    499 # the group names will appear in their defined order.
     552# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
     553# of group names into alphabetical order. If set to NO the group names will
     554# appear in their defined order.
     555# The default value is: NO.
    500556
    501557SORT_GROUP_NAMES       = NO
    502558
    503 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    504 # sorted by fully-qualified names, including namespaces. If set to
    505 # NO (the default), the class list will be sorted only by class name,
    506 # not including the namespace part.
     559# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
     560# fully-qualified names, including namespaces. If set to NO, the class list will
     561# be sorted only by class name, not including the namespace part.
    507562# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    508 # Note: This option applies only to the class list, not to the
    509 # alphabetical list.
     563# Note: This option applies only to the class list, not to the alphabetical
     564# list.
     565# The default value is: NO.
    510566
    511567SORT_BY_SCOPE_NAME     = NO
    512568
    513 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
    514 # do proper type resolution of all parameters of a function it will reject a
    515 # match between the prototype and the implementation of a member function even
    516 # if there is only one candidate or it is obvious which candidate to choose
    517 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
    518 # will still accept a match between prototype and implementation in such cases.
     569# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
     570# type resolution of all parameters of a function it will reject a match between
     571# the prototype and the implementation of a member function even if there is
     572# only one candidate or it is obvious which candidate to choose by doing a
     573# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
     574# accept a match between prototype and implementation in such cases.
     575# The default value is: NO.
    519576
    520577STRICT_PROTO_MATCHING  = NO
    521578
    522 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    523 # disable (NO) the todo list. This list is created by putting \todo
    524 # commands in the documentation.
     579# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
     580# todo list. This list is created by putting \todo commands in the
     581# documentation.
     582# The default value is: YES.
    525583
    526584GENERATE_TODOLIST      = YES
    527585
    528 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    529 # disable (NO) the test list. This list is created by putting \test
    530 # commands in the documentation.
     586# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
     587# test list. This list is created by putting \test commands in the
     588# documentation.
     589# The default value is: YES.
    531590
    532591GENERATE_TESTLIST      = YES
    533592
    534 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    535 # disable (NO) the bug list. This list is created by putting \bug
    536 # commands in the documentation.
     593# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
     594# list. This list is created by putting \bug commands in the documentation.
     595# The default value is: YES.
    537596
    538597GENERATE_BUGLIST       = YES
    539598
    540 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    541 # disable (NO) the deprecated list. This list is created by putting
    542 # \deprecated commands in the documentation.
     599# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
     600# the deprecated list. This list is created by putting \deprecated commands in
     601# the documentation.
     602# The default value is: YES.
    543603
    544604GENERATE_DEPRECATEDLIST= YES
    545605
    546 # The ENABLED_SECTIONS tag can be used to enable conditional
    547 # documentation sections, marked by \if sectionname ... \endif.
     606# The ENABLED_SECTIONS tag can be used to enable conditional documentation
     607# sections, marked by \if <section_label> ... \endif and \cond <section_label>
     608# ... \endcond blocks.
    548609
    549610ENABLED_SECTIONS       =
    550611
    551 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    552 # the initial value of a variable or macro consists of for it to appear in
    553 # the documentation. If the initializer consists of more lines than specified
    554 # here it will be hidden. Use a value of 0 to hide initializers completely.
    555 # The appearance of the initializer of individual variables and macros in the
    556 # documentation can be controlled using \showinitializer or \hideinitializer
    557 # command in the documentation regardless of this setting.
     612# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
     613# initial value of a variable or macro / define can have for it to appear in the
     614# documentation. If the initializer consists of more lines than specified here
     615# it will be hidden. Use a value of 0 to hide initializers completely. The
     616# appearance of the value of individual variables and macros / defines can be
     617# controlled using \showinitializer or \hideinitializer command in the
     618# documentation regardless of this setting.
     619# Minimum value: 0, maximum value: 10000, default value: 30.
    558620
    559621MAX_INITIALIZER_LINES  = 30
    560622
    561 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    562 # at the bottom of the documentation of classes and structs. If set to YES the
    563 # list will mention the files that were used to generate the documentation.
     623# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
     624# the bottom of the documentation of classes and structs. If set to YES the list
     625# will mention the files that were used to generate the documentation.
     626# The default value is: YES.
    564627
    565628SHOW_USED_FILES        = YES
    566629
    567 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    568 # This will remove the Files entry from the Quick Index and from the
    569 # Folder Tree View (if specified). The default is YES.
     630# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
     631# will remove the Files entry from the Quick Index and from the Folder Tree View
     632# (if specified).
     633# The default value is: YES.
    570634
    571635SHOW_FILES             = YES
    572636
    573 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    574 # Namespaces page.
    575 # This will remove the Namespaces entry from the Quick Index
    576 # and from the Folder Tree View (if specified). The default is YES.
     637# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
     638# page. This will remove the Namespaces entry from the Quick Index and from the
     639# Folder Tree View (if specified).
     640# The default value is: YES.
    577641
    578642SHOW_NAMESPACES        = YES
     
    581645# doxygen should invoke to get the current version for each file (typically from
    582646# the version control system). Doxygen will invoke the program by executing (via
    583 # popen()) the command <command> <input-file>, where <command> is the value of
    584 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    585 # provided by doxygen. Whatever the program writes to standard output
    586 # is used as the file version. See the manual for examples.
     647# popen()) the command command input-file, where command is the value of the
     648# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
     649# by doxygen. Whatever the program writes to standard output is used as the file
     650# version. For an example see the documentation.
    587651
    588652FILE_VERSION_FILTER    =
     
    591655# by doxygen. The layout file controls the global structure of the generated
    592656# output files in an output format independent way. To create the layout file
    593 # that represents doxygen's defaults, run doxygen with the -l option.
    594 # You can optionally specify a file name after the option, if omitted
    595 # DoxygenLayout.xml will be used as the name of the layout file.
     657# that represents doxygen's defaults, run doxygen with the -l option. You can
     658# optionally specify a file name after the option, if omitted DoxygenLayout.xml
     659# will be used as the name of the layout file.
     660#
     661# Note that if you run doxygen from a directory containing a file called
     662# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
     663# tag is left empty.
    596664
    597665LAYOUT_FILE            =
    598666
    599 # The CITE_BIB_FILES tag can be used to specify one or more bib files
    600 # containing the references data. This must be a list of .bib files. The
    601 # .bib extension is automatically appended if omitted. Using this command
    602 # requires the bibtex tool to be installed. See also
    603 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
    604 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
    605 # feature you need bibtex and perl available in the search path.
     667# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
     668# the reference definitions. This must be a list of .bib files. The .bib
     669# extension is automatically appended if omitted. This requires the bibtex tool
     670# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
     671# For LaTeX the style of the bibliography can be controlled using
     672# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
     673# search path. Do not use file names with spaces, bibtex cannot handle them. See
     674# also \cite for info how to create references.
    606675
    607676CITE_BIB_FILES         =
    608677
    609678#---------------------------------------------------------------------------
    610 # configuration options related to warning and progress messages
    611 #---------------------------------------------------------------------------
    612 
    613 # The QUIET tag can be used to turn on/off the messages that are generated
    614 # by doxygen. Possible values are YES and NO. If left blank NO is used.
     679# Configuration options related to warning and progress messages
     680#---------------------------------------------------------------------------
     681
     682# The QUIET tag can be used to turn on/off the messages that are generated to
     683# standard output by doxygen. If QUIET is set to YES this implies that the
     684# messages are off.
     685# The default value is: NO.
    615686
    616687QUIET                  = NO
    617688
    618689# The WARNINGS tag can be used to turn on/off the warning messages that are
    619 # generated by doxygen. Possible values are YES and NO. If left blank
    620 # NO is used.
     690# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
     691# this implies that the warnings are on.
     692#
     693# Tip: Turn warnings on while writing the documentation.
     694# The default value is: YES.
    621695
    622696WARNINGS               = YES
    623697
    624 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    625 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    626 # automatically be disabled.
     698# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
     699# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
     700# will automatically be disabled.
     701# The default value is: YES.
    627702
    628703WARN_IF_UNDOCUMENTED   = YES
    629704
    630 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    631 # potential errors in the documentation, such as not documenting some
    632 # parameters in a documented function, or documenting parameters that
    633 # don't exist or using markup commands wrongly.
     705# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
     706# potential errors in the documentation, such as not documenting some parameters
     707# in a documented function, or documenting parameters that don't exist or using
     708# markup commands wrongly.
     709# The default value is: YES.
    634710
    635711WARN_IF_DOC_ERROR      = YES
    636712
    637 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
    638 # functions that are documented, but have no documentation for their parameters
    639 # or return value. If set to NO (the default) doxygen will only warn about
    640 # wrong or incomplete parameter documentation, but not about the absence of
    641 # documentation.
     713# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
     714# are documented, but have no documentation for their parameters or return
     715# value. If set to NO doxygen will only warn about wrong or incomplete parameter
     716# documentation, but not about the absence of documentation.
     717# The default value is: NO.
    642718
    643719WARN_NO_PARAMDOC       = NO
    644720
    645 # The WARN_FORMAT tag determines the format of the warning messages that
    646 # doxygen can produce. The string should contain the $file, $line, and $text
    647 # tags, which will be replaced by the file and line number from which the
    648 # warning originated and the warning text. Optionally the format may contain
    649 # $version, which will be replaced by the version of the file (if it could
    650 # be obtained via FILE_VERSION_FILTER)
     721# The WARN_FORMAT tag determines the format of the warning messages that doxygen
     722# can produce. The string should contain the $file, $line, and $text tags, which
     723# will be replaced by the file and line number from which the warning originated
     724# and the warning text. Optionally the format may contain $version, which will
     725# be replaced by the version of the file (if it could be obtained via
     726# FILE_VERSION_FILTER)
     727# The default value is: $file:$line: $text.
    651728
    652729WARN_FORMAT            = "$file:$line: $text"
    653730
    654 # The WARN_LOGFILE tag can be used to specify a file to which warning
    655 # and error messages should be written. If left blank the output is written
    656 # to stderr.
     731# The WARN_LOGFILE tag can be used to specify a file to which warning and error
     732# messages should be written. If left blank the output is written to standard
     733# error (stderr).
    657734
    658735WARN_LOGFILE           =
    659736
    660737#---------------------------------------------------------------------------
    661 # configuration options related to the input files
    662 #---------------------------------------------------------------------------
    663 
    664 # The INPUT tag can be used to specify the files and/or directories that contain
    665 # documented source files. You may enter file names like "myfile.cpp" or
    666 # directories like "/usr/src/myproject". Separate the files or directories
    667 # with spaces.
     738# Configuration options related to the input files
     739#---------------------------------------------------------------------------
     740
     741# The INPUT tag is used to specify the files and/or directories that contain
     742# documented source files. You may enter file names like myfile.cpp or
     743# directories like /usr/src/myproject. Separate the files or directories with
     744# spaces.
     745# Note: If this tag is empty the current directory is searched.
    668746
    669747INPUT                  = src \
     
    671749
    672750# This tag can be used to specify the character encoding of the source files
    673 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    674 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    675 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    676 # the list of possible encodings.
     751# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
     752# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
     753# documentation (see: http://www.gnu.org/software/libiconv) for the list of
     754# possible encodings.
     755# The default value is: UTF-8.
    677756
    678757INPUT_ENCODING         = UTF-8
    679758
    680759# If the value of the INPUT tag contains directories, you can use the
    681 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    682 # and *.h) to filter out the source-files in the directories. If left
    683 # blank the following patterns are tested:
    684 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
    685 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
    686 # *.f90 *.f *.for *.vhd *.vhdl
     760# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
     761# *.h) to filter out the source-files in the directories. If left blank the
     762# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
     763# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
     764# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
     765# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
     766# *.qsf, *.as and *.js.
    687767
    688768FILE_PATTERNS          = *.c \
     
    718798                         *.vhdl
    719799
    720 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    721 # should be searched for input files as well. Possible values are YES and NO.
    722 # If left blank NO is used.
     800# The RECURSIVE tag can be used to specify whether or not subdirectories should
     801# be searched for input files as well.
     802# The default value is: NO.
    723803
    724804RECURSIVE              = NO
     
    727807# excluded from the INPUT source files. This way you can easily exclude a
    728808# subdirectory from a directory tree whose root is specified with the INPUT tag.
     809#
    729810# Note that relative paths are relative to the directory from which doxygen is
    730811# run.
     
    735816# directories that are symbolic links (a Unix file system feature) are excluded
    736817# from the input.
     818# The default value is: NO.
    737819
    738820EXCLUDE_SYMLINKS       = NO
     
    740822# If the value of the INPUT tag contains directories, you can use the
    741823# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    742 # certain files from those directories. Note that the wildcards are matched
    743 # against the file with absolute path, so to exclude all test directories
    744 # for example use the pattern */test/*
     824# certain files from those directories.
     825#
     826# Note that the wildcards are matched against the file with absolute path, so to
     827# exclude all test directories for example use the pattern */test/*
    745828
    746829EXCLUDE_PATTERNS       =
     
    751834# wildcard * is used, a substring. Examples: ANamespace, AClass,
    752835# AClass::ANamespace, ANamespace::*Test
     836#
     837# Note that the wildcards are matched against the file with absolute path, so to
     838# exclude all test directories use the pattern */test/*
    753839
    754840EXCLUDE_SYMBOLS        =
    755841
    756 # The EXAMPLE_PATH tag can be used to specify one or more files or
    757 # directories that contain example code fragments that are included (see
    758 # the \include command).
     842# The EXAMPLE_PATH tag can be used to specify one or more files or directories
     843# that contain example code fragments that are included (see the \include
     844# command).
    759845
    760846EXAMPLE_PATH           = .
    761847
    762848# If the value of the EXAMPLE_PATH tag contains directories, you can use the
    763 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    764 # and *.h) to filter out the source-files in the directories. If left
    765 # blank all files are included.
     849# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
     850# *.h) to filter out the source-files in the directories. If left blank all
     851# files are included.
    766852
    767853EXAMPLE_PATTERNS       = *
    768854
    769855# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
    770 # searched for input files to be used with the \include or \dontinclude
    771 # commands irrespective of the value of the RECURSIVE tag.
    772 # Possible values are YES and NO. If left blank NO is used.
     856# searched for input files to be used with the \include or \dontinclude commands
     857# irrespective of the value of the RECURSIVE tag.
     858# The default value is: NO.
    773859
    774860EXAMPLE_RECURSIVE      = NO
    775861
    776 # The IMAGE_PATH tag can be used to specify one or more files or
    777 # directories that contain image that are included in the documentation (see
    778 # the \image command).
     862# The IMAGE_PATH tag can be used to specify one or more files or directories
     863# that contain images that are to be included in the documentation (see the
     864# \image command).
    779865
    780866IMAGE_PATH             = resources
     
    782868# The INPUT_FILTER tag can be used to specify a program that doxygen should
    783869# invoke to filter for each input file. Doxygen will invoke the filter program
    784 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    785 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    786 # input file. Doxygen will then use the output that the filter program writes
    787 # to standard output.
    788 # If FILTER_PATTERNS is specified, this tag will be
    789 # ignored.
     870# by executing (via popen()) the command:
     871#
     872# <filter> <input-file>
     873#
     874# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
     875# name of an input file. Doxygen will then use the output that the filter
     876# program writes to standard output. If FILTER_PATTERNS is specified, this tag
     877# will be ignored.
     878#
     879# Note that the filter must not add or remove lines; it is applied before the
     880# code is scanned, but not when the output code is generated. If lines are added
     881# or removed, the anchors will not be placed correctly.
    790882
    791883INPUT_FILTER           =
    792884
    793885# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    794 # basis.
    795 # Doxygen will compare the file name with each pattern and apply the
    796 # filter if there is a match.
    797 # The filters are a list of the form:
    798 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    799 # info on how filters are used. If FILTER_PATTERNS is empty or if
    800 # non of the patterns match the file name, INPUT_FILTER is applied.
     886# basis. Doxygen will compare the file name with each pattern and apply the
     887# filter if there is a match. The filters are a list of the form: pattern=filter
     888# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
     889# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
     890# patterns match the file name, INPUT_FILTER is applied.
    801891
    802892FILTER_PATTERNS        =
    803893
    804894# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    805 # INPUT_FILTER) will be used to filter the input files when producing source
    806 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
     895# INPUT_FILTER ) will also be used to filter the input files that are used for
     896# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
     897# The default value is: NO.
    807898
    808899FILTER_SOURCE_FILES    = NO
    809900
    810901# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
    811 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
    812 # and it is also possible to disable source filtering for a specific pattern
    813 # using *.ext= (so without naming a filter). This option only has effect when
    814 # FILTER_SOURCE_FILES is enabled.
     902# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
     903# it is also possible to disable source filtering for a specific pattern using
     904# *.ext= (so without naming a filter).
     905# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
    815906
    816907FILTER_SOURCE_PATTERNS =
    817908
    818 #---------------------------------------------------------------------------
    819 # configuration options related to source browsing
    820 #---------------------------------------------------------------------------
    821 
    822 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    823 # be generated. Documented entities will be cross-referenced with these sources.
    824 # Note: To get rid of all source code in the generated output, make sure also
    825 # VERBATIM_HEADERS is set to NO.
     909# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
     910# is part of the input, its contents will be placed on the main page
     911# (index.html). This can be useful if you have a project on for instance GitHub
     912# and want to reuse the introduction page also for the doxygen output.
     913
     914USE_MDFILE_AS_MAINPAGE =
     915
     916#---------------------------------------------------------------------------
     917# Configuration options related to source browsing
     918#---------------------------------------------------------------------------
     919
     920# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
     921# generated. Documented entities will be cross-referenced with these sources.
     922#
     923# Note: To get rid of all source code in the generated output, make sure that
     924# also VERBATIM_HEADERS is set to NO.
     925# The default value is: NO.
    826926
    827927SOURCE_BROWSER         = NO
    828928
    829 # Setting the INLINE_SOURCES tag to YES will include the body
    830 # of functions and classes directly in the documentation.
     929# Setting the INLINE_SOURCES tag to YES will include the body of functions,
     930# classes and enums directly into the documentation.
     931# The default value is: NO.
    831932
    832933INLINE_SOURCES         = NO
    833934
    834 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    835 # doxygen to hide any special comment blocks from generated source code
    836 # fragments. Normal C, C++ and Fortran comments will always remain visible.
     935# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
     936# special comment blocks from generated source code fragments. Normal C, C++ and
     937# Fortran comments will always remain visible.
     938# The default value is: YES.
    837939
    838940STRIP_CODE_COMMENTS    = YES
    839941
    840 # If the REFERENCED_BY_RELATION tag is set to YES
    841 # then for each documented function all documented
    842 # functions referencing it will be listed.
     942# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
     943# function all documented functions referencing it will be listed.
     944# The default value is: NO.
    843945
    844946REFERENCED_BY_RELATION = NO
    845947
    846 # If the REFERENCES_RELATION tag is set to YES
    847 # then for each documented function all documented entities
    848 # called/used by that function will be listed.
     948# If the REFERENCES_RELATION tag is set to YES then for each documented function
     949# all documented entities called/used by that function will be listed.
     950# The default value is: NO.
    849951
    850952REFERENCES_RELATION    = NO
    851953
    852 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    853 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    854 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    855 # link to the source code.
    856 # Otherwise they will link to the documentation.
     954# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
     955# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
     956# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
     957# link to the documentation.
     958# The default value is: YES.
    857959
    858960REFERENCES_LINK_SOURCE = YES
    859961
    860 # If the USE_HTAGS tag is set to YES then the references to source code
    861 # will point to the HTML generated by the htags(1) tool instead of doxygen
    862 # built-in source browser. The htags tool is part of GNU's global source
    863 # tagging system (see http://www.gnu.org/software/global/global.html). You
    864 # will need version 4.8.6 or higher.
     962# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
     963# source code will show a tooltip with additional information such as prototype,
     964# brief description and links to the definition and documentation. Since this
     965# will make the HTML file larger and loading of large files a bit slower, you
     966# can opt to disable this feature.
     967# The default value is: YES.
     968# This tag requires that the tag SOURCE_BROWSER is set to YES.
     969
     970SOURCE_TOOLTIPS        = YES
     971
     972# If the USE_HTAGS tag is set to YES then the references to source code will
     973# point to the HTML generated by the htags(1) tool instead of doxygen built-in
     974# source browser. The htags tool is part of GNU's global source tagging system
     975# (see http://www.gnu.org/software/global/global.html). You will need version
     976# 4.8.6 or higher.
     977#
     978# To use it do the following:
     979# - Install the latest version of global
     980# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
     981# - Make sure the INPUT points to the root of the source tree
     982# - Run doxygen as normal
     983#
     984# Doxygen will invoke htags (and that will in turn invoke gtags), so these
     985# tools must be available from the command line (i.e. in the search path).
     986#
     987# The result: instead of the source browser generated by doxygen, the links to
     988# source code will now point to the output of htags.
     989# The default value is: NO.
     990# This tag requires that the tag SOURCE_BROWSER is set to YES.
    865991
    866992USE_HTAGS              = NO
    867993
    868 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    869 # will generate a verbatim copy of the header file for each class for
    870 # which an include is specified. Set to NO to disable this.
     994# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
     995# verbatim copy of the header file for each class for which an include is
     996# specified. Set to NO to disable this.
     997# See also: Section \class.
     998# The default value is: YES.
    871999
    8721000VERBATIM_HEADERS       = YES
    8731001
    874 #---------------------------------------------------------------------------
    875 # configuration options related to the alphabetical class index
    876 #---------------------------------------------------------------------------
    877 
    878 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
    879 # of all compounds will be generated. Enable this if the project
    880 # contains a lot of classes, structs, unions or interfaces.
     1002# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
     1003# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the
     1004# cost of reduced performance. This can be particularly helpful with template
     1005# rich C++ code for which doxygen's built-in parser lacks the necessary type
     1006# information.
     1007# Note: The availability of this option depends on whether or not doxygen was
     1008# compiled with the --with-libclang option.
     1009# The default value is: NO.
     1010
     1011CLANG_ASSISTED_PARSING = NO
     1012
     1013# If clang assisted parsing is enabled you can provide the compiler with command
     1014# line options that you would normally use when invoking the compiler. Note that
     1015# the include paths will already be set by doxygen for the files and directories
     1016# specified with INPUT and INCLUDE_PATH.
     1017# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
     1018
     1019CLANG_OPTIONS          =
     1020
     1021#---------------------------------------------------------------------------
     1022# Configuration options related to the alphabetical class index
     1023#---------------------------------------------------------------------------
     1024
     1025# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
     1026# compounds will be generated. Enable this if the project contains a lot of
     1027# classes, structs, unions or interfaces.
     1028# The default value is: YES.
    8811029
    8821030ALPHABETICAL_INDEX     = NO
    8831031
    884 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
    885 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    886 # in which this list will be split (can be a number in the range [1..20])
     1032# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
     1033# which the alphabetical index list will be split.
     1034# Minimum value: 1, maximum value: 20, default value: 5.
     1035# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    8871036
    8881037COLS_IN_ALPHA_INDEX    = 5
    8891038
    890 # In case all classes in a project start with a common prefix, all
    891 # classes will be put under the same header in the alphabetical index.
    892 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    893 # should be ignored while generating the index headers.
     1039# In case all classes in a project start with a common prefix, all classes will
     1040# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
     1041# can be used to specify a prefix (or a list of prefixes) that should be ignored
     1042# while generating the index headers.
     1043# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    8941044
    8951045IGNORE_PREFIX          =
    8961046
    8971047#---------------------------------------------------------------------------
    898 # configuration options related to the HTML output
    899 #---------------------------------------------------------------------------
    900 
    901 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    902 # generate HTML output.
     1048# Configuration options related to the HTML output
     1049#---------------------------------------------------------------------------
     1050
     1051# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
     1052# The default value is: YES.
    9031053
    9041054GENERATE_HTML          = YES
    9051055
    906 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
    907 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    908 # put in front of it. If left blank `html' will be used as the default path.
     1056# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
     1057# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1058# it.
     1059# The default directory is: html.
     1060# This tag requires that the tag GENERATE_HTML is set to YES.
    9091061
    9101062HTML_OUTPUT            = html
    9111063
    912 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
    913 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    914 # doxygen will generate files with .html extension.
     1064# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
     1065# generated HTML page (for example: .htm, .php, .asp).
     1066# The default value is: .html.
     1067# This tag requires that the tag GENERATE_HTML is set to YES.
    9151068
    9161069HTML_FILE_EXTENSION    = .html
    9171070
    918 # The HTML_HEADER tag can be used to specify a personal HTML header for
    919 # each generated HTML page. If it is left blank doxygen will generate a
    920 # standard header. Note that when using a custom header you are responsible
    921 #  for the proper inclusion of any scripts and style sheets that doxygen
    922 # needs, which is dependent on the configuration options used.
    923 # It is advised to generate a default header using "doxygen -w html
    924 # header.html footer.html stylesheet.css YourConfigFile" and then modify
    925 # that header. Note that the header is subject to change so you typically
    926 # have to redo this when upgrading to a newer version of doxygen or when
    927 # changing the value of configuration settings such as GENERATE_TREEVIEW!
     1071# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
     1072# each generated HTML page. If the tag is left blank doxygen will generate a
     1073# standard header.
     1074#
     1075# To get valid HTML the header file that includes any scripts and style sheets
     1076# that doxygen needs, which is dependent on the configuration options used (e.g.
     1077# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
     1078# default header using
     1079# doxygen -w html new_header.html new_footer.html new_stylesheet.css
     1080# YourConfigFile
     1081# and then modify the file new_header.html. See also section "Doxygen usage"
     1082# for information on how to generate the default header that doxygen normally
     1083# uses.
     1084# Note: The header is subject to change so you typically have to regenerate the
     1085# default header when upgrading to a newer version of doxygen. For a description
     1086# of the possible markers and block names see the documentation.
     1087# This tag requires that the tag GENERATE_HTML is set to YES.
    9281088
    9291089HTML_HEADER            =
    9301090
    931 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    932 # each generated HTML page. If it is left blank doxygen will generate a
    933 # standard footer.
     1091# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
     1092# generated HTML page. If the tag is left blank doxygen will generate a standard
     1093# footer. See HTML_HEADER for more information on how to generate a default
     1094# footer and what special commands can be used inside the footer. See also
     1095# section "Doxygen usage" for information on how to generate the default footer
     1096# that doxygen normally uses.
     1097# This tag requires that the tag GENERATE_HTML is set to YES.
    9341098
    9351099HTML_FOOTER            =
    9361100
    937 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    938 # style sheet that is used by each HTML page. It can be used to
    939 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    940 # will generate a default style sheet. Note that doxygen will try to copy
    941 # the style sheet file to the HTML output directory, so don't put your own
    942 # style sheet in the HTML output directory as well, or it will be erased!
     1101# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
     1102# sheet that is used by each HTML page. It can be used to fine-tune the look of
     1103# the HTML output. If left blank doxygen will generate a default style sheet.
     1104# See also section "Doxygen usage" for information on how to generate the style
     1105# sheet that doxygen normally uses.
     1106# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
     1107# it is more robust and this tag (HTML_STYLESHEET) will in the future become
     1108# obsolete.
     1109# This tag requires that the tag GENERATE_HTML is set to YES.
    9431110
    9441111HTML_STYLESHEET        =
     1112
     1113# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
     1114# defined cascading style sheet that is included after the standard style sheets
     1115# created by doxygen. Using this option one can overrule certain style aspects.
     1116# This is preferred over using HTML_STYLESHEET since it does not replace the
     1117# standard style sheet and is therefor more robust against future updates.
     1118# Doxygen will copy the style sheet file to the output directory. For an example
     1119# see the documentation.
     1120# This tag requires that the tag GENERATE_HTML is set to YES.
     1121
     1122HTML_EXTRA_STYLESHEET  =
    9451123
    9461124# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
    9471125# other source files which should be copied to the HTML output directory. Note
    9481126# that these files will be copied to the base HTML output directory. Use the
    949 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
    950 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
    951 # the files will be copied as-is; there are no commands or markers available.
     1127# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     1128# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
     1129# files will be copied as-is; there are no commands or markers available.
     1130# This tag requires that the tag GENERATE_HTML is set to YES.
    9521131
    9531132HTML_EXTRA_FILES       =
    9541133
    955 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
    956 # Doxygen will adjust the colors in the style sheet and background images
    957 # according to this color. Hue is specified as an angle on a colorwheel,
    958 # see http://en.wikipedia.org/wiki/Hue for more information.
    959 # For instance the value 0 represents red, 60 is yellow, 120 is green,
    960 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
    961 # The allowed range is 0 to 359.
     1134# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
     1135# will adjust the colors in the stylesheet and background images according to
     1136# this color. Hue is specified as an angle on a colorwheel, see
     1137# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
     1138# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
     1139# purple, and 360 is red again.
     1140# Minimum value: 0, maximum value: 359, default value: 220.
     1141# This tag requires that the tag GENERATE_HTML is set to YES.
    9621142
    9631143HTML_COLORSTYLE_HUE    = 220
    9641144
    965 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
    966 # the colors in the HTML output. For a value of 0 the output will use
    967 # grayscales only. A value of 255 will produce the most vivid colors.
     1145# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
     1146# in the HTML output. For a value of 0 the output will use grayscales only. A
     1147# value of 255 will produce the most vivid colors.
     1148# Minimum value: 0, maximum value: 255, default value: 100.
     1149# This tag requires that the tag GENERATE_HTML is set to YES.
    9681150
    9691151HTML_COLORSTYLE_SAT    = 100
    9701152
    971 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
    972 # the luminance component of the colors in the HTML output. Values below
    973 # 100 gradually make the output lighter, whereas values above 100 make
    974 # the output darker. The value divided by 100 is the actual gamma applied,
    975 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
    976 # and 100 does not change the gamma.
     1153# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
     1154# luminance component of the colors in the HTML output. Values below 100
     1155# gradually make the output lighter, whereas values above 100 make the output
     1156# darker. The value divided by 100 is the actual gamma applied, so 80 represents
     1157# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
     1158# change the gamma.
     1159# Minimum value: 40, maximum value: 240, default value: 80.
     1160# This tag requires that the tag GENERATE_HTML is set to YES.
    9771161
    9781162HTML_COLORSTYLE_GAMMA  = 80
    9791163
    9801164# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
    981 # page will contain the date and time when the page was generated. Setting
    982 # this to NO can help when comparing the output of multiple runs.
     1165# page will contain the date and time when the page was generated. Setting this
     1166# to NO can help when comparing the output of multiple runs.
     1167# The default value is: YES.
     1168# This tag requires that the tag GENERATE_HTML is set to YES.
    9831169
    9841170HTML_TIMESTAMP         = YES
     
    9871173# documentation will contain sections that can be hidden and shown after the
    9881174# page has loaded.
     1175# The default value is: NO.
     1176# This tag requires that the tag GENERATE_HTML is set to YES.
    9891177
    9901178HTML_DYNAMIC_SECTIONS  = YES
    9911179
    992 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
    993 # entries shown in the various tree structured indices initially; the user
    994 # can expand and collapse entries dynamically later on. Doxygen will expand
    995 # the tree to such a level that at most the specified number of entries are
    996 # visible (unless a fully collapsed tree already exceeds this amount).
    997 # So setting the number of entries 1 will produce a full collapsed tree by
    998 # default. 0 is a special value representing an infinite number of entries
    999 # and will result in a full expanded tree by default.
     1180# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
     1181# shown in the various tree structured indices initially; the user can expand
     1182# and collapse entries dynamically later on. Doxygen will expand the tree to
     1183# such a level that at most the specified number of entries are visible (unless
     1184# a fully collapsed tree already exceeds this amount). So setting the number of
     1185# entries 1 will produce a full collapsed tree by default. 0 is a special value
     1186# representing an infinite number of entries and will result in a full expanded
     1187# tree by default.
     1188# Minimum value: 0, maximum value: 9999, default value: 100.
     1189# This tag requires that the tag GENERATE_HTML is set to YES.
    10001190
    10011191HTML_INDEX_NUM_ENTRIES = 100
    10021192
    1003 # If the GENERATE_DOCSET tag is set to YES, additional index files
    1004 # will be generated that can be used as input for Apple's Xcode 3
    1005 # integrated development environment, introduced with OSX 10.5 (Leopard).
    1006 # To create a documentation set, doxygen will generate a Makefile in the
    1007 # HTML output directory. Running make will produce the docset in that
    1008 # directory and running "make install" will install the docset in
    1009 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    1010 # it at startup.
    1011 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1193# If the GENERATE_DOCSET tag is set to YES, additional index files will be
     1194# generated that can be used as input for Apple's Xcode 3 integrated development
     1195# environment (see: http://developer.apple.com/tools/xcode/), introduced with
     1196# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
     1197# Makefile in the HTML output directory. Running make will produce the docset in
     1198# that directory and running make install will install the docset in
     1199# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
     1200# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
    10121201# for more information.
     1202# The default value is: NO.
     1203# This tag requires that the tag GENERATE_HTML is set to YES.
    10131204
    10141205GENERATE_DOCSET        = NO
    10151206
    1016 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    1017 # feed. A documentation feed provides an umbrella under which multiple
    1018 # documentation sets from a single provider (such as a company or product suite)
    1019 # can be grouped.
     1207# This tag determines the name of the docset feed. A documentation feed provides
     1208# an umbrella under which multiple documentation sets from a single provider
     1209# (such as a company or product suite) can be grouped.
     1210# The default value is: Doxygen generated docs.
     1211# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10201212
    10211213DOCSET_FEEDNAME        = "Doxygen generated docs"
    10221214
    1023 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    1024 # should uniquely identify the documentation set bundle. This should be a
    1025 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    1026 # will append .docset to the name.
     1215# This tag specifies a string that should uniquely identify the documentation
     1216# set bundle. This should be a reverse domain-name style string, e.g.
     1217# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
     1218# The default value is: org.doxygen.Project.
     1219# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10271220
    10281221DOCSET_BUNDLE_ID       = org.doxygen.Project
    10291222
    1030 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
     1223# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
    10311224# the documentation publisher. This should be a reverse domain-name style
    10321225# string, e.g. com.mycompany.MyDocSet.documentation.
     1226# The default value is: org.doxygen.Publisher.
     1227# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10331228
    10341229DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
    10351230
    1036 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
     1231# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
     1232# The default value is: Publisher.
     1233# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10371234
    10381235DOCSET_PUBLISHER_NAME  = Publisher
    10391236
    1040 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    1041 # will be generated that can be used as input for tools like the
    1042 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    1043 # of the generated HTML documentation.
     1237# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
     1238# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
     1239# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
     1240# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
     1241# Windows.
     1242#
     1243# The HTML Help Workshop contains a compiler that can convert all HTML output
     1244# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
     1245# files are now used as the Windows 98 help format, and will replace the old
     1246# Windows help format (.hlp) on all Windows platforms in the future. Compressed
     1247# HTML files also contain an index, a table of contents, and you can search for
     1248# words in the documentation. The HTML workshop also contains a viewer for
     1249# compressed HTML files.
     1250# The default value is: NO.
     1251# This tag requires that the tag GENERATE_HTML is set to YES.
    10441252
    10451253GENERATE_HTMLHELP      = NO
    10461254
    1047 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    1048 # be used to specify the file name of the resulting .chm file. You
    1049 # can add a path in front of the file if the result should not be
     1255# The CHM_FILE tag can be used to specify the file name of the resulting .chm
     1256# file. You can add a path in front of the file if the result should not be
    10501257# written to the html output directory.
     1258# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10511259
    10521260CHM_FILE               =
    10531261
    1054 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    1055 # be used to specify the location (absolute path including file name) of
    1056 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    1057 # the HTML help compiler on the generated index.hhp.
     1262# The HHC_LOCATION tag can be used to specify the location (absolute path
     1263# including file name) of the HTML help compiler ( hhc.exe). If non-empty
     1264# doxygen will try to run the HTML help compiler on the generated index.hhp.
     1265# The file has to be specified with full path.
     1266# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10581267
    10591268HHC_LOCATION           =
    10601269
    1061 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    1062 # controls if a separate .chi index file is generated (YES) or that
    1063 # it should be included in the master .chm file (NO).
     1270# The GENERATE_CHI flag controls if a separate .chi index file is generated (
     1271# YES) or that it should be included in the master .chm file ( NO).
     1272# The default value is: NO.
     1273# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10641274
    10651275GENERATE_CHI           = NO
    10661276
    1067 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    1068 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    1069 # content.
     1277# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
     1278# and project file content.
     1279# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10701280
    10711281CHM_INDEX_ENCODING     =
    10721282
    1073 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    1074 # controls whether a binary table of contents is generated (YES) or a
    1075 # normal table of contents (NO) in the .chm file.
     1283# The BINARY_TOC flag controls whether a binary table of contents is generated (
     1284# YES) or a normal table of contents ( NO) in the .chm file.
     1285# The default value is: NO.
     1286# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10761287
    10771288BINARY_TOC             = NO
    10781289
    1079 # The TOC_EXPAND flag can be set to YES to add extra items for group members
    1080 # to the contents of the HTML help documentation and to the tree view.
     1290# The TOC_EXPAND flag can be set to YES to add extra items for group members to
     1291# the table of contents of the HTML help documentation and to the tree view.
     1292# The default value is: NO.
     1293# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10811294
    10821295TOC_EXPAND             = NO
    10831296
    10841297# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
    1085 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
    1086 # that can be used as input for Qt's qhelpgenerator to generate a
    1087 # Qt Compressed Help (.qch) of the generated HTML documentation.
     1298# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
     1299# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
     1300# (.qch) of the generated HTML documentation.
     1301# The default value is: NO.
     1302# This tag requires that the tag GENERATE_HTML is set to YES.
    10881303
    10891304GENERATE_QHP           = NO
    10901305
    1091 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    1092 # be used to specify the file name of the resulting .qch file.
    1093 # The path specified is relative to the HTML output folder.
     1306# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
     1307# the file name of the resulting .qch file. The path specified is relative to
     1308# the HTML output folder.
     1309# This tag requires that the tag GENERATE_QHP is set to YES.
    10941310
    10951311QCH_FILE               =
    10961312
    1097 # The QHP_NAMESPACE tag specifies the namespace to use when generating
    1098 # Qt Help Project output. For more information please see
    1099 # http://doc.trolltech.com/qthelpproject.html#namespace
     1313# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
     1314# Project output. For more information please see Qt Help Project / Namespace
     1315# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
     1316# The default value is: org.doxygen.Project.
     1317# This tag requires that the tag GENERATE_QHP is set to YES.
    11001318
    11011319QHP_NAMESPACE          =
    11021320
    1103 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    1104 # Qt Help Project output. For more information please see
    1105 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
     1321# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
     1322# Help Project output. For more information please see Qt Help Project / Virtual
     1323# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
     1324# folders).
     1325# The default value is: doc.
     1326# This tag requires that the tag GENERATE_QHP is set to YES.
    11061327
    11071328QHP_VIRTUAL_FOLDER     = doc
    11081329
    1109 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
    1110 # add. For more information please see
    1111 # http://doc.trolltech.com/qthelpproject.html#custom-filters
     1330# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
     1331# filter to add. For more information please see Qt Help Project / Custom
     1332# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1333# filters).
     1334# This tag requires that the tag GENERATE_QHP is set to YES.
    11121335
    11131336QHP_CUST_FILTER_NAME   =
    11141337
    1115 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
    1116 # custom filter to add. For more information please see
    1117 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
    1118 # Qt Help Project / Custom Filters</a>.
     1338# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
     1339# custom filter to add. For more information please see Qt Help Project / Custom
     1340# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1341# filters).
     1342# This tag requires that the tag GENERATE_QHP is set to YES.
    11191343
    11201344QHP_CUST_FILTER_ATTRS  =
    11211345
    11221346# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
    1123 # project's
    1124 # filter section matches.
    1125 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
    1126 # Qt Help Project / Filter Attributes</a>.
     1347# project's filter section matches. Qt Help Project / Filter Attributes (see:
     1348# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
     1349# This tag requires that the tag GENERATE_QHP is set to YES.
    11271350
    11281351QHP_SECT_FILTER_ATTRS  =
    11291352
    1130 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    1131 # be used to specify the location of Qt's qhelpgenerator.
    1132 # If non-empty doxygen will try to run qhelpgenerator on the generated
    1133 # .qhp file.
     1353# The QHG_LOCATION tag can be used to specify the location of Qt's
     1354# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
     1355# generated .qhp file.
     1356# This tag requires that the tag GENERATE_QHP is set to YES.
    11341357
    11351358QHG_LOCATION           =
    11361359
    1137 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
    1138 #  will be generated, which together with the HTML files, form an Eclipse help
    1139 # plugin. To install this plugin and make it available under the help contents
    1140 # menu in Eclipse, the contents of the directory containing the HTML and XML
    1141 # files needs to be copied into the plugins directory of eclipse. The name of
    1142 # the directory within the plugins directory should be the same as
    1143 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
    1144 # the help appears.
     1360# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
     1361# generated, together with the HTML files, they form an Eclipse help plugin. To
     1362# install this plugin and make it available under the help contents menu in
     1363# Eclipse, the contents of the directory containing the HTML and XML files needs
     1364# to be copied into the plugins directory of eclipse. The name of the directory
     1365# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
     1366# After copying Eclipse needs to be restarted before the help appears.
     1367# The default value is: NO.
     1368# This tag requires that the tag GENERATE_HTML is set to YES.
    11451369
    11461370GENERATE_ECLIPSEHELP   = NO
    11471371
    1148 # A unique identifier for the eclipse help plugin. When installing the plugin
    1149 # the directory name containing the HTML and XML files should also have
    1150 # this name.
     1372# A unique identifier for the Eclipse help plugin. When installing the plugin
     1373# the directory name containing the HTML and XML files should also have this
     1374# name. Each documentation set should have its own identifier.
     1375# The default value is: org.doxygen.Project.
     1376# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
    11511377
    11521378ECLIPSE_DOC_ID         = org.doxygen.Project
    11531379
    1154 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
    1155 # at top of each HTML page. The value NO (the default) enables the index and
    1156 # the value YES disables it. Since the tabs have the same information as the
    1157 # navigation tree you can set this option to NO if you already set
    1158 # GENERATE_TREEVIEW to YES.
     1380# If you want full control over the layout of the generated HTML pages it might
     1381# be necessary to disable the index and replace it with your own. The
     1382# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
     1383# of each HTML page. A value of NO enables the index and the value YES disables
     1384# it. Since the tabs in the index contain the same information as the navigation
     1385# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
     1386# The default value is: NO.
     1387# This tag requires that the tag GENERATE_HTML is set to YES.
    11591388
    11601389DISABLE_INDEX          = NO
    11611390
    11621391# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    1163 # structure should be generated to display hierarchical information.
    1164 # If the tag value is set to YES, a side panel will be generated
    1165 # containing a tree-like index structure (just like the one that
    1166 # is generated for HTML Help). For this to work a browser that supports
    1167 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    1168 # Windows users are probably better off using the HTML help feature.
    1169 # Since the tree basically has the same information as the tab index you
    1170 # could consider to set DISABLE_INDEX to NO when enabling this option.
     1392# structure should be generated to display hierarchical information. If the tag
     1393# value is set to YES, a side panel will be generated containing a tree-like
     1394# index structure (just like the one that is generated for HTML Help). For this
     1395# to work a browser that supports JavaScript, DHTML, CSS and frames is required
     1396# (i.e. any modern browser). Windows users are probably better off using the
     1397# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
     1398# further fine-tune the look of the index. As an example, the default style
     1399# sheet generated by doxygen has an example that shows how to put an image at
     1400# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
     1401# the same information as the tab index, you could consider setting
     1402# DISABLE_INDEX to YES when enabling this option.
     1403# The default value is: NO.
     1404# This tag requires that the tag GENERATE_HTML is set to YES.
    11711405
    11721406GENERATE_TREEVIEW      = NO
    11731407
    1174 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
    1175 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
    1176 # documentation. Note that a value of 0 will completely suppress the enum
    1177 # values from appearing in the overview section.
     1408# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
     1409# doxygen will group on one line in the generated HTML documentation.
     1410#
     1411# Note that a value of 0 will completely suppress the enum values from appearing
     1412# in the overview section.
     1413# Minimum value: 0, maximum value: 20, default value: 4.
     1414# This tag requires that the tag GENERATE_HTML is set to YES.
    11781415
    11791416ENUM_VALUES_PER_LINE   = 4
    11801417
    1181 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    1182 # used to set the initial width (in pixels) of the frame in which the tree
    1183 # is shown.
     1418# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
     1419# to set the initial width (in pixels) of the frame in which the tree is shown.
     1420# Minimum value: 0, maximum value: 1500, default value: 250.
     1421# This tag requires that the tag GENERATE_HTML is set to YES.
    11841422
    11851423TREEVIEW_WIDTH         = 250
    11861424
    1187 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
    1188 # links to external symbols imported via tag files in a separate window.
     1425# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
     1426# external symbols imported via tag files in a separate window.
     1427# The default value is: NO.
     1428# This tag requires that the tag GENERATE_HTML is set to YES.
    11891429
    11901430EXT_LINKS_IN_WINDOW    = NO
    11911431
    1192 # Use this tag to change the font size of Latex formulas included
    1193 # as images in the HTML documentation. The default is 10. Note that
    1194 # when you change the font size after a successful doxygen run you need
    1195 # to manually remove any form_*.png images from the HTML output directory
    1196 # to force them to be regenerated.
     1432# Use this tag to change the font size of LaTeX formulas included as images in
     1433# the HTML documentation. When you change the font size after a successful
     1434# doxygen run you need to manually remove any form_*.png images from the HTML
     1435# output directory to force them to be regenerated.
     1436# Minimum value: 8, maximum value: 50, default value: 10.
     1437# This tag requires that the tag GENERATE_HTML is set to YES.
    11971438
    11981439FORMULA_FONTSIZE       = 10
    11991440
    12001441# Use the FORMULA_TRANPARENT tag to determine whether or not the images
    1201 # generated for formulas are transparent PNGs. Transparent PNGs are
    1202 # not supported properly for IE 6.0, but are supported on all modern browsers.
    1203 # Note that when changing this option you need to delete any form_*.png files
    1204 # in the HTML output before the changes have effect.
     1442# generated for formulas are transparent PNGs. Transparent PNGs are not
     1443# supported properly for IE 6.0, but are supported on all modern browsers.
     1444#
     1445# Note that when changing this option you need to delete any form_*.png files in
     1446# the HTML output directory before the changes have effect.
     1447# The default value is: YES.
     1448# This tag requires that the tag GENERATE_HTML is set to YES.
    12051449
    12061450FORMULA_TRANSPARENT    = YES
    12071451
    1208 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
    1209 # (see http://www.mathjax.org) which uses client side Javascript for the
    1210 # rendering instead of using prerendered bitmaps. Use this if you do not
    1211 # have LaTeX installed or if you want to formulas look prettier in the HTML
    1212 # output. When enabled you may also need to install MathJax separately and
    1213 # configure the path to it using the MATHJAX_RELPATH option.
     1452# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
     1453# http://www.mathjax.org) which uses client side Javascript for the rendering
     1454# instead of using prerendered bitmaps. Use this if you do not have LaTeX
     1455# installed or if you want to formulas look prettier in the HTML output. When
     1456# enabled you may also need to install MathJax separately and configure the path
     1457# to it using the MATHJAX_RELPATH option.
     1458# The default value is: NO.
     1459# This tag requires that the tag GENERATE_HTML is set to YES.
    12141460
    12151461USE_MATHJAX            = NO
    12161462
    1217 # When MathJax is enabled you need to specify the location relative to the
    1218 # HTML output directory using the MATHJAX_RELPATH option. The destination
    1219 # directory should contain the MathJax.js script. For instance, if the mathjax
    1220 # directory is located at the same level as the HTML output directory, then
    1221 # MATHJAX_RELPATH should be ../mathjax. The default value points to
    1222 # the MathJax Content Delivery Network so you can quickly see the result without
    1223 # installing MathJax.
    1224 # However, it is strongly recommended to install a local
    1225 # copy of MathJax from http://www.mathjax.org before deployment.
     1463# When MathJax is enabled you can set the default output format to be used for
     1464# the MathJax output. See the MathJax site (see:
     1465# http://docs.mathjax.org/en/latest/output.html) for more details.
     1466# Possible values are: HTML-CSS (which is slower, but has the best
     1467# compatibility), NativeMML (i.e. MathML) and SVG.
     1468# The default value is: HTML-CSS.
     1469# This tag requires that the tag USE_MATHJAX is set to YES.
     1470
     1471MATHJAX_FORMAT         = HTML-CSS
     1472
     1473# When MathJax is enabled you need to specify the location relative to the HTML
     1474# output directory using the MATHJAX_RELPATH option. The destination directory
     1475# should contain the MathJax.js script. For instance, if the mathjax directory
     1476# is located at the same level as the HTML output directory, then
     1477# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
     1478# Content Delivery Network so you can quickly see the result without installing
     1479# MathJax. However, it is strongly recommended to install a local copy of
     1480# MathJax from http://www.mathjax.org before deployment.
     1481# The default value is: http://cdn.mathjax.org/mathjax/latest.
     1482# This tag requires that the tag USE_MATHJAX is set to YES.
    12261483
    12271484MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
    12281485
    1229 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
    1230 # names that should be enabled during MathJax rendering.
     1486# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
     1487# extension names that should be enabled during MathJax rendering. For example
     1488# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
     1489# This tag requires that the tag USE_MATHJAX is set to YES.
    12311490
    12321491MATHJAX_EXTENSIONS     =
    12331492
    1234 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
    1235 # for the HTML output. The underlying search engine uses javascript
    1236 # and DHTML and should work on any modern browser. Note that when using
    1237 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
    1238 # (GENERATE_DOCSET) there is already a search function so this one should
    1239 # typically be disabled. For large projects the javascript based search engine
    1240 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
     1493# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
     1494# of code that will be used on startup of the MathJax code. See the MathJax site
     1495# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
     1496# example see the documentation.
     1497# This tag requires that the tag USE_MATHJAX is set to YES.
     1498
     1499MATHJAX_CODEFILE       =
     1500
     1501# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
     1502# the HTML output. The underlying search engine uses javascript and DHTML and
     1503# should work on any modern browser. Note that when using HTML help
     1504# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
     1505# there is already a search function so this one should typically be disabled.
     1506# For large projects the javascript based search engine can be slow, then
     1507# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
     1508# search using the keyboard; to jump to the search box use <access key> + S
     1509# (what the <access key> is depends on the OS and browser, but it is typically
     1510# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
     1511# key> to jump into the search results window, the results can be navigated
     1512# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
     1513# the search. The filter options can be selected when the cursor is inside the
     1514# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
     1515# to select a filter and <Enter> or <escape> to activate or cancel the filter
     1516# option.
     1517# The default value is: YES.
     1518# This tag requires that the tag GENERATE_HTML is set to YES.
    12411519
    12421520SEARCHENGINE           = YES
    12431521
    12441522# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    1245 # implemented using a PHP enabled web server instead of at the web client
    1246 # using Javascript. Doxygen will generate the search PHP script and index
    1247 # file to put on the web server. The advantage of the server
    1248 # based approach is that it scales better to large projects and allows
    1249 # full text search. The disadvantages are that it is more difficult to setup
    1250 # and does not have live searching capabilities.
     1523# implemented using a web server instead of a web client using Javascript. There
     1524# are two flavours of web server based searching depending on the
     1525# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
     1526# searching and an index file used by the script. When EXTERNAL_SEARCH is
     1527# enabled the indexing and searching needs to be provided by external tools. See
     1528# the section "External Indexing and Searching" for details.
     1529# The default value is: NO.
     1530# This tag requires that the tag SEARCHENGINE is set to YES.
    12511531
    12521532SERVER_BASED_SEARCH    = NO
    12531533
    1254 #---------------------------------------------------------------------------
    1255 # configuration options related to the LaTeX output
    1256 #---------------------------------------------------------------------------
    1257 
    1258 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    1259 # generate Latex output.
     1534# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
     1535# script for searching. Instead the search results are written to an XML file
     1536# which needs to be processed by an external indexer. Doxygen will invoke an
     1537# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
     1538# search results.
     1539#
     1540# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1541# (doxysearch.cgi) which are based on the open source search engine library
     1542# Xapian (see: http://xapian.org/).
     1543#
     1544# See the section "External Indexing and Searching" for details.
     1545# The default value is: NO.
     1546# This tag requires that the tag SEARCHENGINE is set to YES.
     1547
     1548EXTERNAL_SEARCH        = NO
     1549
     1550# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     1551# which will return the search results when EXTERNAL_SEARCH is enabled.
     1552#
     1553# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1554# (doxysearch.cgi) which are based on the open source search engine library
     1555# Xapian (see: http://xapian.org/). See the section "External Indexing and
     1556# Searching" for details.
     1557# This tag requires that the tag SEARCHENGINE is set to YES.
     1558
     1559SEARCHENGINE_URL       =
     1560
     1561# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     1562# search data is written to a file for indexing by an external tool. With the
     1563# SEARCHDATA_FILE tag the name of this file can be specified.
     1564# The default file is: searchdata.xml.
     1565# This tag requires that the tag SEARCHENGINE is set to YES.
     1566
     1567SEARCHDATA_FILE        = searchdata.xml
     1568
     1569# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
     1570# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
     1571# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
     1572# projects and redirect the results back to the right project.
     1573# This tag requires that the tag SEARCHENGINE is set to YES.
     1574
     1575EXTERNAL_SEARCH_ID     =
     1576
     1577# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     1578# projects other than the one defined by this configuration file, but that are
     1579# all added to the same external search index. Each project needs to have a
     1580# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
     1581# to a relative location where the documentation can be found. The format is:
     1582# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
     1583# This tag requires that the tag SEARCHENGINE is set to YES.
     1584
     1585EXTRA_SEARCH_MAPPINGS  =
     1586
     1587#---------------------------------------------------------------------------
     1588# Configuration options related to the LaTeX output
     1589#---------------------------------------------------------------------------
     1590
     1591# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
     1592# The default value is: YES.
    12601593
    12611594GENERATE_LATEX         = NO
    12621595
    1263 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    1264 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1265 # put in front of it. If left blank `latex' will be used as the default path.
     1596# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
     1597# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1598# it.
     1599# The default directory is: latex.
     1600# This tag requires that the tag GENERATE_LATEX is set to YES.
    12661601
    12671602LATEX_OUTPUT           = latex
    12681603
    12691604# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    1270 # invoked. If left blank `latex' will be used as the default command name.
    1271 # Note that when enabling USE_PDFLATEX this option is only used for
    1272 # generating bitmaps for formulas in the HTML output, but not in the
    1273 # Makefile that is written to the output directory.
     1605# invoked.
     1606#
     1607# Note that when enabling USE_PDFLATEX this option is only used for generating
     1608# bitmaps for formulas in the HTML output, but not in the Makefile that is
     1609# written to the output directory.
     1610# The default file is: latex.
     1611# This tag requires that the tag GENERATE_LATEX is set to YES.
    12741612
    12751613LATEX_CMD_NAME         = latex
    12761614
    1277 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    1278 # generate index for LaTeX. If left blank `makeindex' will be used as the
    1279 # default command name.
     1615# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
     1616# index for LaTeX.
     1617# The default file is: makeindex.
     1618# This tag requires that the tag GENERATE_LATEX is set to YES.
    12801619
    12811620MAKEINDEX_CMD_NAME     = makeindex
    12821621
    1283 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    1284 # LaTeX documents. This may be useful for small projects and may help to
    1285 # save some trees in general.
     1622# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
     1623# documents. This may be useful for small projects and may help to save some
     1624# trees in general.
     1625# The default value is: NO.
     1626# This tag requires that the tag GENERATE_LATEX is set to YES.
    12861627
    12871628COMPACT_LATEX          = NO
    12881629
    1289 # The PAPER_TYPE tag can be used to set the paper type that is used
    1290 # by the printer. Possible values are: a4, letter, legal and
    1291 # executive. If left blank a4wide will be used.
     1630# The PAPER_TYPE tag can be used to set the paper type that is used by the
     1631# printer.
     1632# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
     1633# 14 inches) and executive (7.25 x 10.5 inches).
     1634# The default value is: a4.
     1635# This tag requires that the tag GENERATE_LATEX is set to YES.
    12921636
    12931637PAPER_TYPE             = a4wide
    12941638
    1295 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    1296 # packages that should be included in the LaTeX output.
     1639# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
     1640# that should be included in the LaTeX output. To get the times font for
     1641# instance you can specify
     1642# EXTRA_PACKAGES=times
     1643# If left blank no extra packages will be included.
     1644# This tag requires that the tag GENERATE_LATEX is set to YES.
    12971645
    12981646EXTRA_PACKAGES         =
    12991647
    1300 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    1301 # the generated latex document. The header should contain everything until
    1302 # the first chapter. If it is left blank doxygen will generate a
    1303 # standard header. Notice: only use this tag if you know what you are doing!
     1648# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
     1649# generated LaTeX document. The header should contain everything until the first
     1650# chapter. If it is left blank doxygen will generate a standard header. See
     1651# section "Doxygen usage" for information on how to let doxygen write the
     1652# default header to a separate file.
     1653#
     1654# Note: Only use a user-defined header if you know what you are doing! The
     1655# following commands have a special meaning inside the header: $title,
     1656# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
     1657# replace them by respectively the title of the page, the current date and time,
     1658# only the current date, the version number of doxygen, the project name (see
     1659# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
     1660# This tag requires that the tag GENERATE_LATEX is set to YES.
    13041661
    13051662LATEX_HEADER           =
    13061663
    1307 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
    1308 # the generated latex document. The footer should contain everything after
    1309 # the last chapter. If it is left blank doxygen will generate a
    1310 # standard footer. Notice: only use this tag if you know what you are doing!
     1664# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
     1665# generated LaTeX document. The footer should contain everything after the last
     1666# chapter. If it is left blank doxygen will generate a standard footer.
     1667#
     1668# Note: Only use a user-defined footer if you know what you are doing!
     1669# This tag requires that the tag GENERATE_LATEX is set to YES.
    13111670
    13121671LATEX_FOOTER           =
    13131672
    1314 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    1315 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    1316 # contain links (just like the HTML output) instead of page references
    1317 # This makes the output suitable for online browsing using a pdf viewer.
     1673# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
     1674# other source files which should be copied to the LATEX_OUTPUT output
     1675# directory. Note that the files will be copied as-is; there are no commands or
     1676# markers available.
     1677# This tag requires that the tag GENERATE_LATEX is set to YES.
     1678
     1679LATEX_EXTRA_FILES      =
     1680
     1681# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
     1682# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
     1683# contain links (just like the HTML output) instead of page references. This
     1684# makes the output suitable for online browsing using a PDF viewer.
     1685# The default value is: YES.
     1686# This tag requires that the tag GENERATE_LATEX is set to YES.
    13181687
    13191688PDF_HYPERLINKS         = YES
    13201689
    1321 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    1322 # plain latex in the generated Makefile. Set this option to YES to get a
     1690# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
     1691# the PDF file directly from the LaTeX files. Set this option to YES to get a
    13231692# higher quality PDF documentation.
     1693# The default value is: YES.
     1694# This tag requires that the tag GENERATE_LATEX is set to YES.
    13241695
    13251696USE_PDFLATEX           = YES
    13261697
    1327 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    1328 # command to the generated LaTeX files. This will instruct LaTeX to keep
    1329 # running if errors occur, instead of asking the user for help.
    1330 # This option is also used when generating formulas in HTML.
     1698# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
     1699# command to the generated LaTeX files. This will instruct LaTeX to keep running
     1700# if errors occur, instead of asking the user for help. This option is also used
     1701# when generating formulas in HTML.
     1702# The default value is: NO.
     1703# This tag requires that the tag GENERATE_LATEX is set to YES.
    13311704
    13321705LATEX_BATCHMODE        = NO
    13331706
    1334 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    1335 # include the index chapters (such as File Index, Compound Index, etc.)
    1336 # in the output.
     1707# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
     1708# index chapters (such as File Index, Compound Index, etc.) in the output.
     1709# The default value is: NO.
     1710# This tag requires that the tag GENERATE_LATEX is set to YES.
    13371711
    13381712LATEX_HIDE_INDICES     = NO
    13391713
    1340 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
    1341 # source code with syntax highlighting in the LaTeX output.
    1342 # Note that which sources are shown also depends on other settings
    1343 # such as SOURCE_BROWSER.
     1714# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
     1715# code with syntax highlighting in the LaTeX output.
     1716#
     1717# Note that which sources are shown also depends on other settings such as
     1718# SOURCE_BROWSER.
     1719# The default value is: NO.
     1720# This tag requires that the tag GENERATE_LATEX is set to YES.
    13441721
    13451722LATEX_SOURCE_CODE      = NO
    13461723
    13471724# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
    1348 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
    1349 # http://en.wikipedia.org/wiki/BibTeX for more info.
     1725# bibliography, e.g. plainnat, or ieeetr. See
     1726# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
     1727# The default value is: plain.
     1728# This tag requires that the tag GENERATE_LATEX is set to YES.
    13501729
    13511730LATEX_BIB_STYLE        = plain
    13521731
    13531732#---------------------------------------------------------------------------
    1354 # configuration options related to the RTF output
    1355 #---------------------------------------------------------------------------
    1356 
    1357 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    1358 # The RTF output is optimized for Word 97 and may not look very pretty with
    1359 # other RTF readers or editors.
     1733# Configuration options related to the RTF output
     1734#---------------------------------------------------------------------------
     1735
     1736# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
     1737# RTF output is optimized for Word 97 and may not look too pretty with other RTF
     1738# readers/editors.
     1739# The default value is: NO.
    13601740
    13611741GENERATE_RTF           = NO
    13621742
    1363 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    1364 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1365 # put in front of it. If left blank `rtf' will be used as the default path.
     1743# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
     1744# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1745# it.
     1746# The default directory is: rtf.
     1747# This tag requires that the tag GENERATE_RTF is set to YES.
    13661748
    13671749RTF_OUTPUT             = rtf
    13681750
    1369 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    1370 # RTF documents. This may be useful for small projects and may help to
    1371 # save some trees in general.
     1751# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
     1752# documents. This may be useful for small projects and may help to save some
     1753# trees in general.
     1754# The default value is: NO.
     1755# This tag requires that the tag GENERATE_RTF is set to YES.
    13721756
    13731757COMPACT_RTF            = NO
    13741758
    1375 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    1376 # will contain hyperlink fields. The RTF file will
    1377 # contain links (just like the HTML output) instead of page references.
    1378 # This makes the output suitable for online browsing using WORD or other
    1379 # programs which support those fields.
    1380 # Note: wordpad (write) and others do not support links.
     1759# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
     1760# contain hyperlink fields. The RTF file will contain links (just like the HTML
     1761# output) instead of page references. This makes the output suitable for online
     1762# browsing using Word or some other Word compatible readers that support those
     1763# fields.
     1764#
     1765# Note: WordPad (write) and others do not support links.
     1766# The default value is: NO.
     1767# This tag requires that the tag GENERATE_RTF is set to YES.
    13811768
    13821769RTF_HYPERLINKS         = NO
    13831770
    1384 # Load style sheet definitions from file. Syntax is similar to doxygen's
    1385 # config file, i.e. a series of assignments. You only have to provide
    1386 # replacements, missing definitions are set to their default value.
     1771# Load stylesheet definitions from file. Syntax is similar to doxygen's config
     1772# file, i.e. a series of assignments. You only have to provide replacements,
     1773# missing definitions are set to their default value.
     1774#
     1775# See also section "Doxygen usage" for information on how to generate the
     1776# default style sheet that doxygen normally uses.
     1777# This tag requires that the tag GENERATE_RTF is set to YES.
    13871778
    13881779RTF_STYLESHEET_FILE    =
    13891780
    1390 # Set optional variables used in the generation of an rtf document.
    1391 # Syntax is similar to doxygen's config file.
     1781# Set optional variables used in the generation of an RTF document. Syntax is
     1782# similar to doxygen's config file. A template extensions file can be generated
     1783# using doxygen -e rtf extensionFile.
     1784# This tag requires that the tag GENERATE_RTF is set to YES.
    13921785
    13931786RTF_EXTENSIONS_FILE    =
    13941787
    13951788#---------------------------------------------------------------------------
    1396 # configuration options related to the man page output
    1397 #---------------------------------------------------------------------------
    1398 
    1399 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    1400 # generate man pages
     1789# Configuration options related to the man page output
     1790#---------------------------------------------------------------------------
     1791
     1792# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
     1793# classes and files.
     1794# The default value is: NO.
    14011795
    14021796GENERATE_MAN           = NO
    14031797
    1404 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    1405 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1406 # put in front of it. If left blank `man' will be used as the default path.
     1798# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
     1799# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1800# it. A directory man3 will be created inside the directory specified by
     1801# MAN_OUTPUT.
     1802# The default directory is: man.
     1803# This tag requires that the tag GENERATE_MAN is set to YES.
    14071804
    14081805MAN_OUTPUT             = man
    14091806
    1410 # The MAN_EXTENSION tag determines the extension that is added to
    1411 # the generated man pages (default is the subroutine's section .3)
     1807# The MAN_EXTENSION tag determines the extension that is added to the generated
     1808# man pages. In case the manual section does not start with a number, the number
     1809# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
     1810# optional.
     1811# The default value is: .3.
     1812# This tag requires that the tag GENERATE_MAN is set to YES.
    14121813
    14131814MAN_EXTENSION          = .3
    14141815
    1415 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    1416 # then it will generate one additional man file for each entity
    1417 # documented in the real man page(s). These additional files
    1418 # only source the real man page, but without them the man command
    1419 # would be unable to find the correct page. The default is NO.
     1816# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
     1817# will generate one additional man file for each entity documented in the real
     1818# man page(s). These additional files only source the real man page, but without
     1819# them the man command would be unable to find the correct page.
     1820# The default value is: NO.
     1821# This tag requires that the tag GENERATE_MAN is set to YES.
    14201822
    14211823MAN_LINKS              = NO
    14221824
    14231825#---------------------------------------------------------------------------
    1424 # configuration options related to the XML output
    1425 #---------------------------------------------------------------------------
    1426 
    1427 # If the GENERATE_XML tag is set to YES Doxygen will
    1428 # generate an XML file that captures the structure of
    1429 # the code including all documentation.
     1826# Configuration options related to the XML output
     1827#---------------------------------------------------------------------------
     1828
     1829# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
     1830# captures the structure of the code including all documentation.
     1831# The default value is: NO.
    14301832
    14311833GENERATE_XML           = NO
    14321834
    1433 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    1434 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1435 # put in front of it. If left blank `xml' will be used as the default path.
     1835# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
     1836# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1837# it.
     1838# The default directory is: xml.
     1839# This tag requires that the tag GENERATE_XML is set to YES.
    14361840
    14371841XML_OUTPUT             = xml
    14381842
    1439 # The XML_SCHEMA tag can be used to specify an XML schema,
    1440 # which can be used by a validating XML parser to check the
    1441 # syntax of the XML files.
     1843# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
     1844# validating XML parser to check the syntax of the XML files.
     1845# This tag requires that the tag GENERATE_XML is set to YES.
    14421846
    14431847XML_SCHEMA             =
    14441848
    1445 # The XML_DTD tag can be used to specify an XML DTD,
    1446 # which can be used by a validating XML parser to check the
    1447 # syntax of the XML files.
     1849# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
     1850# validating XML parser to check the syntax of the XML files.
     1851# This tag requires that the tag GENERATE_XML is set to YES.
    14481852
    14491853XML_DTD                =
    14501854
    1451 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    1452 # dump the program listings (including syntax highlighting
    1453 # and cross-referencing information) to the XML output. Note that
    1454 # enabling this will significantly increase the size of the XML output.
     1855# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
     1856# listings (including syntax highlighting and cross-referencing information) to
     1857# the XML output. Note that enabling this will significantly increase the size
     1858# of the XML output.
     1859# The default value is: YES.
     1860# This tag requires that the tag GENERATE_XML is set to YES.
    14551861
    14561862XML_PROGRAMLISTING     = YES
    14571863
    14581864#---------------------------------------------------------------------------
    1459 # configuration options for the AutoGen Definitions output
    1460 #---------------------------------------------------------------------------
    1461 
    1462 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    1463 # generate an AutoGen Definitions (see autogen.sf.net) file
    1464 # that captures the structure of the code including all
    1465 # documentation. Note that this feature is still experimental
    1466 # and incomplete at the moment.
     1865# Configuration options related to the DOCBOOK output
     1866#---------------------------------------------------------------------------
     1867
     1868# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
     1869# that can be used to generate PDF.
     1870# The default value is: NO.
     1871
     1872GENERATE_DOCBOOK       = NO
     1873
     1874# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
     1875# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
     1876# front of it.
     1877# The default directory is: docbook.
     1878# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1879
     1880DOCBOOK_OUTPUT         = docbook
     1881
     1882#---------------------------------------------------------------------------
     1883# Configuration options for the AutoGen Definitions output
     1884#---------------------------------------------------------------------------
     1885
     1886# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
     1887# Definitions (see http://autogen.sf.net) file that captures the structure of
     1888# the code including all documentation. Note that this feature is still
     1889# experimental and incomplete at the moment.
     1890# The default value is: NO.
    14671891
    14681892GENERATE_AUTOGEN_DEF   = NO
    14691893
    14701894#---------------------------------------------------------------------------
    1471 # configuration options related to the Perl module output
    1472 #---------------------------------------------------------------------------
    1473 
    1474 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    1475 # generate a Perl module file that captures the structure of
    1476 # the code including all documentation. Note that this
    1477 # feature is still experimental and incomplete at the
    1478 # moment.
     1895# Configuration options related to the Perl module output
     1896#---------------------------------------------------------------------------
     1897
     1898# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
     1899# file that captures the structure of the code including all documentation.
     1900#
     1901# Note that this feature is still experimental and incomplete at the moment.
     1902# The default value is: NO.
    14791903
    14801904GENERATE_PERLMOD       = NO
    14811905
    1482 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    1483 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    1484 # to generate PDF and DVI output from the Perl module output.
     1906# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
     1907# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
     1908# output from the Perl module output.
     1909# The default value is: NO.
     1910# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    14851911
    14861912PERLMOD_LATEX          = NO
    14871913
    1488 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1489 # nicely formatted so it can be parsed by a human reader.
    1490 # This is useful
    1491 # if you want to understand what is going on.
    1492 # On the other hand, if this
    1493 # tag is set to NO the size of the Perl module output will be much smaller
    1494 # and Perl will parse it just the same.
     1914# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
     1915# formatted so it can be parsed by a human reader. This is useful if you want to
     1916# understand what is going on. On the other hand, if this tag is set to NO the
     1917# size of the Perl module output will be much smaller and Perl will parse it
     1918# just the same.
     1919# The default value is: YES.
     1920# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    14951921
    14961922PERLMOD_PRETTY         = YES
    14971923
    1498 # The names of the make variables in the generated doxyrules.make file
    1499 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    1500 # This is useful so different doxyrules.make files included by the same
    1501 # Makefile don't overwrite each other's variables.
     1924# The names of the make variables in the generated doxyrules.make file are
     1925# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
     1926# so different doxyrules.make files included by the same Makefile don't
     1927# overwrite each other's variables.
     1928# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    15021929
    15031930PERLMOD_MAKEVAR_PREFIX =
     
    15071934#---------------------------------------------------------------------------
    15081935
    1509 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    1510 # evaluate all C-preprocessor directives found in the sources and include
    1511 # files.
     1936# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
     1937# C-preprocessor directives found in the sources and include files.
     1938# The default value is: YES.
    15121939
    15131940ENABLE_PREPROCESSING   = YES
    15141941
    1515 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    1516 # names in the source code. If set to NO (the default) only conditional
    1517 # compilation will be performed. Macro expansion can be done in a controlled
    1518 # way by setting EXPAND_ONLY_PREDEF to YES.
     1942# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
     1943# in the source code. If set to NO only conditional compilation will be
     1944# performed. Macro expansion can be done in a controlled way by setting
     1945# EXPAND_ONLY_PREDEF to YES.
     1946# The default value is: NO.
     1947# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15191948
    15201949MACRO_EXPANSION        = NO
    15211950
    1522 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    1523 # then the macro expansion is limited to the macros specified with the
    1524 # PREDEFINED and EXPAND_AS_DEFINED tags.
     1951# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
     1952# the macro expansion is limited to the macros specified with the PREDEFINED and
     1953# EXPAND_AS_DEFINED tags.
     1954# The default value is: NO.
     1955# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15251956
    15261957EXPAND_ONLY_PREDEF     = NO
    15271958
    1528 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1529 # pointed to by INCLUDE_PATH will be searched when a #include is found.
     1959# If the SEARCH_INCLUDES tag is set to YES the includes files in the
     1960# INCLUDE_PATH will be searched if a #include is found.
     1961# The default value is: YES.
     1962# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15301963
    15311964SEARCH_INCLUDES        = YES
    15321965
    15331966# The INCLUDE_PATH tag can be used to specify one or more directories that
    1534 # contain include files that are not input files but should be processed by
    1535 # the preprocessor.
     1967# contain include files that are not input files but should be processed by the
     1968# preprocessor.
     1969# This tag requires that the tag SEARCH_INCLUDES is set to YES.
    15361970
    15371971INCLUDE_PATH           =
     
    15391973# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    15401974# patterns (like *.h and *.hpp) to filter out the header-files in the
    1541 # directories. If left blank, the patterns specified with FILE_PATTERNS will
    1542 # be used.
     1975# directories. If left blank, the patterns specified with FILE_PATTERNS will be
     1976# used.
     1977# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15431978
    15441979INCLUDE_FILE_PATTERNS  =
    15451980
    1546 # The PREDEFINED tag can be used to specify one or more macro names that
    1547 # are defined before the preprocessor is started (similar to the -D option of
    1548 # gcc). The argument of the tag is a list of macros of the form: name
    1549 # or name=definition (no spaces). If the definition and the = are
    1550 # omitted =1 is assumed. To prevent a macro definition from being
    1551 # undefined via #undef or recursively expanded use the := operator
    1552 # instead of the = operator.
     1981# The PREDEFINED tag can be used to specify one or more macro names that are
     1982# defined before the preprocessor is started (similar to the -D option of e.g.
     1983# gcc). The argument of the tag is a list of macros of the form: name or
     1984# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
     1985# is assumed. To prevent a macro definition from being undefined via #undef or
     1986# recursively expanded use the := operator instead of the = operator.
     1987# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15531988
    15541989PREDEFINED             = __i386__ \
     
    15561991                         DOXYGEN_EXCLUDE
    15571992
    1558 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    1559 # this tag can be used to specify a list of macro names that should be expanded.
    1560 # The macro definition that is found in the sources will be used.
    1561 # Use the PREDEFINED tag if you want to use a different macro definition that
    1562 # overrules the definition found in the source code.
     1993# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
     1994# tag can be used to specify a list of macro names that should be expanded. The
     1995# macro definition that is found in the sources will be used. Use the PREDEFINED
     1996# tag if you want to use a different macro definition that overrules the
     1997# definition found in the source code.
     1998# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15631999
    15642000EXPAND_AS_DEFINED      =
    15652001
    1566 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1567 # doxygen's preprocessor will remove all references to function-like macros
    1568 # that are alone on a line, have an all uppercase name, and do not end with a
    1569 # semicolon, because these will confuse the parser if not removed.
     2002# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
     2003# remove all refrences to function-like macros that are alone on a line, have an
     2004# all uppercase name, and do not end with a semicolon. Such function macros are
     2005# typically used for boiler-plate code, and will confuse the parser if not
     2006# removed.
     2007# The default value is: YES.
     2008# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15702009
    15712010SKIP_FUNCTION_MACROS   = YES
    15722011
    15732012#---------------------------------------------------------------------------
    1574 # Configuration::additions related to external references
    1575 #---------------------------------------------------------------------------
    1576 
    1577 # The TAGFILES option can be used to specify one or more tagfiles. For each
    1578 # tag file the location of the external documentation should be added. The
    1579 # format of a tag file without this location is as follows:
    1580 #
     2013# Configuration options related to external references
     2014#---------------------------------------------------------------------------
     2015
     2016# The TAGFILES tag can be used to specify one or more tag files. For each tag
     2017# file the location of the external documentation should be added. The format of
     2018# a tag file without this location is as follows:
    15812019# TAGFILES = file1 file2 ...
    15822020# Adding location for the tag files is done as follows:
    1583 #
    15842021# TAGFILES = file1=loc1 "file2 = loc2" ...
    1585 # where "loc1" and "loc2" can be relative or absolute paths
    1586 # or URLs. Note that each tag file must have a unique name (where the name does
    1587 # NOT include the path). If a tag file is not located in the directory in which
    1588 # doxygen is run, you must also specify the path to the tagfile here.
     2022# where loc1 and loc2 can be relative or absolute paths or URLs. See the
     2023# section "Linking to external documentation" for more information about the use
     2024# of tag files.
     2025# Note: Each tag file must have an unique name (where the name does NOT include
     2026# the path). If a tag file is not located in the directory in which doxygen is
     2027# run, you must also specify the path to the tagfile here.
    15892028
    15902029TAGFILES               = doc/qt-4.8.tags=http://qt-project.org/doc/qt-4.8
    15912030
    1592 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    1593 # a tag file that is based on the input files it reads.
     2031# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
     2032# tag file that is based on the input files it reads. See section "Linking to
     2033# external documentation" for more information about the usage of tag files.
    15942034
    15952035GENERATE_TAGFILE       = doc/tspsg.tags
    15962036
    1597 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    1598 # in the class index. If set to NO only the inherited external classes
    1599 # will be listed.
     2037# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
     2038# class index. If set to NO only the inherited external classes will be listed.
     2039# The default value is: NO.
    16002040
    16012041ALLEXTERNALS           = NO
    16022042
    1603 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    1604 # in the modules index. If set to NO, only the current project's groups will
     2043# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
     2044# the modules index. If set to NO, only the current project's groups will be
     2045# listed.
     2046# The default value is: YES.
     2047
     2048EXTERNAL_GROUPS        = YES
     2049
     2050# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
     2051# the related pages index. If set to NO, only the current project's pages will
    16052052# be listed.
    1606 
    1607 EXTERNAL_GROUPS        = YES
     2053# The default value is: YES.
     2054
     2055EXTERNAL_PAGES         = YES
    16082056
    16092057# The PERL_PATH should be the absolute path and name of the perl script
    1610 # interpreter (i.e. the result of `which perl').
     2058# interpreter (i.e. the result of 'which perl').
     2059# The default file (with absolute path) is: /usr/bin/perl.
    16112060
    16122061PERL_PATH              = /usr/bin/perl
     
    16162065#---------------------------------------------------------------------------
    16172066
    1618 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1619 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    1620 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    1621 # this option also works with HAVE_DOT disabled, but it is recommended to
    1622 # install and use dot, since it yields more powerful graphs.
     2067# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
     2068# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
     2069# NO turns the diagrams off. Note that this option also works with HAVE_DOT
     2070# disabled, but it is recommended to install and use dot, since it yields more
     2071# powerful graphs.
     2072# The default value is: YES.
    16232073
    16242074CLASS_DIAGRAMS         = YES
    16252075
    16262076# You can define message sequence charts within doxygen comments using the \msc
    1627 # command. Doxygen will then run the mscgen tool (see
    1628 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     2077# command. Doxygen will then run the mscgen tool (see:
     2078# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
    16292079# documentation. The MSCGEN_PATH tag allows you to specify the directory where
    16302080# the mscgen tool resides. If left empty the tool is assumed to be found in the
     
    16332083MSCGEN_PATH            =
    16342084
    1635 # If set to YES, the inheritance and collaboration graphs will hide
    1636 # inheritance and usage relations if the target is undocumented
    1637 # or is not a class.
     2085# If set to YES, the inheritance and collaboration graphs will hide inheritance
     2086# and usage relations if the target is undocumented or is not a class.
     2087# The default value is: YES.
    16382088
    16392089HIDE_UNDOC_RELATIONS   = YES
    16402090
    16412091# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    1642 # available from the path. This tool is part of Graphviz, a graph visualization
    1643 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    1644 # have no effect if this option is set to NO (the default)
     2092# available from the path. This tool is part of Graphviz (see:
     2093# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
     2094# Bell Labs. The other options in this section have no effect if this option is
     2095# set to NO
     2096# The default value is: NO.
    16452097
    16462098HAVE_DOT               = YES
    16472099
    1648 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
    1649 # allowed to run in parallel. When set to 0 (the default) doxygen will
    1650 # base this on the number of processors available in the system. You can set it
    1651 # explicitly to a value larger than 0 to get control over the balance
    1652 # between CPU load and processing speed.
     2100# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
     2101# to run in parallel. When set to 0 doxygen will base this on the number of
     2102# processors available in the system. You can set it explicitly to a value
     2103# larger than 0 to get control over the balance between CPU load and processing
     2104# speed.
     2105# Minimum value: 0, maximum value: 32, default value: 0.
     2106# This tag requires that the tag HAVE_DOT is set to YES.
    16532107
    16542108DOT_NUM_THREADS        = 0
    16552109
    1656 # By default doxygen will use the Helvetica font for all dot files that
    1657 # doxygen generates. When you want a differently looking font you can specify
    1658 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
    1659 # the font, which can be done by putting it in a standard location or by setting
    1660 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
    1661 # directory containing the font.
     2110# When you want a differently looking font n the dot files that doxygen
     2111# generates you can specify the font name using DOT_FONTNAME. You need to make
     2112# sure dot is able to find the font, which can be done by putting it in a
     2113# standard location or by setting the DOTFONTPATH environment variable or by
     2114# setting DOT_FONTPATH to the directory containing the font.
     2115# The default value is: Helvetica.
     2116# This tag requires that the tag HAVE_DOT is set to YES.
    16622117
    16632118DOT_FONTNAME           = FreeSans
    16642119
    1665 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    1666 # The default size is 10pt.
     2120# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
     2121# dot graphs.
     2122# Minimum value: 4, maximum value: 24, default value: 10.
     2123# This tag requires that the tag HAVE_DOT is set to YES.
    16672124
    16682125DOT_FONTSIZE           = 10
    16692126
    1670 # By default doxygen will tell dot to use the Helvetica font.
    1671 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
    1672 # set the path where dot can find it.
     2127# By default doxygen will tell dot to use the default font as specified with
     2128# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
     2129# the path where dot can find it using this tag.
     2130# This tag requires that the tag HAVE_DOT is set to YES.
    16732131
    16742132DOT_FONTPATH           =
    16752133
    1676 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1677 # will generate a graph for each documented class showing the direct and
    1678 # indirect inheritance relations. Setting this tag to YES will force the
    1679 # CLASS_DIAGRAMS tag to NO.
     2134# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
     2135# each documented class showing the direct and indirect inheritance relations.
     2136# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
     2137# The default value is: YES.
     2138# This tag requires that the tag HAVE_DOT is set to YES.
    16802139
    16812140CLASS_GRAPH            = YES
    16822141
    1683 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1684 # will generate a graph for each documented class showing the direct and
    1685 # indirect implementation dependencies (inheritance, containment, and
    1686 # class references variables) of the class with other documented classes.
     2142# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
     2143# graph for each documented class showing the direct and indirect implementation
     2144# dependencies (inheritance, containment, and class references variables) of the
     2145# class with other documented classes.
     2146# The default value is: YES.
     2147# This tag requires that the tag HAVE_DOT is set to YES.
    16872148
    16882149COLLABORATION_GRAPH    = YES
    16892150
    1690 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    1691 # will generate a graph for groups, showing the direct groups dependencies
     2151# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
     2152# groups, showing the direct groups dependencies.
     2153# The default value is: YES.
     2154# This tag requires that the tag HAVE_DOT is set to YES.
    16922155
    16932156GROUP_GRAPHS           = YES
     
    16962159# collaboration diagrams in a style similar to the OMG's Unified Modeling
    16972160# Language.
     2161# The default value is: NO.
     2162# This tag requires that the tag HAVE_DOT is set to YES.
    16982163
    16992164UML_LOOK               = NO
    17002165
    1701 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
    1702 # the class node. If there are many fields or methods and many nodes the
    1703 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
    1704 # threshold limits the number of items for each type to make the size more
    1705 # managable. Set this to 0 for no limit. Note that the threshold may be
    1706 # exceeded by 50% before the limit is enforced.
     2166# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
     2167# class node. If there are many fields or methods and many nodes the graph may
     2168# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
     2169# number of items for each type to make the size more manageable. Set this to 0
     2170# for no limit. Note that the threshold may be exceeded by 50% before the limit
     2171# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
     2172# but if the number exceeds 15, the total amount of fields shown is limited to
     2173# 10.
     2174# Minimum value: 0, maximum value: 100, default value: 10.
     2175# This tag requires that the tag HAVE_DOT is set to YES.
    17072176
    17082177UML_LIMIT_NUM_FIELDS   = 10
    17092178
    1710 # If set to YES, the inheritance and collaboration graphs will show the
    1711 # relations between templates and their instances.
     2179# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
     2180# collaboration graphs will show the relations between templates and their
     2181# instances.
     2182# The default value is: NO.
     2183# This tag requires that the tag HAVE_DOT is set to YES.
    17122184
    17132185TEMPLATE_RELATIONS     = NO
    17142186
    1715 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    1716 # tags are set to YES then doxygen will generate a graph for each documented
    1717 # file showing the direct and indirect include dependencies of the file with
    1718 # other documented files.
     2187# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
     2188# YES then doxygen will generate a graph for each documented file showing the
     2189# direct and indirect include dependencies of the file with other documented
     2190# files.
     2191# The default value is: YES.
     2192# This tag requires that the tag HAVE_DOT is set to YES.
    17192193
    17202194INCLUDE_GRAPH          = YES
    17212195
    1722 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    1723 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    1724 # documented header file showing the documented files that directly or
    1725 # indirectly include this file.
     2196# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
     2197# set to YES then doxygen will generate a graph for each documented file showing
     2198# the direct and indirect include dependencies of the file with other documented
     2199# files.
     2200# The default value is: YES.
     2201# This tag requires that the tag HAVE_DOT is set to YES.
    17262202
    17272203INCLUDED_BY_GRAPH      = YES
    17282204
    1729 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    1730 # doxygen will generate a call dependency graph for every global function
    1731 # or class method. Note that enabling this option will significantly increase
    1732 # the time of a run. So in most cases it will be better to enable call graphs
    1733 # for selected functions only using the \callgraph command.
     2205# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
     2206# dependency graph for every global function or class method.
     2207#
     2208# Note that enabling this option will significantly increase the time of a run.
     2209# So in most cases it will be better to enable call graphs for selected
     2210# functions only using the \callgraph command.
     2211# The default value is: NO.
     2212# This tag requires that the tag HAVE_DOT is set to YES.
    17342213
    17352214CALL_GRAPH             = YES
    17362215
    1737 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    1738 # doxygen will generate a caller dependency graph for every global function
    1739 # or class method. Note that enabling this option will significantly increase
    1740 # the time of a run. So in most cases it will be better to enable caller
    1741 # graphs for selected functions only using the \callergraph command.
     2216# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
     2217# dependency graph for every global function or class method.
     2218#
     2219# Note that enabling this option will significantly increase the time of a run.
     2220# So in most cases it will be better to enable caller graphs for selected
     2221# functions only using the \callergraph command.
     2222# The default value is: NO.
     2223# This tag requires that the tag HAVE_DOT is set to YES.
    17422224
    17432225CALLER_GRAPH           = YES
    17442226
    1745 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1746 # will generate a graphical hierarchy of all classes instead of a textual one.
     2227# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
     2228# hierarchy of all classes instead of a textual one.
     2229# The default value is: YES.
     2230# This tag requires that the tag HAVE_DOT is set to YES.
    17472231
    17482232GRAPHICAL_HIERARCHY    = YES
    17492233
    1750 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
    1751 # then doxygen will show the dependencies a directory has on other directories
    1752 # in a graphical way. The dependency relations are determined by the #include
    1753 # relations between the files in the directories.
     2234# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
     2235# dependencies a directory has on other directories in a graphical way. The
     2236# dependency relations are determined by the #include relations between the
     2237# files in the directories.
     2238# The default value is: YES.
     2239# This tag requires that the tag HAVE_DOT is set to YES.
    17542240
    17552241DIRECTORY_GRAPH        = YES
    17562242
    17572243# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1758 # generated by dot. Possible values are svg, png, jpg, or gif.
    1759 # If left blank png will be used. If you choose svg you need to set
    1760 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    1761 # visible in IE 9+ (other browsers do not have this requirement).
     2244# generated by dot.
     2245# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
     2246# to make the SVG files visible in IE 9+ (other browsers do not have this
     2247# requirement).
     2248# Possible values are: png, jpg, gif and svg.
     2249# The default value is: png.
     2250# This tag requires that the tag HAVE_DOT is set to YES.
    17622251
    17632252DOT_IMAGE_FORMAT       = png
     
    17652254# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
    17662255# enable generation of interactive SVG images that allow zooming and panning.
    1767 # Note that this requires a modern browser other than Internet Explorer.
    1768 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
    1769 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    1770 # visible. Older versions of IE do not have SVG support.
     2256#
     2257# Note that this requires a modern browser other than Internet Explorer. Tested
     2258# and working are Firefox, Chrome, Safari, and Opera.
     2259# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
     2260# the SVG files visible. Older versions of IE do not have SVG support.
     2261# The default value is: NO.
     2262# This tag requires that the tag HAVE_DOT is set to YES.
    17712263
    17722264INTERACTIVE_SVG        = NO
    17732265
    1774 # The tag DOT_PATH can be used to specify the path where the dot tool can be
     2266# The DOT_PATH tag can be used to specify the path where the dot tool can be
    17752267# found. If left blank, it is assumed the dot tool can be found in the path.
     2268# This tag requires that the tag HAVE_DOT is set to YES.
    17762269
    17772270DOT_PATH               =
    17782271
    17792272# The DOTFILE_DIRS tag can be used to specify one or more directories that
    1780 # contain dot files that are included in the documentation (see the
    1781 # \dotfile command).
     2273# contain dot files that are included in the documentation (see the \dotfile
     2274# command).
     2275# This tag requires that the tag HAVE_DOT is set to YES.
    17822276
    17832277DOTFILE_DIRS           =
    17842278
    17852279# The MSCFILE_DIRS tag can be used to specify one or more directories that
    1786 # contain msc files that are included in the documentation (see the
    1787 # \mscfile command).
     2280# contain msc files that are included in the documentation (see the \mscfile
     2281# command).
    17882282
    17892283MSCFILE_DIRS           =
    17902284
    1791 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1792 # nodes that will be shown in the graph. If the number of nodes in a graph
    1793 # becomes larger than this value, doxygen will truncate the graph, which is
    1794 # visualized by representing a node as a red box. Note that doxygen if the
    1795 # number of direct children of the root node in a graph is already larger than
    1796 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    1797 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2285# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
     2286# that will be shown in the graph. If the number of nodes in a graph becomes
     2287# larger than this value, doxygen will truncate the graph, which is visualized
     2288# by representing a node as a red box. Note that doxygen if the number of direct
     2289# children of the root node in a graph is already larger than
     2290# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
     2291# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2292# Minimum value: 0, maximum value: 10000, default value: 50.
     2293# This tag requires that the tag HAVE_DOT is set to YES.
    17982294
    17992295DOT_GRAPH_MAX_NODES    = 50
    18002296
    1801 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1802 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1803 # from the root by following a path via at most 3 edges will be shown. Nodes
    1804 # that lay further from the root node will be omitted. Note that setting this
    1805 # option to 1 or 2 may greatly reduce the computation time needed for large
    1806 # code bases. Also note that the size of a graph can be further restricted by
     2297# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
     2298# generated by dot. A depth value of 3 means that only nodes reachable from the
     2299# root by following a path via at most 3 edges will be shown. Nodes that lay
     2300# further from the root node will be omitted. Note that setting this option to 1
     2301# or 2 may greatly reduce the computation time needed for large code bases. Also
     2302# note that the size of a graph can be further restricted by
    18072303# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
     2304# Minimum value: 0, maximum value: 1000, default value: 0.
     2305# This tag requires that the tag HAVE_DOT is set to YES.
    18082306
    18092307MAX_DOT_GRAPH_DEPTH    = 0
    18102308
    18112309# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1812 # background. This is disabled by default, because dot on Windows does not
    1813 # seem to support this out of the box. Warning: Depending on the platform used,
    1814 # enabling this option may lead to badly anti-aliased labels on the edges of
    1815 # a graph (i.e. they become hard to read).
     2310# background. This is disabled by default, because dot on Windows does not seem
     2311# to support this out of the box.
     2312#
     2313# Warning: Depending on the platform used, enabling this option may lead to
     2314# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     2315# read).
     2316# The default value is: NO.
     2317# This tag requires that the tag HAVE_DOT is set to YES.
    18162318
    18172319DOT_TRANSPARENT        = YES
     
    18192321# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    18202322# files in one run (i.e. multiple -o and -T options on the command line). This
    1821 # makes dot run faster, but since only newer versions of dot (>1.8.10)
    1822 # support this, this feature is disabled by default.
     2323# makes dot run faster, but since only newer versions of dot (>1.8.10) support
     2324# this, this feature is disabled by default.
     2325# The default value is: NO.
     2326# This tag requires that the tag HAVE_DOT is set to YES.
    18232327
    18242328DOT_MULTI_TARGETS      = YES
    18252329
    1826 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1827 # generate a legend page explaining the meaning of the various boxes and
    1828 # arrows in the dot generated graphs.
     2330# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
     2331# explaining the meaning of the various boxes and arrows in the dot generated
     2332# graphs.
     2333# The default value is: YES.
     2334# This tag requires that the tag HAVE_DOT is set to YES.
    18292335
    18302336GENERATE_LEGEND        = YES
    18312337
    1832 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    1833 # remove the intermediate dot files that are used to generate
    1834 # the various graphs.
     2338# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
     2339# files that are used to generate the various graphs.
     2340# The default value is: YES.
     2341# This tag requires that the tag HAVE_DOT is set to YES.
    18352342
    18362343DOT_CLEANUP            = YES
Note: See TracChangeset for help on using the changeset viewer.