Changeset dba677f for doc/full.cfg


Ignore:
Timestamp:
Dec 7, 2013, 8:30:10 PM (6 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
916f0929
Parents:
251da3b
Message:

doc/*.cfg: update to doxygen 1.8.5

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/full.cfg

    r251da3b rdba677f  
    1 # Doxyfile 1.8.3.1
     1# Doxyfile 1.8.5
    22
    33# This file describes the settings to be used by the documentation system
    44# doxygen (www.doxygen.org) for a project.
    55#
    6 # All text after a hash (#) is considered a comment and will be ignored.
     6# All text after a double hash (##) is considered a comment and is placed in
     7# front of the TAG it is preceding.
     8#
     9# All text after a single hash (#) is considered a comment and will be ignored.
    710# The format is:
    8 #       TAG = value [value, ...]
    9 # For lists items can also be appended using:
    10 #       TAG += value [value, ...]
    11 # Values that contain spaces should be placed between quotes (" ").
     11# TAG = value [value, ...]
     12# For lists, items can also be appended using:
     13# TAG += value [value, ...]
     14# Values that contain spaces should be placed between quotes (\" \").
    1215
    1316#---------------------------------------------------------------------------
     
    1619
    1720# This tag specifies the encoding used for all characters in the config file
    18 # that follow. The default is UTF-8 which is also the encoding used for all
    19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
    20 # iconv built into libc) for the transcoding. See
    21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
     21# that follow. The default is UTF-8 which is also the encoding used for all text
     22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
     23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
     24# for the list of possible encodings.
     25# The default value is: UTF-8.
    2226
    2327DOXYFILE_ENCODING      = UTF-8
    2428
    25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
    26 # identify the project. Note that if you do not use Doxywizard you need
    27 # to put quotes around the project name if it contains spaces.
     29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
     30# double-quotes, unless you are using Doxywizard) that should identify the
     31# project for which the documentation is generated. This name is used in the
     32# title of most generated pages and in a few other places.
     33# The default value is: My Project.
     34
    2835PROJECT_NAME           = aubio
    2936
    30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
    31 # This could be handy for archiving the generated documentation or
    32 # 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.
    3340
    3441PROJECT_NUMBER         = "0.4.0alpha full"
    3542
    3643# Using the PROJECT_BRIEF tag one can provide an optional one line description
    37 # for a project that appears at the top of each page and should give viewer
    38 # a quick idea about the purpose of the project. Keep the description short.
     44# for a project that appears at the top of each page and should give viewer a
     45# quick idea about the purpose of the project. Keep the description short.
    3946
    4047PROJECT_BRIEF          =
    4148
    42 # With the PROJECT_LOGO tag one can specify an logo or icon that is
    43 # included in the documentation. The maximum height of the logo should not
    44 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
    45 # Doxygen will copy the logo to the output directory.
     49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
     50# the documentation. The maximum height of the logo should not exceed 55 pixels
     51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
     52# to the output directory.
    4653
    4754PROJECT_LOGO           =
    4855
    49 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    50 # base path where the generated documentation will be put.
    51 # If a relative path is entered, it will be relative to the location
    52 # where doxygen was started. If left blank the current directory will be used.
     56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
     57# into which the generated documentation will be written. If a relative path is
     58# entered, it will be relative to the location where doxygen was started. If
     59# left blank the current directory will be used.
    5360
    5461OUTPUT_DIRECTORY       = full
    5562
    56 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    57 # 4096 sub-directories (in 2 levels) under the output directory of each output
    58 # format and will distribute the generated files over these directories.
    59 # Enabling this option can be useful when feeding doxygen a huge amount of
    60 # source files, where putting all generated files in the same directory would
    61 # 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.
    6270
    6371CREATE_SUBDIRS         = NO
     
    6674# documentation generated by doxygen is written. Doxygen will use this
    6775# information to generate all constant output in the proper language.
    68 # The default language is English, other supported languages are:
    69 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    70 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
    71 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
    72 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
    73 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
    74 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
     76# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
     77# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
     78# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
     79# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
     80# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
     81# Turkish, Ukrainian and Vietnamese.
     82# The default value is: English.
    7583
    7684OUTPUT_LANGUAGE        = English
    7785
    78 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    79 # include brief member descriptions after the members that are listed in
    80 # the file and class documentation (similar to JavaDoc).
    81 # Set to NO to disable this.
     86# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
     87# descriptions after the members that are listed in the file and class
     88# documentation (similar to Javadoc). Set to NO to disable this.
     89# The default value is: YES.
    8290
    8391BRIEF_MEMBER_DESC      = YES
    8492
    85 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
    86 # the brief description of a member or function before the detailed description.
    87 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
     93# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
     94# description of a member or function before the detailed description
     95#
     96# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    8897# brief descriptions will be completely suppressed.
     98# The default value is: YES.
    8999
    90100REPEAT_BRIEF           = YES
    91101
    92 # This tag implements a quasi-intelligent brief description abbreviator
    93 # that is used to form the text in various listings. Each string
    94 # in this list, if found as the leading text of the brief description, will be
    95 # stripped from the text and the result after processing the whole list, is
    96 # used as the annotated text. Otherwise, the brief description is used as-is.
    97 # If left blank, the following values are used ("$name" is automatically
    98 # replaced with the name of the entity): "The $name class" "The $name widget"
    99 # "The $name file" "is" "provides" "specifies" "contains"
    100 # "represents" "a" "an" "the"
     102# This tag implements a quasi-intelligent brief description abbreviator that is
     103# used to form the text in various listings. Each string in this list, if found
     104# as the leading text of the brief description, will be stripped from the text
     105# and the result, after processing the whole list, is used as the annotated
     106# text. Otherwise, the brief description is used as-is. If left blank, the
     107# following values are used ($name is automatically replaced with the name of
     108# the entity):The $name class, The $name widget, The $name file, is, provides,
     109# specifies, contains, represents, a, an and the.
    101110
    102111ABBREVIATE_BRIEF       =
    103112
    104113# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    105 # Doxygen will generate a detailed section even if there is only a brief
     114# doxygen will generate a detailed section even if there is only a brief
    106115# description.
     116# The default value is: NO.
    107117
    108118ALWAYS_DETAILED_SEC    = NO
     
    112122# members were ordinary class members. Constructors, destructors and assignment
    113123# operators of the base classes will not be shown.
     124# The default value is: NO.
    114125
    115126INLINE_INHERITED_MEMB  = NO
    116127
    117 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    118 # path before files name in the file list and in the header files. If set
    119 # to NO the shortest path that makes the file name unique will be used.
     128# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
     129# before files name in the file list and in the header files. If set to NO the
     130# shortest path that makes the file name unique will be used
     131# The default value is: YES.
    120132
    121133FULL_PATH_NAMES        = YES
    122134
    123 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    124 # can be used to strip a user-defined part of the path. Stripping is
    125 # only done if one of the specified strings matches the left-hand part of
    126 # the path. The tag can be used to show relative paths in the file list.
    127 # If left blank the directory from which doxygen is run is used as the
    128 # path to strip. Note that you specify absolute paths here, but also
    129 # relative paths, which will be relative from the directory where doxygen is
    130 # started.
     135# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
     136# Stripping is only done if one of the specified strings matches the left-hand
     137# part of the path. The tag can be used to show relative paths in the file list.
     138# If left blank the directory from which doxygen is run is used as the path to
     139# strip.
     140#
     141# Note that you can specify absolute paths here, but also relative paths, which
     142# will be relative from the directory where doxygen is started.
     143# This tag requires that the tag FULL_PATH_NAMES is set to YES.
    131144
    132145STRIP_FROM_PATH        = ../src
    133146
    134 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    135 # the path mentioned in the documentation of a class, which tells
    136 # the reader which header file to include in order to use a class.
    137 # If left blank only the name of the header file containing the class
    138 # definition is used. Otherwise one should specify the include paths that
    139 # are normally passed to the compiler using the -I flag.
     147# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
     148# path mentioned in the documentation of a class, which tells the reader which
     149# header file to include in order to use a class. If left blank only the name of
     150# the header file containing the class definition is used. Otherwise one should
     151# specify the list of include paths that are normally passed to the compiler
     152# using the -I flag.
    140153
    141154STRIP_FROM_INC_PATH    =
    142155
    143 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    144 # (but less readable) file names. This can be useful if your file system
    145 # doesn't support long names like on DOS, Mac, or CD-ROM.
     156# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
     157# less readable) file names. This can be useful is your file systems doesn't
     158# support long names like on DOS, Mac, or CD-ROM.
     159# The default value is: NO.
    146160
    147161SHORT_NAMES            = NO
    148162
    149 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    150 # will interpret the first line (until the first dot) of a JavaDoc-style
    151 # comment as the brief description. If set to NO, the JavaDoc
    152 # comments will behave just like regular Qt-style comments
    153 # (thus requiring an explicit @brief command for a brief description.)
     163# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
     164# first line (until the first dot) of a Javadoc-style comment as the brief
     165# description. If set to NO, the Javadoc-style will behave just like regular Qt-
     166# style comments (thus requiring an explicit @brief command for a brief
     167# description.)
     168# The default value is: NO.
    154169
    155170JAVADOC_AUTOBRIEF      = YES
    156171
    157 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
    158 # interpret the first line (until the first dot) of a Qt-style
    159 # comment as the brief description. If set to NO, the comments
    160 # will behave just like regular Qt-style comments (thus requiring
    161 # an explicit \brief command for a brief description.)
     172# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
     173# line (until the first dot) of a Qt-style comment as the brief description. If
     174# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
     175# requiring an explicit \brief command for a brief description.)
     176# The default value is: NO.
    162177
    163178QT_AUTOBRIEF           = NO
    164179
    165 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    166 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    167 # comments) as a brief description. This used to be the default behaviour.
    168 # The new default is to treat a multi-line C++ comment block as a detailed
    169 # description. Set this tag to YES if you prefer the old behaviour instead.
     180# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
     181# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
     182# a brief description. This used to be the default behavior. The new default is
     183# to treat a multi-line C++ comment block as a detailed description. Set this
     184# tag to YES if you prefer the old behavior instead.
     185#
     186# Note that setting this tag to YES also means that rational rose comments are
     187# not recognized any more.
     188# The default value is: NO.
    170189
    171190MULTILINE_CPP_IS_BRIEF = NO
    172191
    173 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    174 # member inherits the documentation from any documented member that it
    175 # re-implements.
     192# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
     193# documentation from any documented member that it re-implements.
     194# The default value is: YES.
    176195
    177196INHERIT_DOCS           = YES
    178197
    179 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    180 # a new page for each member. If set to NO, the documentation of a member will
    181 # be part of the file/class/namespace that contains it.
     198# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
     199# new page for each member. If set to NO, the documentation of a member will be
     200# part of the file/class/namespace that contains it.
     201# The default value is: NO.
    182202
    183203SEPARATE_MEMBER_PAGES  = NO
    184204
    185 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    186 # Doxygen uses this value to replace tabs by spaces in code fragments.
     205# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
     206# uses this value to replace tabs by spaces in code fragments.
     207# Minimum value: 1, maximum value: 16, default value: 4.
    187208
    188209TAB_SIZE               = 4
    189210
    190 # This tag can be used to specify a number of aliases that acts
    191 # as commands in the documentation. An alias has the form "name=value".
    192 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    193 # put the command \sideeffect (or @sideeffect) in the documentation, which
    194 # will result in a user-defined paragraph with heading "Side Effects:".
    195 # You can put \n's in the value part of an alias to insert newlines.
     211# This tag can be used to specify a number of aliases that act as commands in
     212# the documentation. An alias has the form:
     213# name=value
     214# For example adding
     215# "sideeffect=@par Side Effects:\n"
     216# will allow you to put the command \sideeffect (or @sideeffect) in the
     217# documentation, which will result in a user-defined paragraph with heading
     218# "Side Effects:". You can put \n's in the value part of an alias to insert
     219# newlines.
    196220
    197221ALIASES                =
    198222
    199223# This tag can be used to specify a number of word-keyword mappings (TCL only).
    200 # A mapping has the form "name=value". For example adding
    201 # "class=itcl::class" will allow you to use the command class in the
    202 # itcl::class meaning.
     224# A mapping has the form "name=value". For example adding "class=itcl::class"
     225# will allow you to use the command class in the itcl::class meaning.
    203226
    204227TCL_SUBST              =
    205228
    206 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    207 # sources only. Doxygen will then generate output that is more tailored for C.
    208 # For instance, some of the names that are used will be different. The list
    209 # of all members will be omitted, etc.
     229# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     230# only. Doxygen will then generate output that is more tailored for C. For
     231# instance, some of the names that are used will be different. The list of all
     232# members will be omitted, etc.
     233# The default value is: NO.
    210234
    211235OPTIMIZE_OUTPUT_FOR_C  = YES
    212236
    213 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    214 # sources only. Doxygen will then generate output that is more tailored for
    215 # Java. For instance, namespaces will be presented as packages, qualified
    216 # scopes will look different, etc.
     237# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
     238# Python sources only. Doxygen will then generate output that is more tailored
     239# for that language. For instance, namespaces will be presented as packages,
     240# qualified scopes will look different, etc.
     241# The default value is: NO.
    217242
    218243OPTIMIZE_OUTPUT_JAVA   = NO
    219244
    220245# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
    221 # sources only. Doxygen will then generate output that is more tailored for
    222 # Fortran.
     246# sources. Doxygen will then generate output that is tailored for Fortran.
     247# The default value is: NO.
    223248
    224249OPTIMIZE_FOR_FORTRAN   = NO
    225250
    226251# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
    227 # sources. Doxygen will then generate output that is tailored for
    228 # VHDL.
     252# sources. Doxygen will then generate output that is tailored for VHDL.
     253# The default value is: NO.
    229254
    230255OPTIMIZE_OUTPUT_VHDL   = NO
     
    233258# parses. With this tag you can assign which parser to use for a given
    234259# extension. Doxygen has a built-in mapping, but you can override or extend it
    235 # using this tag. The format is ext=language, where ext is a file extension,
    236 # and language is one of the parsers supported by doxygen: IDL, Java,
    237 # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
    238 # C++. For instance to make doxygen treat .inc files as Fortran files (default
    239 # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
    240 # that for custom extensions you also need to set FILE_PATTERNS otherwise the
    241 # files are not read by doxygen.
     260# using this tag. The format is ext=language, where ext is a file extension, and
     261# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
     262# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
     263# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
     264# (default is Fortran), use: inc=Fortran f=C.
     265#
     266# Note For files without extension you can use no_extension as a placeholder.
     267#
     268# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
     269# the files are not read by doxygen.
    242270
    243271EXTENSION_MAPPING      =
    244272
    245 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
    246 # comments according to the Markdown format, which allows for more readable
     273# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
     274# according to the Markdown format, which allows for more readable
    247275# documentation. See http://daringfireball.net/projects/markdown/ for details.
    248 # The output of markdown processing is further processed by doxygen, so you
    249 # can mix doxygen, HTML, and XML commands with Markdown formatting.
    250 # Disable only in case of backward compatibilities issues.
     276# The output of markdown processing is further processed by doxygen, so you can
     277# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
     278# case of backward compatibilities issues.
     279# The default value is: YES.
    251280
    252281MARKDOWN_SUPPORT       = YES
    253282
    254 # When enabled doxygen tries to link words that correspond to documented classes,
    255 # or namespaces to their corresponding documentation. Such a link can be
    256 # prevented in individual cases by by putting a % sign in front of the word or
    257 # globally by setting AUTOLINK_SUPPORT to NO.
     283# When enabled doxygen tries to link words that correspond to documented
     284# classes, or namespaces to their corresponding documentation. Such a link can
     285# be prevented in individual cases by by putting a % sign in front of the word
     286# or globally by setting AUTOLINK_SUPPORT to NO.
     287# The default value is: YES.
    258288
    259289AUTOLINK_SUPPORT       = YES
    260290
    261291# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    262 # to include (a tag file for) the STL sources as input, then you should
    263 # set this tag to YES in order to let doxygen match functions declarations and
    264 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    265 # func(std::string) {}). This also makes the inheritance and collaboration
     292# to include (a tag file for) the STL sources as input, then you should set this
     293# tag to YES in order to let doxygen match functions declarations and
     294# definitions whose arguments contain STL classes (e.g. func(std::string);
     295# versus func(std::string) {}). This also make the inheritance and collaboration
    266296# diagrams that involve STL classes more complete and accurate.
     297# The default value is: NO.
    267298
    268299BUILTIN_STL_SUPPORT    = NO
     
    270301# If you use Microsoft's C++/CLI language, you should set this option to YES to
    271302# enable parsing support.
     303# The default value is: NO.
    272304
    273305CPP_CLI_SUPPORT        = NO
    274306
    275 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
    276 # Doxygen will parse them like normal C++ but will assume all classes use public
    277 # instead of private inheritance when no explicit protection keyword is present.
     307# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
     308# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
     309# will parse them like normal C++ but will assume all classes use public instead
     310# of private inheritance when no explicit protection keyword is present.
     311# The default value is: NO.
    278312
    279313SIP_SUPPORT            = NO
    280314
    281315# For Microsoft's IDL there are propget and propput attributes to indicate
    282 # getter and setter methods for a property. Setting this option to YES (the
    283 # default) will make doxygen replace the get and set methods by a property in
    284 # the documentation. This will only work if the methods are indeed getting or
    285 # setting a simple type. If this is not the case, or you want to show the
    286 # methods anyway, you should set this option to NO.
     316# getter and setter methods for a property. Setting this option to YES will make
     317# doxygen to replace the get and set methods by a property in the documentation.
     318# This will only work if the methods are indeed getting or setting a simple
     319# type. If this is not the case, or you want to show the methods anyway, you
     320# should set this option to NO.
     321# The default value is: YES.
    287322
    288323IDL_PROPERTY_SUPPORT   = YES
     
    292327# member in the group (if any) for the other members of the group. By default
    293328# all members of a group must be documented explicitly.
     329# The default value is: NO.
    294330
    295331DISTRIBUTE_GROUP_DOC   = NO
    296332
    297 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    298 # the same type (for instance a group of public functions) to be put as a
    299 # subgroup of that type (e.g. under the Public Functions section). Set it to
    300 # NO to prevent subgrouping. Alternatively, this can be done per class using
    301 # the \nosubgrouping command.
     333# Set the SUBGROUPING tag to YES to allow class member groups of the same type
     334# (for instance a group of public functions) to be put as a subgroup of that
     335# type (e.g. under the Public Functions section). Set it to NO to prevent
     336# subgrouping. Alternatively, this can be done per class using the
     337# \nosubgrouping command.
     338# The default value is: YES.
    302339
    303340SUBGROUPING            = YES
    304341
    305 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
    306 # unions are shown inside the group in which they are included (e.g. using
    307 # @ingroup) instead of on a separate page (for HTML and Man pages) or
    308 # section (for LaTeX and RTF).
     342# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
     343# are shown inside the group in which they are included (e.g. using \ingroup)
     344# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
     345# and RTF).
     346#
     347# Note that this feature does not work in combination with
     348# SEPARATE_MEMBER_PAGES.
     349# The default value is: NO.
    309350
    310351INLINE_GROUPED_CLASSES = NO
    311352
    312 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
    313 # unions with only public data fields will be shown inline in the documentation
    314 # of the scope in which they are defined (i.e. file, namespace, or group
    315 # documentation), provided this scope is documented. If set to NO (the default),
    316 # structs, classes, and unions are shown on a separate page (for HTML and Man
    317 # pages) or section (for LaTeX and RTF).
     353# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
     354# with only public data fields or simple typedef fields will be shown inline in
     355# the documentation of the scope in which they are defined (i.e. file,
     356# namespace, or group documentation), provided this scope is documented. If set
     357# to NO, structs, classes, and unions are shown on a separate page (for HTML and
     358# Man pages) or section (for LaTeX and RTF).
     359# The default value is: NO.
    318360
    319361INLINE_SIMPLE_STRUCTS  = NO
    320362
    321 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    322 # is documented as struct, union, or enum with the name of the typedef. So
     363# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
     364# enum is documented as struct, union, or enum with the name of the typedef. So
    323365# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    324366# with name TypeT. When disabled the typedef will appear as a member of a file,
    325 # namespace, or class. And the struct will be named TypeS. This can typically
    326 # be useful for C code in case the coding convention dictates that all compound
     367# namespace, or class. And the struct will be named TypeS. This can typically be
     368# useful for C code in case the coding convention dictates that all compound
    327369# types are typedef'ed and only the typedef is referenced, never the tag name.
     370# The default value is: NO.
    328371
    329372TYPEDEF_HIDES_STRUCT   = NO
    330373
    331 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
    332 # determine which symbols to keep in memory and which to flush to disk.
    333 # When the cache is full, less often used symbols will be written to disk.
    334 # For small to medium size projects (<1000 input files) the default value is
    335 # probably good enough. For larger projects a too small cache size can cause
    336 # doxygen to be busy swapping symbols to and from disk most of the time
    337 # causing a significant performance penalty.
    338 # If the system has enough physical memory increasing the cache will improve the
    339 # performance by keeping more symbols in memory. Note that the value works on
    340 # a logarithmic scale so increasing the size by one will roughly double the
    341 # memory usage. The cache size is given by this formula:
    342 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    343 # corresponding to a cache size of 2^16 = 65536 symbols.
    344 
    345 SYMBOL_CACHE_SIZE      = 0
    346 
    347 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
    348 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
    349 # their name and scope. Since this can be an expensive process and often the
    350 # same symbol appear multiple times in the code, doxygen keeps a cache of
    351 # pre-resolved symbols. If the cache is too small doxygen will become slower.
    352 # If the cache is too large, memory is wasted. The cache size is given by this
    353 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
    354 # corresponding to a cache size of 2^16 = 65536 symbols.
     374# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
     375# cache is used to resolve symbols given their name and scope. Since this can be
     376# an expensive process and often the same symbol appears multiple times in the
     377# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
     378# doxygen will become slower. If the cache is too large, memory is wasted. The
     379# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
     380# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
     381# symbols. At the end of a run doxygen will report the cache usage and suggest
     382# the optimal cache size from a speed point of view.
     383# Minimum value: 0, maximum value: 9, default value: 0.
    355384
    356385LOOKUP_CACHE_SIZE      = 0
     
    361390
    362391# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    363 # documentation are documented, even if no documentation was available.
    364 # Private class members and static file members will be hidden unless
    365 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     392# documentation are documented, even if no documentation was available. Private
     393# class members and static file members will be hidden unless the
     394# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
     395# Note: This will also disable the warnings about undocumented members that are
     396# normally produced when WARNINGS is set to YES.
     397# The default value is: NO.
    366398
    367399EXTRACT_ALL            = YES
    368400
    369 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    370 # will be included in the documentation.
     401# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
     402# be included in the documentation.
     403# The default value is: NO.
    371404
    372405EXTRACT_PRIVATE        = YES
     
    374407# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
    375408# scope will be included in the documentation.
     409# The default value is: NO.
    376410
    377411EXTRACT_PACKAGE        = NO
    378412
    379 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    380 # will be included in the documentation.
     413# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
     414# included in the documentation.
     415# The default value is: NO.
    381416
    382417EXTRACT_STATIC         = YES
    383418
    384 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    385 # defined locally in source files will be included in the documentation.
    386 # If set to NO only classes defined in header files are included.
     419# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
     420# locally in source files will be included in the documentation. If set to NO
     421# only classes defined in header files are included. Does not have any effect
     422# for Java sources.
     423# The default value is: YES.
    387424
    388425EXTRACT_LOCAL_CLASSES  = YES
    389426
    390 # This flag is only useful for Objective-C code. When set to YES local
    391 # methods, which are defined in the implementation section but not in
    392 # the interface are included in the documentation.
    393 # If set to NO (the default) only methods in the interface are included.
     427# This flag is only useful for Objective-C code. When set to YES local methods,
     428# which are defined in the implementation section but not in the interface are
     429# included in the documentation. If set to NO only methods in the interface are
     430# included.
     431# The default value is: NO.
    394432
    395433EXTRACT_LOCAL_METHODS  = NO
     
    397435# If this flag is set to YES, the members of anonymous namespaces will be
    398436# extracted and appear in the documentation as a namespace called
    399 # 'anonymous_namespace{file}', where file will be replaced with the base
    400 # name of the file that contains the anonymous namespace. By default
    401 # anonymous namespaces are hidden.
     437# 'anonymous_namespace{file}', where file will be replaced with the base name of
     438# the file that contains the anonymous namespace. By default anonymous namespace
     439# are hidden.
     440# The default value is: NO.
    402441
    403442EXTRACT_ANON_NSPACES   = NO
    404443
    405 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    406 # undocumented members of documented classes, files or namespaces.
    407 # If set to NO (the default) these members will be included in the
    408 # various overviews, but no documentation section is generated.
    409 # This option has no effect if EXTRACT_ALL is enabled.
     444# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
     445# undocumented members inside documented classes or files. If set to NO these
     446# members will be included in the various overviews, but no documentation
     447# section is generated. This option has no effect if EXTRACT_ALL is enabled.
     448# The default value is: NO.
    410449
    411450HIDE_UNDOC_MEMBERS     = NO
    412451
    413 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    414 # undocumented classes that are normally visible in the class hierarchy.
    415 # If set to NO (the default) these classes will be included in the various
    416 # overviews. This option has no effect if EXTRACT_ALL is enabled.
     452# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
     453# undocumented classes that are normally visible in the class hierarchy. If set
     454# to NO these classes will be included in the various overviews. This option has
     455# no effect if EXTRACT_ALL is enabled.
     456# The default value is: NO.
    417457
    418458HIDE_UNDOC_CLASSES     = NO
    419459
    420 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    421 # friend (class|struct|union) declarations.
    422 # If set to NO (the default) these declarations will be included in the
    423 # documentation.
     460# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
     461# (class|struct|union) declarations. If set to NO these declarations will be
     462# included in the documentation.
     463# The default value is: NO.
    424464
    425465HIDE_FRIEND_COMPOUNDS  = NO
    426466
    427 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    428 # documentation blocks found inside the body of a function.
    429 # If set to NO (the default) these blocks will be appended to the
    430 # function's detailed documentation block.
     467# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
     468# documentation blocks found inside the body of a function. If set to NO these
     469# blocks will be appended to the function's detailed documentation block.
     470# The default value is: NO.
    431471
    432472HIDE_IN_BODY_DOCS      = NO
    433473
    434 # The INTERNAL_DOCS tag determines if documentation
    435 # that is typed after a \internal command is included. If the tag is set
    436 # to NO (the default) then the documentation will be excluded.
    437 # Set it to YES to include the internal documentation.
     474# The INTERNAL_DOCS tag determines if documentation that is typed after a
     475# \internal command is included. If the tag is set to NO then the documentation
     476# will be excluded. Set it to YES to include the internal documentation.
     477# The default value is: NO.
    438478
    439479INTERNAL_DOCS          = NO
    440480
    441 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    442 # file names in lower-case letters. If set to YES upper-case letters are also
     481# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
     482# names in lower-case letters. If set to YES upper-case letters are also
    443483# allowed. This is useful if you have classes or files whose names only differ
    444484# in case and if your file system supports case sensitive file names. Windows
    445485# and Mac users are advised to set this option to NO.
     486# The default value is: system dependent.
    446487
    447488CASE_SENSE_NAMES       = NO
    448489
    449 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    450 # will show members with their full class and namespace scopes in the
    451 # documentation. If set to YES the scope will be hidden.
     490# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
     491# their full class and namespace scopes in the documentation. If set to YES the
     492# scope will be hidden.
     493# The default value is: NO.
    452494
    453495HIDE_SCOPE_NAMES       = NO
    454496
    455 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    456 # will put a list of the files that are included by a file in the documentation
    457 # of that file.
     497# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
     498# the files that are included by a file in the documentation of that file.
     499# The default value is: YES.
    458500
    459501SHOW_INCLUDE_FILES     = YES
    460502
    461 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
    462 # will list include files with double quotes in the documentation
    463 # rather than with sharp brackets.
     503# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
     504# files with double quotes in the documentation rather than with sharp brackets.
     505# The default value is: NO.
    464506
    465507FORCE_LOCAL_INCLUDES   = NO
    466508
    467 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    468 # is inserted in the documentation for inline members.
     509# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
     510# documentation for inline members.
     511# The default value is: YES.
    469512
    470513INLINE_INFO            = YES
    471514
    472 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    473 # will sort the (detailed) documentation of file and class members
    474 # alphabetically by member name. If set to NO the members will appear in
    475 # declaration order.
     515# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
     516# (detailed) documentation of file and class members alphabetically by member
     517# name. If set to NO the members will appear in declaration order.
     518# The default value is: YES.
    476519
    477520SORT_MEMBER_DOCS       = YES
    478521
    479 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
    480 # brief documentation of file, namespace and class members alphabetically
    481 # by member name. If set to NO (the default) the members will appear in
    482 # declaration order.
     522# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
     523# descriptions of file, namespace and class members alphabetically by member
     524# name. If set to NO the members will appear in declaration order.
     525# The default value is: NO.
    483526
    484527SORT_BRIEF_DOCS        = NO
    485528
    486 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
    487 # will sort the (brief and detailed) documentation of class members so that
    488 # constructors and destructors are listed first. If set to NO (the default)
    489 # the constructors will appear in the respective orders defined by
    490 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
    491 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
    492 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     529# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
     530# (brief and detailed) documentation of class members so that constructors and
     531# destructors are listed first. If set to NO the constructors will appear in the
     532# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
     533# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
     534# member documentation.
     535# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
     536# detailed member documentation.
     537# The default value is: NO.
    493538
    494539SORT_MEMBERS_CTORS_1ST = NO
    495540
    496 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
    497 # hierarchy of group names into alphabetical order. If set to NO (the default)
    498 # the group names will appear in their defined order.
     541# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
     542# of group names into alphabetical order. If set to NO the group names will
     543# appear in their defined order.
     544# The default value is: NO.
    499545
    500546SORT_GROUP_NAMES       = NO
    501547
    502 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    503 # sorted by fully-qualified names, including namespaces. If set to
    504 # NO (the default), the class list will be sorted only by class name,
    505 # not including the namespace part.
     548# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
     549# fully-qualified names, including namespaces. If set to NO, the class list will
     550# be sorted only by class name, not including the namespace part.
    506551# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    507 # Note: This option applies only to the class list, not to the
    508 # alphabetical list.
     552# Note: This option applies only to the class list, not to the alphabetical
     553# list.
     554# The default value is: NO.
    509555
    510556SORT_BY_SCOPE_NAME     = NO
    511557
    512 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
    513 # do proper type resolution of all parameters of a function it will reject a
    514 # match between the prototype and the implementation of a member function even
    515 # if there is only one candidate or it is obvious which candidate to choose
    516 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
    517 # will still accept a match between prototype and implementation in such cases.
     558# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
     559# type resolution of all parameters of a function it will reject a match between
     560# the prototype and the implementation of a member function even if there is
     561# only one candidate or it is obvious which candidate to choose by doing a
     562# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
     563# accept a match between prototype and implementation in such cases.
     564# The default value is: NO.
    518565
    519566STRICT_PROTO_MATCHING  = NO
    520567
    521 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    522 # disable (NO) the todo list. This list is created by putting \todo
    523 # commands in the documentation.
     568# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
     569# todo list. This list is created by putting \todo commands in the
     570# documentation.
     571# The default value is: YES.
    524572
    525573GENERATE_TODOLIST      = YES
    526574
    527 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    528 # disable (NO) the test list. This list is created by putting \test
    529 # commands in the documentation.
     575# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
     576# test list. This list is created by putting \test commands in the
     577# documentation.
     578# The default value is: YES.
    530579
    531580GENERATE_TESTLIST      = YES
    532581
    533 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    534 # disable (NO) the bug list. This list is created by putting \bug
    535 # commands in the documentation.
     582# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
     583# list. This list is created by putting \bug commands in the documentation.
     584# The default value is: YES.
    536585
    537586GENERATE_BUGLIST       = YES
    538587
    539 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    540 # disable (NO) the deprecated list. This list is created by putting
    541 # \deprecated commands in the documentation.
     588# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
     589# the deprecated list. This list is created by putting \deprecated commands in
     590# the documentation.
     591# The default value is: YES.
    542592
    543593GENERATE_DEPRECATEDLIST= YES
    544594
    545 # The ENABLED_SECTIONS tag can be used to enable conditional
    546 # documentation sections, marked by \if section-label ... \endif
    547 # and \cond section-label ... \endcond blocks.
     595# The ENABLED_SECTIONS tag can be used to enable conditional documentation
     596# sections, marked by \if <section_label> ... \endif and \cond <section_label>
     597# ... \endcond blocks.
    548598
    549599ENABLED_SECTIONS       =
    550600
    551 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    552 # the initial value of a variable or macro consists of for it to appear in
    553 # the documentation. If the initializer consists of more lines than specified
    554 # here it will be hidden. Use a value of 0 to hide initializers completely.
    555 # The appearance of the initializer of individual variables and macros in the
    556 # documentation can be controlled using \showinitializer or \hideinitializer
    557 # command in the documentation regardless of this setting.
     601# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
     602# initial value of a variable or macro / define can have for it to appear in the
     603# documentation. If the initializer consists of more lines than specified here
     604# it will be hidden. Use a value of 0 to hide initializers completely. The
     605# appearance of the value of individual variables and macros / defines can be
     606# controlled using \showinitializer or \hideinitializer command in the
     607# documentation regardless of this setting.
     608# Minimum value: 0, maximum value: 10000, default value: 30.
    558609
    559610MAX_INITIALIZER_LINES  = 30
    560611
    561 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    562 # at the bottom of the documentation of classes and structs. If set to YES the
    563 # list will mention the files that were used to generate the documentation.
     612# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
     613# the bottom of the documentation of classes and structs. If set to YES the list
     614# will mention the files that were used to generate the documentation.
     615# The default value is: YES.
    564616
    565617SHOW_USED_FILES        = YES
    566618
    567 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    568 # This will remove the Files entry from the Quick Index and from the
    569 # Folder Tree View (if specified). The default is YES.
     619# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
     620# will remove the Files entry from the Quick Index and from the Folder Tree View
     621# (if specified).
     622# The default value is: YES.
    570623
    571624SHOW_FILES             = YES
    572625
    573 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    574 # Namespaces page.
    575 # This will remove the Namespaces entry from the Quick Index
    576 # and from the Folder Tree View (if specified). The default is YES.
     626# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
     627# page. This will remove the Namespaces entry from the Quick Index and from the
     628# Folder Tree View (if specified).
     629# The default value is: YES.
    577630
    578631SHOW_NAMESPACES        = YES
     
    581634# doxygen should invoke to get the current version for each file (typically from
    582635# the version control system). Doxygen will invoke the program by executing (via
    583 # popen()) the command <command> <input-file>, where <command> is the value of
    584 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    585 # provided by doxygen. Whatever the program writes to standard output
    586 # is used as the file version. See the manual for examples.
     636# popen()) the command command input-file, where command is the value of the
     637# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
     638# by doxygen. Whatever the program writes to standard output is used as the file
     639# version. For an example see the documentation.
    587640
    588641FILE_VERSION_FILTER    =
     
    591644# by doxygen. The layout file controls the global structure of the generated
    592645# output files in an output format independent way. To create the layout file
    593 # that represents doxygen's defaults, run doxygen with the -l option.
    594 # You can optionally specify a file name after the option, if omitted
    595 # DoxygenLayout.xml will be used as the name of the layout file.
     646# that represents doxygen's defaults, run doxygen with the -l option. You can
     647# optionally specify a file name after the option, if omitted DoxygenLayout.xml
     648# will be used as the name of the layout file.
     649#
     650# Note that if you run doxygen from a directory containing a file called
     651# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
     652# tag is left empty.
    596653
    597654LAYOUT_FILE            =
    598655
    599 # The CITE_BIB_FILES tag can be used to specify one or more bib files
    600 # containing the references data. This must be a list of .bib files. The
    601 # .bib extension is automatically appended if omitted. Using this command
    602 # requires the bibtex tool to be installed. See also
    603 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
    604 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
    605 # feature you need bibtex and perl available in the search path. Do not use
    606 # file names with spaces, bibtex cannot handle them.
     656# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
     657# the reference definitions. This must be a list of .bib files. The .bib
     658# extension is automatically appended if omitted. This requires the bibtex tool
     659# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
     660# For LaTeX the style of the bibliography can be controlled using
     661# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
     662# search path. Do not use file names with spaces, bibtex cannot handle them. See
     663# also \cite for info how to create references.
    607664
    608665CITE_BIB_FILES         =
    609666
    610667#---------------------------------------------------------------------------
    611 # configuration options related to warning and progress messages
    612 #---------------------------------------------------------------------------
    613 
    614 # The QUIET tag can be used to turn on/off the messages that are generated
    615 # by doxygen. Possible values are YES and NO. If left blank NO is used.
     668# Configuration options related to warning and progress messages
     669#---------------------------------------------------------------------------
     670
     671# The QUIET tag can be used to turn on/off the messages that are generated to
     672# standard output by doxygen. If QUIET is set to YES this implies that the
     673# messages are off.
     674# The default value is: NO.
    616675
    617676QUIET                  = NO
    618677
    619678# The WARNINGS tag can be used to turn on/off the warning messages that are
    620 # generated by doxygen. Possible values are YES and NO. If left blank
    621 # NO is used.
     679# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
     680# this implies that the warnings are on.
     681#
     682# Tip: Turn warnings on while writing the documentation.
     683# The default value is: YES.
    622684
    623685WARNINGS               = YES
    624686
    625 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    626 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    627 # automatically be disabled.
     687# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
     688# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
     689# will automatically be disabled.
     690# The default value is: YES.
    628691
    629692WARN_IF_UNDOCUMENTED   = YES
    630693
    631 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    632 # potential errors in the documentation, such as not documenting some
    633 # parameters in a documented function, or documenting parameters that
    634 # don't exist or using markup commands wrongly.
     694# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
     695# potential errors in the documentation, such as not documenting some parameters
     696# in a documented function, or documenting parameters that don't exist or using
     697# markup commands wrongly.
     698# The default value is: YES.
    635699
    636700WARN_IF_DOC_ERROR      = YES
    637701
    638 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
    639 # functions that are documented, but have no documentation for their parameters
    640 # or return value. If set to NO (the default) doxygen will only warn about
    641 # wrong or incomplete parameter documentation, but not about the absence of
    642 # documentation.
     702# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
     703# are documented, but have no documentation for their parameters or return
     704# value. If set to NO doxygen will only warn about wrong or incomplete parameter
     705# documentation, but not about the absence of documentation.
     706# The default value is: NO.
    643707
    644708WARN_NO_PARAMDOC       = NO
    645709
    646 # The WARN_FORMAT tag determines the format of the warning messages that
    647 # doxygen can produce. The string should contain the $file, $line, and $text
    648 # tags, which will be replaced by the file and line number from which the
    649 # warning originated and the warning text. Optionally the format may contain
    650 # $version, which will be replaced by the version of the file (if it could
    651 # be obtained via FILE_VERSION_FILTER)
     710# The WARN_FORMAT tag determines the format of the warning messages that doxygen
     711# can produce. The string should contain the $file, $line, and $text tags, which
     712# will be replaced by the file and line number from which the warning originated
     713# and the warning text. Optionally the format may contain $version, which will
     714# be replaced by the version of the file (if it could be obtained via
     715# FILE_VERSION_FILTER)
     716# The default value is: $file:$line: $text.
    652717
    653718WARN_FORMAT            = "$file:$line: $text"
    654719
    655 # The WARN_LOGFILE tag can be used to specify a file to which warning
    656 # and error messages should be written. If left blank the output is written
    657 # to stderr.
     720# The WARN_LOGFILE tag can be used to specify a file to which warning and error
     721# messages should be written. If left blank the output is written to standard
     722# error (stderr).
    658723
    659724WARN_LOGFILE           =
    660725
    661726#---------------------------------------------------------------------------
    662 # configuration options related to the input files
    663 #---------------------------------------------------------------------------
    664 
    665 # The INPUT tag can be used to specify the files and/or directories that contain
    666 # documented source files. You may enter file names like "myfile.cpp" or
    667 # directories like "/usr/src/myproject". Separate the files or directories
    668 # with spaces.
     727# Configuration options related to the input files
     728#---------------------------------------------------------------------------
     729
     730# The INPUT tag is used to specify the files and/or directories that contain
     731# documented source files. You may enter file names like myfile.cpp or
     732# directories like /usr/src/myproject. Separate the files or directories with
     733# spaces.
     734# Note: If this tag is empty the current directory is searched.
    669735
    670736INPUT                  = ../src
    671737
    672738# This tag can be used to specify the character encoding of the source files
    673 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    674 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    675 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    676 # the list of possible encodings.
     739# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
     740# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
     741# documentation (see: http://www.gnu.org/software/libiconv) for the list of
     742# possible encodings.
     743# The default value is: UTF-8.
    677744
    678745INPUT_ENCODING         = UTF-8
    679746
    680747# If the value of the INPUT tag contains directories, you can use the
    681 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    682 # and *.h) to filter out the source-files in the directories. If left
    683 # blank the following patterns are tested:
    684 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
    685 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
    686 # *.f90 *.f *.for *.vhd *.vhdl
    687 
    688 FILE_PATTERNS          = *.h *.c
    689 
    690 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    691 # should be searched for input files as well. Possible values are YES and NO.
    692 # If left blank NO is used.
     748# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
     749# *.h) to filter out the source-files in the directories. If left blank the
     750# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
     751# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
     752# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
     753# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
     754# *.qsf, *.as and *.js.
     755
     756FILE_PATTERNS          = *.h \
     757                         *.c
     758
     759# The RECURSIVE tag can be used to specify whether or not subdirectories should
     760# be searched for input files as well.
     761# The default value is: NO.
    693762
    694763RECURSIVE              = YES
     
    697766# excluded from the INPUT source files. This way you can easily exclude a
    698767# subdirectory from a directory tree whose root is specified with the INPUT tag.
     768#
    699769# Note that relative paths are relative to the directory from which doxygen is
    700770# run.
     
    705775# directories that are symbolic links (a Unix file system feature) are excluded
    706776# from the input.
     777# The default value is: NO.
    707778
    708779EXCLUDE_SYMLINKS       = NO
     
    710781# If the value of the INPUT tag contains directories, you can use the
    711782# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    712 # certain files from those directories. Note that the wildcards are matched
    713 # against the file with absolute path, so to exclude all test directories
    714 # for example use the pattern */test/*
     783# certain files from those directories.
     784#
     785# Note that the wildcards are matched against the file with absolute path, so to
     786# exclude all test directories for example use the pattern */test/*
    715787
    716788EXCLUDE_PATTERNS       =
     
    721793# wildcard * is used, a substring. Examples: ANamespace, AClass,
    722794# AClass::ANamespace, ANamespace::*Test
     795#
     796# Note that the wildcards are matched against the file with absolute path, so to
     797# exclude all test directories use the pattern */test/*
    723798
    724799EXCLUDE_SYMBOLS        =
    725800
    726 # The EXAMPLE_PATH tag can be used to specify one or more files or
    727 # directories that contain example code fragments that are included (see
    728 # the \include command).
    729 
    730 EXAMPLE_PATH           = ../examples ../tests/src
     801# The EXAMPLE_PATH tag can be used to specify one or more files or directories
     802# that contain example code fragments that are included (see the \include
     803# command).
     804
     805EXAMPLE_PATH           = ../examples \
     806                         ../tests/src
    731807
    732808# If the value of the EXAMPLE_PATH tag contains directories, you can use the
    733 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    734 # and *.h) to filter out the source-files in the directories. If left
    735 # blank all files are included.
     809# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
     810# *.h) to filter out the source-files in the directories. If left blank all
     811# files are included.
    736812
    737813EXAMPLE_PATTERNS       =
    738814
    739815# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
    740 # searched for input files to be used with the \include or \dontinclude
    741 # commands irrespective of the value of the RECURSIVE tag.
    742 # Possible values are YES and NO. If left blank NO is used.
     816# searched for input files to be used with the \include or \dontinclude commands
     817# irrespective of the value of the RECURSIVE tag.
     818# The default value is: NO.
    743819
    744820EXAMPLE_RECURSIVE      = NO
    745821
    746 # The IMAGE_PATH tag can be used to specify one or more files or
    747 # directories that contain image that are included in the documentation (see
    748 # the \image command).
     822# The IMAGE_PATH tag can be used to specify one or more files or directories
     823# that contain images that are to be included in the documentation (see the
     824# \image command).
    749825
    750826IMAGE_PATH             =
     
    752828# The INPUT_FILTER tag can be used to specify a program that doxygen should
    753829# invoke to filter for each input file. Doxygen will invoke the filter program
    754 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    755 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    756 # input file. Doxygen will then use the output that the filter program writes
    757 # to standard output.
    758 # If FILTER_PATTERNS is specified, this tag will be
    759 # ignored.
     830# by executing (via popen()) the command:
     831#
     832# <filter> <input-file>
     833#
     834# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
     835# name of an input file. Doxygen will then use the output that the filter
     836# program writes to standard output. If FILTER_PATTERNS is specified, this tag
     837# will be ignored.
     838#
     839# Note that the filter must not add or remove lines; it is applied before the
     840# code is scanned, but not when the output code is generated. If lines are added
     841# or removed, the anchors will not be placed correctly.
    760842
    761843INPUT_FILTER           =
    762844
    763845# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    764 # basis.
    765 # Doxygen will compare the file name with each pattern and apply the
    766 # filter if there is a match.
    767 # The filters are a list of the form:
    768 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    769 # info on how filters are used. If FILTER_PATTERNS is empty or if
    770 # non of the patterns match the file name, INPUT_FILTER is applied.
     846# basis. Doxygen will compare the file name with each pattern and apply the
     847# filter if there is a match. The filters are a list of the form: pattern=filter
     848# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
     849# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
     850# patterns match the file name, INPUT_FILTER is applied.
    771851
    772852FILTER_PATTERNS        =
    773853
    774854# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    775 # INPUT_FILTER) will be used to filter the input files when producing source
    776 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
     855# INPUT_FILTER ) will also be used to filter the input files that are used for
     856# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
     857# The default value is: NO.
    777858
    778859FILTER_SOURCE_FILES    = NO
    779860
    780861# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
    781 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
    782 # and it is also possible to disable source filtering for a specific pattern
    783 # using *.ext= (so without naming a filter). This option only has effect when
    784 # FILTER_SOURCE_FILES is enabled.
     862# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
     863# it is also possible to disable source filtering for a specific pattern using
     864# *.ext= (so without naming a filter).
     865# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
    785866
    786867FILTER_SOURCE_PATTERNS =
    787868
    788 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
    789 # is part of the input, its contents will be placed on the main page (index.html).
    790 # This can be useful if you have a project on for instance GitHub and want reuse
    791 # the introduction page also for the doxygen output.
     869# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
     870# is part of the input, its contents will be placed on the main page
     871# (index.html). This can be useful if you have a project on for instance GitHub
     872# and want to reuse the introduction page also for the doxygen output.
    792873
    793874USE_MDFILE_AS_MAINPAGE =
    794875
    795876#---------------------------------------------------------------------------
    796 # configuration options related to source browsing
    797 #---------------------------------------------------------------------------
    798 
    799 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    800 # be generated. Documented entities will be cross-referenced with these sources.
    801 # Note: To get rid of all source code in the generated output, make sure also
    802 # VERBATIM_HEADERS is set to NO.
     877# Configuration options related to source browsing
     878#---------------------------------------------------------------------------
     879
     880# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
     881# generated. Documented entities will be cross-referenced with these sources.
     882#
     883# Note: To get rid of all source code in the generated output, make sure that
     884# also VERBATIM_HEADERS is set to NO.
     885# The default value is: NO.
    803886
    804887SOURCE_BROWSER         = YES
    805888
    806 # Setting the INLINE_SOURCES tag to YES will include the body
    807 # of functions and classes directly in the documentation.
     889# Setting the INLINE_SOURCES tag to YES will include the body of functions,
     890# classes and enums directly into the documentation.
     891# The default value is: NO.
    808892
    809893INLINE_SOURCES         = NO
    810894
    811 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    812 # doxygen to hide any special comment blocks from generated source code
    813 # fragments. Normal C, C++ and Fortran comments will always remain visible.
     895# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
     896# special comment blocks from generated source code fragments. Normal C, C++ and
     897# Fortran comments will always remain visible.
     898# The default value is: YES.
    814899
    815900STRIP_CODE_COMMENTS    = NO
    816901
    817 # If the REFERENCED_BY_RELATION tag is set to YES
    818 # then for each documented function all documented
    819 # functions referencing it will be listed.
     902# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
     903# function all documented functions referencing it will be listed.
     904# The default value is: NO.
    820905
    821906REFERENCED_BY_RELATION = YES
    822907
    823 # If the REFERENCES_RELATION tag is set to YES
    824 # then for each documented function all documented entities
    825 # called/used by that function will be listed.
     908# If the REFERENCES_RELATION tag is set to YES then for each documented function
     909# all documented entities called/used by that function will be listed.
     910# The default value is: NO.
    826911
    827912REFERENCES_RELATION    = YES
    828913
    829 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    830 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    831 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    832 # link to the source code.
    833 # Otherwise they will link to the documentation.
     914# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
     915# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
     916# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
     917# link to the documentation.
     918# The default value is: YES.
    834919
    835920REFERENCES_LINK_SOURCE = YES
    836921
    837 # If the USE_HTAGS tag is set to YES then the references to source code
    838 # will point to the HTML generated by the htags(1) tool instead of doxygen
    839 # built-in source browser. The htags tool is part of GNU's global source
    840 # tagging system (see http://www.gnu.org/software/global/global.html). You
    841 # will need version 4.8.6 or higher.
     922# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
     923# source code will show a tooltip with additional information such as prototype,
     924# brief description and links to the definition and documentation. Since this
     925# will make the HTML file larger and loading of large files a bit slower, you
     926# can opt to disable this feature.
     927# The default value is: YES.
     928# This tag requires that the tag SOURCE_BROWSER is set to YES.
     929
     930SOURCE_TOOLTIPS        = YES
     931
     932# If the USE_HTAGS tag is set to YES then the references to source code will
     933# point to the HTML generated by the htags(1) tool instead of doxygen built-in
     934# source browser. The htags tool is part of GNU's global source tagging system
     935# (see http://www.gnu.org/software/global/global.html). You will need version
     936# 4.8.6 or higher.
     937#
     938# To use it do the following:
     939# - Install the latest version of global
     940# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
     941# - Make sure the INPUT points to the root of the source tree
     942# - Run doxygen as normal
     943#
     944# Doxygen will invoke htags (and that will in turn invoke gtags), so these
     945# tools must be available from the command line (i.e. in the search path).
     946#
     947# The result: instead of the source browser generated by doxygen, the links to
     948# source code will now point to the output of htags.
     949# The default value is: NO.
     950# This tag requires that the tag SOURCE_BROWSER is set to YES.
    842951
    843952USE_HTAGS              = NO
    844953
    845 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    846 # will generate a verbatim copy of the header file for each class for
    847 # which an include is specified. Set to NO to disable this.
     954# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
     955# verbatim copy of the header file for each class for which an include is
     956# specified. Set to NO to disable this.
     957# See also: Section \class.
     958# The default value is: YES.
    848959
    849960VERBATIM_HEADERS       = YES
    850961
    851962#---------------------------------------------------------------------------
    852 # configuration options related to the alphabetical class index
    853 #---------------------------------------------------------------------------
    854 
    855 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
    856 # of all compounds will be generated. Enable this if the project
    857 # contains a lot of classes, structs, unions or interfaces.
     963# Configuration options related to the alphabetical class index
     964#---------------------------------------------------------------------------
     965
     966# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
     967# compounds will be generated. Enable this if the project contains a lot of
     968# classes, structs, unions or interfaces.
     969# The default value is: YES.
    858970
    859971ALPHABETICAL_INDEX     = NO
    860972
    861 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
    862 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    863 # in which this list will be split (can be a number in the range [1..20])
     973# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
     974# which the alphabetical index list will be split.
     975# Minimum value: 1, maximum value: 20, default value: 5.
     976# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    864977
    865978COLS_IN_ALPHA_INDEX    = 5
    866979
    867 # In case all classes in a project start with a common prefix, all
    868 # classes will be put under the same header in the alphabetical index.
    869 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    870 # should be ignored while generating the index headers.
     980# In case all classes in a project start with a common prefix, all classes will
     981# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
     982# can be used to specify a prefix (or a list of prefixes) that should be ignored
     983# while generating the index headers.
     984# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    871985
    872986IGNORE_PREFIX          =
    873987
    874988#---------------------------------------------------------------------------
    875 # configuration options related to the HTML output
    876 #---------------------------------------------------------------------------
    877 
    878 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    879 # generate HTML output.
     989# Configuration options related to the HTML output
     990#---------------------------------------------------------------------------
     991
     992# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
     993# The default value is: YES.
    880994
    881995GENERATE_HTML          = YES
    882996
    883 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
    884 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    885 # put in front of it. If left blank `html' will be used as the default path.
     997# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
     998# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     999# it.
     1000# The default directory is: html.
     1001# This tag requires that the tag GENERATE_HTML is set to YES.
    8861002
    8871003HTML_OUTPUT            = html
    8881004
    889 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
    890 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    891 # doxygen will generate files with .html extension.
     1005# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
     1006# generated HTML page (for example: .htm, .php, .asp).
     1007# The default value is: .html.
     1008# This tag requires that the tag GENERATE_HTML is set to YES.
    8921009
    8931010HTML_FILE_EXTENSION    = .html
    8941011
    895 # The HTML_HEADER tag can be used to specify a personal HTML header for
    896 # each generated HTML page. If it is left blank doxygen will generate a
    897 # standard header. Note that when using a custom header you are responsible
    898 #  for the proper inclusion of any scripts and style sheets that doxygen
    899 # needs, which is dependent on the configuration options used.
    900 # It is advised to generate a default header using "doxygen -w html
    901 # header.html footer.html stylesheet.css YourConfigFile" and then modify
    902 # that header. Note that the header is subject to change so you typically
    903 # have to redo this when upgrading to a newer version of doxygen or when
    904 # changing the value of configuration settings such as GENERATE_TREEVIEW!
     1012# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
     1013# each generated HTML page. If the tag is left blank doxygen will generate a
     1014# standard header.
     1015#
     1016# To get valid HTML the header file that includes any scripts and style sheets
     1017# that doxygen needs, which is dependent on the configuration options used (e.g.
     1018# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
     1019# default header using
     1020# doxygen -w html new_header.html new_footer.html new_stylesheet.css
     1021# YourConfigFile
     1022# and then modify the file new_header.html. See also section "Doxygen usage"
     1023# for information on how to generate the default header that doxygen normally
     1024# uses.
     1025# Note: The header is subject to change so you typically have to regenerate the
     1026# default header when upgrading to a newer version of doxygen. For a description
     1027# of the possible markers and block names see the documentation.
     1028# This tag requires that the tag GENERATE_HTML is set to YES.
    9051029
    9061030HTML_HEADER            =
    9071031
    908 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    909 # each generated HTML page. If it is left blank doxygen will generate a
    910 # standard footer.
     1032# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
     1033# generated HTML page. If the tag is left blank doxygen will generate a standard
     1034# footer. See HTML_HEADER for more information on how to generate a default
     1035# footer and what special commands can be used inside the footer. See also
     1036# section "Doxygen usage" for information on how to generate the default footer
     1037# that doxygen normally uses.
     1038# This tag requires that the tag GENERATE_HTML is set to YES.
    9111039
    9121040HTML_FOOTER            =
    9131041
    914 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    915 # style sheet that is used by each HTML page. It can be used to
    916 # fine-tune the look of the HTML output. If left blank doxygen will
    917 # generate a default style sheet. Note that it is recommended to use
    918 # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
    919 # tag will in the future become obsolete.
     1042# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
     1043# sheet that is used by each HTML page. It can be used to fine-tune the look of
     1044# the HTML output. If left blank doxygen will generate a default style sheet.
     1045# See also section "Doxygen usage" for information on how to generate the style
     1046# sheet that doxygen normally uses.
     1047# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
     1048# it is more robust and this tag (HTML_STYLESHEET) will in the future become
     1049# obsolete.
     1050# This tag requires that the tag GENERATE_HTML is set to YES.
    9201051
    9211052HTML_STYLESHEET        =
    9221053
    923 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
    924 # user-defined cascading style sheet that is included after the standard
    925 # style sheets created by doxygen. Using this option one can overrule
    926 # certain style aspects. This is preferred over using HTML_STYLESHEET
    927 # since it does not replace the standard style sheet and is therefor more
    928 # robust against future updates. Doxygen will copy the style sheet file to
    929 # the output directory.
     1054# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
     1055# defined cascading style sheet that is included after the standard style sheets
     1056# created by doxygen. Using this option one can overrule certain style aspects.
     1057# This is preferred over using HTML_STYLESHEET since it does not replace the
     1058# standard style sheet and is therefor more robust against future updates.
     1059# Doxygen will copy the style sheet file to the output directory. For an example
     1060# see the documentation.
     1061# This tag requires that the tag GENERATE_HTML is set to YES.
    9301062
    9311063HTML_EXTRA_STYLESHEET  =
     
    9341066# other source files which should be copied to the HTML output directory. Note
    9351067# that these files will be copied to the base HTML output directory. Use the
    936 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
    937 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
    938 # the files will be copied as-is; there are no commands or markers available.
     1068# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     1069# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
     1070# files will be copied as-is; there are no commands or markers available.
     1071# This tag requires that the tag GENERATE_HTML is set to YES.
    9391072
    9401073HTML_EXTRA_FILES       =
    9411074
    942 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
    943 # Doxygen will adjust the colors in the style sheet and background images
    944 # according to this color. Hue is specified as an angle on a colorwheel,
    945 # see http://en.wikipedia.org/wiki/Hue for more information.
    946 # For instance the value 0 represents red, 60 is yellow, 120 is green,
    947 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
    948 # The allowed range is 0 to 359.
     1075# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
     1076# will adjust the colors in the stylesheet and background images according to
     1077# this color. Hue is specified as an angle on a colorwheel, see
     1078# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
     1079# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
     1080# purple, and 360 is red again.
     1081# Minimum value: 0, maximum value: 359, default value: 220.
     1082# This tag requires that the tag GENERATE_HTML is set to YES.
    9491083
    9501084HTML_COLORSTYLE_HUE    = 220
    9511085
    952 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
    953 # the colors in the HTML output. For a value of 0 the output will use
    954 # grayscales only. A value of 255 will produce the most vivid colors.
     1086# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
     1087# in the HTML output. For a value of 0 the output will use grayscales only. A
     1088# value of 255 will produce the most vivid colors.
     1089# Minimum value: 0, maximum value: 255, default value: 100.
     1090# This tag requires that the tag GENERATE_HTML is set to YES.
    9551091
    9561092HTML_COLORSTYLE_SAT    = 100
    9571093
    958 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
    959 # the luminance component of the colors in the HTML output. Values below
    960 # 100 gradually make the output lighter, whereas values above 100 make
    961 # the output darker. The value divided by 100 is the actual gamma applied,
    962 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
    963 # and 100 does not change the gamma.
     1094# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
     1095# luminance component of the colors in the HTML output. Values below 100
     1096# gradually make the output lighter, whereas values above 100 make the output
     1097# darker. The value divided by 100 is the actual gamma applied, so 80 represents
     1098# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
     1099# change the gamma.
     1100# Minimum value: 40, maximum value: 240, default value: 80.
     1101# This tag requires that the tag GENERATE_HTML is set to YES.
    9641102
    9651103HTML_COLORSTYLE_GAMMA  = 80
    9661104
    9671105# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
    968 # page will contain the date and time when the page was generated. Setting
    969 # this to NO can help when comparing the output of multiple runs.
     1106# page will contain the date and time when the page was generated. Setting this
     1107# to NO can help when comparing the output of multiple runs.
     1108# The default value is: YES.
     1109# This tag requires that the tag GENERATE_HTML is set to YES.
    9701110
    9711111HTML_TIMESTAMP         = YES
     
    9741114# documentation will contain sections that can be hidden and shown after the
    9751115# page has loaded.
     1116# The default value is: NO.
     1117# This tag requires that the tag GENERATE_HTML is set to YES.
    9761118
    9771119HTML_DYNAMIC_SECTIONS  = NO
    9781120
    979 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
    980 # entries shown in the various tree structured indices initially; the user
    981 # can expand and collapse entries dynamically later on. Doxygen will expand
    982 # the tree to such a level that at most the specified number of entries are
    983 # visible (unless a fully collapsed tree already exceeds this amount).
    984 # So setting the number of entries 1 will produce a full collapsed tree by
    985 # default. 0 is a special value representing an infinite number of entries
    986 # and will result in a full expanded tree by default.
     1121# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
     1122# shown in the various tree structured indices initially; the user can expand
     1123# and collapse entries dynamically later on. Doxygen will expand the tree to
     1124# such a level that at most the specified number of entries are visible (unless
     1125# a fully collapsed tree already exceeds this amount). So setting the number of
     1126# entries 1 will produce a full collapsed tree by default. 0 is a special value
     1127# representing an infinite number of entries and will result in a full expanded
     1128# tree by default.
     1129# Minimum value: 0, maximum value: 9999, default value: 100.
     1130# This tag requires that the tag GENERATE_HTML is set to YES.
    9871131
    9881132HTML_INDEX_NUM_ENTRIES = 100
    9891133
    990 # If the GENERATE_DOCSET tag is set to YES, additional index files
    991 # will be generated that can be used as input for Apple's Xcode 3
    992 # integrated development environment, introduced with OSX 10.5 (Leopard).
    993 # To create a documentation set, doxygen will generate a Makefile in the
    994 # HTML output directory. Running make will produce the docset in that
    995 # directory and running "make install" will install the docset in
    996 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    997 # it at startup.
    998 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1134# If the GENERATE_DOCSET tag is set to YES, additional index files will be
     1135# generated that can be used as input for Apple's Xcode 3 integrated development
     1136# environment (see: http://developer.apple.com/tools/xcode/), introduced with
     1137# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
     1138# Makefile in the HTML output directory. Running make will produce the docset in
     1139# that directory and running make install will install the docset in
     1140# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
     1141# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
    9991142# for more information.
     1143# The default value is: NO.
     1144# This tag requires that the tag GENERATE_HTML is set to YES.
    10001145
    10011146GENERATE_DOCSET        = NO
    10021147
    1003 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    1004 # feed. A documentation feed provides an umbrella under which multiple
    1005 # documentation sets from a single provider (such as a company or product suite)
    1006 # can be grouped.
     1148# This tag determines the name of the docset feed. A documentation feed provides
     1149# an umbrella under which multiple documentation sets from a single provider
     1150# (such as a company or product suite) can be grouped.
     1151# The default value is: Doxygen generated docs.
     1152# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10071153
    10081154DOCSET_FEEDNAME        = "Doxygen generated docs"
    10091155
    1010 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    1011 # should uniquely identify the documentation set bundle. This should be a
    1012 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    1013 # will append .docset to the name.
     1156# This tag specifies a string that should uniquely identify the documentation
     1157# set bundle. This should be a reverse domain-name style string, e.g.
     1158# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
     1159# The default value is: org.doxygen.Project.
     1160# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10141161
    10151162DOCSET_BUNDLE_ID       = org.aubio.aubio
    10161163
    1017 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
    1018 # identify the documentation publisher. This should be a reverse domain-name
    1019 # style string, e.g. com.mycompany.MyDocSet.documentation.
     1164# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
     1165# the documentation publisher. This should be a reverse domain-name style
     1166# string, e.g. com.mycompany.MyDocSet.documentation.
     1167# The default value is: org.doxygen.Publisher.
     1168# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10201169
    10211170DOCSET_PUBLISHER_ID    = org.aubio.aubio.Maintainer
    10221171
    1023 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
     1172# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
     1173# The default value is: Publisher.
     1174# This tag requires that the tag GENERATE_DOCSET is set to YES.
    10241175
    10251176DOCSET_PUBLISHER_NAME  = Publisher
    10261177
    1027 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    1028 # will be generated that can be used as input for tools like the
    1029 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    1030 # of the generated HTML documentation.
     1178# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
     1179# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
     1180# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
     1181# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
     1182# Windows.
     1183#
     1184# The HTML Help Workshop contains a compiler that can convert all HTML output
     1185# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
     1186# files are now used as the Windows 98 help format, and will replace the old
     1187# Windows help format (.hlp) on all Windows platforms in the future. Compressed
     1188# HTML files also contain an index, a table of contents, and you can search for
     1189# words in the documentation. The HTML workshop also contains a viewer for
     1190# compressed HTML files.
     1191# The default value is: NO.
     1192# This tag requires that the tag GENERATE_HTML is set to YES.
    10311193
    10321194GENERATE_HTMLHELP      = NO
    10331195
    1034 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    1035 # be used to specify the file name of the resulting .chm file. You
    1036 # can add a path in front of the file if the result should not be
     1196# The CHM_FILE tag can be used to specify the file name of the resulting .chm
     1197# file. You can add a path in front of the file if the result should not be
    10371198# written to the html output directory.
     1199# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10381200
    10391201CHM_FILE               =
    10401202
    1041 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    1042 # be used to specify the location (absolute path including file name) of
    1043 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    1044 # the HTML help compiler on the generated index.hhp.
     1203# The HHC_LOCATION tag can be used to specify the location (absolute path
     1204# including file name) of the HTML help compiler ( hhc.exe). If non-empty
     1205# doxygen will try to run the HTML help compiler on the generated index.hhp.
     1206# The file has to be specified with full path.
     1207# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10451208
    10461209HHC_LOCATION           =
    10471210
    1048 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    1049 # controls if a separate .chi index file is generated (YES) or that
    1050 # it should be included in the master .chm file (NO).
     1211# The GENERATE_CHI flag controls if a separate .chi index file is generated (
     1212# YES) or that it should be included in the master .chm file ( NO).
     1213# The default value is: NO.
     1214# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10511215
    10521216GENERATE_CHI           = NO
    10531217
    1054 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    1055 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    1056 # content.
     1218# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
     1219# and project file content.
     1220# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10571221
    10581222CHM_INDEX_ENCODING     =
    10591223
    1060 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    1061 # controls whether a binary table of contents is generated (YES) or a
    1062 # normal table of contents (NO) in the .chm file.
     1224# The BINARY_TOC flag controls whether a binary table of contents is generated (
     1225# YES) or a normal table of contents ( NO) in the .chm file.
     1226# The default value is: NO.
     1227# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10631228
    10641229BINARY_TOC             = NO
    10651230
    1066 # The TOC_EXPAND flag can be set to YES to add extra items for group members
    1067 # to the contents of the HTML help documentation and to the tree view.
     1231# The TOC_EXPAND flag can be set to YES to add extra items for group members to
     1232# the table of contents of the HTML help documentation and to the tree view.
     1233# The default value is: NO.
     1234# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    10681235
    10691236TOC_EXPAND             = NO
    10701237
    10711238# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
    1072 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
    1073 # that can be used as input for Qt's qhelpgenerator to generate a
    1074 # Qt Compressed Help (.qch) of the generated HTML documentation.
     1239# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
     1240# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
     1241# (.qch) of the generated HTML documentation.
     1242# The default value is: NO.
     1243# This tag requires that the tag GENERATE_HTML is set to YES.
    10751244
    10761245GENERATE_QHP           = NO
    10771246
    1078 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    1079 # be used to specify the file name of the resulting .qch file.
    1080 # The path specified is relative to the HTML output folder.
     1247# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
     1248# the file name of the resulting .qch file. The path specified is relative to
     1249# the HTML output folder.
     1250# This tag requires that the tag GENERATE_QHP is set to YES.
    10811251
    10821252QCH_FILE               =
    10831253
    1084 # The QHP_NAMESPACE tag specifies the namespace to use when generating
    1085 # Qt Help Project output. For more information please see
    1086 # http://doc.trolltech.com/qthelpproject.html#namespace
     1254# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
     1255# Project output. For more information please see Qt Help Project / Namespace
     1256# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
     1257# The default value is: org.doxygen.Project.
     1258# This tag requires that the tag GENERATE_QHP is set to YES.
    10871259
    10881260QHP_NAMESPACE          =
    10891261
    1090 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    1091 # Qt Help Project output. For more information please see
    1092 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
     1262# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
     1263# Help Project output. For more information please see Qt Help Project / Virtual
     1264# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
     1265# folders).
     1266# The default value is: doc.
     1267# This tag requires that the tag GENERATE_QHP is set to YES.
    10931268
    10941269QHP_VIRTUAL_FOLDER     = doc
    10951270
    1096 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
    1097 # add. For more information please see
    1098 # http://doc.trolltech.com/qthelpproject.html#custom-filters
     1271# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
     1272# filter to add. For more information please see Qt Help Project / Custom
     1273# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1274# filters).
     1275# This tag requires that the tag GENERATE_QHP is set to YES.
    10991276
    11001277QHP_CUST_FILTER_NAME   =
    11011278
    1102 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
    1103 # custom filter to add. For more information please see
    1104 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
    1105 # Qt Help Project / Custom Filters</a>.
     1279# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
     1280# custom filter to add. For more information please see Qt Help Project / Custom
     1281# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1282# filters).
     1283# This tag requires that the tag GENERATE_QHP is set to YES.
    11061284
    11071285QHP_CUST_FILTER_ATTRS  =
    11081286
    11091287# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
    1110 # project's
    1111 # filter section matches.
    1112 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
    1113 # Qt Help Project / Filter Attributes</a>.
     1288# project's filter section matches. Qt Help Project / Filter Attributes (see:
     1289# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
     1290# This tag requires that the tag GENERATE_QHP is set to YES.
    11141291
    11151292QHP_SECT_FILTER_ATTRS  =
    11161293
    1117 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    1118 # be used to specify the location of Qt's qhelpgenerator.
    1119 # If non-empty doxygen will try to run qhelpgenerator on the generated
    1120 # .qhp file.
     1294# The QHG_LOCATION tag can be used to specify the location of Qt's
     1295# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
     1296# generated .qhp file.
     1297# This tag requires that the tag GENERATE_QHP is set to YES.
    11211298
    11221299QHG_LOCATION           =
    11231300
    1124 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
    1125 #  will be generated, which together with the HTML files, form an Eclipse help
    1126 # plugin. To install this plugin and make it available under the help contents
    1127 # menu in Eclipse, the contents of the directory containing the HTML and XML
    1128 # files needs to be copied into the plugins directory of eclipse. The name of
    1129 # the directory within the plugins directory should be the same as
    1130 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
    1131 # the help appears.
     1301# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
     1302# generated, together with the HTML files, they form an Eclipse help plugin. To
     1303# install this plugin and make it available under the help contents menu in
     1304# Eclipse, the contents of the directory containing the HTML and XML files needs
     1305# to be copied into the plugins directory of eclipse. The name of the directory
     1306# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
     1307# After copying Eclipse needs to be restarted before the help appears.
     1308# The default value is: NO.
     1309# This tag requires that the tag GENERATE_HTML is set to YES.
    11321310
    11331311GENERATE_ECLIPSEHELP   = NO
    11341312
    1135 # A unique identifier for the eclipse help plugin. When installing the plugin
    1136 # the directory name containing the HTML and XML files should also have
    1137 # this name.
     1313# A unique identifier for the Eclipse help plugin. When installing the plugin
     1314# the directory name containing the HTML and XML files should also have this
     1315# name. Each documentation set should have its own identifier.
     1316# The default value is: org.doxygen.Project.
     1317# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
    11381318
    11391319ECLIPSE_DOC_ID         = org.aubio.aubio
    11401320
    1141 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
    1142 # at top of each HTML page. The value NO (the default) enables the index and
    1143 # the value YES disables it. Since the tabs have the same information as the
    1144 # navigation tree you can set this option to NO if you already set
    1145 # GENERATE_TREEVIEW to YES.
     1321# If you want full control over the layout of the generated HTML pages it might
     1322# be necessary to disable the index and replace it with your own. The
     1323# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
     1324# of each HTML page. A value of NO enables the index and the value YES disables
     1325# it. Since the tabs in the index contain the same information as the navigation
     1326# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
     1327# The default value is: NO.
     1328# This tag requires that the tag GENERATE_HTML is set to YES.
    11461329
    11471330DISABLE_INDEX          = NO
    11481331
    11491332# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    1150 # structure should be generated to display hierarchical information.
    1151 # If the tag value is set to YES, a side panel will be generated
    1152 # containing a tree-like index structure (just like the one that
    1153 # is generated for HTML Help). For this to work a browser that supports
    1154 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    1155 # Windows users are probably better off using the HTML help feature.
    1156 # Since the tree basically has the same information as the tab index you
    1157 # could consider to set DISABLE_INDEX to NO when enabling this option.
     1333# structure should be generated to display hierarchical information. If the tag
     1334# value is set to YES, a side panel will be generated containing a tree-like
     1335# index structure (just like the one that is generated for HTML Help). For this
     1336# to work a browser that supports JavaScript, DHTML, CSS and frames is required
     1337# (i.e. any modern browser). Windows users are probably better off using the
     1338# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
     1339# further fine-tune the look of the index. As an example, the default style
     1340# sheet generated by doxygen has an example that shows how to put an image at
     1341# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
     1342# the same information as the tab index, you could consider setting
     1343# DISABLE_INDEX to YES when enabling this option.
     1344# The default value is: NO.
     1345# This tag requires that the tag GENERATE_HTML is set to YES.
    11581346
    11591347GENERATE_TREEVIEW      = NO
    11601348
    1161 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
    1162 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
    1163 # documentation. Note that a value of 0 will completely suppress the enum
    1164 # values from appearing in the overview section.
     1349# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
     1350# doxygen will group on one line in the generated HTML documentation.
     1351#
     1352# Note that a value of 0 will completely suppress the enum values from appearing
     1353# in the overview section.
     1354# Minimum value: 0, maximum value: 20, default value: 4.
     1355# This tag requires that the tag GENERATE_HTML is set to YES.
    11651356
    11661357ENUM_VALUES_PER_LINE   = 4
    11671358
    1168 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    1169 # used to set the initial width (in pixels) of the frame in which the tree
    1170 # is shown.
     1359# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
     1360# to set the initial width (in pixels) of the frame in which the tree is shown.
     1361# Minimum value: 0, maximum value: 1500, default value: 250.
     1362# This tag requires that the tag GENERATE_HTML is set to YES.
    11711363
    11721364TREEVIEW_WIDTH         = 250
    11731365
    1174 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
    1175 # links to external symbols imported via tag files in a separate window.
     1366# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
     1367# external symbols imported via tag files in a separate window.
     1368# The default value is: NO.
     1369# This tag requires that the tag GENERATE_HTML is set to YES.
    11761370
    11771371EXT_LINKS_IN_WINDOW    = NO
    11781372
    1179 # Use this tag to change the font size of Latex formulas included
    1180 # as images in the HTML documentation. The default is 10. Note that
    1181 # when you change the font size after a successful doxygen run you need
    1182 # to manually remove any form_*.png images from the HTML output directory
    1183 # to force them to be regenerated.
     1373# Use this tag to change the font size of LaTeX formulas included as images in
     1374# the HTML documentation. When you change the font size after a successful
     1375# doxygen run you need to manually remove any form_*.png images from the HTML
     1376# output directory to force them to be regenerated.
     1377# Minimum value: 8, maximum value: 50, default value: 10.
     1378# This tag requires that the tag GENERATE_HTML is set to YES.
    11841379
    11851380FORMULA_FONTSIZE       = 10
    11861381
    11871382# Use the FORMULA_TRANPARENT tag to determine whether or not the images
    1188 # generated for formulas are transparent PNGs. Transparent PNGs are
    1189 # not supported properly for IE 6.0, but are supported on all modern browsers.
    1190 # Note that when changing this option you need to delete any form_*.png files
    1191 # in the HTML output before the changes have effect.
     1383# generated for formulas are transparent PNGs. Transparent PNGs are not
     1384# supported properly for IE 6.0, but are supported on all modern browsers.
     1385#
     1386# Note that when changing this option you need to delete any form_*.png files in
     1387# the HTML output directory before the changes have effect.
     1388# The default value is: YES.
     1389# This tag requires that the tag GENERATE_HTML is set to YES.
    11921390
    11931391FORMULA_TRANSPARENT    = YES
    11941392
    1195 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
    1196 # (see http://www.mathjax.org) which uses client side Javascript for the
    1197 # rendering instead of using prerendered bitmaps. Use this if you do not
    1198 # have LaTeX installed or if you want to formulas look prettier in the HTML
    1199 # output. When enabled you may also need to install MathJax separately and
    1200 # configure the path to it using the MATHJAX_RELPATH option.
     1393# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
     1394# http://www.mathjax.org) which uses client side Javascript for the rendering
     1395# instead of using prerendered bitmaps. Use this if you do not have LaTeX
     1396# installed or if you want to formulas look prettier in the HTML output. When
     1397# enabled you may also need to install MathJax separately and configure the path
     1398# to it using the MATHJAX_RELPATH option.
     1399# The default value is: NO.
     1400# This tag requires that the tag GENERATE_HTML is set to YES.
    12011401
    12021402USE_MATHJAX            = YES
    12031403
    12041404# When MathJax is enabled you can set the default output format to be used for
    1205 # thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
    1206 # SVG. The default value is HTML-CSS, which is slower, but has the best
    1207 # compatibility.
     1405# the MathJax output. See the MathJax site (see:
     1406# http://docs.mathjax.org/en/latest/output.html) for more details.
     1407# Possible values are: HTML-CSS (which is slower, but has the best
     1408# compatibility), NativeMML (i.e. MathML) and SVG.
     1409# The default value is: HTML-CSS.
     1410# This tag requires that the tag USE_MATHJAX is set to YES.
    12081411
    12091412MATHJAX_FORMAT         = HTML-CSS
    12101413
    1211 # When MathJax is enabled you need to specify the location relative to the
    1212 # HTML output directory using the MATHJAX_RELPATH option. The destination
    1213 # directory should contain the MathJax.js script. For instance, if the mathjax
    1214 # directory is located at the same level as the HTML output directory, then
    1215 # MATHJAX_RELPATH should be ../mathjax. The default value points to
    1216 # the MathJax Content Delivery Network so you can quickly see the result without
    1217 # installing MathJax.
    1218 # However, it is strongly recommended to install a local
    1219 # copy of MathJax from http://www.mathjax.org before deployment.
     1414# When MathJax is enabled you need to specify the location relative to the HTML
     1415# output directory using the MATHJAX_RELPATH option. The destination directory
     1416# should contain the MathJax.js script. For instance, if the mathjax directory
     1417# is located at the same level as the HTML output directory, then
     1418# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
     1419# Content Delivery Network so you can quickly see the result without installing
     1420# MathJax. However, it is strongly recommended to install a local copy of
     1421# MathJax from http://www.mathjax.org before deployment.
     1422# The default value is: http://cdn.mathjax.org/mathjax/latest.
     1423# This tag requires that the tag USE_MATHJAX is set to YES.
    12201424
    12211425MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
    12221426
    1223 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
    1224 # names that should be enabled during MathJax rendering.
     1427# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
     1428# extension names that should be enabled during MathJax rendering. For example
     1429# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
     1430# This tag requires that the tag USE_MATHJAX is set to YES.
    12251431
    12261432MATHJAX_EXTENSIONS     =
    12271433
    1228 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
    1229 # for the HTML output. The underlying search engine uses javascript
    1230 # and DHTML and should work on any modern browser. Note that when using
    1231 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
    1232 # (GENERATE_DOCSET) there is already a search function so this one should
    1233 # typically be disabled. For large projects the javascript based search engine
    1234 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
     1434# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
     1435# of code that will be used on startup of the MathJax code. See the MathJax site
     1436# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
     1437# example see the documentation.
     1438# This tag requires that the tag USE_MATHJAX is set to YES.
     1439
     1440MATHJAX_CODEFILE       =
     1441
     1442# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
     1443# the HTML output. The underlying search engine uses javascript and DHTML and
     1444# should work on any modern browser. Note that when using HTML help
     1445# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
     1446# there is already a search function so this one should typically be disabled.
     1447# For large projects the javascript based search engine can be slow, then
     1448# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
     1449# search using the keyboard; to jump to the search box use <access key> + S
     1450# (what the <access key> is depends on the OS and browser, but it is typically
     1451# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
     1452# key> to jump into the search results window, the results can be navigated
     1453# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
     1454# the search. The filter options can be selected when the cursor is inside the
     1455# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
     1456# to select a filter and <Enter> or <escape> to activate or cancel the filter
     1457# option.
     1458# The default value is: YES.
     1459# This tag requires that the tag GENERATE_HTML is set to YES.
    12351460
    12361461SEARCHENGINE           = YES
    12371462
    12381463# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    1239 # implemented using a web server instead of a web client using Javascript.
    1240 # There are two flavours of web server based search depending on the
     1464# implemented using a web server instead of a web client using Javascript. There
     1465# are two flavours of web server based searching depending on the
    12411466# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
    12421467# searching and an index file used by the script. When EXTERNAL_SEARCH is
    1243 # enabled the indexing and searching needs to be provided by external tools.
    1244 # See the manual for details.
     1468# enabled the indexing and searching needs to be provided by external tools. See
     1469# the section "External Indexing and Searching" for details.
     1470# The default value is: NO.
     1471# This tag requires that the tag SEARCHENGINE is set to YES.
    12451472
    12461473SERVER_BASED_SEARCH    = NO
    12471474
    1248 # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
     1475# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
    12491476# script for searching. Instead the search results are written to an XML file
    12501477# which needs to be processed by an external indexer. Doxygen will invoke an
    1251 # external search engine pointed to by the SEARCHENGINE_URL option to obtain
    1252 # the search results. Doxygen ships with an example indexer (doxyindexer) and
    1253 # search engine (doxysearch.cgi) which are based on the open source search engine
    1254 # library Xapian. See the manual for configuration details.
     1478# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
     1479# search results.
     1480#
     1481# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1482# (doxysearch.cgi) which are based on the open source search engine library
     1483# Xapian (see: http://xapian.org/).
     1484#
     1485# See the section "External Indexing and Searching" for details.
     1486# The default value is: NO.
     1487# This tag requires that the tag SEARCHENGINE is set to YES.
    12551488
    12561489EXTERNAL_SEARCH        = NO
    12571490
    12581491# The SEARCHENGINE_URL should point to a search engine hosted by a web server
    1259 # which will returned the search results when EXTERNAL_SEARCH is enabled.
    1260 # Doxygen ships with an example search engine (doxysearch) which is based on
    1261 # the open source search engine library Xapian. See the manual for configuration
    1262 # details.
     1492# which will return the search results when EXTERNAL_SEARCH is enabled.
     1493#
     1494# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1495# (doxysearch.cgi) which are based on the open source search engine library
     1496# Xapian (see: http://xapian.org/). See the section "External Indexing and
     1497# Searching" for details.
     1498# This tag requires that the tag SEARCHENGINE is set to YES.
    12631499
    12641500SEARCHENGINE_URL       =
     
    12671503# search data is written to a file for indexing by an external tool. With the
    12681504# SEARCHDATA_FILE tag the name of this file can be specified.
     1505# The default file is: searchdata.xml.
     1506# This tag requires that the tag SEARCHENGINE is set to YES.
    12691507
    12701508SEARCHDATA_FILE        = searchdata.xml
    12711509
    1272 # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
     1510# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
    12731511# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
    12741512# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
    12751513# projects and redirect the results back to the right project.
     1514# This tag requires that the tag SEARCHENGINE is set to YES.
    12761515
    12771516EXTERNAL_SEARCH_ID     =
     
    12801519# projects other than the one defined by this configuration file, but that are
    12811520# all added to the same external search index. Each project needs to have a
    1282 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
    1283 # of to a relative location where the documentation can be found.
    1284 # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
     1521# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
     1522# to a relative location where the documentation can be found. The format is:
     1523# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
     1524# This tag requires that the tag SEARCHENGINE is set to YES.
    12851525
    12861526EXTRA_SEARCH_MAPPINGS  =
    12871527
    12881528#---------------------------------------------------------------------------
    1289 # configuration options related to the LaTeX output
    1290 #---------------------------------------------------------------------------
    1291 
    1292 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    1293 # generate Latex output.
     1529# Configuration options related to the LaTeX output
     1530#---------------------------------------------------------------------------
     1531
     1532# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
     1533# The default value is: YES.
    12941534
    12951535GENERATE_LATEX         = NO
    12961536
    1297 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    1298 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1299 # put in front of it. If left blank `latex' will be used as the default path.
     1537# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
     1538# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1539# it.
     1540# The default directory is: latex.
     1541# This tag requires that the tag GENERATE_LATEX is set to YES.
    13001542
    13011543LATEX_OUTPUT           = latex
    13021544
    13031545# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    1304 # invoked. If left blank `latex' will be used as the default command name.
    1305 # Note that when enabling USE_PDFLATEX this option is only used for
    1306 # generating bitmaps for formulas in the HTML output, but not in the
    1307 # Makefile that is written to the output directory.
     1546# invoked.
     1547#
     1548# Note that when enabling USE_PDFLATEX this option is only used for generating
     1549# bitmaps for formulas in the HTML output, but not in the Makefile that is
     1550# written to the output directory.
     1551# The default file is: latex.
     1552# This tag requires that the tag GENERATE_LATEX is set to YES.
    13081553
    13091554LATEX_CMD_NAME         = latex
    13101555
    1311 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    1312 # generate index for LaTeX. If left blank `makeindex' will be used as the
    1313 # default command name.
     1556# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
     1557# index for LaTeX.
     1558# The default file is: makeindex.
     1559# This tag requires that the tag GENERATE_LATEX is set to YES.
    13141560
    13151561MAKEINDEX_CMD_NAME     = makeindex
    13161562
    1317 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    1318 # LaTeX documents. This may be useful for small projects and may help to
    1319 # save some trees in general.
     1563# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
     1564# documents. This may be useful for small projects and may help to save some
     1565# trees in general.
     1566# The default value is: NO.
     1567# This tag requires that the tag GENERATE_LATEX is set to YES.
    13201568
    13211569COMPACT_LATEX          = NO
    13221570
    1323 # The PAPER_TYPE tag can be used to set the paper type that is used
    1324 # by the printer. Possible values are: a4, letter, legal and
    1325 # executive. If left blank a4wide will be used.
     1571# The PAPER_TYPE tag can be used to set the paper type that is used by the
     1572# printer.
     1573# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
     1574# 14 inches) and executive (7.25 x 10.5 inches).
     1575# The default value is: a4.
     1576# This tag requires that the tag GENERATE_LATEX is set to YES.
    13261577
    13271578PAPER_TYPE             = a4
    13281579
    1329 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    1330 # packages that should be included in the LaTeX output.
     1580# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
     1581# that should be included in the LaTeX output. To get the times font for
     1582# instance you can specify
     1583# EXTRA_PACKAGES=times
     1584# If left blank no extra packages will be included.
     1585# This tag requires that the tag GENERATE_LATEX is set to YES.
    13311586
    13321587EXTRA_PACKAGES         =
    13331588
    1334 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    1335 # the generated latex document. The header should contain everything until
    1336 # the first chapter. If it is left blank doxygen will generate a
    1337 # standard header. Notice: only use this tag if you know what you are doing!
     1589# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
     1590# generated LaTeX document. The header should contain everything until the first
     1591# chapter. If it is left blank doxygen will generate a standard header. See
     1592# section "Doxygen usage" for information on how to let doxygen write the
     1593# default header to a separate file.
     1594#
     1595# Note: Only use a user-defined header if you know what you are doing! The
     1596# following commands have a special meaning inside the header: $title,
     1597# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
     1598# replace them by respectively the title of the page, the current date and time,
     1599# only the current date, the version number of doxygen, the project name (see
     1600# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
     1601# This tag requires that the tag GENERATE_LATEX is set to YES.
    13381602
    13391603LATEX_HEADER           =
    13401604
    1341 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
    1342 # the generated latex document. The footer should contain everything after
    1343 # the last chapter. If it is left blank doxygen will generate a
    1344 # standard footer. Notice: only use this tag if you know what you are doing!
     1605# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
     1606# generated LaTeX document. The footer should contain everything after the last
     1607# chapter. If it is left blank doxygen will generate a standard footer.
     1608#
     1609# Note: Only use a user-defined footer if you know what you are doing!
     1610# This tag requires that the tag GENERATE_LATEX is set to YES.
    13451611
    13461612LATEX_FOOTER           =
    13471613
    1348 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    1349 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    1350 # contain links (just like the HTML output) instead of page references
    1351 # This makes the output suitable for online browsing using a pdf viewer.
     1614# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
     1615# other source files which should be copied to the LATEX_OUTPUT output
     1616# directory. Note that the files will be copied as-is; there are no commands or
     1617# markers available.
     1618# This tag requires that the tag GENERATE_LATEX is set to YES.
     1619
     1620LATEX_EXTRA_FILES      =
     1621
     1622# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
     1623# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
     1624# contain links (just like the HTML output) instead of page references. This
     1625# makes the output suitable for online browsing using a PDF viewer.
     1626# The default value is: YES.
     1627# This tag requires that the tag GENERATE_LATEX is set to YES.
    13521628
    13531629PDF_HYPERLINKS         = YES
    13541630
    1355 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    1356 # plain latex in the generated Makefile. Set this option to YES to get a
     1631# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
     1632# the PDF file directly from the LaTeX files. Set this option to YES to get a
    13571633# higher quality PDF documentation.
     1634# The default value is: YES.
     1635# This tag requires that the tag GENERATE_LATEX is set to YES.
    13581636
    13591637USE_PDFLATEX           = YES
    13601638
    1361 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    1362 # command to the generated LaTeX files. This will instruct LaTeX to keep
    1363 # running if errors occur, instead of asking the user for help.
    1364 # This option is also used when generating formulas in HTML.
     1639# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
     1640# command to the generated LaTeX files. This will instruct LaTeX to keep running
     1641# if errors occur, instead of asking the user for help. This option is also used
     1642# when generating formulas in HTML.
     1643# The default value is: NO.
     1644# This tag requires that the tag GENERATE_LATEX is set to YES.
    13651645
    13661646LATEX_BATCHMODE        = NO
    13671647
    1368 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    1369 # include the index chapters (such as File Index, Compound Index, etc.)
    1370 # in the output.
     1648# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
     1649# index chapters (such as File Index, Compound Index, etc.) in the output.
     1650# The default value is: NO.
     1651# This tag requires that the tag GENERATE_LATEX is set to YES.
    13711652
    13721653LATEX_HIDE_INDICES     = NO
    13731654
    1374 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
    1375 # source code with syntax highlighting in the LaTeX output.
    1376 # Note that which sources are shown also depends on other settings
    1377 # such as SOURCE_BROWSER.
     1655# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
     1656# code with syntax highlighting in the LaTeX output.
     1657#
     1658# Note that which sources are shown also depends on other settings such as
     1659# SOURCE_BROWSER.
     1660# The default value is: NO.
     1661# This tag requires that the tag GENERATE_LATEX is set to YES.
    13781662
    13791663LATEX_SOURCE_CODE      = NO
    13801664
    13811665# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
    1382 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
    1383 # http://en.wikipedia.org/wiki/BibTeX for more info.
     1666# bibliography, e.g. plainnat, or ieeetr. See
     1667# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
     1668# The default value is: plain.
     1669# This tag requires that the tag GENERATE_LATEX is set to YES.
    13841670
    13851671LATEX_BIB_STYLE        = plain
    13861672
    13871673#---------------------------------------------------------------------------
    1388 # configuration options related to the RTF output
    1389 #---------------------------------------------------------------------------
    1390 
    1391 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    1392 # The RTF output is optimized for Word 97 and may not look very pretty with
    1393 # other RTF readers or editors.
     1674# Configuration options related to the RTF output
     1675#---------------------------------------------------------------------------
     1676
     1677# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
     1678# RTF output is optimized for Word 97 and may not look too pretty with other RTF
     1679# readers/editors.
     1680# The default value is: NO.
    13941681
    13951682GENERATE_RTF           = NO
    13961683
    1397 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    1398 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1399 # put in front of it. If left blank `rtf' will be used as the default path.
     1684# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
     1685# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1686# it.
     1687# The default directory is: rtf.
     1688# This tag requires that the tag GENERATE_RTF is set to YES.
    14001689
    14011690RTF_OUTPUT             = rtf
    14021691
    1403 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    1404 # RTF documents. This may be useful for small projects and may help to
    1405 # save some trees in general.
     1692# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
     1693# documents. This may be useful for small projects and may help to save some
     1694# trees in general.
     1695# The default value is: NO.
     1696# This tag requires that the tag GENERATE_RTF is set to YES.
    14061697
    14071698COMPACT_RTF            = NO
    14081699
    1409 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    1410 # will contain hyperlink fields. The RTF file will
    1411 # contain links (just like the HTML output) instead of page references.
    1412 # This makes the output suitable for online browsing using WORD or other
    1413 # programs which support those fields.
    1414 # Note: wordpad (write) and others do not support links.
     1700# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
     1701# contain hyperlink fields. The RTF file will contain links (just like the HTML
     1702# output) instead of page references. This makes the output suitable for online
     1703# browsing using Word or some other Word compatible readers that support those
     1704# fields.
     1705#
     1706# Note: WordPad (write) and others do not support links.
     1707# The default value is: NO.
     1708# This tag requires that the tag GENERATE_RTF is set to YES.
    14151709
    14161710RTF_HYPERLINKS         = NO
    14171711
    1418 # Load style sheet definitions from file. Syntax is similar to doxygen's
    1419 # config file, i.e. a series of assignments. You only have to provide
    1420 # replacements, missing definitions are set to their default value.
     1712# Load stylesheet definitions from file. Syntax is similar to doxygen's config
     1713# file, i.e. a series of assignments. You only have to provide replacements,
     1714# missing definitions are set to their default value.
     1715#
     1716# See also section "Doxygen usage" for information on how to generate the
     1717# default style sheet that doxygen normally uses.
     1718# This tag requires that the tag GENERATE_RTF is set to YES.
    14211719
    14221720RTF_STYLESHEET_FILE    =
    14231721
    1424 # Set optional variables used in the generation of an rtf document.
    1425 # Syntax is similar to doxygen's config file.
     1722# Set optional variables used in the generation of an RTF document. Syntax is
     1723# similar to doxygen's config file. A template extensions file can be generated
     1724# using doxygen -e rtf extensionFile.
     1725# This tag requires that the tag GENERATE_RTF is set to YES.
    14261726
    14271727RTF_EXTENSIONS_FILE    =
    14281728
    14291729#---------------------------------------------------------------------------
    1430 # configuration options related to the man page output
    1431 #---------------------------------------------------------------------------
    1432 
    1433 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    1434 # generate man pages
     1730# Configuration options related to the man page output
     1731#---------------------------------------------------------------------------
     1732
     1733# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
     1734# classes and files.
     1735# The default value is: NO.
    14351736
    14361737GENERATE_MAN           = NO
    14371738
    1438 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    1439 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1440 # put in front of it. If left blank `man' will be used as the default path.
     1739# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
     1740# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1741# it. A directory man3 will be created inside the directory specified by
     1742# MAN_OUTPUT.
     1743# The default directory is: man.
     1744# This tag requires that the tag GENERATE_MAN is set to YES.
    14411745
    14421746MAN_OUTPUT             = man
    14431747
    1444 # The MAN_EXTENSION tag determines the extension that is added to
    1445 # the generated man pages (default is the subroutine's section .3)
     1748# The MAN_EXTENSION tag determines the extension that is added to the generated
     1749# man pages. In case the manual section does not start with a number, the number
     1750# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
     1751# optional.
     1752# The default value is: .3.
     1753# This tag requires that the tag GENERATE_MAN is set to YES.
    14461754
    14471755MAN_EXTENSION          = .3
    14481756
    1449 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    1450 # then it will generate one additional man file for each entity
    1451 # documented in the real man page(s). These additional files
    1452 # only source the real man page, but without them the man command
    1453 # would be unable to find the correct page. The default is NO.
     1757# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
     1758# will generate one additional man file for each entity documented in the real
     1759# man page(s). These additional files only source the real man page, but without
     1760# them the man command would be unable to find the correct page.
     1761# The default value is: NO.
     1762# This tag requires that the tag GENERATE_MAN is set to YES.
    14541763
    14551764MAN_LINKS              = NO
    14561765
    14571766#---------------------------------------------------------------------------
    1458 # configuration options related to the XML output
    1459 #---------------------------------------------------------------------------
    1460 
    1461 # If the GENERATE_XML tag is set to YES Doxygen will
    1462 # generate an XML file that captures the structure of
    1463 # the code including all documentation.
     1767# Configuration options related to the XML output
     1768#---------------------------------------------------------------------------
     1769
     1770# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
     1771# captures the structure of the code including all documentation.
     1772# The default value is: NO.
    14641773
    14651774GENERATE_XML           = NO
    14661775
    1467 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    1468 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1469 # put in front of it. If left blank `xml' will be used as the default path.
     1776# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
     1777# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1778# it.
     1779# The default directory is: xml.
     1780# This tag requires that the tag GENERATE_XML is set to YES.
    14701781
    14711782XML_OUTPUT             = xml
    14721783
    1473 # The XML_SCHEMA tag can be used to specify an XML schema,
    1474 # which can be used by a validating XML parser to check the
    1475 # syntax of the XML files.
     1784# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
     1785# validating XML parser to check the syntax of the XML files.
     1786# This tag requires that the tag GENERATE_XML is set to YES.
    14761787
    14771788XML_SCHEMA             =
    14781789
    1479 # The XML_DTD tag can be used to specify an XML DTD,
    1480 # which can be used by a validating XML parser to check the
    1481 # syntax of the XML files.
     1790# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
     1791# validating XML parser to check the syntax of the XML files.
     1792# This tag requires that the tag GENERATE_XML is set to YES.
    14821793
    14831794XML_DTD                =
    14841795
    1485 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    1486 # dump the program listings (including syntax highlighting
    1487 # and cross-referencing information) to the XML output. Note that
    1488 # enabling this will significantly increase the size of the XML output.
     1796# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
     1797# listings (including syntax highlighting and cross-referencing information) to
     1798# the XML output. Note that enabling this will significantly increase the size
     1799# of the XML output.
     1800# The default value is: YES.
     1801# This tag requires that the tag GENERATE_XML is set to YES.
    14891802
    14901803XML_PROGRAMLISTING     = YES
    14911804
    14921805#---------------------------------------------------------------------------
    1493 # configuration options for the AutoGen Definitions output
    1494 #---------------------------------------------------------------------------
    1495 
    1496 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    1497 # generate an AutoGen Definitions (see autogen.sf.net) file
    1498 # that captures the structure of the code including all
    1499 # documentation. Note that this feature is still experimental
    1500 # and incomplete at the moment.
     1806# Configuration options related to the DOCBOOK output
     1807#---------------------------------------------------------------------------
     1808
     1809# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
     1810# that can be used to generate PDF.
     1811# The default value is: NO.
     1812
     1813GENERATE_DOCBOOK       = NO
     1814
     1815# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
     1816# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
     1817# front of it.
     1818# The default directory is: docbook.
     1819# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1820
     1821DOCBOOK_OUTPUT         = docbook
     1822
     1823#---------------------------------------------------------------------------
     1824# Configuration options for the AutoGen Definitions output
     1825#---------------------------------------------------------------------------
     1826
     1827# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
     1828# Definitions (see http://autogen.sf.net) file that captures the structure of
     1829# the code including all documentation. Note that this feature is still
     1830# experimental and incomplete at the moment.
     1831# The default value is: NO.
    15011832
    15021833GENERATE_AUTOGEN_DEF   = NO
    15031834
    15041835#---------------------------------------------------------------------------
    1505 # configuration options related to the Perl module output
    1506 #---------------------------------------------------------------------------
    1507 
    1508 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    1509 # generate a Perl module file that captures the structure of
    1510 # the code including all documentation. Note that this
    1511 # feature is still experimental and incomplete at the
    1512 # moment.
     1836# Configuration options related to the Perl module output
     1837#---------------------------------------------------------------------------
     1838
     1839# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
     1840# file that captures the structure of the code including all documentation.
     1841#
     1842# Note that this feature is still experimental and incomplete at the moment.
     1843# The default value is: NO.
    15131844
    15141845GENERATE_PERLMOD       = NO
    15151846
    1516 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    1517 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    1518 # to generate PDF and DVI output from the Perl module output.
     1847# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
     1848# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
     1849# output from the Perl module output.
     1850# The default value is: NO.
     1851# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    15191852
    15201853PERLMOD_LATEX          = NO
    15211854
    1522 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1523 # nicely formatted so it can be parsed by a human reader.
    1524 # This is useful
    1525 # if you want to understand what is going on.
    1526 # On the other hand, if this
    1527 # tag is set to NO the size of the Perl module output will be much smaller
    1528 # and Perl will parse it just the same.
     1855# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
     1856# formatted so it can be parsed by a human reader. This is useful if you want to
     1857# understand what is going on. On the other hand, if this tag is set to NO the
     1858# size of the Perl module output will be much smaller and Perl will parse it
     1859# just the same.
     1860# The default value is: YES.
     1861# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    15291862
    15301863PERLMOD_PRETTY         = YES
    15311864
    1532 # The names of the make variables in the generated doxyrules.make file
    1533 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    1534 # This is useful so different doxyrules.make files included by the same
    1535 # Makefile don't overwrite each other's variables.
     1865# The names of the make variables in the generated doxyrules.make file are
     1866# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
     1867# so different doxyrules.make files included by the same Makefile don't
     1868# overwrite each other's variables.
     1869# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    15361870
    15371871PERLMOD_MAKEVAR_PREFIX =
     
    15411875#---------------------------------------------------------------------------
    15421876
    1543 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    1544 # evaluate all C-preprocessor directives found in the sources and include
    1545 # files.
     1877# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
     1878# C-preprocessor directives found in the sources and include files.
     1879# The default value is: YES.
    15461880
    15471881ENABLE_PREPROCESSING   = YES
    15481882
    1549 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    1550 # names in the source code. If set to NO (the default) only conditional
    1551 # compilation will be performed. Macro expansion can be done in a controlled
    1552 # way by setting EXPAND_ONLY_PREDEF to YES.
     1883# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
     1884# in the source code. If set to NO only conditional compilation will be
     1885# performed. Macro expansion can be done in a controlled way by setting
     1886# EXPAND_ONLY_PREDEF to YES.
     1887# The default value is: NO.
     1888# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15531889
    15541890MACRO_EXPANSION        = NO
    15551891
    1556 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    1557 # then the macro expansion is limited to the macros specified with the
    1558 # PREDEFINED and EXPAND_AS_DEFINED tags.
     1892# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
     1893# the macro expansion is limited to the macros specified with the PREDEFINED and
     1894# EXPAND_AS_DEFINED tags.
     1895# The default value is: NO.
     1896# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15591897
    15601898EXPAND_ONLY_PREDEF     = NO
    15611899
    1562 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1563 # pointed to by INCLUDE_PATH will be searched when a #include is found.
     1900# If the SEARCH_INCLUDES tag is set to YES the includes files in the
     1901# INCLUDE_PATH will be searched if a #include is found.
     1902# The default value is: YES.
     1903# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15641904
    15651905SEARCH_INCLUDES        = YES
    15661906
    15671907# The INCLUDE_PATH tag can be used to specify one or more directories that
    1568 # contain include files that are not input files but should be processed by
    1569 # the preprocessor.
     1908# contain include files that are not input files but should be processed by the
     1909# preprocessor.
     1910# This tag requires that the tag SEARCH_INCLUDES is set to YES.
    15701911
    15711912INCLUDE_PATH           =
     
    15731914# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    15741915# patterns (like *.h and *.hpp) to filter out the header-files in the
    1575 # directories. If left blank, the patterns specified with FILE_PATTERNS will
    1576 # be used.
     1916# directories. If left blank, the patterns specified with FILE_PATTERNS will be
     1917# used.
     1918# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15771919
    15781920INCLUDE_FILE_PATTERNS  =
    15791921
    1580 # The PREDEFINED tag can be used to specify one or more macro names that
    1581 # are defined before the preprocessor is started (similar to the -D option of
    1582 # gcc). The argument of the tag is a list of macros of the form: name
    1583 # or name=definition (no spaces). If the definition and the = are
    1584 # omitted =1 is assumed. To prevent a macro definition from being
    1585 # undefined via #undef or recursively expanded use the := operator
    1586 # instead of the = operator.
     1922# The PREDEFINED tag can be used to specify one or more macro names that are
     1923# defined before the preprocessor is started (similar to the -D option of e.g.
     1924# gcc). The argument of the tag is a list of macros of the form: name or
     1925# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
     1926# is assumed. To prevent a macro definition from being undefined via #undef or
     1927# recursively expanded use the := operator instead of the = operator.
     1928# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15871929
    15881930PREDEFINED             =
    15891931
    1590 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    1591 # this tag can be used to specify a list of macro names that should be expanded.
    1592 # The macro definition that is found in the sources will be used.
    1593 # Use the PREDEFINED tag if you want to use a different macro definition that
    1594 # overrules the definition found in the source code.
     1932# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
     1933# tag can be used to specify a list of macro names that should be expanded. The
     1934# macro definition that is found in the sources will be used. Use the PREDEFINED
     1935# tag if you want to use a different macro definition that overrules the
     1936# definition found in the source code.
     1937# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    15951938
    15961939EXPAND_AS_DEFINED      =
    15971940
    1598 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1599 # doxygen's preprocessor will remove all references to function-like macros
    1600 # that are alone on a line, have an all uppercase name, and do not end with a
    1601 # semicolon, because these will confuse the parser if not removed.
     1941# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
     1942# remove all refrences to function-like macros that are alone on a line, have an
     1943# all uppercase name, and do not end with a semicolon. Such function macros are
     1944# typically used for boiler-plate code, and will confuse the parser if not
     1945# removed.
     1946# The default value is: YES.
     1947# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    16021948
    16031949SKIP_FUNCTION_MACROS   = YES
    16041950
    16051951#---------------------------------------------------------------------------
    1606 # Configuration::additions related to external references
    1607 #---------------------------------------------------------------------------
    1608 
    1609 # The TAGFILES option can be used to specify one or more tagfiles. For each
    1610 # tag file the location of the external documentation should be added. The
    1611 # format of a tag file without this location is as follows:
    1612 #
     1952# Configuration options related to external references
     1953#---------------------------------------------------------------------------
     1954
     1955# The TAGFILES tag can be used to specify one or more tag files. For each tag
     1956# file the location of the external documentation should be added. The format of
     1957# a tag file without this location is as follows:
    16131958# TAGFILES = file1 file2 ...
    16141959# Adding location for the tag files is done as follows:
    1615 #
    16161960# TAGFILES = file1=loc1 "file2 = loc2" ...
    1617 # where "loc1" and "loc2" can be relative or absolute paths
    1618 # or URLs. Note that each tag file must have a unique name (where the name does
    1619 # NOT include the path). If a tag file is not located in the directory in which
    1620 # doxygen is run, you must also specify the path to the tagfile here.
     1961# where loc1 and loc2 can be relative or absolute paths or URLs. See the
     1962# section "Linking to external documentation" for more information about the use
     1963# of tag files.
     1964# Note: Each tag file must have an unique name (where the name does NOT include
     1965# the path). If a tag file is not located in the directory in which doxygen is
     1966# run, you must also specify the path to the tagfile here.
    16211967
    16221968TAGFILES               =
    16231969
    1624 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    1625 # a tag file that is based on the input files it reads.
     1970# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
     1971# tag file that is based on the input files it reads. See section "Linking to
     1972# external documentation" for more information about the usage of tag files.
    16261973
    16271974GENERATE_TAGFILE       =
    16281975
    1629 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    1630 # in the class index. If set to NO only the inherited external classes
    1631 # will be listed.
     1976# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
     1977# class index. If set to NO only the inherited external classes will be listed.
     1978# The default value is: NO.
    16321979
    16331980ALLEXTERNALS           = NO
    16341981
    1635 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    1636 # in the modules index. If set to NO, only the current project's groups will
     1982# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
     1983# the modules index. If set to NO, only the current project's groups will be
     1984# listed.
     1985# The default value is: YES.
     1986
     1987EXTERNAL_GROUPS        = YES
     1988
     1989# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
     1990# the related pages index. If set to NO, only the current project's pages will
    16371991# be listed.
    1638 
    1639 EXTERNAL_GROUPS        = YES
     1992# The default value is: YES.
     1993
     1994EXTERNAL_PAGES         = YES
    16401995
    16411996# The PERL_PATH should be the absolute path and name of the perl script
    1642 # interpreter (i.e. the result of `which perl').
     1997# interpreter (i.e. the result of 'which perl').
     1998# The default file (with absolute path) is: /usr/bin/perl.
    16431999
    16442000PERL_PATH              = /usr/bin/perl
     
    16482004#---------------------------------------------------------------------------
    16492005
    1650 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1651 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    1652 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    1653 # this option also works with HAVE_DOT disabled, but it is recommended to
    1654 # install and use dot, since it yields more powerful graphs.
     2006# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
     2007# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
     2008# NO turns the diagrams off. Note that this option also works with HAVE_DOT
     2009# disabled, but it is recommended to install and use dot, since it yields more
     2010# powerful graphs.
     2011# The default value is: YES.
    16552012
    16562013CLASS_DIAGRAMS         = YES
    16572014
    16582015# You can define message sequence charts within doxygen comments using the \msc
    1659 # command. Doxygen will then run the mscgen tool (see
    1660 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     2016# command. Doxygen will then run the mscgen tool (see:
     2017# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
    16612018# documentation. The MSCGEN_PATH tag allows you to specify the directory where
    16622019# the mscgen tool resides. If left empty the tool is assumed to be found in the
     
    16652022MSCGEN_PATH            =
    16662023
    1667 # If set to YES, the inheritance and collaboration graphs will hide
    1668 # inheritance and usage relations if the target is undocumented
    1669 # or is not a class.
     2024# If set to YES, the inheritance and collaboration graphs will hide inheritance
     2025# and usage relations if the target is undocumented or is not a class.
     2026# The default value is: YES.
    16702027
    16712028HIDE_UNDOC_RELATIONS   = NO
    16722029
    16732030# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    1674 # available from the path. This tool is part of Graphviz, a graph visualization
    1675 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    1676 # have no effect if this option is set to NO (the default)
     2031# available from the path. This tool is part of Graphviz (see:
     2032# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
     2033# Bell Labs. The other options in this section have no effect if this option is
     2034# set to NO
     2035# The default value is: NO.
    16772036
    16782037HAVE_DOT               = NO
    16792038
    1680 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
    1681 # allowed to run in parallel. When set to 0 (the default) doxygen will
    1682 # base this on the number of processors available in the system. You can set it
    1683 # explicitly to a value larger than 0 to get control over the balance
    1684 # between CPU load and processing speed.
     2039# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
     2040# to run in parallel. When set to 0 doxygen will base this on the number of
     2041# processors available in the system. You can set it explicitly to a value
     2042# larger than 0 to get control over the balance between CPU load and processing
     2043# speed.
     2044# Minimum value: 0, maximum value: 32, default value: 0.
     2045# This tag requires that the tag HAVE_DOT is set to YES.
    16852046
    16862047DOT_NUM_THREADS        = 0
    16872048
    1688 # By default doxygen will use the Helvetica font for all dot files that
    1689 # doxygen generates. When you want a differently looking font you can specify
    1690 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
    1691 # the font, which can be done by putting it in a standard location or by setting
    1692 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
    1693 # directory containing the font.
    1694 
    1695 DOT_FONTNAME           = FreeSans
    1696 
    1697 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    1698 # The default size is 10pt.
     2049# When you want a differently looking font n the dot files that doxygen
     2050# generates you can specify the font name using DOT_FONTNAME. You need to make
     2051# sure dot is able to find the font, which can be done by putting it in a
     2052# standard location or by setting the DOTFONTPATH environment variable or by
     2053# setting DOT_FONTPATH to the directory containing the font.
     2054# The default value is: Helvetica.
     2055# This tag requires that the tag HAVE_DOT is set to YES.
     2056
     2057DOT_FONTNAME           =
     2058
     2059# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
     2060# dot graphs.
     2061# Minimum value: 4, maximum value: 24, default value: 10.
     2062# This tag requires that the tag HAVE_DOT is set to YES.
    16992063
    17002064DOT_FONTSIZE           = 10
    17012065
    1702 # By default doxygen will tell dot to use the Helvetica font.
    1703 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
    1704 # set the path where dot can find it.
     2066# By default doxygen will tell dot to use the default font as specified with
     2067# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
     2068# the path where dot can find it using this tag.
     2069# This tag requires that the tag HAVE_DOT is set to YES.
    17052070
    17062071DOT_FONTPATH           =
    17072072
    1708 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1709 # will generate a graph for each documented class showing the direct and
    1710 # indirect inheritance relations. Setting this tag to YES will force the
    1711 # CLASS_DIAGRAMS tag to NO.
     2073# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
     2074# each documented class showing the direct and indirect inheritance relations.
     2075# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
     2076# The default value is: YES.
     2077# This tag requires that the tag HAVE_DOT is set to YES.
    17122078
    17132079CLASS_GRAPH            = YES
    17142080
    1715 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1716 # will generate a graph for each documented class showing the direct and
    1717 # indirect implementation dependencies (inheritance, containment, and
    1718 # class references variables) of the class with other documented classes.
     2081# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
     2082# graph for each documented class showing the direct and indirect implementation
     2083# dependencies (inheritance, containment, and class references variables) of the
     2084# class with other documented classes.
     2085# The default value is: YES.
     2086# This tag requires that the tag HAVE_DOT is set to YES.
    17192087
    17202088COLLABORATION_GRAPH    = YES
    17212089
    1722 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    1723 # will generate a graph for groups, showing the direct groups dependencies
     2090# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
     2091# groups, showing the direct groups dependencies.
     2092# The default value is: YES.
     2093# This tag requires that the tag HAVE_DOT is set to YES.
    17242094
    17252095GROUP_GRAPHS           = YES
     
    17282098# collaboration diagrams in a style similar to the OMG's Unified Modeling
    17292099# Language.
     2100# The default value is: NO.
     2101# This tag requires that the tag HAVE_DOT is set to YES.
    17302102
    17312103UML_LOOK               = NO
    17322104
    1733 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
    1734 # the class node. If there are many fields or methods and many nodes the
    1735 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
    1736 # threshold limits the number of items for each type to make the size more
    1737 # managable. Set this to 0 for no limit. Note that the threshold may be
    1738 # exceeded by 50% before the limit is enforced.
     2105# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
     2106# class node. If there are many fields or methods and many nodes the graph may
     2107# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
     2108# number of items for each type to make the size more manageable. Set this to 0
     2109# for no limit. Note that the threshold may be exceeded by 50% before the limit
     2110# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
     2111# but if the number exceeds 15, the total amount of fields shown is limited to
     2112# 10.
     2113# Minimum value: 0, maximum value: 100, default value: 10.
     2114# This tag requires that the tag HAVE_DOT is set to YES.
    17392115
    17402116UML_LIMIT_NUM_FIELDS   = 10
    17412117
    1742 # If set to YES, the inheritance and collaboration graphs will show the
    1743 # relations between templates and their instances.
     2118# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
     2119# collaboration graphs will show the relations between templates and their
     2120# instances.
     2121# The default value is: NO.
     2122# This tag requires that the tag HAVE_DOT is set to YES.
    17442123
    17452124TEMPLATE_RELATIONS     = NO
    17462125
    1747 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    1748 # tags are set to YES then doxygen will generate a graph for each documented
    1749 # file showing the direct and indirect include dependencies of the file with
    1750 # other documented files.
     2126# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
     2127# YES then doxygen will generate a graph for each documented file showing the
     2128# direct and indirect include dependencies of the file with other documented
     2129# files.
     2130# The default value is: YES.
     2131# This tag requires that the tag HAVE_DOT is set to YES.
    17512132
    17522133INCLUDE_GRAPH          = YES
    17532134
    1754 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    1755 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    1756 # documented header file showing the documented files that directly or
    1757 # indirectly include this file.
     2135# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
     2136# set to YES then doxygen will generate a graph for each documented file showing
     2137# the direct and indirect include dependencies of the file with other documented
     2138# files.
     2139# The default value is: YES.
     2140# This tag requires that the tag HAVE_DOT is set to YES.
    17582141
    17592142INCLUDED_BY_GRAPH      = YES
    17602143
    1761 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    1762 # doxygen will generate a call dependency graph for every global function
    1763 # or class method. Note that enabling this option will significantly increase
    1764 # the time of a run. So in most cases it will be better to enable call graphs
    1765 # for selected functions only using the \callgraph command.
     2144# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
     2145# dependency graph for every global function or class method.
     2146#
     2147# Note that enabling this option will significantly increase the time of a run.
     2148# So in most cases it will be better to enable call graphs for selected
     2149# functions only using the \callgraph command.
     2150# The default value is: NO.
     2151# This tag requires that the tag HAVE_DOT is set to YES.
    17662152
    17672153CALL_GRAPH             = NO
    17682154
    1769 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    1770 # doxygen will generate a caller dependency graph for every global function
    1771 # or class method. Note that enabling this option will significantly increase
    1772 # the time of a run. So in most cases it will be better to enable caller
    1773 # graphs for selected functions only using the \callergraph command.
     2155# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
     2156# dependency graph for every global function or class method.
     2157#
     2158# Note that enabling this option will significantly increase the time of a run.
     2159# So in most cases it will be better to enable caller graphs for selected
     2160# functions only using the \callergraph command.
     2161# The default value is: NO.
     2162# This tag requires that the tag HAVE_DOT is set to YES.
    17742163
    17752164CALLER_GRAPH           = NO
    17762165
    1777 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1778 # will generate a graphical hierarchy of all classes instead of a textual one.
     2166# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
     2167# hierarchy of all classes instead of a textual one.
     2168# The default value is: YES.
     2169# This tag requires that the tag HAVE_DOT is set to YES.
    17792170
    17802171GRAPHICAL_HIERARCHY    = YES
    17812172
    1782 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
    1783 # then doxygen will show the dependencies a directory has on other directories
    1784 # in a graphical way. The dependency relations are determined by the #include
    1785 # relations between the files in the directories.
     2173# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
     2174# dependencies a directory has on other directories in a graphical way. The
     2175# dependency relations are determined by the #include relations between the
     2176# files in the directories.
     2177# The default value is: YES.
     2178# This tag requires that the tag HAVE_DOT is set to YES.
    17862179
    17872180DIRECTORY_GRAPH        = YES
    17882181
    17892182# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1790 # generated by dot. Possible values are svg, png, jpg, or gif.
    1791 # If left blank png will be used. If you choose svg you need to set
    1792 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    1793 # visible in IE 9+ (other browsers do not have this requirement).
     2183# generated by dot.
     2184# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
     2185# to make the SVG files visible in IE 9+ (other browsers do not have this
     2186# requirement).
     2187# Possible values are: png, jpg, gif and svg.
     2188# The default value is: png.
     2189# This tag requires that the tag HAVE_DOT is set to YES.
    17942190
    17952191DOT_IMAGE_FORMAT       = png
     
    17972193# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
    17982194# enable generation of interactive SVG images that allow zooming and panning.
    1799 # Note that this requires a modern browser other than Internet Explorer.
    1800 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
    1801 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    1802 # visible. Older versions of IE do not have SVG support.
     2195#
     2196# Note that this requires a modern browser other than Internet Explorer. Tested
     2197# and working are Firefox, Chrome, Safari, and Opera.
     2198# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
     2199# the SVG files visible. Older versions of IE do not have SVG support.
     2200# The default value is: NO.
     2201# This tag requires that the tag HAVE_DOT is set to YES.
    18032202
    18042203INTERACTIVE_SVG        = NO
    18052204
    1806 # The tag DOT_PATH can be used to specify the path where the dot tool can be
     2205# The DOT_PATH tag can be used to specify the path where the dot tool can be
    18072206# found. If left blank, it is assumed the dot tool can be found in the path.
     2207# This tag requires that the tag HAVE_DOT is set to YES.
    18082208
    18092209DOT_PATH               =
    18102210
    18112211# The DOTFILE_DIRS tag can be used to specify one or more directories that
    1812 # contain dot files that are included in the documentation (see the
    1813 # \dotfile command).
     2212# contain dot files that are included in the documentation (see the \dotfile
     2213# command).
     2214# This tag requires that the tag HAVE_DOT is set to YES.
    18142215
    18152216DOTFILE_DIRS           =
    18162217
    18172218# The MSCFILE_DIRS tag can be used to specify one or more directories that
    1818 # contain msc files that are included in the documentation (see the
    1819 # \mscfile command).
     2219# contain msc files that are included in the documentation (see the \mscfile
     2220# command).
    18202221
    18212222MSCFILE_DIRS           =
    18222223
    1823 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1824 # nodes that will be shown in the graph. If the number of nodes in a graph
    1825 # becomes larger than this value, doxygen will truncate the graph, which is
    1826 # visualized by representing a node as a red box. Note that doxygen if the
    1827 # number of direct children of the root node in a graph is already larger than
    1828 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    1829 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2224# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
     2225# that will be shown in the graph. If the number of nodes in a graph becomes
     2226# larger than this value, doxygen will truncate the graph, which is visualized
     2227# by representing a node as a red box. Note that doxygen if the number of direct
     2228# children of the root node in a graph is already larger than
     2229# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
     2230# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2231# Minimum value: 0, maximum value: 10000, default value: 50.
     2232# This tag requires that the tag HAVE_DOT is set to YES.
    18302233
    18312234DOT_GRAPH_MAX_NODES    = 50
    18322235
    1833 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1834 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1835 # from the root by following a path via at most 3 edges will be shown. Nodes
    1836 # that lay further from the root node will be omitted. Note that setting this
    1837 # option to 1 or 2 may greatly reduce the computation time needed for large
    1838 # code bases. Also note that the size of a graph can be further restricted by
     2236# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
     2237# generated by dot. A depth value of 3 means that only nodes reachable from the
     2238# root by following a path via at most 3 edges will be shown. Nodes that lay
     2239# further from the root node will be omitted. Note that setting this option to 1
     2240# or 2 may greatly reduce the computation time needed for large code bases. Also
     2241# note that the size of a graph can be further restricted by
    18392242# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
     2243# Minimum value: 0, maximum value: 1000, default value: 0.
     2244# This tag requires that the tag HAVE_DOT is set to YES.
    18402245
    18412246MAX_DOT_GRAPH_DEPTH    = 0
    18422247
    18432248# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1844 # background. This is disabled by default, because dot on Windows does not
    1845 # seem to support this out of the box. Warning: Depending on the platform used,
    1846 # enabling this option may lead to badly anti-aliased labels on the edges of
    1847 # a graph (i.e. they become hard to read).
     2249# background. This is disabled by default, because dot on Windows does not seem
     2250# to support this out of the box.
     2251#
     2252# Warning: Depending on the platform used, enabling this option may lead to
     2253# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     2254# read).
     2255# The default value is: NO.
     2256# This tag requires that the tag HAVE_DOT is set to YES.
    18482257
    18492258DOT_TRANSPARENT        = NO
     
    18512260# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    18522261# files in one run (i.e. multiple -o and -T options on the command line). This
    1853 # makes dot run faster, but since only newer versions of dot (>1.8.10)
    1854 # support this, this feature is disabled by default.
     2262# makes dot run faster, but since only newer versions of dot (>1.8.10) support
     2263# this, this feature is disabled by default.
     2264# The default value is: NO.
     2265# This tag requires that the tag HAVE_DOT is set to YES.
    18552266
    18562267DOT_MULTI_TARGETS      = NO
    18572268
    1858 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1859 # generate a legend page explaining the meaning of the various boxes and
    1860 # arrows in the dot generated graphs.
     2269# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
     2270# explaining the meaning of the various boxes and arrows in the dot generated
     2271# graphs.
     2272# The default value is: YES.
     2273# This tag requires that the tag HAVE_DOT is set to YES.
    18612274
    18622275GENERATE_LEGEND        = YES
    18632276
    1864 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    1865 # remove the intermediate dot files that are used to generate
    1866 # the various graphs.
     2277# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
     2278# files that are used to generate the various graphs.
     2279# The default value is: YES.
     2280# This tag requires that the tag HAVE_DOT is set to YES.
    18672281
    18682282DOT_CLEANUP            = YES
Note: See TracChangeset for help on using the changeset viewer.