Changeset 579:7d8bd4b502c4


Ignore:
Timestamp:
12/14/14 08:02:53 (10 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
default
Phase:
public
Message:

Update the Doxygen configuration file to be compatible with the newer version of Doxygen

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/Doxyfile

    r301 r579  
    1 # Doxyfile 1.7.6.1
     1# Doxyfile 1.8.8
    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           = "MAVA Logger X"
    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.
    40 
    41 #PROJECT_BRIEF          =
    42 
    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.
    47 
    48 #PROJECT_LOGO           =
    49 
    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.
     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.
     46
     47PROJECT_BRIEF          =
     48
     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.
     53
     54PROJECT_LOGO           =
     55
     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       =
    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
     72
     73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
     74# characters to appear in the names of generated files. If set to NO, non-ASCII
     75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
     76# U+3044.
     77# The default value is: NO.
     78
     79ALLOW_UNICODE_NAMES    = NO
    6580
    6681# The OUTPUT_LANGUAGE tag is used to specify the language in which all
    6782# documentation generated by doxygen is written. Doxygen will use this
    6883# 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.
     84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
     85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
     86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
     87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
     88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
     89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
     90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
     91# Ukrainian and Vietnamese.
     92# The default value is: English.
    7693
    7794OUTPUT_LANGUAGE        = English
    7895
    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.
     96# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
     97# descriptions after the members that are listed in the file and class
     98# documentation (similar to Javadoc). Set to NO to disable this.
     99# The default value is: YES.
    83100
    84101BRIEF_MEMBER_DESC      = YES
    85102
    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
     103# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
     104# description of a member or function before the detailed description
     105#
     106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    89107# brief descriptions will be completely suppressed.
     108# The default value is: YES.
    90109
    91110REPEAT_BRIEF           = YES
    92111
    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"
     112# This tag implements a quasi-intelligent brief description abbreviator that is
     113# used to form the text in various listings. Each string in this list, if found
     114# as the leading text of the brief description, will be stripped from the text
     115# and the result, after processing the whole list, is used as the annotated
     116# text. Otherwise, the brief description is used as-is. If left blank, the
     117# following values are used ($name is automatically replaced with the name of
     118# the entity):The $name class, The $name widget, The $name file, is, provides,
     119# specifies, contains, represents, a, an and the.
    102120
    103121ABBREVIATE_BRIEF       =
    104122
    105123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    106 # 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
    107125# description.
     126# The default value is: NO.
    108127
    109128ALWAYS_DETAILED_SEC    = NO
     
    113132# members were ordinary class members. Constructors, destructors and assignment
    114133# operators of the base classes will not be shown.
     134# The default value is: NO.
    115135
    116136INLINE_INHERITED_MEMB  = NO
    117137
    118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    119 # path before files name in the file list and in the header files. If set
    120 # 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.
    121142
    122143FULL_PATH_NAMES        = NO
    123144
    124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    125 # can be used to strip a user-defined part of the path. Stripping is
    126 # only done if one of the specified strings matches the left-hand part of
    127 # the path. The tag can be used to show relative paths in the file list.
    128 # If left blank the directory from which doxygen is run is used as the
    129 # 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.
    130154
    131155STRIP_FROM_PATH        =
    132156
    133 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    134 # the path mentioned in the documentation of a class, which tells
    135 # the reader which header file to include in order to use a class.
    136 # If left blank only the name of the header file containing the class
    137 # definition is used. Otherwise one should specify the include paths that
    138 # 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.
    139163
    140164STRIP_FROM_INC_PATH    =
    141165
    142 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    143 # (but less readable) file names. This can be useful if your file system
    144 # 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.
    145170
    146171SHORT_NAMES            = NO
    147172
    148 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    149 # will interpret the first line (until the first dot) of a JavaDoc-style
    150 # comment as the brief description. If set to NO, the JavaDoc
    151 # comments will behave just like regular Qt-style comments
    152 # (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.
    153179
    154180JAVADOC_AUTOBRIEF      = NO
    155181
    156 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
    157 # interpret the first line (until the first dot) of a Qt-style
    158 # comment as the brief description. If set to NO, the comments
    159 # will behave just like regular Qt-style comments (thus requiring
    160 # 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.
    161187
    162188QT_AUTOBRIEF           = NO
    163189
    164 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    165 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    166 # comments) as a brief description. This used to be the default behaviour.
    167 # The new default is to treat a multi-line C++ comment block as a detailed
    168 # 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.
    169199
    170200MULTILINE_CPP_IS_BRIEF = NO
    171201
    172 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    173 # member inherits the documentation from any documented member that it
    174 # 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.
    175205
    176206INHERIT_DOCS           = YES
    177207
    178 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    179 # a new page for each member. If set to NO, the documentation of a member will
    180 # 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.
    181212
    182213SEPARATE_MEMBER_PAGES  = NO
    183214
    184 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    185 # 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.
    186218
    187219TAB_SIZE               = 8
    188220
    189 # This tag can be used to specify a number of aliases that acts
    190 # as commands in the documentation. An alias has the form "name=value".
    191 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    192 # put the command \sideeffect (or @sideeffect) in the documentation, which
    193 # will result in a user-defined paragraph with heading "Side Effects:".
    194 # 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.
    195230
    196231ALIASES                =
    197232
    198233# This tag can be used to specify a number of word-keyword mappings (TCL only).
    199 # A mapping has the form "name=value". For example adding
    200 # "class=itcl::class" will allow you to use the command class in the
    201 # itcl::class meaning.
    202 
    203 #TCL_SUBST              =
    204 
    205 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    206 # sources only. Doxygen will then generate output that is more tailored for C.
    207 # For instance, some of the names that are used will be different. The list
    208 # of all members will be omitted, etc.
     234# A mapping has the form "name=value". For example adding "class=itcl::class"
     235# will allow you to use the command class in the itcl::class meaning.
     236
     237TCL_SUBST              =
     238
     239# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     240# only. Doxygen will then generate output that is more tailored for C. For
     241# instance, some of the names that are used will be different. The list of all
     242# members will be omitted, etc.
     243# The default value is: NO.
    209244
    210245OPTIMIZE_OUTPUT_FOR_C  = NO
    211246
    212 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    213 # sources only. Doxygen will then generate output that is more tailored for
    214 # Java. For instance, namespaces will be presented as packages, qualified
    215 # scopes will look different, etc.
     247# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
     248# Python sources only. Doxygen will then generate output that is more tailored
     249# for that language. For instance, namespaces will be presented as packages,
     250# qualified scopes will look different, etc.
     251# The default value is: NO.
    216252
    217253OPTIMIZE_OUTPUT_JAVA   = NO
    218254
    219255# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
    220 # sources only. Doxygen will then generate output that is more tailored for
    221 # Fortran.
     256# sources. Doxygen will then generate output that is tailored for Fortran.
     257# The default value is: NO.
    222258
    223259OPTIMIZE_FOR_FORTRAN   = NO
    224260
    225261# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
    226 # sources. Doxygen will then generate output that is tailored for
    227 # VHDL.
     262# sources. Doxygen will then generate output that is tailored for VHDL.
     263# The default value is: NO.
    228264
    229265OPTIMIZE_OUTPUT_VHDL   = NO
    230266
    231267# Doxygen selects the parser to use depending on the extension of the files it
    232 # parses. With this tag you can assign which parser to use for a given extension.
    233 # Doxygen has a built-in mapping, but you can override or extend it using this
    234 # tag. The format is ext=language, where ext is a file extension, and language
    235 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
    236 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
    237 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
    238 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
    239 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     268# parses. With this tag you can assign which parser to use for a given
     269# extension. Doxygen has a built-in mapping, but you can override or extend it
     270# using this tag. The format is ext=language, where ext is a file extension, and
     271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
     272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
     273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
     274# Fortran. In the later case the parser tries to guess whether the code is fixed
     275# or free formatted code, this is the default for Fortran type files), VHDL. For
     276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
     277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
     278#
     279# Note For files without extension you can use no_extension as a placeholder.
     280#
     281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
     282# the files are not read by doxygen.
    240283
    241284EXTENSION_MAPPING      =
    242285
     286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
     287# according to the Markdown format, which allows for more readable
     288# documentation. See http://daringfireball.net/projects/markdown/ for details.
     289# The output of markdown processing is further processed by doxygen, so you can
     290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
     291# case of backward compatibilities issues.
     292# The default value is: YES.
     293
     294MARKDOWN_SUPPORT       = YES
     295
     296# When enabled doxygen tries to link words that correspond to documented
     297# classes, or namespaces to their corresponding documentation. Such a link can
     298# be prevented in individual cases by by putting a % sign in front of the word
     299# or globally by setting AUTOLINK_SUPPORT to NO.
     300# The default value is: YES.
     301
     302AUTOLINK_SUPPORT       = YES
     303
    243304# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    244 # to include (a tag file for) the STL sources as input, then you should
    245 # set this tag to YES in order to let doxygen match functions declarations and
    246 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    247 # func(std::string) {}). This also makes the inheritance and collaboration
     305# to include (a tag file for) the STL sources as input, then you should set this
     306# tag to YES in order to let doxygen match functions declarations and
     307# definitions whose arguments contain STL classes (e.g. func(std::string);
     308# versus func(std::string) {}). This also make the inheritance and collaboration
    248309# diagrams that involve STL classes more complete and accurate.
     310# The default value is: NO.
    249311
    250312BUILTIN_STL_SUPPORT    = NO
     
    252314# If you use Microsoft's C++/CLI language, you should set this option to YES to
    253315# enable parsing support.
     316# The default value is: NO.
    254317
    255318CPP_CLI_SUPPORT        = NO
    256319
    257 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
    258 # Doxygen will parse them like normal C++ but will assume all classes use public
    259 # instead of private inheritance when no explicit protection keyword is present.
     320# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
     321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
     322# will parse them like normal C++ but will assume all classes use public instead
     323# of private inheritance when no explicit protection keyword is present.
     324# The default value is: NO.
    260325
    261326SIP_SUPPORT            = NO
    262327
    263 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    264 # and setter methods for a property. Setting this option to YES (the default)
    265 # will make doxygen replace the get and set methods by a property in the
    266 # documentation. This will only work if the methods are indeed getting or
    267 # setting a simple type. If this is not the case, or you want to show the
    268 # methods anyway, you should set this option to NO.
     328# For Microsoft's IDL there are propget and propput attributes to indicate
     329# getter and setter methods for a property. Setting this option to YES will make
     330# doxygen to replace the get and set methods by a property in the documentation.
     331# This will only work if the methods are indeed getting or setting a simple
     332# type. If this is not the case, or you want to show the methods anyway, you
     333# should set this option to NO.
     334# The default value is: YES.
    269335
    270336IDL_PROPERTY_SUPPORT   = YES
     
    274340# member in the group (if any) for the other members of the group. By default
    275341# all members of a group must be documented explicitly.
     342# The default value is: NO.
    276343
    277344DISTRIBUTE_GROUP_DOC   = NO
    278345
    279 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    280 # the same type (for instance a group of public functions) to be put as a
    281 # subgroup of that type (e.g. under the Public Functions section). Set it to
    282 # NO to prevent subgrouping. Alternatively, this can be done per class using
    283 # the \nosubgrouping command.
     346# Set the SUBGROUPING tag to YES to allow class member groups of the same type
     347# (for instance a group of public functions) to be put as a subgroup of that
     348# type (e.g. under the Public Functions section). Set it to NO to prevent
     349# subgrouping. Alternatively, this can be done per class using the
     350# \nosubgrouping command.
     351# The default value is: YES.
    284352
    285353SUBGROUPING            = YES
    286354
    287 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
    288 # unions are shown inside the group in which they are included (e.g. using
    289 # @ingroup) instead of on a separate page (for HTML and Man pages) or
    290 # section (for LaTeX and RTF).
    291 
    292 #INLINE_GROUPED_CLASSES = NO
    293 
    294 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
    295 # unions with only public data fields will be shown inline in the documentation
    296 # of the scope in which they are defined (i.e. file, namespace, or group
    297 # documentation), provided this scope is documented. If set to NO (the default),
    298 # structs, classes, and unions are shown on a separate page (for HTML and Man
    299 # pages) or section (for LaTeX and RTF).
    300 
    301 #INLINE_SIMPLE_STRUCTS  = NO
    302 
    303 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    304 # is documented as struct, union, or enum with the name of the typedef. So
     355# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
     356# are shown inside the group in which they are included (e.g. using \ingroup)
     357# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
     358# and RTF).
     359#
     360# Note that this feature does not work in combination with
     361# SEPARATE_MEMBER_PAGES.
     362# The default value is: NO.
     363
     364INLINE_GROUPED_CLASSES = NO
     365
     366# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
     367# with only public data fields or simple typedef fields will be shown inline in
     368# the documentation of the scope in which they are defined (i.e. file,
     369# namespace, or group documentation), provided this scope is documented. If set
     370# to NO, structs, classes, and unions are shown on a separate page (for HTML and
     371# Man pages) or section (for LaTeX and RTF).
     372# The default value is: NO.
     373
     374INLINE_SIMPLE_STRUCTS  = NO
     375
     376# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
     377# enum is documented as struct, union, or enum with the name of the typedef. So
    305378# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    306379# with name TypeT. When disabled the typedef will appear as a member of a file,
    307 # namespace, or class. And the struct will be named TypeS. This can typically
    308 # be useful for C code in case the coding convention dictates that all compound
     380# namespace, or class. And the struct will be named TypeS. This can typically be
     381# useful for C code in case the coding convention dictates that all compound
    309382# types are typedef'ed and only the typedef is referenced, never the tag name.
     383# The default value is: NO.
    310384
    311385TYPEDEF_HIDES_STRUCT   = NO
    312386
    313 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
    314 # determine which symbols to keep in memory and which to flush to disk.
    315 # When the cache is full, less often used symbols will be written to disk.
    316 # For small to medium size projects (<1000 input files) the default value is
    317 # probably good enough. For larger projects a too small cache size can cause
    318 # doxygen to be busy swapping symbols to and from disk most of the time
    319 # causing a significant performance penalty.
    320 # If the system has enough physical memory increasing the cache will improve the
    321 # performance by keeping more symbols in memory. Note that the value works on
    322 # a logarithmic scale so increasing the size by one will roughly double the
    323 # memory usage. The cache size is given by this formula:
    324 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    325 # corresponding to a cache size of 2^16 = 65536 symbols.
    326 
    327 SYMBOL_CACHE_SIZE      = 0
    328 
    329 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
    330 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
    331 # their name and scope. Since this can be an expensive process and often the
    332 # same symbol appear multiple times in the code, doxygen keeps a cache of
    333 # pre-resolved symbols. If the cache is too small doxygen will become slower.
    334 # If the cache is too large, memory is wasted. The cache size is given by this
    335 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
    336 # corresponding to a cache size of 2^16 = 65536 symbols.
    337 
    338 #LOOKUP_CACHE_SIZE      = 0
     387# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
     388# cache is used to resolve symbols given their name and scope. Since this can be
     389# an expensive process and often the same symbol appears multiple times in the
     390# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
     391# doxygen will become slower. If the cache is too large, memory is wasted. The
     392# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
     393# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
     394# symbols. At the end of a run doxygen will report the cache usage and suggest
     395# the optimal cache size from a speed point of view.
     396# Minimum value: 0, maximum value: 9, default value: 0.
     397
     398LOOKUP_CACHE_SIZE      = 0
    339399
    340400#---------------------------------------------------------------------------
     
    343403
    344404# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    345 # documentation are documented, even if no documentation was available.
    346 # Private class members and static file members will be hidden unless
    347 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     405# documentation are documented, even if no documentation was available. Private
     406# class members and static file members will be hidden unless the
     407# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
     408# Note: This will also disable the warnings about undocumented members that are
     409# normally produced when WARNINGS is set to YES.
     410# The default value is: NO.
    348411
    349412EXTRACT_ALL            = NO
    350413
    351 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    352 # will be included in the documentation.
     414# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
     415# be included in the documentation.
     416# The default value is: NO.
    353417
    354418EXTRACT_PRIVATE        = YES
    355419
    356 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    357 # will be included in the documentation.
     420# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
     421# scope will be included in the documentation.
     422# The default value is: NO.
     423
     424EXTRACT_PACKAGE        = NO
     425
     426# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
     427# included in the documentation.
     428# The default value is: NO.
    358429
    359430EXTRACT_STATIC         = NO
    360431
    361 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    362 # defined locally in source files will be included in the documentation.
    363 # If set to NO only classes defined in header files are included.
     432# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
     433# locally in source files will be included in the documentation. If set to NO
     434# only classes defined in header files are included. Does not have any effect
     435# for Java sources.
     436# The default value is: YES.
    364437
    365438EXTRACT_LOCAL_CLASSES  = YES
    366439
    367 # This flag is only useful for Objective-C code. When set to YES local
    368 # methods, which are defined in the implementation section but not in
    369 # the interface are included in the documentation.
    370 # If set to NO (the default) only methods in the interface are included.
     440# This flag is only useful for Objective-C code. When set to YES local methods,
     441# which are defined in the implementation section but not in the interface are
     442# included in the documentation. If set to NO only methods in the interface are
     443# included.
     444# The default value is: NO.
    371445
    372446EXTRACT_LOCAL_METHODS  = NO
     
    374448# If this flag is set to YES, the members of anonymous namespaces will be
    375449# extracted and appear in the documentation as a namespace called
    376 # 'anonymous_namespace{file}', where file will be replaced with the base
    377 # name of the file that contains the anonymous namespace. By default
    378 # anonymous namespaces are hidden.
     450# 'anonymous_namespace{file}', where file will be replaced with the base name of
     451# the file that contains the anonymous namespace. By default anonymous namespace
     452# are hidden.
     453# The default value is: NO.
    379454
    380455EXTRACT_ANON_NSPACES   = NO
    381456
    382 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    383 # undocumented members of documented classes, files or namespaces.
    384 # If set to NO (the default) these members will be included in the
    385 # various overviews, but no documentation section is generated.
    386 # This option has no effect if EXTRACT_ALL is enabled.
     457# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
     458# undocumented members inside documented classes or files. If set to NO these
     459# members will be included in the various overviews, but no documentation
     460# section is generated. This option has no effect if EXTRACT_ALL is enabled.
     461# The default value is: NO.
    387462
    388463HIDE_UNDOC_MEMBERS     = NO
    389464
    390 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    391 # undocumented classes that are normally visible in the class hierarchy.
    392 # If set to NO (the default) these classes will be included in the various
    393 # overviews. This option has no effect if EXTRACT_ALL is enabled.
     465# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
     466# undocumented classes that are normally visible in the class hierarchy. If set
     467# to NO these classes will be included in the various overviews. This option has
     468# no effect if EXTRACT_ALL is enabled.
     469# The default value is: NO.
    394470
    395471HIDE_UNDOC_CLASSES     = NO
    396472
    397 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    398 # friend (class|struct|union) declarations.
    399 # If set to NO (the default) these declarations will be included in the
    400 # documentation.
     473# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
     474# (class|struct|union) declarations. If set to NO these declarations will be
     475# included in the documentation.
     476# The default value is: NO.
    401477
    402478HIDE_FRIEND_COMPOUNDS  = NO
    403479
    404 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    405 # documentation blocks found inside the body of a function.
    406 # If set to NO (the default) these blocks will be appended to the
    407 # function's detailed documentation block.
     480# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
     481# documentation blocks found inside the body of a function. If set to NO these
     482# blocks will be appended to the function's detailed documentation block.
     483# The default value is: NO.
    408484
    409485HIDE_IN_BODY_DOCS      = NO
    410486
    411 # The INTERNAL_DOCS tag determines if documentation
    412 # that is typed after a \internal command is included. If the tag is set
    413 # to NO (the default) then the documentation will be excluded.
    414 # Set it to YES to include the internal documentation.
     487# The INTERNAL_DOCS tag determines if documentation that is typed after a
     488# \internal command is included. If the tag is set to NO then the documentation
     489# will be excluded. Set it to YES to include the internal documentation.
     490# The default value is: NO.
    415491
    416492INTERNAL_DOCS          = NO
    417493
    418 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    419 # file names in lower-case letters. If set to YES upper-case letters are also
     494# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
     495# names in lower-case letters. If set to YES upper-case letters are also
    420496# allowed. This is useful if you have classes or files whose names only differ
    421497# in case and if your file system supports case sensitive file names. Windows
    422498# and Mac users are advised to set this option to NO.
     499# The default value is: system dependent.
    423500
    424501CASE_SENSE_NAMES       = YES
    425502
    426 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    427 # will show members with their full class and namespace scopes in the
    428 # documentation. If set to YES the scope will be hidden.
     503# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
     504# their full class and namespace scopes in the documentation. If set to YES the
     505# scope will be hidden.
     506# The default value is: NO.
    429507
    430508HIDE_SCOPE_NAMES       = NO
    431509
    432 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    433 # will put a list of the files that are included by a file in the documentation
    434 # of that file.
     510# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
     511# the files that are included by a file in the documentation of that file.
     512# The default value is: YES.
    435513
    436514SHOW_INCLUDE_FILES     = YES
    437515
    438 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
    439 # will list include files with double quotes in the documentation
    440 # rather than with sharp brackets.
     516# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
     517# grouped member an include statement to the documentation, telling the reader
     518# which file to include in order to use the member.
     519# The default value is: NO.
     520
     521SHOW_GROUPED_MEMB_INC  = NO
     522
     523# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
     524# files with double quotes in the documentation rather than with sharp brackets.
     525# The default value is: NO.
    441526
    442527FORCE_LOCAL_INCLUDES   = NO
    443528
    444 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    445 # is inserted in the documentation for inline members.
     529# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
     530# documentation for inline members.
     531# The default value is: YES.
    446532
    447533INLINE_INFO            = YES
    448534
    449 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    450 # will sort the (detailed) documentation of file and class members
    451 # alphabetically by member name. If set to NO the members will appear in
    452 # declaration order.
     535# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
     536# (detailed) documentation of file and class members alphabetically by member
     537# name. If set to NO the members will appear in declaration order.
     538# The default value is: YES.
    453539
    454540SORT_MEMBER_DOCS       = YES
    455541
    456 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
    457 # brief documentation of file, namespace and class members alphabetically
    458 # by member name. If set to NO (the default) the members will appear in
    459 # declaration order.
     542# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
     543# descriptions of file, namespace and class members alphabetically by member
     544# name. If set to NO the members will appear in declaration order. Note that
     545# this will also influence the order of the classes in the class list.
     546# The default value is: NO.
    460547
    461548SORT_BRIEF_DOCS        = NO
    462549
    463 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
    464 # will sort the (brief and detailed) documentation of class members so that
    465 # constructors and destructors are listed first. If set to NO (the default)
    466 # the constructors will appear in the respective orders defined by
    467 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
    468 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
    469 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     550# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
     551# (brief and detailed) documentation of class members so that constructors and
     552# destructors are listed first. If set to NO the constructors will appear in the
     553# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
     554# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
     555# member documentation.
     556# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
     557# detailed member documentation.
     558# The default value is: NO.
    470559
    471560SORT_MEMBERS_CTORS_1ST = NO
    472561
    473 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
    474 # hierarchy of group names into alphabetical order. If set to NO (the default)
    475 # the group names will appear in their defined order.
     562# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
     563# of group names into alphabetical order. If set to NO the group names will
     564# appear in their defined order.
     565# The default value is: NO.
    476566
    477567SORT_GROUP_NAMES       = NO
    478568
    479 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    480 # sorted by fully-qualified names, including namespaces. If set to
    481 # NO (the default), the class list will be sorted only by class name,
    482 # not including the namespace part.
     569# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
     570# fully-qualified names, including namespaces. If set to NO, the class list will
     571# be sorted only by class name, not including the namespace part.
    483572# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    484 # Note: This option applies only to the class list, not to the
    485 # alphabetical list.
     573# Note: This option applies only to the class list, not to the alphabetical
     574# list.
     575# The default value is: NO.
    486576
    487577SORT_BY_SCOPE_NAME     = NO
    488578
    489 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
    490 # do proper type resolution of all parameters of a function it will reject a
    491 # match between the prototype and the implementation of a member function even
    492 # if there is only one candidate or it is obvious which candidate to choose
    493 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
    494 # will still accept a match between prototype and implementation in such cases.
    495 
    496 #STRICT_PROTO_MATCHING  = NO
    497 
    498 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    499 # disable (NO) the todo list. This list is created by putting \todo
    500 # commands in the documentation.
     579# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
     580# type resolution of all parameters of a function it will reject a match between
     581# the prototype and the implementation of a member function even if there is
     582# only one candidate or it is obvious which candidate to choose by doing a
     583# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
     584# accept a match between prototype and implementation in such cases.
     585# The default value is: NO.
     586
     587STRICT_PROTO_MATCHING  = NO
     588
     589# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
     590# todo list. This list is created by putting \todo commands in the
     591# documentation.
     592# The default value is: YES.
    501593
    502594GENERATE_TODOLIST      = YES
    503595
    504 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    505 # disable (NO) the test list. This list is created by putting \test
    506 # commands in the documentation.
     596# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
     597# test list. This list is created by putting \test commands in the
     598# documentation.
     599# The default value is: YES.
    507600
    508601GENERATE_TESTLIST      = YES
    509602
    510 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    511 # disable (NO) the bug list. This list is created by putting \bug
    512 # commands in the documentation.
     603# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
     604# list. This list is created by putting \bug commands in the documentation.
     605# The default value is: YES.
    513606
    514607GENERATE_BUGLIST       = YES
    515608
    516 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    517 # disable (NO) the deprecated list. This list is created by putting
    518 # \deprecated commands in the documentation.
     609# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
     610# the deprecated list. This list is created by putting \deprecated commands in
     611# the documentation.
     612# The default value is: YES.
    519613
    520614GENERATE_DEPRECATEDLIST= YES
    521615
    522 # The ENABLED_SECTIONS tag can be used to enable conditional
    523 # documentation sections, marked by \if sectionname ... \endif.
     616# The ENABLED_SECTIONS tag can be used to enable conditional documentation
     617# sections, marked by \if <section_label> ... \endif and \cond <section_label>
     618# ... \endcond blocks.
    524619
    525620ENABLED_SECTIONS       =
    526621
    527 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    528 # the initial value of a variable or macro consists of for it to appear in
    529 # the documentation. If the initializer consists of more lines than specified
    530 # here it will be hidden. Use a value of 0 to hide initializers completely.
    531 # The appearance of the initializer of individual variables and macros in the
    532 # documentation can be controlled using \showinitializer or \hideinitializer
    533 # command in the documentation regardless of this setting.
     622# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
     623# initial value of a variable or macro / define can have for it to appear in the
     624# documentation. If the initializer consists of more lines than specified here
     625# it will be hidden. Use a value of 0 to hide initializers completely. The
     626# appearance of the value of individual variables and macros / defines can be
     627# controlled using \showinitializer or \hideinitializer command in the
     628# documentation regardless of this setting.
     629# Minimum value: 0, maximum value: 10000, default value: 30.
    534630
    535631MAX_INITIALIZER_LINES  = 30
    536632
    537 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    538 # at the bottom of the documentation of classes and structs. If set to YES the
    539 # list will mention the files that were used to generate the documentation.
     633# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
     634# the bottom of the documentation of classes and structs. If set to YES the list
     635# will mention the files that were used to generate the documentation.
     636# The default value is: YES.
    540637
    541638SHOW_USED_FILES        = YES
    542639
    543 # If the sources in your project are distributed over multiple directories
    544 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    545 # in the documentation. The default is NO.
    546 
    547 SHOW_DIRECTORIES       = NO
    548 
    549 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    550 # This will remove the Files entry from the Quick Index and from the
    551 # Folder Tree View (if specified). The default is YES.
     640# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
     641# will remove the Files entry from the Quick Index and from the Folder Tree View
     642# (if specified).
     643# The default value is: YES.
    552644
    553645SHOW_FILES             = YES
    554646
    555 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    556 # Namespaces page.
    557 # This will remove the Namespaces entry from the Quick Index
    558 # and from the Folder Tree View (if specified). The default is YES.
     647# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
     648# page. This will remove the Namespaces entry from the Quick Index and from the
     649# Folder Tree View (if specified).
     650# The default value is: YES.
    559651
    560652SHOW_NAMESPACES        = YES
     
    563655# doxygen should invoke to get the current version for each file (typically from
    564656# the version control system). Doxygen will invoke the program by executing (via
    565 # popen()) the command <command> <input-file>, where <command> is the value of
    566 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    567 # provided by doxygen. Whatever the program writes to standard output
    568 # is used as the file version. See the manual for examples.
     657# popen()) the command command input-file, where command is the value of the
     658# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
     659# by doxygen. Whatever the program writes to standard output is used as the file
     660# version. For an example see the documentation.
    569661
    570662FILE_VERSION_FILTER    =
     
    572664# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
    573665# by doxygen. The layout file controls the global structure of the generated
    574 # output files in an output format independent way. The create the layout file
    575 # that represents doxygen's defaults, run doxygen with the -l option.
    576 # You can optionally specify a file name after the option, if omitted
    577 # DoxygenLayout.xml will be used as the name of the layout file.
     666# output files in an output format independent way. To create the layout file
     667# that represents doxygen's defaults, run doxygen with the -l option. You can
     668# optionally specify a file name after the option, if omitted DoxygenLayout.xml
     669# will be used as the name of the layout file.
     670#
     671# Note that if you run doxygen from a directory containing a file called
     672# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
     673# tag is left empty.
    578674
    579675LAYOUT_FILE            =
    580676
    581 # The CITE_BIB_FILES tag can be used to specify one or more bib files
    582 # containing the references data. This must be a list of .bib files. The
    583 # .bib extension is automatically appended if omitted. Using this command
    584 # requires the bibtex tool to be installed. See also
    585 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
    586 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
    587 # feature you need bibtex and perl available in the search path.
    588 
    589 #CITE_BIB_FILES         =
    590 
    591 #---------------------------------------------------------------------------
    592 # configuration options related to warning and progress messages
    593 #---------------------------------------------------------------------------
    594 
    595 # The QUIET tag can be used to turn on/off the messages that are generated
    596 # by doxygen. Possible values are YES and NO. If left blank NO is used.
     677# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
     678# the reference definitions. This must be a list of .bib files. The .bib
     679# extension is automatically appended if omitted. This requires the bibtex tool
     680# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
     681# For LaTeX the style of the bibliography can be controlled using
     682# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
     683# search path. See also \cite for info how to create references.
     684
     685CITE_BIB_FILES         =
     686
     687#---------------------------------------------------------------------------
     688# Configuration options related to warning and progress messages
     689#---------------------------------------------------------------------------
     690
     691# The QUIET tag can be used to turn on/off the messages that are generated to
     692# standard output by doxygen. If QUIET is set to YES this implies that the
     693# messages are off.
     694# The default value is: NO.
    597695
    598696QUIET                  = YES
    599697
    600698# The WARNINGS tag can be used to turn on/off the warning messages that are
    601 # generated by doxygen. Possible values are YES and NO. If left blank
    602 # NO is used.
     699# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
     700# this implies that the warnings are on.
     701#
     702# Tip: Turn warnings on while writing the documentation.
     703# The default value is: YES.
    603704
    604705WARNINGS               = YES
    605706
    606 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    607 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    608 # automatically be disabled.
     707# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
     708# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
     709# will automatically be disabled.
     710# The default value is: YES.
    609711
    610712WARN_IF_UNDOCUMENTED   = YES
    611713
    612 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    613 # potential errors in the documentation, such as not documenting some
    614 # parameters in a documented function, or documenting parameters that
    615 # don't exist or using markup commands wrongly.
     714# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
     715# potential errors in the documentation, such as not documenting some parameters
     716# in a documented function, or documenting parameters that don't exist or using
     717# markup commands wrongly.
     718# The default value is: YES.
    616719
    617720WARN_IF_DOC_ERROR      = YES
    618721
    619 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
    620 # functions that are documented, but have no documentation for their parameters
    621 # or return value. If set to NO (the default) doxygen will only warn about
    622 # wrong or incomplete parameter documentation, but not about the absence of
    623 # documentation.
     722# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
     723# are documented, but have no documentation for their parameters or return
     724# value. If set to NO doxygen will only warn about wrong or incomplete parameter
     725# documentation, but not about the absence of documentation.
     726# The default value is: NO.
    624727
    625728WARN_NO_PARAMDOC       = NO
    626729
    627 # The WARN_FORMAT tag determines the format of the warning messages that
    628 # doxygen can produce. The string should contain the $file, $line, and $text
    629 # tags, which will be replaced by the file and line number from which the
    630 # warning originated and the warning text. Optionally the format may contain
    631 # $version, which will be replaced by the version of the file (if it could
    632 # be obtained via FILE_VERSION_FILTER)
     730# The WARN_FORMAT tag determines the format of the warning messages that doxygen
     731# can produce. The string should contain the $file, $line, and $text tags, which
     732# will be replaced by the file and line number from which the warning originated
     733# and the warning text. Optionally the format may contain $version, which will
     734# be replaced by the version of the file (if it could be obtained via
     735# FILE_VERSION_FILTER)
     736# The default value is: $file:$line: $text.
    633737
    634738WARN_FORMAT            = "$file:$line: $text"
    635739
    636 # The WARN_LOGFILE tag can be used to specify a file to which warning
    637 # and error messages should be written. If left blank the output is written
    638 # to stderr.
     740# The WARN_LOGFILE tag can be used to specify a file to which warning and error
     741# messages should be written. If left blank the output is written to standard
     742# error (stderr).
    639743
    640744WARN_LOGFILE           =
    641745
    642746#---------------------------------------------------------------------------
    643 # configuration options related to the input files
    644 #---------------------------------------------------------------------------
    645 
    646 # The INPUT tag can be used to specify the files and/or directories that contain
    647 # documented source files. You may enter file names like "myfile.cpp" or
    648 # directories like "/usr/src/myproject". Separate the files or directories
    649 # with spaces.
    650 
    651 INPUT                  =  overview.dox ../src/mlx ../src/mlx/gui
     747# Configuration options related to the input files
     748#---------------------------------------------------------------------------
     749
     750# The INPUT tag is used to specify the files and/or directories that contain
     751# documented source files. You may enter file names like myfile.cpp or
     752# directories like /usr/src/myproject. Separate the files or directories with
     753# spaces.
     754# Note: If this tag is empty the current directory is searched.
     755
     756INPUT                  = overview.dox \
     757                         ../src/mlx \
     758                         ../src/mlx/gui
    652759
    653760# This tag can be used to specify the character encoding of the source files
    654 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    655 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    656 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    657 # the list of possible encodings.
     761# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
     762# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
     763# documentation (see: http://www.gnu.org/software/libiconv) for the list of
     764# possible encodings.
     765# The default value is: UTF-8.
    658766
    659767INPUT_ENCODING         = UTF-8
    660768
    661769# If the value of the INPUT tag contains directories, you can use the
    662 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    663 # and *.h) to filter out the source-files in the directories. If left
    664 # blank the following patterns are tested:
    665 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
    666 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
    667 # *.f90 *.f *.for *.vhd *.vhdl
     770# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
     771# *.h) to filter out the source-files in the directories. If left blank the
     772# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
     773# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
     774# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
     775# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
     776# *.qsf, *.as and *.js.
    668777
    669778FILE_PATTERNS          = *.py
    670779
    671 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    672 # should be searched for input files as well. Possible values are YES and NO.
    673 # If left blank NO is used.
     780# The RECURSIVE tag can be used to specify whether or not subdirectories should
     781# be searched for input files as well.
     782# The default value is: NO.
    674783
    675784RECURSIVE              = NO
     
    678787# excluded from the INPUT source files. This way you can easily exclude a
    679788# subdirectory from a directory tree whose root is specified with the INPUT tag.
     789#
    680790# Note that relative paths are relative to the directory from which doxygen is
    681791# run.
     
    686796# directories that are symbolic links (a Unix file system feature) are excluded
    687797# from the input.
     798# The default value is: NO.
    688799
    689800EXCLUDE_SYMLINKS       = NO
     
    691802# If the value of the INPUT tag contains directories, you can use the
    692803# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    693 # certain files from those directories. Note that the wildcards are matched
    694 # against the file with absolute path, so to exclude all test directories
    695 # for example use the pattern */test/*
     804# certain files from those directories.
     805#
     806# Note that the wildcards are matched against the file with absolute path, so to
     807# exclude all test directories for example use the pattern */test/*
    696808
    697809EXCLUDE_PATTERNS       =
     
    702814# wildcard * is used, a substring. Examples: ANamespace, AClass,
    703815# AClass::ANamespace, ANamespace::*Test
     816#
     817# Note that the wildcards are matched against the file with absolute path, so to
     818# exclude all test directories use the pattern */test/*
    704819
    705820EXCLUDE_SYMBOLS        =
    706821
    707 # The EXAMPLE_PATH tag can be used to specify one or more files or
    708 # directories that contain example code fragments that are included (see
    709 # the \include command).
     822# The EXAMPLE_PATH tag can be used to specify one or more files or directories
     823# that contain example code fragments that are included (see the \include
     824# command).
    710825
    711826EXAMPLE_PATH           =
    712827
    713828# If the value of the EXAMPLE_PATH tag contains directories, you can use the
    714 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    715 # and *.h) to filter out the source-files in the directories. If left
    716 # blank all files are included.
     829# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
     830# *.h) to filter out the source-files in the directories. If left blank all
     831# files are included.
    717832
    718833EXAMPLE_PATTERNS       =
    719834
    720835# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
    721 # searched for input files to be used with the \include or \dontinclude
    722 # commands irrespective of the value of the RECURSIVE tag.
    723 # Possible values are YES and NO. If left blank NO is used.
     836# searched for input files to be used with the \include or \dontinclude commands
     837# irrespective of the value of the RECURSIVE tag.
     838# The default value is: NO.
    724839
    725840EXAMPLE_RECURSIVE      = NO
    726841
    727 # The IMAGE_PATH tag can be used to specify one or more files or
    728 # directories that contain image that are included in the documentation (see
    729 # the \image command).
     842# The IMAGE_PATH tag can be used to specify one or more files or directories
     843# that contain images that are to be included in the documentation (see the
     844# \image command).
    730845
    731846IMAGE_PATH             =
     
    733848# The INPUT_FILTER tag can be used to specify a program that doxygen should
    734849# invoke to filter for each input file. Doxygen will invoke the filter program
    735 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    736 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    737 # input file. Doxygen will then use the output that the filter program writes
    738 # to standard output.
    739 # If FILTER_PATTERNS is specified, this tag will be
    740 # ignored.
     850# by executing (via popen()) the command:
     851#
     852# <filter> <input-file>
     853#
     854# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
     855# name of an input file. Doxygen will then use the output that the filter
     856# program writes to standard output. If FILTER_PATTERNS is specified, this tag
     857# will be ignored.
     858#
     859# Note that the filter must not add or remove lines; it is applied before the
     860# code is scanned, but not when the output code is generated. If lines are added
     861# or removed, the anchors will not be placed correctly.
    741862
    742863INPUT_FILTER           =
    743864
    744865# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    745 # basis.
    746 # Doxygen will compare the file name with each pattern and apply the
    747 # filter if there is a match.
    748 # The filters are a list of the form:
    749 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    750 # info on how filters are used. If FILTER_PATTERNS is empty or if
    751 # non of the patterns match the file name, INPUT_FILTER is applied.
     866# basis. Doxygen will compare the file name with each pattern and apply the
     867# filter if there is a match. The filters are a list of the form: pattern=filter
     868# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
     869# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
     870# patterns match the file name, INPUT_FILTER is applied.
    752871
    753872FILTER_PATTERNS        =
    754873
    755874# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    756 # INPUT_FILTER) will be used to filter the input files when producing source
    757 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
     875# INPUT_FILTER ) will also be used to filter the input files that are used for
     876# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
     877# The default value is: NO.
    758878
    759879FILTER_SOURCE_FILES    = NO
    760880
    761881# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
    762 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
    763 # and it is also possible to disable source filtering for a specific pattern
    764 # using *.ext= (so without naming a filter). This option only has effect when
    765 # FILTER_SOURCE_FILES is enabled.
    766 
    767 #FILTER_SOURCE_PATTERNS =
    768 
    769 #---------------------------------------------------------------------------
    770 # configuration options related to source browsing
    771 #---------------------------------------------------------------------------
    772 
    773 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    774 # be generated. Documented entities will be cross-referenced with these sources.
    775 # Note: To get rid of all source code in the generated output, make sure also
    776 # VERBATIM_HEADERS is set to NO.
     882# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
     883# it is also possible to disable source filtering for a specific pattern using
     884# *.ext= (so without naming a filter).
     885# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
     886
     887FILTER_SOURCE_PATTERNS =
     888
     889# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
     890# is part of the input, its contents will be placed on the main page
     891# (index.html). This can be useful if you have a project on for instance GitHub
     892# and want to reuse the introduction page also for the doxygen output.
     893
     894USE_MDFILE_AS_MAINPAGE =
     895
     896#---------------------------------------------------------------------------
     897# Configuration options related to source browsing
     898#---------------------------------------------------------------------------
     899
     900# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
     901# generated. Documented entities will be cross-referenced with these sources.
     902#
     903# Note: To get rid of all source code in the generated output, make sure that
     904# also VERBATIM_HEADERS is set to NO.
     905# The default value is: NO.
    777906
    778907SOURCE_BROWSER         = YES
    779908
    780 # Setting the INLINE_SOURCES tag to YES will include the body
    781 # of functions and classes directly in the documentation.
     909# Setting the INLINE_SOURCES tag to YES will include the body of functions,
     910# classes and enums directly into the documentation.
     911# The default value is: NO.
    782912
    783913INLINE_SOURCES         = NO
    784914
    785 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    786 # doxygen to hide any special comment blocks from generated source code
    787 # fragments. Normal C and C++ comments will always remain visible.
     915# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
     916# special comment blocks from generated source code fragments. Normal C, C++ and
     917# Fortran comments will always remain visible.
     918# The default value is: YES.
    788919
    789920STRIP_CODE_COMMENTS    = YES
    790921
    791 # If the REFERENCED_BY_RELATION tag is set to YES
    792 # then for each documented function all documented
    793 # functions referencing it will be listed.
     922# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
     923# function all documented functions referencing it will be listed.
     924# The default value is: NO.
    794925
    795926REFERENCED_BY_RELATION = NO
    796927
    797 # If the REFERENCES_RELATION tag is set to YES
    798 # then for each documented function all documented entities
    799 # called/used by that function will be listed.
     928# If the REFERENCES_RELATION tag is set to YES then for each documented function
     929# all documented entities called/used by that function will be listed.
     930# The default value is: NO.
    800931
    801932REFERENCES_RELATION    = NO
    802933
    803 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    804 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    805 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    806 # link to the source code.
    807 # Otherwise they will link to the documentation.
     934# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
     935# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
     936# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
     937# link to the documentation.
     938# The default value is: YES.
    808939
    809940REFERENCES_LINK_SOURCE = YES
    810941
    811 # If the USE_HTAGS tag is set to YES then the references to source code
    812 # will point to the HTML generated by the htags(1) tool instead of doxygen
    813 # built-in source browser. The htags tool is part of GNU's global source
    814 # tagging system (see http://www.gnu.org/software/global/global.html). You
    815 # will need version 4.8.6 or higher.
     942# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
     943# source code will show a tooltip with additional information such as prototype,
     944# brief description and links to the definition and documentation. Since this
     945# will make the HTML file larger and loading of large files a bit slower, you
     946# can opt to disable this feature.
     947# The default value is: YES.
     948# This tag requires that the tag SOURCE_BROWSER is set to YES.
     949
     950SOURCE_TOOLTIPS        = YES
     951
     952# If the USE_HTAGS tag is set to YES then the references to source code will
     953# point to the HTML generated by the htags(1) tool instead of doxygen built-in
     954# source browser. The htags tool is part of GNU's global source tagging system
     955# (see http://www.gnu.org/software/global/global.html). You will need version
     956# 4.8.6 or higher.
     957#
     958# To use it do the following:
     959# - Install the latest version of global
     960# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
     961# - Make sure the INPUT points to the root of the source tree
     962# - Run doxygen as normal
     963#
     964# Doxygen will invoke htags (and that will in turn invoke gtags), so these
     965# tools must be available from the command line (i.e. in the search path).
     966#
     967# The result: instead of the source browser generated by doxygen, the links to
     968# source code will now point to the output of htags.
     969# The default value is: NO.
     970# This tag requires that the tag SOURCE_BROWSER is set to YES.
    816971
    817972USE_HTAGS              = NO
    818973
    819 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    820 # will generate a verbatim copy of the header file for each class for
    821 # which an include is specified. Set to NO to disable this.
     974# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
     975# verbatim copy of the header file for each class for which an include is
     976# specified. Set to NO to disable this.
     977# See also: Section \class.
     978# The default value is: YES.
    822979
    823980VERBATIM_HEADERS       = YES
    824981
    825 #---------------------------------------------------------------------------
    826 # configuration options related to the alphabetical class index
    827 #---------------------------------------------------------------------------
    828 
    829 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
    830 # of all compounds will be generated. Enable this if the project
    831 # contains a lot of classes, structs, unions or interfaces.
     982# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
     983# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
     984# cost of reduced performance. This can be particularly helpful with template
     985# rich C++ code for which doxygen's built-in parser lacks the necessary type
     986# information.
     987# Note: The availability of this option depends on whether or not doxygen was
     988# compiled with the --with-libclang option.
     989# The default value is: NO.
     990
     991CLANG_ASSISTED_PARSING = NO
     992
     993# If clang assisted parsing is enabled you can provide the compiler with command
     994# line options that you would normally use when invoking the compiler. Note that
     995# the include paths will already be set by doxygen for the files and directories
     996# specified with INPUT and INCLUDE_PATH.
     997# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
     998
     999CLANG_OPTIONS          =
     1000
     1001#---------------------------------------------------------------------------
     1002# Configuration options related to the alphabetical class index
     1003#---------------------------------------------------------------------------
     1004
     1005# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
     1006# compounds will be generated. Enable this if the project contains a lot of
     1007# classes, structs, unions or interfaces.
     1008# The default value is: YES.
    8321009
    8331010ALPHABETICAL_INDEX     = YES
    8341011
    835 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
    836 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    837 # in which this list will be split (can be a number in the range [1..20])
     1012# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
     1013# which the alphabetical index list will be split.
     1014# Minimum value: 1, maximum value: 20, default value: 5.
     1015# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    8381016
    8391017COLS_IN_ALPHA_INDEX    = 5
    8401018
    841 # In case all classes in a project start with a common prefix, all
    842 # classes will be put under the same header in the alphabetical index.
    843 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    844 # should be ignored while generating the index headers.
     1019# In case all classes in a project start with a common prefix, all classes will
     1020# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
     1021# can be used to specify a prefix (or a list of prefixes) that should be ignored
     1022# while generating the index headers.
     1023# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    8451024
    8461025IGNORE_PREFIX          =
    8471026
    8481027#---------------------------------------------------------------------------
    849 # configuration options related to the HTML output
    850 #---------------------------------------------------------------------------
    851 
    852 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    853 # generate HTML output.
     1028# Configuration options related to the HTML output
     1029#---------------------------------------------------------------------------
     1030
     1031# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
     1032# The default value is: YES.
    8541033
    8551034GENERATE_HTML          = YES
    8561035
    857 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
    858 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    859 # put in front of it. If left blank `html' will be used as the default path.
     1036# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
     1037# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1038# it.
     1039# The default directory is: html.
     1040# This tag requires that the tag GENERATE_HTML is set to YES.
    8601041
    8611042HTML_OUTPUT            = html
    8621043
    863 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
    864 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    865 # doxygen will generate files with .html extension.
     1044# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
     1045# generated HTML page (for example: .htm, .php, .asp).
     1046# The default value is: .html.
     1047# This tag requires that the tag GENERATE_HTML is set to YES.
    8661048
    8671049HTML_FILE_EXTENSION    = .html
    8681050
    869 # The HTML_HEADER tag can be used to specify a personal HTML header for
    870 # each generated HTML page. If it is left blank doxygen will generate a
    871 # standard header. Note that when using a custom header you are responsible
    872 #  for the proper inclusion of any scripts and style sheets that doxygen
    873 # needs, which is dependent on the configuration options used.
    874 # It is advised to generate a default header using "doxygen -w html
    875 # header.html footer.html stylesheet.css YourConfigFile" and then modify
    876 # that header. Note that the header is subject to change so you typically
    877 # have to redo this when upgrading to a newer version of doxygen or when
    878 # changing the value of configuration settings such as GENERATE_TREEVIEW!
     1051# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
     1052# each generated HTML page. If the tag is left blank doxygen will generate a
     1053# standard header.
     1054#
     1055# To get valid HTML the header file that includes any scripts and style sheets
     1056# that doxygen needs, which is dependent on the configuration options used (e.g.
     1057# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
     1058# default header using
     1059# doxygen -w html new_header.html new_footer.html new_stylesheet.css
     1060# YourConfigFile
     1061# and then modify the file new_header.html. See also section "Doxygen usage"
     1062# for information on how to generate the default header that doxygen normally
     1063# uses.
     1064# Note: The header is subject to change so you typically have to regenerate the
     1065# default header when upgrading to a newer version of doxygen. For a description
     1066# of the possible markers and block names see the documentation.
     1067# This tag requires that the tag GENERATE_HTML is set to YES.
    8791068
    8801069HTML_HEADER            =
    8811070
    882 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    883 # each generated HTML page. If it is left blank doxygen will generate a
    884 # standard footer.
     1071# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
     1072# generated HTML page. If the tag is left blank doxygen will generate a standard
     1073# footer. See HTML_HEADER for more information on how to generate a default
     1074# footer and what special commands can be used inside the footer. See also
     1075# section "Doxygen usage" for information on how to generate the default footer
     1076# that doxygen normally uses.
     1077# This tag requires that the tag GENERATE_HTML is set to YES.
    8851078
    8861079HTML_FOOTER            =
    8871080
    888 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    889 # style sheet that is used by each HTML page. It can be used to
    890 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    891 # will generate a default style sheet. Note that doxygen will try to copy
    892 # the style sheet file to the HTML output directory, so don't put your own
    893 # style sheet in the HTML output directory as well, or it will be erased!
     1081# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
     1082# sheet that is used by each HTML page. It can be used to fine-tune the look of
     1083# the HTML output. If left blank doxygen will generate a default style sheet.
     1084# See also section "Doxygen usage" for information on how to generate the style
     1085# sheet that doxygen normally uses.
     1086# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
     1087# it is more robust and this tag (HTML_STYLESHEET) will in the future become
     1088# obsolete.
     1089# This tag requires that the tag GENERATE_HTML is set to YES.
    8941090
    8951091HTML_STYLESHEET        =
     1092
     1093# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
     1094# cascading style sheets that are included after the standard style sheets
     1095# created by doxygen. Using this option one can overrule certain style aspects.
     1096# This is preferred over using HTML_STYLESHEET since it does not replace the
     1097# standard style sheet and is therefor more robust against future updates.
     1098# Doxygen will copy the style sheet files to the output directory.
     1099# Note: The order of the extra stylesheet files is of importance (e.g. the last
     1100# stylesheet in the list overrules the setting of the previous ones in the
     1101# list). For an example see the documentation.
     1102# This tag requires that the tag GENERATE_HTML is set to YES.
     1103
     1104HTML_EXTRA_STYLESHEET  =
    8961105
    8971106# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
    8981107# other source files which should be copied to the HTML output directory. Note
    8991108# that these files will be copied to the base HTML output directory. Use the
    900 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
    901 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
    902 # the files will be copied as-is; there are no commands or markers available.
    903 
    904 #HTML_EXTRA_FILES       =
    905 
    906 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
    907 # Doxygen will adjust the colors in the style sheet and background images
    908 # according to this color. Hue is specified as an angle on a colorwheel,
    909 # see http://en.wikipedia.org/wiki/Hue for more information.
    910 # For instance the value 0 represents red, 60 is yellow, 120 is green,
    911 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
    912 # The allowed range is 0 to 359.
    913 
    914 #HTML_COLORSTYLE_HUE    = 220
    915 
    916 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
    917 # the colors in the HTML output. For a value of 0 the output will use
    918 # grayscales only. A value of 255 will produce the most vivid colors.
    919 
    920 #HTML_COLORSTYLE_SAT    = 100
    921 
    922 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
    923 # the luminance component of the colors in the HTML output. Values below
    924 # 100 gradually make the output lighter, whereas values above 100 make
    925 # the output darker. The value divided by 100 is the actual gamma applied,
    926 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
    927 # and 100 does not change the gamma.
    928 
    929 #HTML_COLORSTYLE_GAMMA  = 80
     1109# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     1110# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
     1111# files will be copied as-is; there are no commands or markers available.
     1112# This tag requires that the tag GENERATE_HTML is set to YES.
     1113
     1114HTML_EXTRA_FILES       =
     1115
     1116# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
     1117# will adjust the colors in the stylesheet and background images according to
     1118# this color. Hue is specified as an angle on a colorwheel, see
     1119# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
     1120# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
     1121# purple, and 360 is red again.
     1122# Minimum value: 0, maximum value: 359, default value: 220.
     1123# This tag requires that the tag GENERATE_HTML is set to YES.
     1124
     1125HTML_COLORSTYLE_HUE    = 220
     1126
     1127# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
     1128# in the HTML output. For a value of 0 the output will use grayscales only. A
     1129# value of 255 will produce the most vivid colors.
     1130# Minimum value: 0, maximum value: 255, default value: 100.
     1131# This tag requires that the tag GENERATE_HTML is set to YES.
     1132
     1133HTML_COLORSTYLE_SAT    = 100
     1134
     1135# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
     1136# luminance component of the colors in the HTML output. Values below 100
     1137# gradually make the output lighter, whereas values above 100 make the output
     1138# darker. The value divided by 100 is the actual gamma applied, so 80 represents
     1139# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
     1140# change the gamma.
     1141# Minimum value: 40, maximum value: 240, default value: 80.
     1142# This tag requires that the tag GENERATE_HTML is set to YES.
     1143
     1144HTML_COLORSTYLE_GAMMA  = 80
    9301145
    9311146# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
    932 # page will contain the date and time when the page was generated. Setting
    933 # this to NO can help when comparing the output of multiple runs.
     1147# page will contain the date and time when the page was generated. Setting this
     1148# to NO can help when comparing the output of multiple runs.
     1149# The default value is: YES.
     1150# This tag requires that the tag GENERATE_HTML is set to YES.
    9341151
    9351152HTML_TIMESTAMP         = YES
    936 
    937 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    938 # files or namespaces will be aligned in HTML using tables. If set to
    939 # NO a bullet list will be used.
    940 
    941 HTML_ALIGN_MEMBERS     = YES
    9421153
    9431154# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    9441155# documentation will contain sections that can be hidden and shown after the
    945 # page has loaded. For this to work a browser that supports
    946 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    947 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     1156# page has loaded.
     1157# The default value is: NO.
     1158# This tag requires that the tag GENERATE_HTML is set to YES.
    9481159
    9491160HTML_DYNAMIC_SECTIONS  = NO
    9501161
    951 # If the GENERATE_DOCSET tag is set to YES, additional index files
    952 # will be generated that can be used as input for Apple's Xcode 3
    953 # integrated development environment, introduced with OSX 10.5 (Leopard).
    954 # To create a documentation set, doxygen will generate a Makefile in the
    955 # HTML output directory. Running make will produce the docset in that
    956 # directory and running "make install" will install the docset in
    957 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    958 # it at startup.
    959 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1162# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
     1163# shown in the various tree structured indices initially; the user can expand
     1164# and collapse entries dynamically later on. Doxygen will expand the tree to
     1165# such a level that at most the specified number of entries are visible (unless
     1166# a fully collapsed tree already exceeds this amount). So setting the number of
     1167# entries 1 will produce a full collapsed tree by default. 0 is a special value
     1168# representing an infinite number of entries and will result in a full expanded
     1169# tree by default.
     1170# Minimum value: 0, maximum value: 9999, default value: 100.
     1171# This tag requires that the tag GENERATE_HTML is set to YES.
     1172
     1173HTML_INDEX_NUM_ENTRIES = 100
     1174
     1175# If the GENERATE_DOCSET tag is set to YES, additional index files will be
     1176# generated that can be used as input for Apple's Xcode 3 integrated development
     1177# environment (see: http://developer.apple.com/tools/xcode/), introduced with
     1178# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
     1179# Makefile in the HTML output directory. Running make will produce the docset in
     1180# that directory and running make install will install the docset in
     1181# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
     1182# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
    9601183# for more information.
     1184# The default value is: NO.
     1185# This tag requires that the tag GENERATE_HTML is set to YES.
    9611186
    9621187GENERATE_DOCSET        = NO
    9631188
    964 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    965 # feed. A documentation feed provides an umbrella under which multiple
    966 # documentation sets from a single provider (such as a company or product suite)
    967 # can be grouped.
     1189# This tag determines the name of the docset feed. A documentation feed provides
     1190# an umbrella under which multiple documentation sets from a single provider
     1191# (such as a company or product suite) can be grouped.
     1192# The default value is: Doxygen generated docs.
     1193# This tag requires that the tag GENERATE_DOCSET is set to YES.
    9681194
    9691195DOCSET_FEEDNAME        = "Doxygen generated docs"
    9701196
    971 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    972 # should uniquely identify the documentation set bundle. This should be a
    973 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    974 # will append .docset to the name.
     1197# This tag specifies a string that should uniquely identify the documentation
     1198# set bundle. This should be a reverse domain-name style string, e.g.
     1199# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
     1200# The default value is: org.doxygen.Project.
     1201# This tag requires that the tag GENERATE_DOCSET is set to YES.
    9751202
    9761203DOCSET_BUNDLE_ID       = org.doxygen.Project
    9771204
    978 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
     1205# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
    9791206# the documentation publisher. This should be a reverse domain-name style
    9801207# string, e.g. com.mycompany.MyDocSet.documentation.
    981 
    982 #DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
    983 
    984 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
    985 
    986 #DOCSET_PUBLISHER_NAME  = Publisher
    987 
    988 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    989 # will be generated that can be used as input for tools like the
    990 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    991 # of the generated HTML documentation.
     1208# The default value is: org.doxygen.Publisher.
     1209# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1210
     1211DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
     1212
     1213# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
     1214# The default value is: Publisher.
     1215# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1216
     1217DOCSET_PUBLISHER_NAME  = Publisher
     1218
     1219# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
     1220# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
     1221# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
     1222# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
     1223# Windows.
     1224#
     1225# The HTML Help Workshop contains a compiler that can convert all HTML output
     1226# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
     1227# files are now used as the Windows 98 help format, and will replace the old
     1228# Windows help format (.hlp) on all Windows platforms in the future. Compressed
     1229# HTML files also contain an index, a table of contents, and you can search for
     1230# words in the documentation. The HTML workshop also contains a viewer for
     1231# compressed HTML files.
     1232# The default value is: NO.
     1233# This tag requires that the tag GENERATE_HTML is set to YES.
    9921234
    9931235GENERATE_HTMLHELP      = NO
    9941236
    995 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    996 # be used to specify the file name of the resulting .chm file. You
    997 # can add a path in front of the file if the result should not be
     1237# The CHM_FILE tag can be used to specify the file name of the resulting .chm
     1238# file. You can add a path in front of the file if the result should not be
    9981239# written to the html output directory.
     1240# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    9991241
    10001242CHM_FILE               =
    10011243
    1002 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    1003 # be used to specify the location (absolute path including file name) of
    1004 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    1005 # the HTML help compiler on the generated index.hhp.
     1244# The HHC_LOCATION tag can be used to specify the location (absolute path
     1245# including file name) of the HTML help compiler ( hhc.exe). If non-empty
     1246# doxygen will try to run the HTML help compiler on the generated index.hhp.
     1247# The file has to be specified with full path.
     1248# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10061249
    10071250HHC_LOCATION           =
    10081251
    1009 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    1010 # controls if a separate .chi index file is generated (YES) or that
    1011 # it should be included in the master .chm file (NO).
     1252# The GENERATE_CHI flag controls if a separate .chi index file is generated (
     1253# YES) or that it should be included in the master .chm file ( NO).
     1254# The default value is: NO.
     1255# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10121256
    10131257GENERATE_CHI           = NO
    10141258
    1015 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    1016 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    1017 # content.
     1259# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
     1260# and project file content.
     1261# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10181262
    10191263CHM_INDEX_ENCODING     =
    10201264
    1021 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    1022 # controls whether a binary table of contents is generated (YES) or a
    1023 # normal table of contents (NO) in the .chm file.
     1265# The BINARY_TOC flag controls whether a binary table of contents is generated (
     1266# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
     1267# enables the Previous and Next buttons.
     1268# The default value is: NO.
     1269# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10241270
    10251271BINARY_TOC             = NO
    10261272
    1027 # The TOC_EXPAND flag can be set to YES to add extra items for group members
    1028 # to the contents of the HTML help documentation and to the tree view.
     1273# The TOC_EXPAND flag can be set to YES to add extra items for group members to
     1274# the table of contents of the HTML help documentation and to the tree view.
     1275# The default value is: NO.
     1276# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10291277
    10301278TOC_EXPAND             = NO
    10311279
    10321280# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
    1033 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
    1034 # that can be used as input for Qt's qhelpgenerator to generate a
    1035 # Qt Compressed Help (.qch) of the generated HTML documentation.
     1281# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
     1282# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
     1283# (.qch) of the generated HTML documentation.
     1284# The default value is: NO.
     1285# This tag requires that the tag GENERATE_HTML is set to YES.
    10361286
    10371287GENERATE_QHP           = NO
    10381288
    1039 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    1040 # be used to specify the file name of the resulting .qch file.
    1041 # The path specified is relative to the HTML output folder.
     1289# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
     1290# the file name of the resulting .qch file. The path specified is relative to
     1291# the HTML output folder.
     1292# This tag requires that the tag GENERATE_QHP is set to YES.
    10421293
    10431294QCH_FILE               =
    10441295
    1045 # The QHP_NAMESPACE tag specifies the namespace to use when generating
    1046 # Qt Help Project output. For more information please see
    1047 # http://doc.trolltech.com/qthelpproject.html#namespace
     1296# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
     1297# Project output. For more information please see Qt Help Project / Namespace
     1298# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
     1299# The default value is: org.doxygen.Project.
     1300# This tag requires that the tag GENERATE_QHP is set to YES.
    10481301
    10491302QHP_NAMESPACE          = org.doxygen.Project
    10501303
    1051 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    1052 # Qt Help Project output. For more information please see
    1053 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
     1304# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
     1305# Help Project output. For more information please see Qt Help Project / Virtual
     1306# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
     1307# folders).
     1308# The default value is: doc.
     1309# This tag requires that the tag GENERATE_QHP is set to YES.
    10541310
    10551311QHP_VIRTUAL_FOLDER     = doc
    10561312
    1057 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
    1058 # add. For more information please see
    1059 # http://doc.trolltech.com/qthelpproject.html#custom-filters
     1313# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
     1314# filter to add. For more information please see Qt Help Project / Custom
     1315# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1316# filters).
     1317# This tag requires that the tag GENERATE_QHP is set to YES.
    10601318
    10611319QHP_CUST_FILTER_NAME   =
    10621320
    1063 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
    1064 # custom filter to add. For more information please see
    1065 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
    1066 # Qt Help Project / Custom Filters</a>.
     1321# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
     1322# custom filter to add. For more information please see Qt Help Project / Custom
     1323# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1324# filters).
     1325# This tag requires that the tag GENERATE_QHP is set to YES.
    10671326
    10681327QHP_CUST_FILTER_ATTRS  =
    10691328
    10701329# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
    1071 # project's
    1072 # filter section matches.
    1073 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
    1074 # Qt Help Project / Filter Attributes</a>.
     1330# project's filter section matches. Qt Help Project / Filter Attributes (see:
     1331# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
     1332# This tag requires that the tag GENERATE_QHP is set to YES.
    10751333
    10761334QHP_SECT_FILTER_ATTRS  =
    10771335
    1078 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    1079 # be used to specify the location of Qt's qhelpgenerator.
    1080 # If non-empty doxygen will try to run qhelpgenerator on the generated
    1081 # .qhp file.
     1336# The QHG_LOCATION tag can be used to specify the location of Qt's
     1337# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
     1338# generated .qhp file.
     1339# This tag requires that the tag GENERATE_QHP is set to YES.
    10821340
    10831341QHG_LOCATION           =
    10841342
    1085 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
    1086 #  will be generated, which together with the HTML files, form an Eclipse help
    1087 # plugin. To install this plugin and make it available under the help contents
    1088 # menu in Eclipse, the contents of the directory containing the HTML and XML
    1089 # files needs to be copied into the plugins directory of eclipse. The name of
    1090 # the directory within the plugins directory should be the same as
    1091 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
    1092 # the help appears.
     1343# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
     1344# generated, together with the HTML files, they form an Eclipse help plugin. To
     1345# install this plugin and make it available under the help contents menu in
     1346# Eclipse, the contents of the directory containing the HTML and XML files needs
     1347# to be copied into the plugins directory of eclipse. The name of the directory
     1348# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
     1349# After copying Eclipse needs to be restarted before the help appears.
     1350# The default value is: NO.
     1351# This tag requires that the tag GENERATE_HTML is set to YES.
    10931352
    10941353GENERATE_ECLIPSEHELP   = NO
    10951354
    1096 # A unique identifier for the eclipse help plugin. When installing the plugin
    1097 # the directory name containing the HTML and XML files should also have
    1098 # this name.
     1355# A unique identifier for the Eclipse help plugin. When installing the plugin
     1356# the directory name containing the HTML and XML files should also have this
     1357# name. Each documentation set should have its own identifier.
     1358# The default value is: org.doxygen.Project.
     1359# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
    10991360
    11001361ECLIPSE_DOC_ID         = org.doxygen.Project
    11011362
    1102 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
    1103 # at top of each HTML page. The value NO (the default) enables the index and
    1104 # the value YES disables it. Since the tabs have the same information as the
    1105 # navigation tree you can set this option to NO if you already set
    1106 # GENERATE_TREEVIEW to YES.
     1363# If you want full control over the layout of the generated HTML pages it might
     1364# be necessary to disable the index and replace it with your own. The
     1365# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
     1366# of each HTML page. A value of NO enables the index and the value YES disables
     1367# it. Since the tabs in the index contain the same information as the navigation
     1368# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
     1369# The default value is: NO.
     1370# This tag requires that the tag GENERATE_HTML is set to YES.
    11071371
    11081372DISABLE_INDEX          = NO
    11091373
    11101374# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    1111 # structure should be generated to display hierarchical information.
    1112 # If the tag value is set to YES, a side panel will be generated
    1113 # containing a tree-like index structure (just like the one that
    1114 # is generated for HTML Help). For this to work a browser that supports
    1115 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    1116 # Windows users are probably better off using the HTML help feature.
    1117 # Since the tree basically has the same information as the tab index you
    1118 # could consider to set DISABLE_INDEX to NO when enabling this option.
     1375# structure should be generated to display hierarchical information. If the tag
     1376# value is set to YES, a side panel will be generated containing a tree-like
     1377# index structure (just like the one that is generated for HTML Help). For this
     1378# to work a browser that supports JavaScript, DHTML, CSS and frames is required
     1379# (i.e. any modern browser). Windows users are probably better off using the
     1380# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
     1381# further fine-tune the look of the index. As an example, the default style
     1382# sheet generated by doxygen has an example that shows how to put an image at
     1383# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
     1384# the same information as the tab index, you could consider setting
     1385# DISABLE_INDEX to YES when enabling this option.
     1386# The default value is: NO.
     1387# This tag requires that the tag GENERATE_HTML is set to YES.
    11191388
    11201389GENERATE_TREEVIEW      = NO
    11211390
    1122 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
    1123 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
    1124 # documentation. Note that a value of 0 will completely suppress the enum
    1125 # values from appearing in the overview section.
     1391# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
     1392# doxygen will group on one line in the generated HTML documentation.
     1393#
     1394# Note that a value of 0 will completely suppress the enum values from appearing
     1395# in the overview section.
     1396# Minimum value: 0, maximum value: 20, default value: 4.
     1397# This tag requires that the tag GENERATE_HTML is set to YES.
    11261398
    11271399ENUM_VALUES_PER_LINE   = 4
    11281400
    1129 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
    1130 # and Class Hierarchy pages using a tree view instead of an ordered list.
    1131 
    1132 USE_INLINE_TREES       = NO
    1133 
    1134 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    1135 # used to set the initial width (in pixels) of the frame in which the tree
    1136 # is shown.
     1401# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
     1402# to set the initial width (in pixels) of the frame in which the tree is shown.
     1403# Minimum value: 0, maximum value: 1500, default value: 250.
     1404# This tag requires that the tag GENERATE_HTML is set to YES.
    11371405
    11381406TREEVIEW_WIDTH         = 250
    11391407
    1140 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
    1141 # links to external symbols imported via tag files in a separate window.
    1142 
    1143 #EXT_LINKS_IN_WINDOW    = NO
    1144 
    1145 # Use this tag to change the font size of Latex formulas included
    1146 # as images in the HTML documentation. The default is 10. Note that
    1147 # when you change the font size after a successful doxygen run you need
    1148 # to manually remove any form_*.png images from the HTML output directory
    1149 # to force them to be regenerated.
     1408# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
     1409# external symbols imported via tag files in a separate window.
     1410# The default value is: NO.
     1411# This tag requires that the tag GENERATE_HTML is set to YES.
     1412
     1413EXT_LINKS_IN_WINDOW    = NO
     1414
     1415# Use this tag to change the font size of LaTeX formulas included as images in
     1416# the HTML documentation. When you change the font size after a successful
     1417# doxygen run you need to manually remove any form_*.png images from the HTML
     1418# output directory to force them to be regenerated.
     1419# Minimum value: 8, maximum value: 50, default value: 10.
     1420# This tag requires that the tag GENERATE_HTML is set to YES.
    11501421
    11511422FORMULA_FONTSIZE       = 10
    11521423
    11531424# Use the FORMULA_TRANPARENT tag to determine whether or not the images
    1154 # generated for formulas are transparent PNGs. Transparent PNGs are
    1155 # not supported properly for IE 6.0, but are supported on all modern browsers.
    1156 # Note that when changing this option you need to delete any form_*.png files
    1157 # in the HTML output before the changes have effect.
    1158 
    1159 #FORMULA_TRANSPARENT    = YES
    1160 
    1161 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
    1162 # (see http://www.mathjax.org) which uses client side Javascript for the
    1163 # rendering instead of using prerendered bitmaps. Use this if you do not
    1164 # have LaTeX installed or if you want to formulas look prettier in the HTML
    1165 # output. When enabled you also need to install MathJax separately and
    1166 # configure the path to it using the MATHJAX_RELPATH option.
    1167 
    1168 #USE_MATHJAX            = NO
    1169 
    1170 # When MathJax is enabled you need to specify the location relative to the
    1171 # HTML output directory using the MATHJAX_RELPATH option. The destination
    1172 # directory should contain the MathJax.js script. For instance, if the mathjax
    1173 # directory is located at the same level as the HTML output directory, then
    1174 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
    1175 # mathjax.org site, so you can quickly see the result without installing
    1176 # MathJax, but it is strongly recommended to install a local copy of MathJax
    1177 # before deployment.
    1178 
    1179 #MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
    1180 
    1181 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
    1182 # names that should be enabled during MathJax rendering.
    1183 
    1184 #MATHJAX_EXTENSIONS     =
    1185 
    1186 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
    1187 # for the HTML output. The underlying search engine uses javascript
    1188 # and DHTML and should work on any modern browser. Note that when using
    1189 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
    1190 # (GENERATE_DOCSET) there is already a search function so this one should
    1191 # typically be disabled. For large projects the javascript based search engine
    1192 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
     1425# generated for formulas are transparent PNGs. Transparent PNGs are not
     1426# supported properly for IE 6.0, but are supported on all modern browsers.
     1427#
     1428# Note that when changing this option you need to delete any form_*.png files in
     1429# the HTML output directory before the changes have effect.
     1430# The default value is: YES.
     1431# This tag requires that the tag GENERATE_HTML is set to YES.
     1432
     1433FORMULA_TRANSPARENT    = YES
     1434
     1435# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
     1436# http://www.mathjax.org) which uses client side Javascript for the rendering
     1437# instead of using prerendered bitmaps. Use this if you do not have LaTeX
     1438# installed or if you want to formulas look prettier in the HTML output. When
     1439# enabled you may also need to install MathJax separately and configure the path
     1440# to it using the MATHJAX_RELPATH option.
     1441# The default value is: NO.
     1442# This tag requires that the tag GENERATE_HTML is set to YES.
     1443
     1444USE_MATHJAX            = NO
     1445
     1446# When MathJax is enabled you can set the default output format to be used for
     1447# the MathJax output. See the MathJax site (see:
     1448# http://docs.mathjax.org/en/latest/output.html) for more details.
     1449# Possible values are: HTML-CSS (which is slower, but has the best
     1450# compatibility), NativeMML (i.e. MathML) and SVG.
     1451# The default value is: HTML-CSS.
     1452# This tag requires that the tag USE_MATHJAX is set to YES.
     1453
     1454MATHJAX_FORMAT         = HTML-CSS
     1455
     1456# When MathJax is enabled you need to specify the location relative to the HTML
     1457# output directory using the MATHJAX_RELPATH option. The destination directory
     1458# should contain the MathJax.js script. For instance, if the mathjax directory
     1459# is located at the same level as the HTML output directory, then
     1460# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
     1461# Content Delivery Network so you can quickly see the result without installing
     1462# MathJax. However, it is strongly recommended to install a local copy of
     1463# MathJax from http://www.mathjax.org before deployment.
     1464# The default value is: http://cdn.mathjax.org/mathjax/latest.
     1465# This tag requires that the tag USE_MATHJAX is set to YES.
     1466
     1467MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1468
     1469# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
     1470# extension names that should be enabled during MathJax rendering. For example
     1471# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
     1472# This tag requires that the tag USE_MATHJAX is set to YES.
     1473
     1474MATHJAX_EXTENSIONS     =
     1475
     1476# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
     1477# of code that will be used on startup of the MathJax code. See the MathJax site
     1478# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
     1479# example see the documentation.
     1480# This tag requires that the tag USE_MATHJAX is set to YES.
     1481
     1482MATHJAX_CODEFILE       =
     1483
     1484# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
     1485# the HTML output. The underlying search engine uses javascript and DHTML and
     1486# should work on any modern browser. Note that when using HTML help
     1487# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
     1488# there is already a search function so this one should typically be disabled.
     1489# For large projects the javascript based search engine can be slow, then
     1490# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
     1491# search using the keyboard; to jump to the search box use <access key> + S
     1492# (what the <access key> is depends on the OS and browser, but it is typically
     1493# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
     1494# key> to jump into the search results window, the results can be navigated
     1495# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
     1496# the search. The filter options can be selected when the cursor is inside the
     1497# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
     1498# to select a filter and <Enter> or <escape> to activate or cancel the filter
     1499# option.
     1500# The default value is: YES.
     1501# This tag requires that the tag GENERATE_HTML is set to YES.
    11931502
    11941503SEARCHENGINE           = YES
    11951504
    11961505# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    1197 # implemented using a PHP enabled web server instead of at the web client
    1198 # using Javascript. Doxygen will generate the search PHP script and index
    1199 # file to put on the web server. The advantage of the server
    1200 # based approach is that it scales better to large projects and allows
    1201 # full text search. The disadvantages are that it is more difficult to setup
    1202 # and does not have live searching capabilities.
     1506# implemented using a web server instead of a web client using Javascript. There
     1507# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
     1508# setting. When disabled, doxygen will generate a PHP script for searching and
     1509# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
     1510# and searching needs to be provided by external tools. See the section
     1511# "External Indexing and Searching" for details.
     1512# The default value is: NO.
     1513# This tag requires that the tag SEARCHENGINE is set to YES.
    12031514
    12041515SERVER_BASED_SEARCH    = NO
    12051516
    1206 #---------------------------------------------------------------------------
    1207 # configuration options related to the LaTeX output
    1208 #---------------------------------------------------------------------------
    1209 
    1210 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    1211 # generate Latex output.
     1517# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
     1518# script for searching. Instead the search results are written to an XML file
     1519# which needs to be processed by an external indexer. Doxygen will invoke an
     1520# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
     1521# search results.
     1522#
     1523# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1524# (doxysearch.cgi) which are based on the open source search engine library
     1525# Xapian (see: http://xapian.org/).
     1526#
     1527# See the section "External Indexing and Searching" for details.
     1528# The default value is: NO.
     1529# This tag requires that the tag SEARCHENGINE is set to YES.
     1530
     1531EXTERNAL_SEARCH        = NO
     1532
     1533# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     1534# which will return the search results when EXTERNAL_SEARCH is enabled.
     1535#
     1536# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1537# (doxysearch.cgi) which are based on the open source search engine library
     1538# Xapian (see: http://xapian.org/). See the section "External Indexing and
     1539# Searching" for details.
     1540# This tag requires that the tag SEARCHENGINE is set to YES.
     1541
     1542SEARCHENGINE_URL       =
     1543
     1544# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     1545# search data is written to a file for indexing by an external tool. With the
     1546# SEARCHDATA_FILE tag the name of this file can be specified.
     1547# The default file is: searchdata.xml.
     1548# This tag requires that the tag SEARCHENGINE is set to YES.
     1549
     1550SEARCHDATA_FILE        = searchdata.xml
     1551
     1552# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
     1553# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
     1554# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
     1555# projects and redirect the results back to the right project.
     1556# This tag requires that the tag SEARCHENGINE is set to YES.
     1557
     1558EXTERNAL_SEARCH_ID     =
     1559
     1560# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     1561# projects other than the one defined by this configuration file, but that are
     1562# all added to the same external search index. Each project needs to have a
     1563# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
     1564# to a relative location where the documentation can be found. The format is:
     1565# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
     1566# This tag requires that the tag SEARCHENGINE is set to YES.
     1567
     1568EXTRA_SEARCH_MAPPINGS  =
     1569
     1570#---------------------------------------------------------------------------
     1571# Configuration options related to the LaTeX output
     1572#---------------------------------------------------------------------------
     1573
     1574# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
     1575# The default value is: YES.
    12121576
    12131577GENERATE_LATEX         = NO
    12141578
    1215 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    1216 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1217 # put in front of it. If left blank `latex' will be used as the default path.
     1579# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
     1580# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1581# it.
     1582# The default directory is: latex.
     1583# This tag requires that the tag GENERATE_LATEX is set to YES.
    12181584
    12191585LATEX_OUTPUT           = latex
    12201586
    12211587# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    1222 # invoked. If left blank `latex' will be used as the default command name.
    1223 # Note that when enabling USE_PDFLATEX this option is only used for
    1224 # generating bitmaps for formulas in the HTML output, but not in the
    1225 # Makefile that is written to the output directory.
     1588# invoked.
     1589#
     1590# Note that when enabling USE_PDFLATEX this option is only used for generating
     1591# bitmaps for formulas in the HTML output, but not in the Makefile that is
     1592# written to the output directory.
     1593# The default file is: latex.
     1594# This tag requires that the tag GENERATE_LATEX is set to YES.
    12261595
    12271596LATEX_CMD_NAME         = latex
    12281597
    1229 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    1230 # generate index for LaTeX. If left blank `makeindex' will be used as the
    1231 # default command name.
     1598# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
     1599# index for LaTeX.
     1600# The default file is: makeindex.
     1601# This tag requires that the tag GENERATE_LATEX is set to YES.
    12321602
    12331603MAKEINDEX_CMD_NAME     = makeindex
    12341604
    1235 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    1236 # LaTeX documents. This may be useful for small projects and may help to
    1237 # save some trees in general.
     1605# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
     1606# documents. This may be useful for small projects and may help to save some
     1607# trees in general.
     1608# The default value is: NO.
     1609# This tag requires that the tag GENERATE_LATEX is set to YES.
    12381610
    12391611COMPACT_LATEX          = NO
    12401612
    1241 # The PAPER_TYPE tag can be used to set the paper type that is used
    1242 # by the printer. Possible values are: a4, letter, legal and
    1243 # executive. If left blank a4wide will be used.
     1613# The PAPER_TYPE tag can be used to set the paper type that is used by the
     1614# printer.
     1615# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
     1616# 14 inches) and executive (7.25 x 10.5 inches).
     1617# The default value is: a4.
     1618# This tag requires that the tag GENERATE_LATEX is set to YES.
    12441619
    12451620PAPER_TYPE             = a4
    12461621
    1247 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    1248 # packages that should be included in the LaTeX output.
     1622# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
     1623# that should be included in the LaTeX output. To get the times font for
     1624# instance you can specify
     1625# EXTRA_PACKAGES=times
     1626# If left blank no extra packages will be included.
     1627# This tag requires that the tag GENERATE_LATEX is set to YES.
    12491628
    12501629EXTRA_PACKAGES         =
    12511630
    1252 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    1253 # the generated latex document. The header should contain everything until
    1254 # the first chapter. If it is left blank doxygen will generate a
    1255 # standard header. Notice: only use this tag if you know what you are doing!
     1631# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
     1632# generated LaTeX document. The header should contain everything until the first
     1633# chapter. If it is left blank doxygen will generate a standard header. See
     1634# section "Doxygen usage" for information on how to let doxygen write the
     1635# default header to a separate file.
     1636#
     1637# Note: Only use a user-defined header if you know what you are doing! The
     1638# following commands have a special meaning inside the header: $title,
     1639# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
     1640# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
     1641# for the replacement values of the other commands the user is refered to
     1642# HTML_HEADER.
     1643# This tag requires that the tag GENERATE_LATEX is set to YES.
    12561644
    12571645LATEX_HEADER           =
    12581646
    1259 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
    1260 # the generated latex document. The footer should contain everything after
    1261 # the last chapter. If it is left blank doxygen will generate a
    1262 # standard footer. Notice: only use this tag if you know what you are doing!
    1263 
    1264 #LATEX_FOOTER           =
    1265 
    1266 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    1267 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    1268 # contain links (just like the HTML output) instead of page references
    1269 # This makes the output suitable for online browsing using a pdf viewer.
     1647# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
     1648# generated LaTeX document. The footer should contain everything after the last
     1649# chapter. If it is left blank doxygen will generate a standard footer. See
     1650# LATEX_HEADER for more information on how to generate a default footer and what
     1651# special commands can be used inside the footer.
     1652#
     1653# Note: Only use a user-defined footer if you know what you are doing!
     1654# This tag requires that the tag GENERATE_LATEX is set to YES.
     1655
     1656LATEX_FOOTER           =
     1657
     1658# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
     1659# other source files which should be copied to the LATEX_OUTPUT output
     1660# directory. Note that the files will be copied as-is; there are no commands or
     1661# markers available.
     1662# This tag requires that the tag GENERATE_LATEX is set to YES.
     1663
     1664LATEX_EXTRA_FILES      =
     1665
     1666# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
     1667# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
     1668# contain links (just like the HTML output) instead of page references. This
     1669# makes the output suitable for online browsing using a PDF viewer.
     1670# The default value is: YES.
     1671# This tag requires that the tag GENERATE_LATEX is set to YES.
    12701672
    12711673PDF_HYPERLINKS         = YES
    12721674
    1273 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    1274 # plain latex in the generated Makefile. Set this option to YES to get a
     1675# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
     1676# the PDF file directly from the LaTeX files. Set this option to YES to get a
    12751677# higher quality PDF documentation.
     1678# The default value is: YES.
     1679# This tag requires that the tag GENERATE_LATEX is set to YES.
    12761680
    12771681USE_PDFLATEX           = YES
    12781682
    1279 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    1280 # command to the generated LaTeX files. This will instruct LaTeX to keep
    1281 # running if errors occur, instead of asking the user for help.
    1282 # This option is also used when generating formulas in HTML.
     1683# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
     1684# command to the generated LaTeX files. This will instruct LaTeX to keep running
     1685# if errors occur, instead of asking the user for help. This option is also used
     1686# when generating formulas in HTML.
     1687# The default value is: NO.
     1688# This tag requires that the tag GENERATE_LATEX is set to YES.
    12831689
    12841690LATEX_BATCHMODE        = NO
    12851691
    1286 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    1287 # include the index chapters (such as File Index, Compound Index, etc.)
    1288 # in the output.
     1692# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
     1693# index chapters (such as File Index, Compound Index, etc.) in the output.
     1694# The default value is: NO.
     1695# This tag requires that the tag GENERATE_LATEX is set to YES.
    12891696
    12901697LATEX_HIDE_INDICES     = NO
    12911698
    1292 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
    1293 # source code with syntax highlighting in the LaTeX output.
    1294 # Note that which sources are shown also depends on other settings
    1295 # such as SOURCE_BROWSER.
     1699# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
     1700# code with syntax highlighting in the LaTeX output.
     1701#
     1702# Note that which sources are shown also depends on other settings such as
     1703# SOURCE_BROWSER.
     1704# The default value is: NO.
     1705# This tag requires that the tag GENERATE_LATEX is set to YES.
    12961706
    12971707LATEX_SOURCE_CODE      = NO
    12981708
    12991709# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
    1300 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
    1301 # http://en.wikipedia.org/wiki/BibTeX for more info.
    1302 
    1303 #LATEX_BIB_STYLE        = plain
    1304 
    1305 #---------------------------------------------------------------------------
    1306 # configuration options related to the RTF output
    1307 #---------------------------------------------------------------------------
    1308 
    1309 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    1310 # The RTF output is optimized for Word 97 and may not look very pretty with
    1311 # other RTF readers or editors.
     1710# bibliography, e.g. plainnat, or ieeetr. See
     1711# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
     1712# The default value is: plain.
     1713# This tag requires that the tag GENERATE_LATEX is set to YES.
     1714
     1715LATEX_BIB_STYLE        = plain
     1716
     1717#---------------------------------------------------------------------------
     1718# Configuration options related to the RTF output
     1719#---------------------------------------------------------------------------
     1720
     1721# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
     1722# RTF output is optimized for Word 97 and may not look too pretty with other RTF
     1723# readers/editors.
     1724# The default value is: NO.
    13121725
    13131726GENERATE_RTF           = NO
    13141727
    1315 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    1316 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1317 # put in front of it. If left blank `rtf' will be used as the default path.
     1728# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
     1729# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1730# it.
     1731# The default directory is: rtf.
     1732# This tag requires that the tag GENERATE_RTF is set to YES.
    13181733
    13191734RTF_OUTPUT             = rtf
    13201735
    1321 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    1322 # RTF documents. This may be useful for small projects and may help to
    1323 # save some trees in general.
     1736# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
     1737# documents. This may be useful for small projects and may help to save some
     1738# trees in general.
     1739# The default value is: NO.
     1740# This tag requires that the tag GENERATE_RTF is set to YES.
    13241741
    13251742COMPACT_RTF            = NO
    13261743
    1327 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    1328 # will contain hyperlink fields. The RTF file will
    1329 # contain links (just like the HTML output) instead of page references.
    1330 # This makes the output suitable for online browsing using WORD or other
    1331 # programs which support those fields.
    1332 # Note: wordpad (write) and others do not support links.
     1744# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
     1745# contain hyperlink fields. The RTF file will contain links (just like the HTML
     1746# output) instead of page references. This makes the output suitable for online
     1747# browsing using Word or some other Word compatible readers that support those
     1748# fields.
     1749#
     1750# Note: WordPad (write) and others do not support links.
     1751# The default value is: NO.
     1752# This tag requires that the tag GENERATE_RTF is set to YES.
    13331753
    13341754RTF_HYPERLINKS         = NO
    13351755
    1336 # Load style sheet definitions from file. Syntax is similar to doxygen's
    1337 # config file, i.e. a series of assignments. You only have to provide
    1338 # replacements, missing definitions are set to their default value.
     1756# Load stylesheet definitions from file. Syntax is similar to doxygen's config
     1757# file, i.e. a series of assignments. You only have to provide replacements,
     1758# missing definitions are set to their default value.
     1759#
     1760# See also section "Doxygen usage" for information on how to generate the
     1761# default style sheet that doxygen normally uses.
     1762# This tag requires that the tag GENERATE_RTF is set to YES.
    13391763
    13401764RTF_STYLESHEET_FILE    =
    13411765
    1342 # Set optional variables used in the generation of an rtf document.
    1343 # Syntax is similar to doxygen's config file.
     1766# Set optional variables used in the generation of an RTF document. Syntax is
     1767# similar to doxygen's config file. A template extensions file can be generated
     1768# using doxygen -e rtf extensionFile.
     1769# This tag requires that the tag GENERATE_RTF is set to YES.
    13441770
    13451771RTF_EXTENSIONS_FILE    =
    13461772
    13471773#---------------------------------------------------------------------------
    1348 # configuration options related to the man page output
    1349 #---------------------------------------------------------------------------
    1350 
    1351 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    1352 # generate man pages
     1774# Configuration options related to the man page output
     1775#---------------------------------------------------------------------------
     1776
     1777# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
     1778# classes and files.
     1779# The default value is: NO.
    13531780
    13541781GENERATE_MAN           = NO
    13551782
    1356 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    1357 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1358 # put in front of it. If left blank `man' will be used as the default path.
     1783# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
     1784# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1785# it. A directory man3 will be created inside the directory specified by
     1786# MAN_OUTPUT.
     1787# The default directory is: man.
     1788# This tag requires that the tag GENERATE_MAN is set to YES.
    13591789
    13601790MAN_OUTPUT             = man
    13611791
    1362 # The MAN_EXTENSION tag determines the extension that is added to
    1363 # the generated man pages (default is the subroutine's section .3)
     1792# The MAN_EXTENSION tag determines the extension that is added to the generated
     1793# man pages. In case the manual section does not start with a number, the number
     1794# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
     1795# optional.
     1796# The default value is: .3.
     1797# This tag requires that the tag GENERATE_MAN is set to YES.
    13641798
    13651799MAN_EXTENSION          = .3
    13661800
    1367 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    1368 # then it will generate one additional man file for each entity
    1369 # documented in the real man page(s). These additional files
    1370 # only source the real man page, but without them the man command
    1371 # would be unable to find the correct page. The default is NO.
     1801# The MAN_SUBDIR tag determines the name of the directory created within
     1802# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
     1803# MAN_EXTENSION with the initial . removed.
     1804# This tag requires that the tag GENERATE_MAN is set to YES.
     1805
     1806MAN_SUBDIR             =
     1807
     1808# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
     1809# will generate one additional man file for each entity documented in the real
     1810# man page(s). These additional files only source the real man page, but without
     1811# them the man command would be unable to find the correct page.
     1812# The default value is: NO.
     1813# This tag requires that the tag GENERATE_MAN is set to YES.
    13721814
    13731815MAN_LINKS              = NO
    13741816
    13751817#---------------------------------------------------------------------------
    1376 # configuration options related to the XML output
    1377 #---------------------------------------------------------------------------
    1378 
    1379 # If the GENERATE_XML tag is set to YES Doxygen will
    1380 # generate an XML file that captures the structure of
    1381 # the code including all documentation.
     1818# Configuration options related to the XML output
     1819#---------------------------------------------------------------------------
     1820
     1821# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
     1822# captures the structure of the code including all documentation.
     1823# The default value is: NO.
    13821824
    13831825GENERATE_XML           = NO
    13841826
    1385 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    1386 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1387 # put in front of it. If left blank `xml' will be used as the default path.
     1827# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
     1828# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1829# it.
     1830# The default directory is: xml.
     1831# This tag requires that the tag GENERATE_XML is set to YES.
    13881832
    13891833XML_OUTPUT             = xml
    13901834
    1391 # The XML_SCHEMA tag can be used to specify an XML schema,
    1392 # which can be used by a validating XML parser to check the
    1393 # syntax of the XML files.
    1394 
    1395 XML_SCHEMA             =
    1396 
    1397 # The XML_DTD tag can be used to specify an XML DTD,
    1398 # which can be used by a validating XML parser to check the
    1399 # syntax of the XML files.
    1400 
    1401 XML_DTD                =
    1402 
    1403 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    1404 # dump the program listings (including syntax highlighting
    1405 # and cross-referencing information) to the XML output. Note that
    1406 # enabling this will significantly increase the size of the XML output.
     1835# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
     1836# listings (including syntax highlighting and cross-referencing information) to
     1837# the XML output. Note that enabling this will significantly increase the size
     1838# of the XML output.
     1839# The default value is: YES.
     1840# This tag requires that the tag GENERATE_XML is set to YES.
    14071841
    14081842XML_PROGRAMLISTING     = YES
    14091843
    14101844#---------------------------------------------------------------------------
    1411 # configuration options for the AutoGen Definitions output
    1412 #---------------------------------------------------------------------------
    1413 
    1414 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    1415 # generate an AutoGen Definitions (see autogen.sf.net) file
    1416 # that captures the structure of the code including all
    1417 # documentation. Note that this feature is still experimental
    1418 # and incomplete at the moment.
     1845# Configuration options related to the DOCBOOK output
     1846#---------------------------------------------------------------------------
     1847
     1848# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
     1849# that can be used to generate PDF.
     1850# The default value is: NO.
     1851
     1852GENERATE_DOCBOOK       = NO
     1853
     1854# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
     1855# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
     1856# front of it.
     1857# The default directory is: docbook.
     1858# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1859
     1860DOCBOOK_OUTPUT         = docbook
     1861
     1862# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
     1863# program listings (including syntax highlighting and cross-referencing
     1864# information) to the DOCBOOK output. Note that enabling this will significantly
     1865# increase the size of the DOCBOOK output.
     1866# The default value is: NO.
     1867# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1868
     1869DOCBOOK_PROGRAMLISTING = NO
     1870
     1871#---------------------------------------------------------------------------
     1872# Configuration options for the AutoGen Definitions output
     1873#---------------------------------------------------------------------------
     1874
     1875# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
     1876# Definitions (see http://autogen.sf.net) file that captures the structure of
     1877# the code including all documentation. Note that this feature is still
     1878# experimental and incomplete at the moment.
     1879# The default value is: NO.
    14191880
    14201881GENERATE_AUTOGEN_DEF   = NO
    14211882
    14221883#---------------------------------------------------------------------------
    1423 # configuration options related to the Perl module output
    1424 #---------------------------------------------------------------------------
    1425 
    1426 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    1427 # generate a Perl module file that captures the structure of
    1428 # the code including all documentation. Note that this
    1429 # feature is still experimental and incomplete at the
    1430 # moment.
     1884# Configuration options related to the Perl module output
     1885#---------------------------------------------------------------------------
     1886
     1887# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
     1888# file that captures the structure of the code including all documentation.
     1889#
     1890# Note that this feature is still experimental and incomplete at the moment.
     1891# The default value is: NO.
    14311892
    14321893GENERATE_PERLMOD       = NO
    14331894
    1434 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    1435 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    1436 # to generate PDF and DVI output from the Perl module output.
     1895# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
     1896# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
     1897# output from the Perl module output.
     1898# The default value is: NO.
     1899# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    14371900
    14381901PERLMOD_LATEX          = NO
    14391902
    1440 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1441 # nicely formatted so it can be parsed by a human reader.
    1442 # This is useful
    1443 # if you want to understand what is going on.
    1444 # On the other hand, if this
    1445 # tag is set to NO the size of the Perl module output will be much smaller
    1446 # and Perl will parse it just the same.
     1903# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
     1904# formatted so it can be parsed by a human reader. This is useful if you want to
     1905# understand what is going on. On the other hand, if this tag is set to NO the
     1906# size of the Perl module output will be much smaller and Perl will parse it
     1907# just the same.
     1908# The default value is: YES.
     1909# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    14471910
    14481911PERLMOD_PRETTY         = YES
    14491912
    1450 # The names of the make variables in the generated doxyrules.make file
    1451 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    1452 # This is useful so different doxyrules.make files included by the same
    1453 # Makefile don't overwrite each other's variables.
     1913# The names of the make variables in the generated doxyrules.make file are
     1914# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
     1915# so different doxyrules.make files included by the same Makefile don't
     1916# overwrite each other's variables.
     1917# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    14541918
    14551919PERLMOD_MAKEVAR_PREFIX =
     
    14591923#---------------------------------------------------------------------------
    14601924
    1461 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    1462 # evaluate all C-preprocessor directives found in the sources and include
    1463 # files.
     1925# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
     1926# C-preprocessor directives found in the sources and include files.
     1927# The default value is: YES.
    14641928
    14651929ENABLE_PREPROCESSING   = NO
    14661930
    1467 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    1468 # names in the source code. If set to NO (the default) only conditional
    1469 # compilation will be performed. Macro expansion can be done in a controlled
    1470 # way by setting EXPAND_ONLY_PREDEF to YES.
     1931# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
     1932# in the source code. If set to NO only conditional compilation will be
     1933# performed. Macro expansion can be done in a controlled way by setting
     1934# EXPAND_ONLY_PREDEF to YES.
     1935# The default value is: NO.
     1936# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    14711937
    14721938MACRO_EXPANSION        = NO
    14731939
    1474 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    1475 # then the macro expansion is limited to the macros specified with the
    1476 # PREDEFINED and EXPAND_AS_DEFINED tags.
     1940# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
     1941# the macro expansion is limited to the macros specified with the PREDEFINED and
     1942# EXPAND_AS_DEFINED tags.
     1943# The default value is: NO.
     1944# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    14771945
    14781946EXPAND_ONLY_PREDEF     = NO
    14791947
    1480 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1481 # pointed to by INCLUDE_PATH will be searched when a #include is found.
     1948# If the SEARCH_INCLUDES tag is set to YES the includes files in the
     1949# INCLUDE_PATH will be searched if a #include is found.
     1950# The default value is: YES.
     1951# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    14821952
    14831953SEARCH_INCLUDES        = YES
    14841954
    14851955# The INCLUDE_PATH tag can be used to specify one or more directories that
    1486 # contain include files that are not input files but should be processed by
    1487 # the preprocessor.
     1956# contain include files that are not input files but should be processed by the
     1957# preprocessor.
     1958# This tag requires that the tag SEARCH_INCLUDES is set to YES.
    14881959
    14891960INCLUDE_PATH           =
     
    14911962# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    14921963# patterns (like *.h and *.hpp) to filter out the header-files in the
    1493 # directories. If left blank, the patterns specified with FILE_PATTERNS will
    1494 # be used.
     1964# directories. If left blank, the patterns specified with FILE_PATTERNS will be
     1965# used.
     1966# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    14951967
    14961968INCLUDE_FILE_PATTERNS  =
    14971969
    1498 # The PREDEFINED tag can be used to specify one or more macro names that
    1499 # are defined before the preprocessor is started (similar to the -D option of
    1500 # gcc). The argument of the tag is a list of macros of the form: name
    1501 # or name=definition (no spaces). If the definition and the = are
    1502 # omitted =1 is assumed. To prevent a macro definition from being
    1503 # undefined via #undef or recursively expanded use the := operator
    1504 # instead of the = operator.
     1970# The PREDEFINED tag can be used to specify one or more macro names that are
     1971# defined before the preprocessor is started (similar to the -D option of e.g.
     1972# gcc). The argument of the tag is a list of macros of the form: name or
     1973# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
     1974# is assumed. To prevent a macro definition from being undefined via #undef or
     1975# recursively expanded use the := operator instead of the = operator.
     1976# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15051977
    15061978PREDEFINED             =
    15071979
    1508 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    1509 # this tag can be used to specify a list of macro names that should be expanded.
    1510 # The macro definition that is found in the sources will be used.
    1511 # Use the PREDEFINED tag if you want to use a different macro definition that
    1512 # overrules the definition found in the source code.
     1980# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
     1981# tag can be used to specify a list of macro names that should be expanded. The
     1982# macro definition that is found in the sources will be used. Use the PREDEFINED
     1983# tag if you want to use a different macro definition that overrules the
     1984# definition found in the source code.
     1985# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15131986
    15141987EXPAND_AS_DEFINED      =
    15151988
    1516 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1517 # doxygen's preprocessor will remove all references to function-like macros
    1518 # that are alone on a line, have an all uppercase name, and do not end with a
    1519 # semicolon, because these will confuse the parser if not removed.
     1989# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
     1990# remove all references to function-like macros that are alone on a line, have
     1991# an all uppercase name, and do not end with a semicolon. Such function macros
     1992# are typically used for boiler-plate code, and will confuse the parser if not
     1993# removed.
     1994# The default value is: YES.
     1995# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15201996
    15211997SKIP_FUNCTION_MACROS   = YES
    15221998
    15231999#---------------------------------------------------------------------------
    1524 # Configuration::additions related to external references
    1525 #---------------------------------------------------------------------------
    1526 
    1527 # The TAGFILES option can be used to specify one or more tagfiles.
    1528 # Optionally an initial location of the external documentation
    1529 # can be added for each tagfile. The format of a tag file without
    1530 # this location is as follows:
    1531 #
     2000# Configuration options related to external references
     2001#---------------------------------------------------------------------------
     2002
     2003# The TAGFILES tag can be used to specify one or more tag files. For each tag
     2004# file the location of the external documentation should be added. The format of
     2005# a tag file without this location is as follows:
    15322006# TAGFILES = file1 file2 ...
    15332007# Adding location for the tag files is done as follows:
    1534 #
    15352008# TAGFILES = file1=loc1 "file2 = loc2" ...
    1536 # where "loc1" and "loc2" can be relative or absolute paths or
    1537 # URLs. If a location is present for each tag, the installdox tool
    1538 # does not have to be run to correct the links.
    1539 # Note that each tag file must have a unique name
    1540 # (where the name does NOT include the path)
    1541 # If a tag file is not located in the directory in which doxygen
    1542 # is run, you must also specify the path to the tagfile here.
     2009# where loc1 and loc2 can be relative or absolute paths or URLs. See the
     2010# section "Linking to external documentation" for more information about the use
     2011# of tag files.
     2012# Note: Each tag file must have a unique name (where the name does NOT include
     2013# the path). If a tag file is not located in the directory in which doxygen is
     2014# run, you must also specify the path to the tagfile here.
    15432015
    15442016TAGFILES               =
    15452017
    1546 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    1547 # a tag file that is based on the input files it reads.
     2018# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
     2019# tag file that is based on the input files it reads. See section "Linking to
     2020# external documentation" for more information about the usage of tag files.
    15482021
    15492022GENERATE_TAGFILE       =
    15502023
    1551 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    1552 # in the class index. If set to NO only the inherited external classes
    1553 # will be listed.
     2024# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
     2025# class index. If set to NO only the inherited external classes will be listed.
     2026# The default value is: NO.
    15542027
    15552028ALLEXTERNALS           = NO
    15562029
    1557 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    1558 # in the modules index. If set to NO, only the current project's groups will
     2030# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
     2031# the modules index. If set to NO, only the current project's groups will be
     2032# listed.
     2033# The default value is: YES.
     2034
     2035EXTERNAL_GROUPS        = YES
     2036
     2037# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
     2038# the related pages index. If set to NO, only the current project's pages will
    15592039# be listed.
    1560 
    1561 EXTERNAL_GROUPS        = YES
     2040# The default value is: YES.
     2041
     2042EXTERNAL_PAGES         = YES
    15622043
    15632044# The PERL_PATH should be the absolute path and name of the perl script
    1564 # interpreter (i.e. the result of `which perl').
     2045# interpreter (i.e. the result of 'which perl').
     2046# The default file (with absolute path) is: /usr/bin/perl.
    15652047
    15662048PERL_PATH              = /usr/bin/perl
     
    15702052#---------------------------------------------------------------------------
    15712053
    1572 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1573 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    1574 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    1575 # this option also works with HAVE_DOT disabled, but it is recommended to
    1576 # install and use dot, since it yields more powerful graphs.
     2054# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
     2055# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
     2056# NO turns the diagrams off. Note that this option also works with HAVE_DOT
     2057# disabled, but it is recommended to install and use dot, since it yields more
     2058# powerful graphs.
     2059# The default value is: YES.
    15772060
    15782061CLASS_DIAGRAMS         = YES
    15792062
    15802063# You can define message sequence charts within doxygen comments using the \msc
    1581 # command. Doxygen will then run the mscgen tool (see
    1582 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     2064# command. Doxygen will then run the mscgen tool (see:
     2065# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
    15832066# documentation. The MSCGEN_PATH tag allows you to specify the directory where
    15842067# the mscgen tool resides. If left empty the tool is assumed to be found in the
     
    15872070MSCGEN_PATH            =
    15882071
    1589 # If set to YES, the inheritance and collaboration graphs will hide
    1590 # inheritance and usage relations if the target is undocumented
    1591 # or is not a class.
     2072# You can include diagrams made with dia in doxygen documentation. Doxygen will
     2073# then run dia to produce the diagram and insert it in the documentation. The
     2074# DIA_PATH tag allows you to specify the directory where the dia binary resides.
     2075# If left empty dia is assumed to be found in the default search path.
     2076
     2077DIA_PATH               =
     2078
     2079# If set to YES, the inheritance and collaboration graphs will hide inheritance
     2080# and usage relations if the target is undocumented or is not a class.
     2081# The default value is: YES.
    15922082
    15932083HIDE_UNDOC_RELATIONS   = YES
    15942084
    15952085# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    1596 # available from the path. This tool is part of Graphviz, a graph visualization
    1597 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    1598 # have no effect if this option is set to NO (the default)
     2086# available from the path. This tool is part of Graphviz (see:
     2087# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
     2088# Bell Labs. The other options in this section have no effect if this option is
     2089# set to NO
     2090# The default value is: YES.
    15992091
    16002092HAVE_DOT               = NO
    16012093
    1602 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
    1603 # allowed to run in parallel. When set to 0 (the default) doxygen will
    1604 # base this on the number of processors available in the system. You can set it
    1605 # explicitly to a value larger than 0 to get control over the balance
    1606 # between CPU load and processing speed.
    1607 
    1608 #DOT_NUM_THREADS        = 0
    1609 
    1610 # By default doxygen will use the Helvetica font for all dot files that
    1611 # doxygen generates. When you want a differently looking font you can specify
    1612 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
    1613 # the font, which can be done by putting it in a standard location or by setting
    1614 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
    1615 # directory containing the font.
     2094# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
     2095# to run in parallel. When set to 0 doxygen will base this on the number of
     2096# processors available in the system. You can set it explicitly to a value
     2097# larger than 0 to get control over the balance between CPU load and processing
     2098# speed.
     2099# Minimum value: 0, maximum value: 32, default value: 0.
     2100# This tag requires that the tag HAVE_DOT is set to YES.
     2101
     2102DOT_NUM_THREADS        = 0
     2103
     2104# When you want a differently looking font in the dot files that doxygen
     2105# generates you can specify the font name using DOT_FONTNAME. You need to make
     2106# sure dot is able to find the font, which can be done by putting it in a
     2107# standard location or by setting the DOTFONTPATH environment variable or by
     2108# setting DOT_FONTPATH to the directory containing the font.
     2109# The default value is: Helvetica.
     2110# This tag requires that the tag HAVE_DOT is set to YES.
    16162111
    16172112DOT_FONTNAME           = Helvetica
    16182113
    1619 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    1620 # The default size is 10pt.
     2114# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
     2115# dot graphs.
     2116# Minimum value: 4, maximum value: 24, default value: 10.
     2117# This tag requires that the tag HAVE_DOT is set to YES.
    16212118
    16222119DOT_FONTSIZE           = 10
    16232120
    1624 # By default doxygen will tell dot to use the Helvetica font.
    1625 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
    1626 # set the path where dot can find it.
     2121# By default doxygen will tell dot to use the default font as specified with
     2122# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
     2123# the path where dot can find it using this tag.
     2124# This tag requires that the tag HAVE_DOT is set to YES.
    16272125
    16282126DOT_FONTPATH           =
    16292127
    1630 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1631 # will generate a graph for each documented class showing the direct and
    1632 # indirect inheritance relations. Setting this tag to YES will force the
    1633 # CLASS_DIAGRAMS tag to NO.
     2128# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
     2129# each documented class showing the direct and indirect inheritance relations.
     2130# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
     2131# The default value is: YES.
     2132# This tag requires that the tag HAVE_DOT is set to YES.
    16342133
    16352134CLASS_GRAPH            = YES
    16362135
    1637 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1638 # will generate a graph for each documented class showing the direct and
    1639 # indirect implementation dependencies (inheritance, containment, and
    1640 # class references variables) of the class with other documented classes.
     2136# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
     2137# graph for each documented class showing the direct and indirect implementation
     2138# dependencies (inheritance, containment, and class references variables) of the
     2139# class with other documented classes.
     2140# The default value is: YES.
     2141# This tag requires that the tag HAVE_DOT is set to YES.
    16412142
    16422143COLLABORATION_GRAPH    = YES
    16432144
    1644 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    1645 # will generate a graph for groups, showing the direct groups dependencies
     2145# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
     2146# groups, showing the direct groups dependencies.
     2147# The default value is: YES.
     2148# This tag requires that the tag HAVE_DOT is set to YES.
    16462149
    16472150GROUP_GRAPHS           = YES
     
    16502153# collaboration diagrams in a style similar to the OMG's Unified Modeling
    16512154# Language.
     2155# The default value is: NO.
     2156# This tag requires that the tag HAVE_DOT is set to YES.
    16522157
    16532158UML_LOOK               = NO
    16542159
    1655 # If set to YES, the inheritance and collaboration graphs will show the
    1656 # relations between templates and their instances.
     2160# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
     2161# class node. If there are many fields or methods and many nodes the graph may
     2162# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
     2163# number of items for each type to make the size more manageable. Set this to 0
     2164# for no limit. Note that the threshold may be exceeded by 50% before the limit
     2165# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
     2166# but if the number exceeds 15, the total amount of fields shown is limited to
     2167# 10.
     2168# Minimum value: 0, maximum value: 100, default value: 10.
     2169# This tag requires that the tag HAVE_DOT is set to YES.
     2170
     2171UML_LIMIT_NUM_FIELDS   = 10
     2172
     2173# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
     2174# collaboration graphs will show the relations between templates and their
     2175# instances.
     2176# The default value is: NO.
     2177# This tag requires that the tag HAVE_DOT is set to YES.
    16572178
    16582179TEMPLATE_RELATIONS     = NO
    16592180
    1660 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    1661 # tags are set to YES then doxygen will generate a graph for each documented
    1662 # file showing the direct and indirect include dependencies of the file with
    1663 # other documented files.
     2181# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
     2182# YES then doxygen will generate a graph for each documented file showing the
     2183# direct and indirect include dependencies of the file with other documented
     2184# files.
     2185# The default value is: YES.
     2186# This tag requires that the tag HAVE_DOT is set to YES.
    16642187
    16652188INCLUDE_GRAPH          = YES
    16662189
    1667 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    1668 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    1669 # documented header file showing the documented files that directly or
    1670 # indirectly include this file.
     2190# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
     2191# set to YES then doxygen will generate a graph for each documented file showing
     2192# the direct and indirect include dependencies of the file with other documented
     2193# files.
     2194# The default value is: YES.
     2195# This tag requires that the tag HAVE_DOT is set to YES.
    16712196
    16722197INCLUDED_BY_GRAPH      = YES
    16732198
    1674 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    1675 # doxygen will generate a call dependency graph for every global function
    1676 # or class method. Note that enabling this option will significantly increase
    1677 # the time of a run. So in most cases it will be better to enable call graphs
    1678 # for selected functions only using the \callgraph command.
     2199# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
     2200# dependency graph for every global function or class method.
     2201#
     2202# Note that enabling this option will significantly increase the time of a run.
     2203# So in most cases it will be better to enable call graphs for selected
     2204# functions only using the \callgraph command.
     2205# The default value is: NO.
     2206# This tag requires that the tag HAVE_DOT is set to YES.
    16792207
    16802208CALL_GRAPH             = NO
    16812209
    1682 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    1683 # doxygen will generate a caller dependency graph for every global function
    1684 # or class method. Note that enabling this option will significantly increase
    1685 # the time of a run. So in most cases it will be better to enable caller
    1686 # graphs for selected functions only using the \callergraph command.
     2210# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
     2211# dependency graph for every global function or class method.
     2212#
     2213# Note that enabling this option will significantly increase the time of a run.
     2214# So in most cases it will be better to enable caller graphs for selected
     2215# functions only using the \callergraph command.
     2216# The default value is: NO.
     2217# This tag requires that the tag HAVE_DOT is set to YES.
    16872218
    16882219CALLER_GRAPH           = NO
    16892220
    1690 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1691 # will generate a graphical hierarchy of all classes instead of a textual one.
     2221# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
     2222# hierarchy of all classes instead of a textual one.
     2223# The default value is: YES.
     2224# This tag requires that the tag HAVE_DOT is set to YES.
    16922225
    16932226GRAPHICAL_HIERARCHY    = YES
    16942227
    1695 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    1696 # then doxygen will show the dependencies a directory has on other directories
    1697 # in a graphical way. The dependency relations are determined by the #include
    1698 # relations between the files in the directories.
     2228# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
     2229# dependencies a directory has on other directories in a graphical way. The
     2230# dependency relations are determined by the #include relations between the
     2231# files in the directories.
     2232# The default value is: YES.
     2233# This tag requires that the tag HAVE_DOT is set to YES.
    16992234
    17002235DIRECTORY_GRAPH        = YES
    17012236
    17022237# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1703 # generated by dot. Possible values are svg, png, jpg, or gif.
    1704 # If left blank png will be used. If you choose svg you need to set
    1705 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    1706 # visible in IE 9+ (other browsers do not have this requirement).
     2238# generated by dot.
     2239# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
     2240# to make the SVG files visible in IE 9+ (other browsers do not have this
     2241# requirement).
     2242# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
     2243# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
     2244# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
     2245# The default value is: png.
     2246# This tag requires that the tag HAVE_DOT is set to YES.
    17072247
    17082248DOT_IMAGE_FORMAT       = png
     
    17102250# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
    17112251# enable generation of interactive SVG images that allow zooming and panning.
    1712 # Note that this requires a modern browser other than Internet Explorer.
    1713 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
    1714 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    1715 # visible. Older versions of IE do not have SVG support.
    1716 
    1717 #INTERACTIVE_SVG        = NO
    1718 
    1719 # The tag DOT_PATH can be used to specify the path where the dot tool can be
     2252#
     2253# Note that this requires a modern browser other than Internet Explorer. Tested
     2254# and working are Firefox, Chrome, Safari, and Opera.
     2255# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
     2256# the SVG files visible. Older versions of IE do not have SVG support.
     2257# The default value is: NO.
     2258# This tag requires that the tag HAVE_DOT is set to YES.
     2259
     2260INTERACTIVE_SVG        = NO
     2261
     2262# The DOT_PATH tag can be used to specify the path where the dot tool can be
    17202263# found. If left blank, it is assumed the dot tool can be found in the path.
     2264# This tag requires that the tag HAVE_DOT is set to YES.
    17212265
    17222266DOT_PATH               =
    17232267
    17242268# The DOTFILE_DIRS tag can be used to specify one or more directories that
    1725 # contain dot files that are included in the documentation (see the
    1726 # \dotfile command).
     2269# contain dot files that are included in the documentation (see the \dotfile
     2270# command).
     2271# This tag requires that the tag HAVE_DOT is set to YES.
    17272272
    17282273DOTFILE_DIRS           =
    17292274
    17302275# The MSCFILE_DIRS tag can be used to specify one or more directories that
    1731 # contain msc files that are included in the documentation (see the
    1732 # \mscfile command).
    1733 
    1734 #MSCFILE_DIRS           =
    1735 
    1736 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1737 # nodes that will be shown in the graph. If the number of nodes in a graph
    1738 # becomes larger than this value, doxygen will truncate the graph, which is
    1739 # visualized by representing a node as a red box. Note that doxygen if the
    1740 # number of direct children of the root node in a graph is already larger than
    1741 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    1742 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2276# contain msc files that are included in the documentation (see the \mscfile
     2277# command).
     2278
     2279MSCFILE_DIRS           =
     2280
     2281# The DIAFILE_DIRS tag can be used to specify one or more directories that
     2282# contain dia files that are included in the documentation (see the \diafile
     2283# command).
     2284
     2285DIAFILE_DIRS           =
     2286
     2287# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
     2288# path where java can find the plantuml.jar file. If left blank, it is assumed
     2289# PlantUML is not used or called during a preprocessing step. Doxygen will
     2290# generate a warning when it encounters a \startuml command in this case and
     2291# will not generate output for the diagram.
     2292# This tag requires that the tag HAVE_DOT is set to YES.
     2293
     2294PLANTUML_JAR_PATH      =
     2295
     2296# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
     2297# that will be shown in the graph. If the number of nodes in a graph becomes
     2298# larger than this value, doxygen will truncate the graph, which is visualized
     2299# by representing a node as a red box. Note that doxygen if the number of direct
     2300# children of the root node in a graph is already larger than
     2301# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
     2302# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2303# Minimum value: 0, maximum value: 10000, default value: 50.
     2304# This tag requires that the tag HAVE_DOT is set to YES.
    17432305
    17442306DOT_GRAPH_MAX_NODES    = 50
    17452307
    1746 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1747 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1748 # from the root by following a path via at most 3 edges will be shown. Nodes
    1749 # that lay further from the root node will be omitted. Note that setting this
    1750 # option to 1 or 2 may greatly reduce the computation time needed for large
    1751 # code bases. Also note that the size of a graph can be further restricted by
     2308# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
     2309# generated by dot. A depth value of 3 means that only nodes reachable from the
     2310# root by following a path via at most 3 edges will be shown. Nodes that lay
     2311# further from the root node will be omitted. Note that setting this option to 1
     2312# or 2 may greatly reduce the computation time needed for large code bases. Also
     2313# note that the size of a graph can be further restricted by
    17522314# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
     2315# Minimum value: 0, maximum value: 1000, default value: 0.
     2316# This tag requires that the tag HAVE_DOT is set to YES.
    17532317
    17542318MAX_DOT_GRAPH_DEPTH    = 0
    17552319
    17562320# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1757 # background. This is disabled by default, because dot on Windows does not
    1758 # seem to support this out of the box. Warning: Depending on the platform used,
    1759 # enabling this option may lead to badly anti-aliased labels on the edges of
    1760 # a graph (i.e. they become hard to read).
     2321# background. This is disabled by default, because dot on Windows does not seem
     2322# to support this out of the box.
     2323#
     2324# Warning: Depending on the platform used, enabling this option may lead to
     2325# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     2326# read).
     2327# The default value is: NO.
     2328# This tag requires that the tag HAVE_DOT is set to YES.
    17612329
    17622330DOT_TRANSPARENT        = NO
     
    17642332# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    17652333# files in one run (i.e. multiple -o and -T options on the command line). This
    1766 # makes dot run faster, but since only newer versions of dot (>1.8.10)
    1767 # support this, this feature is disabled by default.
     2334# makes dot run faster, but since only newer versions of dot (>1.8.10) support
     2335# this, this feature is disabled by default.
     2336# The default value is: NO.
     2337# This tag requires that the tag HAVE_DOT is set to YES.
    17682338
    17692339DOT_MULTI_TARGETS      = YES
    17702340
    1771 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1772 # generate a legend page explaining the meaning of the various boxes and
    1773 # arrows in the dot generated graphs.
     2341# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
     2342# explaining the meaning of the various boxes and arrows in the dot generated
     2343# graphs.
     2344# The default value is: YES.
     2345# This tag requires that the tag HAVE_DOT is set to YES.
    17742346
    17752347GENERATE_LEGEND        = YES
    17762348
    1777 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    1778 # remove the intermediate dot files that are used to generate
    1779 # the various graphs.
     2349# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
     2350# files that are used to generate the various graphs.
     2351# The default value is: YES.
     2352# This tag requires that the tag HAVE_DOT is set to YES.
    17802353
    17812354DOT_CLEANUP            = YES
Note: See TracChangeset for help on using the changeset viewer.