Changeset 4877 for libcaca


Ignore:
Timestamp:
Jun 2, 2014, 10:35:26 PM (5 years ago)
Author:
Sam Hocevar
Message:

doc: update the Doxygen configuration file.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/doc/doxygen.cfg.in

    r4825 r4877  
    1 # Doxyfile 1.5.9
     1# Doxyfile 1.8.6
    22
    33# This file describes the settings to be used by the documentation system
    4 # doxygen (www.doxygen.org) for a project
    5 #
    6 # All text after a hash (#) is considered a comment and will be ignored
     4# doxygen (www.doxygen.org) for a project.
     5#
     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#---------------------------------------------------------------------------
     
    1518#---------------------------------------------------------------------------
    1619
    17 # 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.
     20# This tag specifies the encoding used for all characters in the config file
     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 a sequence of words surrounded
    26 # by quotes) that should identify the project.
     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.
    2734
    2835PROJECT_NAME           = @PACKAGE@
    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         = @VERSION@
    3542
    36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    37 # base path where the generated documentation will be put.
    38 # If a relative path is entered, it will be relative to the location
    39 # where doxygen was started. If left blank the current directory will be used.
     43# Using the PROJECT_BRIEF tag one can provide an optional one line description
     44# for a project that appears at the top of each page and should give viewer a
     45# quick idea about the purpose of the project. Keep the description short.
     46
     47PROJECT_BRIEF          =
     48
     49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
     50# the documentation. The maximum height of the logo should not exceed 55 pixels
     51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
     52# to the output directory.
     53
     54PROJECT_LOGO           =
     55
     56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
     57# into which the generated documentation will be written. If a relative path is
     58# entered, it will be relative to the location where doxygen was started. If
     59# left blank the current directory will be used.
    4060
    4161OUTPUT_DIRECTORY       = .
    4262
    43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    44 # 4096 sub-directories (in 2 levels) under the output directory of each output
    45 # format and will distribute the generated files over these directories.
    46 # Enabling this option can be useful when feeding doxygen a huge amount of
    47 # source files, where putting all generated files in the same directory would
    48 # 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.
    4970
    5071CREATE_SUBDIRS         = NO
    5172
    52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    53 # documentation generated by doxygen is written. Doxygen will use this
    54 # information to generate all constant output in the proper language.
    55 # The default language is English, other supported languages are:
    56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
    58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
    59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
    60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
    61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
     73# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     74# documentation generated by doxygen is written. Doxygen will use this
     75# information to generate all constant output in the proper language.
     76# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
     77# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
     78# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
     79# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
     80# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
     81# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
     82# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
     83# Ukrainian and Vietnamese.
     84# The default value is: English.
    6285
    6386OUTPUT_LANGUAGE        = English
    6487
    65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    66 # include brief member descriptions after the members that are listed in
    67 # the file and class documentation (similar to JavaDoc).
    68 # Set to NO to disable this.
     88# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
     89# descriptions after the members that are listed in the file and class
     90# documentation (similar to Javadoc). Set to NO to disable this.
     91# The default value is: YES.
    6992
    7093BRIEF_MEMBER_DESC      = YES
    7194
    72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
    73 # the brief description of a member or function before the detailed description.
    74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
     95# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
     96# description of a member or function before the detailed description
     97#
     98# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    7599# brief descriptions will be completely suppressed.
     100# The default value is: YES.
    76101
    77102REPEAT_BRIEF           = NO
    78103
    79 # This tag implements a quasi-intelligent brief description abbreviator
    80 # that is used to form the text in various listings. Each string
    81 # in this list, if found as the leading text of the brief description, will be
    82 # stripped from the text and the result after processing the whole list, is
    83 # used as the annotated text. Otherwise, the brief description is used as-is.
    84 # If left blank, the following values are used ("$name" is automatically
    85 # replaced with the name of the entity): "The $name class" "The $name widget"
    86 # "The $name file" "is" "provides" "specifies" "contains"
    87 # "represents" "a" "an" "the"
    88 
    89 ABBREVIATE_BRIEF       =
    90 
    91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    92 # Doxygen will generate a detailed section even if there is only a brief
     104# This tag implements a quasi-intelligent brief description abbreviator that is
     105# used to form the text in various listings. Each string in this list, if found
     106# as the leading text of the brief description, will be stripped from the text
     107# and the result, after processing the whole list, is used as the annotated
     108# text. Otherwise, the brief description is used as-is. If left blank, the
     109# following values are used ($name is automatically replaced with the name of
     110# the entity):The $name class, The $name widget, The $name file, is, provides,
     111# specifies, contains, represents, a, an and the.
     112
     113ABBREVIATE_BRIEF       =
     114
     115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     116# doxygen will generate a detailed section even if there is only a brief
    93117# description.
     118# The default value is: NO.
    94119
    95120ALWAYS_DETAILED_SEC    = NO
    96121
    97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    98 # inherited members of a class in the documentation of that class as if those 
    99 # members were ordinary class members. Constructors, destructors and assignment 
     122# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     123# inherited members of a class in the documentation of that class as if those
     124# members were ordinary class members. Constructors, destructors and assignment
    100125# operators of the base classes will not be shown.
     126# The default value is: NO.
    101127
    102128INLINE_INHERITED_MEMB  = NO
    103129
    104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    105 # path before files name in the file list and in the header files. If set
    106 # to NO the shortest path that makes the file name unique will be used.
     130# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
     131# before files name in the file list and in the header files. If set to NO the
     132# shortest path that makes the file name unique will be used
     133# The default value is: YES.
    107134
    108135FULL_PATH_NAMES        = NO
    109136
    110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    111 # can be used to strip a user-defined part of the path. Stripping is
    112 # only done if one of the specified strings matches the left-hand part of
    113 # the path. The tag can be used to show relative paths in the file list.
    114 # If left blank the directory from which doxygen is run is used as the
    115 # path to strip.
    116 
    117 STRIP_FROM_PATH        =
    118 
    119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    120 # the path mentioned in the documentation of a class, which tells
    121 # the reader which header file to include in order to use a class.
    122 # If left blank only the name of the header file containing the class
    123 # definition is used. Otherwise one should specify the include paths that
    124 # are normally passed to the compiler using the -I flag.
    125 
    126 STRIP_FROM_INC_PATH    =
    127 
    128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    129 # (but less readable) file names. This can be useful is your file systems
    130 # doesn't support long names like on DOS, Mac, or CD-ROM.
     137# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
     138# Stripping is only done if one of the specified strings matches the left-hand
     139# part of the path. The tag can be used to show relative paths in the file list.
     140# If left blank the directory from which doxygen is run is used as the path to
     141# strip.
     142#
     143# Note that you can specify absolute paths here, but also relative paths, which
     144# will be relative from the directory where doxygen is started.
     145# This tag requires that the tag FULL_PATH_NAMES is set to YES.
     146
     147STRIP_FROM_PATH        =
     148
     149# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
     150# path mentioned in the documentation of a class, which tells the reader which
     151# header file to include in order to use a class. If left blank only the name of
     152# the header file containing the class definition is used. Otherwise one should
     153# specify the list of include paths that are normally passed to the compiler
     154# using the -I flag.
     155
     156STRIP_FROM_INC_PATH    =
     157
     158# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
     159# less readable) file names. This can be useful is your file systems doesn't
     160# support long names like on DOS, Mac, or CD-ROM.
     161# The default value is: NO.
    131162
    132163SHORT_NAMES            = NO
    133164
    134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    135 # will interpret the first line (until the first dot) of a JavaDoc-style
    136 # comment as the brief description. If set to NO, the JavaDoc
    137 # comments will behave just like regular Qt-style comments
    138 # (thus requiring an explicit @brief command for a brief description.)
     165# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
     166# first line (until the first dot) of a Javadoc-style comment as the brief
     167# description. If set to NO, the Javadoc-style will behave just like regular Qt-
     168# style comments (thus requiring an explicit @brief command for a brief
     169# description.)
     170# The default value is: NO.
    139171
    140172JAVADOC_AUTOBRIEF      = NO
    141173
    142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
    143 # interpret the first line (until the first dot) of a Qt-style
    144 # comment as the brief description. If set to NO, the comments
    145 # will behave just like regular Qt-style comments (thus requiring
    146 # an explicit \brief command for a brief description.)
     174# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
     175# line (until the first dot) of a Qt-style comment as the brief description. If
     176# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
     177# requiring an explicit \brief command for a brief description.)
     178# The default value is: NO.
    147179
    148180QT_AUTOBRIEF           = NO
    149181
    150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    152 # comments) as a brief description. This used to be the default behaviour.
    153 # The new default is to treat a multi-line C++ comment block as a detailed
    154 # description. Set this tag to YES if you prefer the old behaviour instead.
     182# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
     183# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
     184# a brief description. This used to be the default behavior. The new default is
     185# to treat a multi-line C++ comment block as a detailed description. Set this
     186# tag to YES if you prefer the old behavior instead.
     187#
     188# Note that setting this tag to YES also means that rational rose comments are
     189# not recognized any more.
     190# The default value is: NO.
    155191
    156192MULTILINE_CPP_IS_BRIEF = NO
    157193
    158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    159 # member inherits the documentation from any documented member that it
    160 # re-implements.
     194# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
     195# documentation from any documented member that it re-implements.
     196# The default value is: YES.
    161197
    162198INHERIT_DOCS           = YES
    163199
    164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    165 # a new page for each member. If set to NO, the documentation of a member will
    166 # be part of the file/class/namespace that contains it.
     200# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
     201# new page for each member. If set to NO, the documentation of a member will be
     202# part of the file/class/namespace that contains it.
     203# The default value is: NO.
    167204
    168205SEPARATE_MEMBER_PAGES  = NO
    169206
    170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    171 # Doxygen uses this value to replace tabs by spaces in code fragments.
     207# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
     208# uses this value to replace tabs by spaces in code fragments.
     209# Minimum value: 1, maximum value: 16, default value: 4.
    172210
    173211TAB_SIZE               = 8
    174212
    175 # This tag can be used to specify a number of aliases that acts
    176 # as commands in the documentation. An alias has the form "name=value".
    177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    178 # put the command \sideeffect (or @sideeffect) in the documentation, which
    179 # will result in a user-defined paragraph with heading "Side Effects:".
    180 # You can put \n's in the value part of an alias to insert newlines.
    181 
    182 ALIASES                =
    183 
    184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    185 # sources only. Doxygen will then generate output that is more tailored for C.
    186 # For instance, some of the names that are used will be different. The list
    187 # of all members will be omitted, etc.
     213# This tag can be used to specify a number of aliases that act as commands in
     214# the documentation. An alias has the form:
     215# name=value
     216# For example adding
     217# "sideeffect=@par Side Effects:\n"
     218# will allow you to put the command \sideeffect (or @sideeffect) in the
     219# documentation, which will result in a user-defined paragraph with heading
     220# "Side Effects:". You can put \n's in the value part of an alias to insert
     221# newlines.
     222
     223ALIASES                =
     224
     225# This tag can be used to specify a number of word-keyword mappings (TCL only).
     226# A mapping has the form "name=value". For example adding "class=itcl::class"
     227# will allow you to use the command class in the itcl::class meaning.
     228
     229TCL_SUBST              =
     230
     231# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     232# only. Doxygen will then generate output that is more tailored for C. For
     233# instance, some of the names that are used will be different. The list of all
     234# members will be omitted, etc.
     235# The default value is: NO.
    188236
    189237OPTIMIZE_OUTPUT_FOR_C  = YES
    190238
    191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    192 # sources only. Doxygen will then generate output that is more tailored for
    193 # Java. For instance, namespaces will be presented as packages, qualified
    194 # scopes will look different, etc.
     239# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
     240# Python sources only. Doxygen will then generate output that is more tailored
     241# for that language. For instance, namespaces will be presented as packages,
     242# qualified scopes will look different, etc.
     243# The default value is: NO.
    195244
    196245OPTIMIZE_OUTPUT_JAVA   = NO
    197246
    198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
    199 # sources only. Doxygen will then generate output that is more tailored for
    200 # Fortran.
     247# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     248# sources. Doxygen will then generate output that is tailored for Fortran.
     249# The default value is: NO.
    201250
    202251OPTIMIZE_FOR_FORTRAN   = NO
    203252
    204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
    205 # sources. Doxygen will then generate output that is tailored for
    206 # VHDL.
     253# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     254# sources. Doxygen will then generate output that is tailored for VHDL.
     255# The default value is: NO.
    207256
    208257OPTIMIZE_OUTPUT_VHDL   = NO
    209258
    210 # Doxygen selects the parser to use depending on the extension of the files it parses.
    211 # With this tag you can assign which parser to use for a given extension.
    212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
    213 # The format is ext=language, where ext is a file extension, and language is one of
    214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
    215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
    216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
    217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
    218 
    219 EXTENSION_MAPPING      =
    220 
    221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    222 # to include (a tag file for) the STL sources as input, then you should
    223 # set this tag to YES in order to let doxygen match functions declarations and
    224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    225 # func(std::string) {}). This also make the inheritance and collaboration
     259# Doxygen selects the parser to use depending on the extension of the files it
     260# parses. With this tag you can assign which parser to use for a given
     261# extension. Doxygen has a built-in mapping, but you can override or extend it
     262# using this tag. The format is ext=language, where ext is a file extension, and
     263# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
     264# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
     265# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
     266# (default is Fortran), use: inc=Fortran f=C.
     267#
     268# Note For files without extension you can use no_extension as a placeholder.
     269#
     270# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
     271# the files are not read by doxygen.
     272
     273EXTENSION_MAPPING      =
     274
     275# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
     276# according to the Markdown format, which allows for more readable
     277# documentation. See http://daringfireball.net/projects/markdown/ for details.
     278# The output of markdown processing is further processed by doxygen, so you can
     279# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
     280# case of backward compatibilities issues.
     281# The default value is: YES.
     282
     283MARKDOWN_SUPPORT       = YES
     284
     285# When enabled doxygen tries to link words that correspond to documented
     286# classes, or namespaces to their corresponding documentation. Such a link can
     287# be prevented in individual cases by by putting a % sign in front of the word
     288# or globally by setting AUTOLINK_SUPPORT to NO.
     289# The default value is: YES.
     290
     291AUTOLINK_SUPPORT       = YES
     292
     293# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     294# to include (a tag file for) the STL sources as input, then you should set this
     295# tag to YES in order to let doxygen match functions declarations and
     296# definitions whose arguments contain STL classes (e.g. func(std::string);
     297# versus func(std::string) {}). This also make the inheritance and collaboration
    226298# diagrams that involve STL classes more complete and accurate.
     299# The default value is: NO.
    227300
    228301BUILTIN_STL_SUPPORT    = NO
    229302
    230 # If you use Microsoft's C++/CLI language, you should set this option to YES to 
     303# If you use Microsoft's C++/CLI language, you should set this option to YES to
    231304# enable parsing support.
     305# The default value is: NO.
    232306
    233307CPP_CLI_SUPPORT        = NO
    234308
    235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
    236 # Doxygen will parse them like normal C++ but will assume all classes use public
    237 # instead of private inheritance when no explicit protection keyword is present.
     309# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
     310# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
     311# will parse them like normal C++ but will assume all classes use public instead
     312# of private inheritance when no explicit protection keyword is present.
     313# The default value is: NO.
    238314
    239315SIP_SUPPORT            = NO
    240316
    241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    242 # and setter methods for a property. Setting this option to YES (the default)
    243 # will make doxygen to replace the get and set methods by a property in the
    244 # documentation. This will only work if the methods are indeed getting or
    245 # setting a simple type. If this is not the case, or you want to show the
    246 # methods anyway, you should set this option to NO.
     317# For Microsoft's IDL there are propget and propput attributes to indicate
     318# getter and setter methods for a property. Setting this option to YES will make
     319# doxygen to replace the get and set methods by a property in the documentation.
     320# This will only work if the methods are indeed getting or setting a simple
     321# type. If this is not the case, or you want to show the methods anyway, you
     322# should set this option to NO.
     323# The default value is: YES.
    247324
    248325IDL_PROPERTY_SUPPORT   = YES
    249326
    250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
    251 # tag is set to YES, then doxygen will reuse the documentation of the first 
    252 # member in the group (if any) for the other members of the group. By default 
     327# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     328# tag is set to YES, then doxygen will reuse the documentation of the first
     329# member in the group (if any) for the other members of the group. By default
    253330# all members of a group must be documented explicitly.
     331# The default value is: NO.
    254332
    255333DISTRIBUTE_GROUP_DOC   = NO
    256334
    257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    258 # the same type (for instance a group of public functions) to be put as a
    259 # subgroup of that type (e.g. under the Public Functions section). Set it to
    260 # NO to prevent subgrouping. Alternatively, this can be done per class using
    261 # the \nosubgrouping command.
     335# Set the SUBGROUPING tag to YES to allow class member groups of the same type
     336# (for instance a group of public functions) to be put as a subgroup of that
     337# type (e.g. under the Public Functions section). Set it to NO to prevent
     338# subgrouping. Alternatively, this can be done per class using the
     339# \nosubgrouping command.
     340# The default value is: YES.
    262341
    263342SUBGROUPING            = YES
    264343
    265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    266 # is documented as struct, union, or enum with the name of the typedef. So
    267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    268 # with name TypeT. When disabled the typedef will appear as a member of a file,
    269 # namespace, or class. And the struct will be named TypeS. This can typically
    270 # be useful for C code in case the coding convention dictates that all compound
     344# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
     345# are shown inside the group in which they are included (e.g. using \ingroup)
     346# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
     347# and RTF).
     348#
     349# Note that this feature does not work in combination with
     350# SEPARATE_MEMBER_PAGES.
     351# The default value is: NO.
     352
     353INLINE_GROUPED_CLASSES = NO
     354
     355# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
     356# with only public data fields or simple typedef fields will be shown inline in
     357# the documentation of the scope in which they are defined (i.e. file,
     358# namespace, or group documentation), provided this scope is documented. If set
     359# to NO, structs, classes, and unions are shown on a separate page (for HTML and
     360# Man pages) or section (for LaTeX and RTF).
     361# The default value is: NO.
     362
     363INLINE_SIMPLE_STRUCTS  = NO
     364
     365# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
     366# enum is documented as struct, union, or enum with the name of the typedef. So
     367# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     368# with name TypeT. When disabled the typedef will appear as a member of a file,
     369# namespace, or class. And the struct will be named TypeS. This can typically be
     370# useful for C code in case the coding convention dictates that all compound
    271371# types are typedef'ed and only the typedef is referenced, never the tag name.
     372# The default value is: NO.
    272373
    273374TYPEDEF_HIDES_STRUCT   = NO
    274375
    275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
    276 # determine which symbols to keep in memory and which to flush to disk.
    277 # When the cache is full, less often used symbols will be written to disk.
    278 # For small to medium size projects (<1000 input files) the default value is
    279 # probably good enough. For larger projects a too small cache size can cause
    280 # doxygen to be busy swapping symbols to and from disk most of the time
    281 # causing a significant performance penality.
    282 # If the system has enough physical memory increasing the cache will improve the
    283 # performance by keeping more symbols in memory. Note that the value works on
    284 # a logarithmic scale so increasing the size by one will rougly double the
    285 # memory usage. The cache size is given by this formula:
    286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    287 # corresponding to a cache size of 2^16 = 65536 symbols
    288 
    289 SYMBOL_CACHE_SIZE      = 0
     376# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
     377# cache is used to resolve symbols given their name and scope. Since this can be
     378# an expensive process and often the same symbol appears multiple times in the
     379# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
     380# doxygen will become slower. If the cache is too large, memory is wasted. The
     381# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
     382# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
     383# symbols. At the end of a run doxygen will report the cache usage and suggest
     384# the optimal cache size from a speed point of view.
     385# Minimum value: 0, maximum value: 9, default value: 0.
     386
     387LOOKUP_CACHE_SIZE      = 0
    290388
    291389#---------------------------------------------------------------------------
     
    293391#---------------------------------------------------------------------------
    294392
    295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    296 # documentation are documented, even if no documentation was available.
    297 # Private class members and static file members will be hidden unless
    298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     393# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     394# documentation are documented, even if no documentation was available. Private
     395# class members and static file members will be hidden unless the
     396# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
     397# Note: This will also disable the warnings about undocumented members that are
     398# normally produced when WARNINGS is set to YES.
     399# The default value is: NO.
    299400
    300401EXTRACT_ALL            = NO
    301402
    302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    303 # will be included in the documentation.
     403# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
     404# be included in the documentation.
     405# The default value is: NO.
    304406
    305407EXTRACT_PRIVATE        = NO
    306408
    307 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    308 # will be included in the documentation.
     409# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
     410# scope will be included in the documentation.
     411# The default value is: NO.
     412
     413EXTRACT_PACKAGE        = NO
     414
     415# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
     416# included in the documentation.
     417# The default value is: NO.
    309418
    310419EXTRACT_STATIC         = NO
    311420
    312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    313 # defined locally in source files will be included in the documentation.
    314 # If set to NO only classes defined in header files are included.
     421# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
     422# locally in source files will be included in the documentation. If set to NO
     423# only classes defined in header files are included. Does not have any effect
     424# for Java sources.
     425# The default value is: YES.
    315426
    316427EXTRACT_LOCAL_CLASSES  = NO
    317428
    318 # This flag is only useful for Objective-C code. When set to YES local
    319 # methods, which are defined in the implementation section but not in
    320 # the interface are included in the documentation.
    321 # If set to NO (the default) only methods in the interface are included.
     429# This flag is only useful for Objective-C code. When set to YES local methods,
     430# which are defined in the implementation section but not in the interface are
     431# included in the documentation. If set to NO only methods in the interface are
     432# included.
     433# The default value is: NO.
    322434
    323435EXTRACT_LOCAL_METHODS  = NO
    324436
    325 # If this flag is set to YES, the members of anonymous namespaces will be
    326 # extracted and appear in the documentation as a namespace called
    327 # 'anonymous_namespace{file}', where file will be replaced with the base
    328 # name of the file that contains the anonymous namespace. By default
    329 # anonymous namespace are hidden.
     437# If this flag is set to YES, the members of anonymous namespaces will be
     438# extracted and appear in the documentation as a namespace called
     439# 'anonymous_namespace{file}', where file will be replaced with the base name of
     440# the file that contains the anonymous namespace. By default anonymous namespace
     441# are hidden.
     442# The default value is: NO.
    330443
    331444EXTRACT_ANON_NSPACES   = NO
    332445
    333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    334 # undocumented members of documented classes, files or namespaces.
    335 # If set to NO (the default) these members will be included in the
    336 # various overviews, but no documentation section is generated.
    337 # This option has no effect if EXTRACT_ALL is enabled.
     446# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
     447# undocumented members inside documented classes or files. If set to NO these
     448# members will be included in the various overviews, but no documentation
     449# section is generated. This option has no effect if EXTRACT_ALL is enabled.
     450# The default value is: NO.
    338451
    339452HIDE_UNDOC_MEMBERS     = NO
    340453
    341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    342 # undocumented classes that are normally visible in the class hierarchy.
    343 # If set to NO (the default) these classes will be included in the various
    344 # overviews. This option has no effect if EXTRACT_ALL is enabled.
     454# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
     455# undocumented classes that are normally visible in the class hierarchy. If set
     456# to NO these classes will be included in the various overviews. This option has
     457# no effect if EXTRACT_ALL is enabled.
     458# The default value is: NO.
    345459
    346460HIDE_UNDOC_CLASSES     = NO
    347461
    348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    349 # friend (class|struct|union) declarations.
    350 # If set to NO (the default) these declarations will be included in the
     462# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
     463# (class|struct|union) declarations. If set to NO these declarations will be
     464# included in the documentation.
     465# The default value is: NO.
     466
     467HIDE_FRIEND_COMPOUNDS  = NO
     468
     469# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
     470# documentation blocks found inside the body of a function. If set to NO these
     471# blocks will be appended to the function's detailed documentation block.
     472# The default value is: NO.
     473
     474HIDE_IN_BODY_DOCS      = NO
     475
     476# The INTERNAL_DOCS tag determines if documentation that is typed after a
     477# \internal command is included. If the tag is set to NO then the documentation
     478# will be excluded. Set it to YES to include the internal documentation.
     479# The default value is: NO.
     480
     481INTERNAL_DOCS          = NO
     482
     483# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
     484# names in lower-case letters. If set to YES upper-case letters are also
     485# allowed. This is useful if you have classes or files whose names only differ
     486# in case and if your file system supports case sensitive file names. Windows
     487# and Mac users are advised to set this option to NO.
     488# The default value is: system dependent.
     489
     490CASE_SENSE_NAMES       = NO
     491
     492# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
     493# their full class and namespace scopes in the documentation. If set to YES the
     494# scope will be hidden.
     495# The default value is: NO.
     496
     497HIDE_SCOPE_NAMES       = NO
     498
     499# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
     500# the files that are included by a file in the documentation of that file.
     501# The default value is: YES.
     502
     503SHOW_INCLUDE_FILES     = NO
     504
     505# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
     506# grouped member an include statement to the documentation, telling the reader
     507# which file to include in order to use the member.
     508# The default value is: NO.
     509
     510SHOW_GROUPED_MEMB_INC  = NO
     511
     512# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
     513# files with double quotes in the documentation rather than with sharp brackets.
     514# The default value is: NO.
     515
     516FORCE_LOCAL_INCLUDES   = NO
     517
     518# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
     519# documentation for inline members.
     520# The default value is: YES.
     521
     522INLINE_INFO            = YES
     523
     524# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
     525# (detailed) documentation of file and class members alphabetically by member
     526# name. If set to NO the members will appear in declaration order.
     527# The default value is: YES.
     528
     529SORT_MEMBER_DOCS       = NO
     530
     531# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
     532# descriptions of file, namespace and class members alphabetically by member
     533# name. If set to NO the members will appear in declaration order. Note that
     534# this will also influence the order of the classes in the class list.
     535# The default value is: NO.
     536
     537SORT_BRIEF_DOCS        = NO
     538
     539# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
     540# (brief and detailed) documentation of class members so that constructors and
     541# destructors are listed first. If set to NO the constructors will appear in the
     542# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
     543# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
     544# member documentation.
     545# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
     546# detailed member documentation.
     547# The default value is: NO.
     548
     549SORT_MEMBERS_CTORS_1ST = NO
     550
     551# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
     552# of group names into alphabetical order. If set to NO the group names will
     553# appear in their defined order.
     554# The default value is: NO.
     555
     556SORT_GROUP_NAMES       = NO
     557
     558# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
     559# fully-qualified names, including namespaces. If set to NO, the class list will
     560# be sorted only by class name, not including the namespace part.
     561# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     562# Note: This option applies only to the class list, not to the alphabetical
     563# list.
     564# The default value is: NO.
     565
     566SORT_BY_SCOPE_NAME     = NO
     567
     568# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
     569# type resolution of all parameters of a function it will reject a match between
     570# the prototype and the implementation of a member function even if there is
     571# only one candidate or it is obvious which candidate to choose by doing a
     572# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
     573# accept a match between prototype and implementation in such cases.
     574# The default value is: NO.
     575
     576STRICT_PROTO_MATCHING  = NO
     577
     578# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
     579# todo list. This list is created by putting \todo commands in the
    351580# documentation.
    352 
    353 HIDE_FRIEND_COMPOUNDS  = NO
    354 
    355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    356 # documentation blocks found inside the body of a function.
    357 # If set to NO (the default) these blocks will be appended to the
    358 # function's detailed documentation block.
    359 
    360 HIDE_IN_BODY_DOCS      = NO
    361 
    362 # The INTERNAL_DOCS tag determines if documentation
    363 # that is typed after a \internal command is included. If the tag is set
    364 # to NO (the default) then the documentation will be excluded.
    365 # Set it to YES to include the internal documentation.
    366 
    367 INTERNAL_DOCS          = NO
    368 
    369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    370 # file names in lower-case letters. If set to YES upper-case letters are also
    371 # allowed. This is useful if you have classes or files whose names only differ
    372 # in case and if your file system supports case sensitive file names. Windows
    373 # and Mac users are advised to set this option to NO.
    374 
    375 CASE_SENSE_NAMES       = NO
    376 
    377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    378 # will show members with their full class and namespace scopes in the
    379 # documentation. If set to YES the scope will be hidden.
    380 
    381 HIDE_SCOPE_NAMES       = NO
    382 
    383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    384 # will put a list of the files that are included by a file in the documentation
    385 # of that file.
    386 
    387 SHOW_INCLUDE_FILES     = NO
    388 
    389 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    390 # is inserted in the documentation for inline members.
    391 
    392 INLINE_INFO            = YES
    393 
    394 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    395 # will sort the (detailed) documentation of file and class members
    396 # alphabetically by member name. If set to NO the members will appear in
    397 # declaration order.
    398 
    399 SORT_MEMBER_DOCS       = NO
    400 
    401 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
    402 # brief documentation of file, namespace and class members alphabetically
    403 # by member name. If set to NO (the default) the members will appear in
    404 # declaration order.
    405 
    406 SORT_BRIEF_DOCS        = NO
    407 
    408 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
    409 # hierarchy of group names into alphabetical order. If set to NO (the default)
    410 # the group names will appear in their defined order.
    411 
    412 SORT_GROUP_NAMES       = NO
    413 
    414 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    415 # sorted by fully-qualified names, including namespaces. If set to
    416 # NO (the default), the class list will be sorted only by class name,
    417 # not including the namespace part.
    418 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    419 # Note: This option applies only to the class list, not to the
    420 # alphabetical list.
    421 
    422 SORT_BY_SCOPE_NAME     = NO
    423 
    424 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    425 # disable (NO) the todo list. This list is created by putting \todo
    426 # commands in the documentation.
     581# The default value is: YES.
    427582
    428583GENERATE_TODOLIST      = YES
    429584
    430 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    431 # disable (NO) the test list. This list is created by putting \test
    432 # commands in the documentation.
     585# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
     586# test list. This list is created by putting \test commands in the
     587# documentation.
     588# The default value is: YES.
    433589
    434590GENERATE_TESTLIST      = YES
    435591
    436 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    437 # disable (NO) the bug list. This list is created by putting \bug
    438 # commands in the documentation.
     592# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
     593# list. This list is created by putting \bug commands in the documentation.
     594# The default value is: YES.
    439595
    440596GENERATE_BUGLIST       = YES
    441597
    442 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    443 # disable (NO) the deprecated list. This list is created by putting
    444 # \deprecated commands in the documentation.
     598# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
     599# the deprecated list. This list is created by putting \deprecated commands in
     600# the documentation.
     601# The default value is: YES.
    445602
    446603GENERATE_DEPRECATEDLIST= YES
    447604
    448 # The ENABLED_SECTIONS tag can be used to enable conditional
    449 # documentation sections, marked by \if sectionname ... \endif.
    450 
    451 ENABLED_SECTIONS       =
    452 
    453 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    454 # the initial value of a variable or define consists of for it to appear in
    455 # the documentation. If the initializer consists of more lines than specified
    456 # here it will be hidden. Use a value of 0 to hide initializers completely.
    457 # The appearance of the initializer of individual variables and defines in the
    458 # documentation can be controlled using \showinitializer or \hideinitializer
    459 # command in the documentation regardless of this setting.
     605# The ENABLED_SECTIONS tag can be used to enable conditional documentation
     606# sections, marked by \if <section_label> ... \endif and \cond <section_label>
     607# ... \endcond blocks.
     608
     609ENABLED_SECTIONS       =
     610
     611# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
     612# initial value of a variable or macro / define can have for it to appear in the
     613# documentation. If the initializer consists of more lines than specified here
     614# it will be hidden. Use a value of 0 to hide initializers completely. The
     615# appearance of the value of individual variables and macros / defines can be
     616# controlled using \showinitializer or \hideinitializer command in the
     617# documentation regardless of this setting.
     618# Minimum value: 0, maximum value: 10000, default value: 30.
    460619
    461620MAX_INITIALIZER_LINES  = 30
    462621
    463 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    464 # at the bottom of the documentation of classes and structs. If set to YES the
    465 # list will mention the files that were used to generate the documentation.
     622# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
     623# the bottom of the documentation of classes and structs. If set to YES the list
     624# will mention the files that were used to generate the documentation.
     625# The default value is: YES.
    466626
    467627SHOW_USED_FILES        = NO
    468628
    469 # If the sources in your project are distributed over multiple directories
    470 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    471 # in the documentation. The default is NO.
    472 
    473 SHOW_DIRECTORIES       = NO
    474 
    475 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    476 # This will remove the Files entry from the Quick Index and from the
    477 # Folder Tree View (if specified). The default is YES.
     629# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
     630# will remove the Files entry from the Quick Index and from the Folder Tree View
     631# (if specified).
     632# The default value is: YES.
    478633
    479634SHOW_FILES             = YES
    480635
    481 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    482 # Namespaces page.
    483 # This will remove the Namespaces entry from the Quick Index
    484 # and from the Folder Tree View (if specified). The default is YES.
     636# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
     637# page. This will remove the Namespaces entry from the Quick Index and from the
     638# Folder Tree View (if specified).
     639# The default value is: YES.
    485640
    486641SHOW_NAMESPACES        = YES
    487642
    488 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
    489 # doxygen should invoke to get the current version for each file (typically from
    490 # the version control system). Doxygen will invoke the program by executing (via
    491 # popen()) the command <command> <input-file>, where <command> is the value of
    492 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    493 # provided by doxygen. Whatever the program writes to standard output
    494 # is used as the file version. See the manual for examples.
    495 
    496 FILE_VERSION_FILTER    =
    497 
    498 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
    499 # doxygen. The layout file controls the global structure of the generated output files
    500 # in an output format independent way. The create the layout file that represents
    501 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
    502 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
    503 # of the layout file.
    504 
    505 LAYOUT_FILE            =
    506 
    507 #---------------------------------------------------------------------------
    508 # configuration options related to warning and progress messages
    509 #---------------------------------------------------------------------------
    510 
    511 # The QUIET tag can be used to turn on/off the messages that are generated
    512 # by doxygen. Possible values are YES and NO. If left blank NO is used.
     643# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     644# doxygen should invoke to get the current version for each file (typically from
     645# the version control system). Doxygen will invoke the program by executing (via
     646# popen()) the command command input-file, where command is the value of the
     647# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
     648# by doxygen. Whatever the program writes to standard output is used as the file
     649# version. For an example see the documentation.
     650
     651FILE_VERSION_FILTER    =
     652
     653# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
     654# by doxygen. The layout file controls the global structure of the generated
     655# output files in an output format independent way. To create the layout file
     656# that represents doxygen's defaults, run doxygen with the -l option. You can
     657# optionally specify a file name after the option, if omitted DoxygenLayout.xml
     658# will be used as the name of the layout file.
     659#
     660# Note that if you run doxygen from a directory containing a file called
     661# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
     662# tag is left empty.
     663
     664LAYOUT_FILE            =
     665
     666# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
     667# the reference definitions. This must be a list of .bib files. The .bib
     668# extension is automatically appended if omitted. This requires the bibtex tool
     669# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
     670# For LaTeX the style of the bibliography can be controlled using
     671# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
     672# search path. Do not use file names with spaces, bibtex cannot handle them. See
     673# also \cite for info how to create references.
     674
     675CITE_BIB_FILES         =
     676
     677#---------------------------------------------------------------------------
     678# Configuration options related to warning and progress messages
     679#---------------------------------------------------------------------------
     680
     681# The QUIET tag can be used to turn on/off the messages that are generated to
     682# standard output by doxygen. If QUIET is set to YES this implies that the
     683# messages are off.
     684# The default value is: NO.
    513685
    514686QUIET                  = NO
    515687
    516 # The WARNINGS tag can be used to turn on/off the warning messages that are
    517 # generated by doxygen. Possible values are YES and NO. If left blank
    518 # NO is used.
     688# The WARNINGS tag can be used to turn on/off the warning messages that are
     689# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
     690# this implies that the warnings are on.
     691#
     692# Tip: Turn warnings on while writing the documentation.
     693# The default value is: YES.
    519694
    520695WARNINGS               = YES
    521696
    522 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    523 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    524 # automatically be disabled.
     697# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
     698# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
     699# will automatically be disabled.
     700# The default value is: YES.
    525701
    526702WARN_IF_UNDOCUMENTED   = YES
    527703
    528 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    529 # potential errors in the documentation, such as not documenting some
    530 # parameters in a documented function, or documenting parameters that
    531 # don't exist or using markup commands wrongly.
     704# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
     705# potential errors in the documentation, such as not documenting some parameters
     706# in a documented function, or documenting parameters that don't exist or using
     707# markup commands wrongly.
     708# The default value is: YES.
    532709
    533710WARN_IF_DOC_ERROR      = YES
    534711
    535 # This WARN_NO_PARAMDOC option can be abled to get warnings for
    536 # functions that are documented, but have no documentation for their parameters
    537 # or return value. If set to NO (the default) doxygen will only warn about
    538 # wrong or incomplete parameter documentation, but not about the absence of
    539 # documentation.
     712# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
     713# are documented, but have no documentation for their parameters or return
     714# value. If set to NO doxygen will only warn about wrong or incomplete parameter
     715# documentation, but not about the absence of documentation.
     716# The default value is: NO.
    540717
    541718WARN_NO_PARAMDOC       = NO
    542719
    543 # The WARN_FORMAT tag determines the format of the warning messages that
    544 # doxygen can produce. The string should contain the $file, $line, and $text
    545 # tags, which will be replaced by the file and line number from which the
    546 # warning originated and the warning text. Optionally the format may contain
    547 # $version, which will be replaced by the version of the file (if it could
    548 # be obtained via FILE_VERSION_FILTER)
     720# The WARN_FORMAT tag determines the format of the warning messages that doxygen
     721# can produce. The string should contain the $file, $line, and $text tags, which
     722# will be replaced by the file and line number from which the warning originated
     723# and the warning text. Optionally the format may contain $version, which will
     724# be replaced by the version of the file (if it could be obtained via
     725# FILE_VERSION_FILTER)
     726# The default value is: $file:$line: $text.
    549727
    550728WARN_FORMAT            = "$file:$line: $text  "
    551729
    552 # The WARN_LOGFILE tag can be used to specify a file to which warning
    553 # and error messages should be written. If left blank the output is written
    554 # to stderr.
    555 
    556 WARN_LOGFILE           =
    557 
    558 #---------------------------------------------------------------------------
    559 # configuration options related to the input files
    560 #---------------------------------------------------------------------------
    561 
    562 # The INPUT tag can be used to specify the files and/or directories that contain
    563 # documented source files. You may enter file names like "myfile.cpp" or
    564 # directories like "/usr/src/myproject". Separate the files or directories
    565 # with spaces.
     730# The WARN_LOGFILE tag can be used to specify a file to which warning and error
     731# messages should be written. If left blank the output is written to standard
     732# error (stderr).
     733
     734WARN_LOGFILE           =
     735
     736#---------------------------------------------------------------------------
     737# Configuration options related to the input files
     738#---------------------------------------------------------------------------
     739
     740# The INPUT tag is used to specify the files and/or directories that contain
     741# documented source files. You may enter file names like myfile.cpp or
     742# directories like /usr/src/myproject. Separate the files or directories with
     743# spaces.
     744# Note: If this tag is empty the current directory is searched.
    566745
    567746INPUT                  = @top_srcdir@ \
     
    572751                         @top_srcdir@/ruby
    573752
    574 # This tag can be used to specify the character encoding of the source files
    575 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    576 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    577 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    578 # the list of possible encodings.
     753# This tag can be used to specify the character encoding of the source files
     754# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
     755# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
     756# documentation (see: http://www.gnu.org/software/libiconv) for the list of
     757# possible encodings.
     758# The default value is: UTF-8.
    579759
    580760INPUT_ENCODING         = UTF-8
    581761
    582 # If the value of the INPUT tag contains directories, you can use the
    583 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    584 # and *.h) to filter out the source-files in the directories. If left
    585 # blank the following patterns are tested:
    586 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
    587 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     762# If the value of the INPUT tag contains directories, you can use the
     763# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
     764# *.h) to filter out the source-files in the directories. If left blank the
     765# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
     766# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
     767# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
     768# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
     769# *.qsf, *.as and *.js.
    588770
    589771FILE_PATTERNS          = *.dox \
     
    595777                         THANKS
    596778
    597 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    598 # should be searched for input files as well. Possible values are YES and NO.
    599 # If left blank NO is used.
     779# The RECURSIVE tag can be used to specify whether or not subdirectories should
     780# be searched for input files as well.
     781# The default value is: NO.
    600782
    601783RECURSIVE              = NO
    602784
    603 # The EXCLUDE tag can be used to specify files and/or directories that should
    604 # excluded from the INPUT source files. This way you can easily exclude a 
     785# The EXCLUDE tag can be used to specify files and/or directories that should be
     786# excluded from the INPUT source files. This way you can easily exclude a
    605787# subdirectory from a directory tree whose root is specified with the INPUT tag.
    606 
    607 EXCLUDE                =
    608 
    609 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    610 # directories that are symbolic links (a Unix filesystem feature) are excluded
     788#
     789# Note that relative paths are relative to the directory from which doxygen is
     790# run.
     791
     792EXCLUDE                =
     793
     794# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
     795# directories that are symbolic links (a Unix file system feature) are excluded
    611796# from the input.
     797# The default value is: NO.
    612798
    613799EXCLUDE_SYMLINKS       = NO
    614800
    615 # If the value of the INPUT tag contains directories, you can use the
    616 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    617 # certain files from those directories. Note that the wildcards are matched
    618 # against the file with absolute path, so to exclude all test directories
    619 # for example use the pattern */test/*
     801# If the value of the INPUT tag contains directories, you can use the
     802# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     803# certain files from those directories.
     804#
     805# Note that the wildcards are matched against the file with absolute path, so to
     806# exclude all test directories for example use the pattern */test/*
    620807
    621808EXCLUDE_PATTERNS       = *_internal.h \
    622809                         driver_*.c
    623810
    624 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
    625 # (namespaces, classes, functions, etc.) that should be excluded from the 
    626 # output. The symbol name can be a fully qualified name, a word, or if the 
    627 # wildcard * is used, a substring. Examples: ANamespace, AClass, 
     811# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     812# (namespaces, classes, functions, etc.) that should be excluded from the
     813# output. The symbol name can be a fully qualified name, a word, or if the
     814# wildcard * is used, a substring. Examples: ANamespace, AClass,
    628815# AClass::ANamespace, ANamespace::*Test
    629 
    630 EXCLUDE_SYMBOLS        =
    631 
    632 # The EXAMPLE_PATH tag can be used to specify one or more files or
    633 # directories that contain example code fragments that are included (see
    634 # the \include command).
    635 
    636 EXAMPLE_PATH           =
    637 
    638 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
    639 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    640 # and *.h) to filter out the source-files in the directories. If left
    641 # blank all files are included.
    642 
    643 EXAMPLE_PATTERNS       =
    644 
    645 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
    646 # searched for input files to be used with the \include or \dontinclude
    647 # commands irrespective of the value of the RECURSIVE tag.
    648 # Possible values are YES and NO. If left blank NO is used.
     816#
     817# Note that the wildcards are matched against the file with absolute path, so to
     818# exclude all test directories use the pattern */test/*
     819
     820EXCLUDE_SYMBOLS        =
     821
     822# The EXAMPLE_PATH tag can be used to specify one or more files or directories
     823# that contain example code fragments that are included (see the \include
     824# command).
     825
     826EXAMPLE_PATH           =
     827
     828# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     829# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
     830# *.h) to filter out the source-files in the directories. If left blank all
     831# files are included.
     832
     833EXAMPLE_PATTERNS       =
     834
     835# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     836# searched for input files to be used with the \include or \dontinclude commands
     837# irrespective of the value of the RECURSIVE tag.
     838# The default value is: NO.
    649839
    650840EXAMPLE_RECURSIVE      = NO
    651841
    652 # The IMAGE_PATH tag can be used to specify one or more files or
    653 # directories that contain image that are included in the documentation (see
    654 # the \image command).
    655 
    656 IMAGE_PATH             =
    657 
    658 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    659 # invoke to filter for each input file. Doxygen will invoke the filter program
    660 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    661 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    662 # input file. Doxygen will then use the output that the filter program writes
    663 # to standard output.
    664 # If FILTER_PATTERNS is specified, this tag will be
    665 # ignored.
    666 
    667 INPUT_FILTER           =
    668 
    669 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    670 # basis.
    671 # Doxygen will compare the file name with each pattern and apply the
    672 # filter if there is a match.
    673 # The filters are a list of the form:
    674 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    675 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    676 # is applied to all files.
    677 
    678 FILTER_PATTERNS        =
    679 
    680 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    681 # INPUT_FILTER) will be used to filter the input files when producing source
    682 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
     842# The IMAGE_PATH tag can be used to specify one or more files or directories
     843# that contain images that are to be included in the documentation (see the
     844# \image command).
     845
     846IMAGE_PATH             =
     847
     848# The INPUT_FILTER tag can be used to specify a program that doxygen should
     849# invoke to filter for each input file. Doxygen will invoke the filter program
     850# by executing (via popen()) the command:
     851#
     852# <filter> <input-file>
     853#
     854# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
     855# name of an input file. Doxygen will then use the output that the filter
     856# program writes to standard output. If FILTER_PATTERNS is specified, this tag
     857# will be ignored.
     858#
     859# Note that the filter must not add or remove lines; it is applied before the
     860# code is scanned, but not when the output code is generated. If lines are added
     861# or removed, the anchors will not be placed correctly.
     862
     863INPUT_FILTER           =
     864
     865# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     866# basis. Doxygen will compare the file name with each pattern and apply the
     867# filter if there is a match. The filters are a list of the form: pattern=filter
     868# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
     869# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
     870# patterns match the file name, INPUT_FILTER is applied.
     871
     872FILTER_PATTERNS        =
     873
     874# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     875# INPUT_FILTER ) will also be used to filter the input files that are used for
     876# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
     877# The default value is: NO.
    683878
    684879FILTER_SOURCE_FILES    = NO
    685880
    686 #---------------------------------------------------------------------------
    687 # configuration options related to source browsing
    688 #---------------------------------------------------------------------------
    689 
    690 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    691 # be generated. Documented entities will be cross-referenced with these sources.
    692 # Note: To get rid of all source code in the generated output, make sure also
    693 # VERBATIM_HEADERS is set to NO.
     881# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
     882# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
     883# it is also possible to disable source filtering for a specific pattern using
     884# *.ext= (so without naming a filter).
     885# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
     886
     887FILTER_SOURCE_PATTERNS =
     888
     889# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
     890# is part of the input, its contents will be placed on the main page
     891# (index.html). This can be useful if you have a project on for instance GitHub
     892# and want to reuse the introduction page also for the doxygen output.
     893
     894USE_MDFILE_AS_MAINPAGE =
     895
     896#---------------------------------------------------------------------------
     897# Configuration options related to source browsing
     898#---------------------------------------------------------------------------
     899
     900# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
     901# generated. Documented entities will be cross-referenced with these sources.
     902#
     903# Note: To get rid of all source code in the generated output, make sure that
     904# also VERBATIM_HEADERS is set to NO.
     905# The default value is: NO.
    694906
    695907SOURCE_BROWSER         = NO
    696908
    697 # Setting the INLINE_SOURCES tag to YES will include the body
    698 # of functions and classes directly in the documentation.
     909# Setting the INLINE_SOURCES tag to YES will include the body of functions,
     910# classes and enums directly into the documentation.
     911# The default value is: NO.
    699912
    700913INLINE_SOURCES         = NO
    701914
    702 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    703 # doxygen to hide any special comment blocks from generated source code
    704 # fragments. Normal C and C++ comments will always remain visible.
     915# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
     916# special comment blocks from generated source code fragments. Normal C, C++ and
     917# Fortran comments will always remain visible.
     918# The default value is: YES.
    705919
    706920STRIP_CODE_COMMENTS    = YES
    707921
    708 # If the REFERENCED_BY_RELATION tag is set to YES
    709 # then for each documented function all documented
    710 # functions referencing it will be listed.
     922# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
     923# function all documented functions referencing it will be listed.
     924# The default value is: NO.
    711925
    712926REFERENCED_BY_RELATION = YES
    713927
    714 # If the REFERENCES_RELATION tag is set to YES
    715 # then for each documented function all documented entities
    716 # called/used by that function will be listed.
     928# If the REFERENCES_RELATION tag is set to YES then for each documented function
     929# all documented entities called/used by that function will be listed.
     930# The default value is: NO.
    717931
    718932REFERENCES_RELATION    = YES
    719933
    720 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    721 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    722 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    723 # link to the source code.
    724 # Otherwise they will link to the documentation.
     934# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
     935# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
     936# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
     937# link to the documentation.
     938# The default value is: YES.
    725939
    726940REFERENCES_LINK_SOURCE = YES
    727941
    728 # If the USE_HTAGS tag is set to YES then the references to source code
    729 # will point to the HTML generated by the htags(1) tool instead of doxygen
    730 # built-in source browser. The htags tool is part of GNU's global source
    731 # tagging system (see http://www.gnu.org/software/global/global.html). You
    732 # will need version 4.8.6 or higher.
     942# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
     943# source code will show a tooltip with additional information such as prototype,
     944# brief description and links to the definition and documentation. Since this
     945# will make the HTML file larger and loading of large files a bit slower, you
     946# can opt to disable this feature.
     947# The default value is: YES.
     948# This tag requires that the tag SOURCE_BROWSER is set to YES.
     949
     950SOURCE_TOOLTIPS        = YES
     951
     952# If the USE_HTAGS tag is set to YES then the references to source code will
     953# point to the HTML generated by the htags(1) tool instead of doxygen built-in
     954# source browser. The htags tool is part of GNU's global source tagging system
     955# (see http://www.gnu.org/software/global/global.html). You will need version
     956# 4.8.6 or higher.
     957#
     958# To use it do the following:
     959# - Install the latest version of global
     960# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
     961# - Make sure the INPUT points to the root of the source tree
     962# - Run doxygen as normal
     963#
     964# Doxygen will invoke htags (and that will in turn invoke gtags), so these
     965# tools must be available from the command line (i.e. in the search path).
     966#
     967# The result: instead of the source browser generated by doxygen, the links to
     968# source code will now point to the output of htags.
     969# The default value is: NO.
     970# This tag requires that the tag SOURCE_BROWSER is set to YES.
    733971
    734972USE_HTAGS              = NO
    735973
    736 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    737 # will generate a verbatim copy of the header file for each class for
    738 # which an include is specified. Set to NO to disable this.
     974# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
     975# verbatim copy of the header file for each class for which an include is
     976# specified. Set to NO to disable this.
     977# See also: Section \class.
     978# The default value is: YES.
    739979
    740980VERBATIM_HEADERS       = NO
    741981
    742982#---------------------------------------------------------------------------
    743 # configuration options related to the alphabetical class index
    744 #---------------------------------------------------------------------------
    745 
    746 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
    747 # of all compounds will be generated. Enable this if the project
    748 # contains a lot of classes, structs, unions or interfaces.
     983# Configuration options related to the alphabetical class index
     984#---------------------------------------------------------------------------
     985
     986# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
     987# compounds will be generated. Enable this if the project contains a lot of
     988# classes, structs, unions or interfaces.
     989# The default value is: YES.
    749990
    750991ALPHABETICAL_INDEX     = NO
    751992
    752 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
    753 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    754 # in which this list will be split (can be a number in the range [1..20])
     993# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
     994# which the alphabetical index list will be split.
     995# Minimum value: 1, maximum value: 20, default value: 5.
     996# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    755997
    756998COLS_IN_ALPHA_INDEX    = 5
    757999
    758 # In case all classes in a project start with a common prefix, all
    759 # classes will be put under the same header in the alphabetical index.
    760 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    761 # should be ignored while generating the index headers.
    762 
    763 IGNORE_PREFIX          =
    764 
    765 #---------------------------------------------------------------------------
    766 # configuration options related to the HTML output
    767 #---------------------------------------------------------------------------
    768 
    769 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    770 # generate HTML output.
     1000# In case all classes in a project start with a common prefix, all classes will
     1001# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
     1002# can be used to specify a prefix (or a list of prefixes) that should be ignored
     1003# while generating the index headers.
     1004# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
     1005
     1006IGNORE_PREFIX          =
     1007
     1008#---------------------------------------------------------------------------
     1009# Configuration options related to the HTML output
     1010#---------------------------------------------------------------------------
     1011
     1012# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
     1013# The default value is: YES.
    7711014
    7721015GENERATE_HTML          = YES
    7731016
    774 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
    775 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    776 # put in front of it. If left blank `html' will be used as the default path.
     1017# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
     1018# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1019# it.
     1020# The default directory is: html.
     1021# This tag requires that the tag GENERATE_HTML is set to YES.
    7771022
    7781023HTML_OUTPUT            = html
    7791024
    780 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
    781 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    782 # doxygen will generate files with .html extension.
     1025# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
     1026# generated HTML page (for example: .htm, .php, .asp).
     1027# The default value is: .html.
     1028# This tag requires that the tag GENERATE_HTML is set to YES.
    7831029
    7841030HTML_FILE_EXTENSION    = .html
    7851031
    786 # The HTML_HEADER tag can be used to specify a personal HTML header for
    787 # each generated HTML page. If it is left blank doxygen will generate a
     1032# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
     1033# each generated HTML page. If the tag is left blank doxygen will generate a
    7881034# standard header.
     1035#
     1036# To get valid HTML the header file that includes any scripts and style sheets
     1037# that doxygen needs, which is dependent on the configuration options used (e.g.
     1038# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
     1039# default header using
     1040# doxygen -w html new_header.html new_footer.html new_stylesheet.css
     1041# YourConfigFile
     1042# and then modify the file new_header.html. See also section "Doxygen usage"
     1043# for information on how to generate the default header that doxygen normally
     1044# uses.
     1045# Note: The header is subject to change so you typically have to regenerate the
     1046# default header when upgrading to a newer version of doxygen. For a description
     1047# of the possible markers and block names see the documentation.
     1048# This tag requires that the tag GENERATE_HTML is set to YES.
    7891049
    7901050HTML_HEADER            = @srcdir@/header.html
    7911051
    792 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    793 # each generated HTML page. If it is left blank doxygen will generate a
    794 # standard footer.
     1052# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
     1053# generated HTML page. If the tag is left blank doxygen will generate a standard
     1054# footer. See HTML_HEADER for more information on how to generate a default
     1055# footer and what special commands can be used inside the footer. See also
     1056# section "Doxygen usage" for information on how to generate the default footer
     1057# that doxygen normally uses.
     1058# This tag requires that the tag GENERATE_HTML is set to YES.
    7951059
    7961060HTML_FOOTER            = @srcdir@/footer.html
    7971061
    798 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    799 # style sheet that is used by each HTML page. It can be used to
    800 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    801 # will generate a default style sheet. Note that doxygen will try to copy
    802 # the style sheet file to the HTML output directory, so don't put your own
    803 # stylesheet in the HTML output directory as well, or it will be erased!
     1062# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
     1063# sheet that is used by each HTML page. It can be used to fine-tune the look of
     1064# the HTML output. If left blank doxygen will generate a default style sheet.
     1065# See also section "Doxygen usage" for information on how to generate the style
     1066# sheet that doxygen normally uses.
     1067# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
     1068# it is more robust and this tag (HTML_STYLESHEET) will in the future become
     1069# obsolete.
     1070# This tag requires that the tag GENERATE_HTML is set to YES.
    8041071
    8051072HTML_STYLESHEET        = doxygen.css
    8061073
    807 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    808 # files or namespaces will be aligned in HTML using tables. If set to
    809 # NO a bullet list will be used.
    810 
    811 HTML_ALIGN_MEMBERS     = YES
    812 
    813 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    814 # documentation will contain sections that can be hidden and shown after the
    815 # page has loaded. For this to work a browser that supports
    816 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    817 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     1074# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
     1075# defined cascading style sheet that is included after the standard style sheets
     1076# created by doxygen. Using this option one can overrule certain style aspects.
     1077# This is preferred over using HTML_STYLESHEET since it does not replace the
     1078# standard style sheet and is therefor more robust against future updates.
     1079# Doxygen will copy the style sheet file to the output directory. For an example
     1080# see the documentation.
     1081# This tag requires that the tag GENERATE_HTML is set to YES.
     1082
     1083HTML_EXTRA_STYLESHEET  =
     1084
     1085# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
     1086# other source files which should be copied to the HTML output directory. Note
     1087# that these files will be copied to the base HTML output directory. Use the
     1088# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     1089# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
     1090# files will be copied as-is; there are no commands or markers available.
     1091# This tag requires that the tag GENERATE_HTML is set to YES.
     1092
     1093HTML_EXTRA_FILES       =
     1094
     1095# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
     1096# will adjust the colors in the stylesheet and background images according to
     1097# this color. Hue is specified as an angle on a colorwheel, see
     1098# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
     1099# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
     1100# purple, and 360 is red again.
     1101# Minimum value: 0, maximum value: 359, default value: 220.
     1102# This tag requires that the tag GENERATE_HTML is set to YES.
     1103
     1104HTML_COLORSTYLE_HUE    = 220
     1105
     1106# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
     1107# in the HTML output. For a value of 0 the output will use grayscales only. A
     1108# value of 255 will produce the most vivid colors.
     1109# Minimum value: 0, maximum value: 255, default value: 100.
     1110# This tag requires that the tag GENERATE_HTML is set to YES.
     1111
     1112HTML_COLORSTYLE_SAT    = 100
     1113
     1114# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
     1115# luminance component of the colors in the HTML output. Values below 100
     1116# gradually make the output lighter, whereas values above 100 make the output
     1117# darker. The value divided by 100 is the actual gamma applied, so 80 represents
     1118# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
     1119# change the gamma.
     1120# Minimum value: 40, maximum value: 240, default value: 80.
     1121# This tag requires that the tag GENERATE_HTML is set to YES.
     1122
     1123HTML_COLORSTYLE_GAMMA  = 80
     1124
     1125# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
     1126# page will contain the date and time when the page was generated. Setting this
     1127# to NO can help when comparing the output of multiple runs.
     1128# The default value is: YES.
     1129# This tag requires that the tag GENERATE_HTML is set to YES.
     1130
     1131HTML_TIMESTAMP         = YES
     1132
     1133# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     1134# documentation will contain sections that can be hidden and shown after the
     1135# page has loaded.
     1136# The default value is: NO.
     1137# This tag requires that the tag GENERATE_HTML is set to YES.
    8181138
    8191139HTML_DYNAMIC_SECTIONS  = NO
    8201140
    821 # If the GENERATE_DOCSET tag is set to YES, additional index files
    822 # will be generated that can be used as input for Apple's Xcode 3
    823 # integrated development environment, introduced with OSX 10.5 (Leopard).
    824 # To create a documentation set, doxygen will generate a Makefile in the
    825 # HTML output directory. Running make will produce the docset in that
    826 # directory and running "make install" will install the docset in
    827 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    828 # it at startup.
    829 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     1141# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
     1142# shown in the various tree structured indices initially; the user can expand
     1143# and collapse entries dynamically later on. Doxygen will expand the tree to
     1144# such a level that at most the specified number of entries are visible (unless
     1145# a fully collapsed tree already exceeds this amount). So setting the number of
     1146# entries 1 will produce a full collapsed tree by default. 0 is a special value
     1147# representing an infinite number of entries and will result in a full expanded
     1148# tree by default.
     1149# Minimum value: 0, maximum value: 9999, default value: 100.
     1150# This tag requires that the tag GENERATE_HTML is set to YES.
     1151
     1152HTML_INDEX_NUM_ENTRIES = 100
     1153
     1154# If the GENERATE_DOCSET tag is set to YES, additional index files will be
     1155# generated that can be used as input for Apple's Xcode 3 integrated development
     1156# environment (see: http://developer.apple.com/tools/xcode/), introduced with
     1157# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
     1158# Makefile in the HTML output directory. Running make will produce the docset in
     1159# that directory and running make install will install the docset in
     1160# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
     1161# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1162# for more information.
     1163# The default value is: NO.
     1164# This tag requires that the tag GENERATE_HTML is set to YES.
    8301165
    8311166GENERATE_DOCSET        = NO
    8321167
    833 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    834 # feed. A documentation feed provides an umbrella under which multiple
    835 # documentation sets from a single provider (such as a company or product suite)
    836 # can be grouped.
     1168# This tag determines the name of the docset feed. A documentation feed provides
     1169# an umbrella under which multiple documentation sets from a single provider
     1170# (such as a company or product suite) can be grouped.
     1171# The default value is: Doxygen generated docs.
     1172# This tag requires that the tag GENERATE_DOCSET is set to YES.
    8371173
    8381174DOCSET_FEEDNAME        = "Doxygen generated docs"
    8391175
    840 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    841 # should uniquely identify the documentation set bundle. This should be a
    842 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    843 # will append .docset to the name.
     1176# This tag specifies a string that should uniquely identify the documentation
     1177# set bundle. This should be a reverse domain-name style string, e.g.
     1178# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
     1179# The default value is: org.doxygen.Project.
     1180# This tag requires that the tag GENERATE_DOCSET is set to YES.
    8441181
    8451182DOCSET_BUNDLE_ID       = org.doxygen.Project
    8461183
    847 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    848 # will be generated that can be used as input for tools like the
    849 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    850 # of the generated HTML documentation.
     1184# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
     1185# the documentation publisher. This should be a reverse domain-name style
     1186# string, e.g. com.mycompany.MyDocSet.documentation.
     1187# The default value is: org.doxygen.Publisher.
     1188# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1189
     1190DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
     1191
     1192# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
     1193# The default value is: Publisher.
     1194# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1195
     1196DOCSET_PUBLISHER_NAME  = Publisher
     1197
     1198# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
     1199# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
     1200# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
     1201# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
     1202# Windows.
     1203#
     1204# The HTML Help Workshop contains a compiler that can convert all HTML output
     1205# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
     1206# files are now used as the Windows 98 help format, and will replace the old
     1207# Windows help format (.hlp) on all Windows platforms in the future. Compressed
     1208# HTML files also contain an index, a table of contents, and you can search for
     1209# words in the documentation. The HTML workshop also contains a viewer for
     1210# compressed HTML files.
     1211# The default value is: NO.
     1212# This tag requires that the tag GENERATE_HTML is set to YES.
    8511213
    8521214GENERATE_HTMLHELP      = NO
    8531215
    854 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    855 # be used to specify the file name of the resulting .chm file. You
    856 # can add a path in front of the file if the result should not be
     1216# The CHM_FILE tag can be used to specify the file name of the resulting .chm
     1217# file. You can add a path in front of the file if the result should not be
    8571218# written to the html output directory.
    858 
    859 CHM_FILE               =
    860 
    861 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    862 # be used to specify the location (absolute path including file name) of
    863 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    864 # the HTML help compiler on the generated index.hhp.
    865 
    866 HHC_LOCATION           =
    867 
    868 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    869 # controls if a separate .chi index file is generated (YES) or that
    870 # it should be included in the master .chm file (NO).
     1219# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     1220
     1221CHM_FILE               =
     1222
     1223# The HHC_LOCATION tag can be used to specify the location (absolute path
     1224# including file name) of the HTML help compiler ( hhc.exe). If non-empty
     1225# doxygen will try to run the HTML help compiler on the generated index.hhp.
     1226# The file has to be specified with full path.
     1227# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     1228
     1229HHC_LOCATION           =
     1230
     1231# The GENERATE_CHI flag controls if a separate .chi index file is generated (
     1232# YES) or that it should be included in the master .chm file ( NO).
     1233# The default value is: NO.
     1234# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8711235
    8721236GENERATE_CHI           = NO
    8731237
    874 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    875 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    876 # content.
    877 
    878 CHM_INDEX_ENCODING     =
    879 
    880 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    881 # controls whether a binary table of contents is generated (YES) or a
    882 # normal table of contents (NO) in the .chm file.
     1238# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
     1239# and project file content.
     1240# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     1241
     1242CHM_INDEX_ENCODING     =
     1243
     1244# The BINARY_TOC flag controls whether a binary table of contents is generated (
     1245# YES) or a normal table of contents ( NO) in the .chm file.
     1246# The default value is: NO.
     1247# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8831248
    8841249BINARY_TOC             = NO
    8851250
    886 # The TOC_EXPAND flag can be set to YES to add extra items for group members
    887 # to the contents of the HTML help documentation and to the tree view.
     1251# The TOC_EXPAND flag can be set to YES to add extra items for group members to
     1252# the table of contents of the HTML help documentation and to the tree view.
     1253# The default value is: NO.
     1254# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8881255
    8891256TOC_EXPAND             = NO
    8901257
    891 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
    892 # are set, an additional index file will be generated that can be used as input for
    893 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
    894 # HTML documentation.
     1258# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
     1259# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
     1260# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
     1261# (.qch) of the generated HTML documentation.
     1262# The default value is: NO.
     1263# This tag requires that the tag GENERATE_HTML is set to YES.
    8951264
    8961265GENERATE_QHP           = NO
    8971266
    898 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    899 # be used to specify the file name of the resulting .qch file.
    900 # The path specified is relative to the HTML output folder.
    901 
    902 QCH_FILE               =
    903 
    904 # The QHP_NAMESPACE tag specifies the namespace to use when generating
    905 # Qt Help Project output. For more information please see
    906 # http://doc.trolltech.com/qthelpproject.html#namespace
    907 
    908 QHP_NAMESPACE          =
    909 
    910 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    911 # Qt Help Project output. For more information please see
    912 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
     1267# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
     1268# the file name of the resulting .qch file. The path specified is relative to
     1269# the HTML output folder.
     1270# This tag requires that the tag GENERATE_QHP is set to YES.
     1271
     1272QCH_FILE               =
     1273
     1274# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
     1275# Project output. For more information please see Qt Help Project / Namespace
     1276# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
     1277# The default value is: org.doxygen.Project.
     1278# This tag requires that the tag GENERATE_QHP is set to YES.
     1279
     1280QHP_NAMESPACE          =
     1281
     1282# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
     1283# Help Project output. For more information please see Qt Help Project / Virtual
     1284# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
     1285# folders).
     1286# The default value is: doc.
     1287# This tag requires that the tag GENERATE_QHP is set to YES.
    9131288
    9141289QHP_VIRTUAL_FOLDER     = doc
    9151290
    916 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
    917 # For more information please see
    918 # http://doc.trolltech.com/qthelpproject.html#custom-filters
    919 
    920 QHP_CUST_FILTER_NAME   =
    921 
    922 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
    923 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
    924 
    925 QHP_CUST_FILTER_ATTRS  =
    926 
    927 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
    928 # filter section matches.
    929 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
    930 
    931 QHP_SECT_FILTER_ATTRS  =
    932 
    933 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    934 # be used to specify the location of Qt's qhelpgenerator.
    935 # If non-empty doxygen will try to run qhelpgenerator on the generated
    936 # .qhp file.
    937 
    938 QHG_LOCATION           =
    939 
    940 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    941 # top of each HTML page. The value NO (the default) enables the index and
    942 # the value YES disables it.
     1291# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
     1292# filter to add. For more information please see Qt Help Project / Custom
     1293# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1294# filters).
     1295# This tag requires that the tag GENERATE_QHP is set to YES.
     1296
     1297QHP_CUST_FILTER_NAME   =
     1298
     1299# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
     1300# custom filter to add. For more information please see Qt Help Project / Custom
     1301# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1302# filters).
     1303# This tag requires that the tag GENERATE_QHP is set to YES.
     1304
     1305QHP_CUST_FILTER_ATTRS  =
     1306
     1307# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
     1308# project's filter section matches. Qt Help Project / Filter Attributes (see:
     1309# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
     1310# This tag requires that the tag GENERATE_QHP is set to YES.
     1311
     1312QHP_SECT_FILTER_ATTRS  =
     1313
     1314# The QHG_LOCATION tag can be used to specify the location of Qt's
     1315# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
     1316# generated .qhp file.
     1317# This tag requires that the tag GENERATE_QHP is set to YES.
     1318
     1319QHG_LOCATION           =
     1320
     1321# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
     1322# generated, together with the HTML files, they form an Eclipse help plugin. To
     1323# install this plugin and make it available under the help contents menu in
     1324# Eclipse, the contents of the directory containing the HTML and XML files needs
     1325# to be copied into the plugins directory of eclipse. The name of the directory
     1326# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
     1327# After copying Eclipse needs to be restarted before the help appears.
     1328# The default value is: NO.
     1329# This tag requires that the tag GENERATE_HTML is set to YES.
     1330
     1331GENERATE_ECLIPSEHELP   = NO
     1332
     1333# A unique identifier for the Eclipse help plugin. When installing the plugin
     1334# the directory name containing the HTML and XML files should also have this
     1335# name. Each documentation set should have its own identifier.
     1336# The default value is: org.doxygen.Project.
     1337# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
     1338
     1339ECLIPSE_DOC_ID         = org.doxygen.Project
     1340
     1341# If you want full control over the layout of the generated HTML pages it might
     1342# be necessary to disable the index and replace it with your own. The
     1343# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
     1344# of each HTML page. A value of NO enables the index and the value YES disables
     1345# it. Since the tabs in the index contain the same information as the navigation
     1346# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
     1347# The default value is: NO.
     1348# This tag requires that the tag GENERATE_HTML is set to YES.
    9431349
    9441350DISABLE_INDEX          = YES
    9451351
    946 # This tag can be used to set the number of enum values (range [1..20])
    947 # that doxygen will group on one line in the generated HTML documentation.
     1352# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     1353# structure should be generated to display hierarchical information. If the tag
     1354# value is set to YES, a side panel will be generated containing a tree-like
     1355# index structure (just like the one that is generated for HTML Help). For this
     1356# to work a browser that supports JavaScript, DHTML, CSS and frames is required
     1357# (i.e. any modern browser). Windows users are probably better off using the
     1358# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
     1359# further fine-tune the look of the index. As an example, the default style
     1360# sheet generated by doxygen has an example that shows how to put an image at
     1361# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
     1362# the same information as the tab index, you could consider setting
     1363# DISABLE_INDEX to YES when enabling this option.
     1364# The default value is: NO.
     1365# This tag requires that the tag GENERATE_HTML is set to YES.
     1366
     1367GENERATE_TREEVIEW      = NO
     1368
     1369# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
     1370# doxygen will group on one line in the generated HTML documentation.
     1371#
     1372# Note that a value of 0 will completely suppress the enum values from appearing
     1373# in the overview section.
     1374# Minimum value: 0, maximum value: 20, default value: 4.
     1375# This tag requires that the tag GENERATE_HTML is set to YES.
    9481376
    9491377ENUM_VALUES_PER_LINE   = 1
    9501378
    951 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    952 # structure should be generated to display hierarchical information.
    953 # If the tag value is set to FRAME, a side panel will be generated
    954 # containing a tree-like index structure (just like the one that
    955 # is generated for HTML Help). For this to work a browser that supports
    956 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    957 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    958 # probably better off using the HTML help feature. Other possible values
    959 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
    960 # and Class Hierarchy pages using a tree view instead of an ordered list;
    961 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
    962 # disables this behavior completely. For backwards compatibility with previous
    963 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
    964 # respectively.
    965 
    966 GENERATE_TREEVIEW      = NO
    967 
    968 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    969 # used to set the initial width (in pixels) of the frame in which the tree
    970 # is shown.
     1379# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
     1380# to set the initial width (in pixels) of the frame in which the tree is shown.
     1381# Minimum value: 0, maximum value: 1500, default value: 250.
     1382# This tag requires that the tag GENERATE_HTML is set to YES.
    9711383
    9721384TREEVIEW_WIDTH         = 250
    9731385
    974 # Use this tag to change the font size of Latex formulas included
    975 # as images in the HTML documentation. The default is 10. Note that
    976 # when you change the font size after a successful doxygen run you need
    977 # to manually remove any form_*.png images from the HTML output directory
    978 # to force them to be regenerated.
     1386# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
     1387# external symbols imported via tag files in a separate window.
     1388# The default value is: NO.
     1389# This tag requires that the tag GENERATE_HTML is set to YES.
     1390
     1391EXT_LINKS_IN_WINDOW    = NO
     1392
     1393# Use this tag to change the font size of LaTeX formulas included as images in
     1394# the HTML documentation. When you change the font size after a successful
     1395# doxygen run you need to manually remove any form_*.png images from the HTML
     1396# output directory to force them to be regenerated.
     1397# Minimum value: 8, maximum value: 50, default value: 10.
     1398# This tag requires that the tag GENERATE_HTML is set to YES.
    9791399
    9801400FORMULA_FONTSIZE       = 10
    9811401
    982 #---------------------------------------------------------------------------
    983 # configuration options related to the LaTeX output
    984 #---------------------------------------------------------------------------
    985 
    986 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    987 # generate Latex output.
     1402# Use the FORMULA_TRANPARENT tag to determine whether or not the images
     1403# generated for formulas are transparent PNGs. Transparent PNGs are not
     1404# supported properly for IE 6.0, but are supported on all modern browsers.
     1405#
     1406# Note that when changing this option you need to delete any form_*.png files in
     1407# the HTML output directory before the changes have effect.
     1408# The default value is: YES.
     1409# This tag requires that the tag GENERATE_HTML is set to YES.
     1410
     1411FORMULA_TRANSPARENT    = YES
     1412
     1413# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
     1414# http://www.mathjax.org) which uses client side Javascript for the rendering
     1415# instead of using prerendered bitmaps. Use this if you do not have LaTeX
     1416# installed or if you want to formulas look prettier in the HTML output. When
     1417# enabled you may also need to install MathJax separately and configure the path
     1418# to it using the MATHJAX_RELPATH option.
     1419# The default value is: NO.
     1420# This tag requires that the tag GENERATE_HTML is set to YES.
     1421
     1422USE_MATHJAX            = NO
     1423
     1424# When MathJax is enabled you can set the default output format to be used for
     1425# the MathJax output. See the MathJax site (see:
     1426# http://docs.mathjax.org/en/latest/output.html) for more details.
     1427# Possible values are: HTML-CSS (which is slower, but has the best
     1428# compatibility), NativeMML (i.e. MathML) and SVG.
     1429# The default value is: HTML-CSS.
     1430# This tag requires that the tag USE_MATHJAX is set to YES.
     1431
     1432MATHJAX_FORMAT         = HTML-CSS
     1433
     1434# When MathJax is enabled you need to specify the location relative to the HTML
     1435# output directory using the MATHJAX_RELPATH option. The destination directory
     1436# should contain the MathJax.js script. For instance, if the mathjax directory
     1437# is located at the same level as the HTML output directory, then
     1438# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
     1439# Content Delivery Network so you can quickly see the result without installing
     1440# MathJax. However, it is strongly recommended to install a local copy of
     1441# MathJax from http://www.mathjax.org before deployment.
     1442# The default value is: http://cdn.mathjax.org/mathjax/latest.
     1443# This tag requires that the tag USE_MATHJAX is set to YES.
     1444
     1445MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1446
     1447# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
     1448# extension names that should be enabled during MathJax rendering. For example
     1449# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
     1450# This tag requires that the tag USE_MATHJAX is set to YES.
     1451
     1452MATHJAX_EXTENSIONS     =
     1453
     1454# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
     1455# of code that will be used on startup of the MathJax code. See the MathJax site
     1456# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
     1457# example see the documentation.
     1458# This tag requires that the tag USE_MATHJAX is set to YES.
     1459
     1460MATHJAX_CODEFILE       =
     1461
     1462# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
     1463# the HTML output. The underlying search engine uses javascript and DHTML and
     1464# should work on any modern browser. Note that when using HTML help
     1465# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
     1466# there is already a search function so this one should typically be disabled.
     1467# For large projects the javascript based search engine can be slow, then
     1468# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
     1469# search using the keyboard; to jump to the search box use <access key> + S
     1470# (what the <access key> is depends on the OS and browser, but it is typically
     1471# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
     1472# key> to jump into the search results window, the results can be navigated
     1473# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
     1474# the search. The filter options can be selected when the cursor is inside the
     1475# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
     1476# to select a filter and <Enter> or <escape> to activate or cancel the filter
     1477# option.
     1478# The default value is: YES.
     1479# This tag requires that the tag GENERATE_HTML is set to YES.
     1480
     1481SEARCHENGINE           = NO
     1482
     1483# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
     1484# implemented using a web server instead of a web client using Javascript. There
     1485# are two flavours of web server based searching depending on the
     1486# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
     1487# searching and an index file used by the script. When EXTERNAL_SEARCH is
     1488# enabled the indexing and searching needs to be provided by external tools. See
     1489# the section "External Indexing and Searching" for details.
     1490# The default value is: NO.
     1491# This tag requires that the tag SEARCHENGINE is set to YES.
     1492
     1493SERVER_BASED_SEARCH    = NO
     1494
     1495# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
     1496# script for searching. Instead the search results are written to an XML file
     1497# which needs to be processed by an external indexer. Doxygen will invoke an
     1498# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
     1499# search results.
     1500#
     1501# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1502# (doxysearch.cgi) which are based on the open source search engine library
     1503# Xapian (see: http://xapian.org/).
     1504#
     1505# See the section "External Indexing and Searching" for details.
     1506# The default value is: NO.
     1507# This tag requires that the tag SEARCHENGINE is set to YES.
     1508
     1509EXTERNAL_SEARCH        = NO
     1510
     1511# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     1512# which will return the search results when EXTERNAL_SEARCH is enabled.
     1513#
     1514# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1515# (doxysearch.cgi) which are based on the open source search engine library
     1516# Xapian (see: http://xapian.org/). See the section "External Indexing and
     1517# Searching" for details.
     1518# This tag requires that the tag SEARCHENGINE is set to YES.
     1519
     1520SEARCHENGINE_URL       =
     1521
     1522# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     1523# search data is written to a file for indexing by an external tool. With the
     1524# SEARCHDATA_FILE tag the name of this file can be specified.
     1525# The default file is: searchdata.xml.
     1526# This tag requires that the tag SEARCHENGINE is set to YES.
     1527
     1528SEARCHDATA_FILE        = searchdata.xml
     1529
     1530# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
     1531# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
     1532# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
     1533# projects and redirect the results back to the right project.
     1534# This tag requires that the tag SEARCHENGINE is set to YES.
     1535
     1536EXTERNAL_SEARCH_ID     =
     1537
     1538# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     1539# projects other than the one defined by this configuration file, but that are
     1540# all added to the same external search index. Each project needs to have a
     1541# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
     1542# to a relative location where the documentation can be found. The format is:
     1543# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
     1544# This tag requires that the tag SEARCHENGINE is set to YES.
     1545
     1546EXTRA_SEARCH_MAPPINGS  =
     1547
     1548#---------------------------------------------------------------------------
     1549# Configuration options related to the LaTeX output
     1550#---------------------------------------------------------------------------
     1551
     1552# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
     1553# The default value is: YES.
    9881554
    9891555GENERATE_LATEX         = YES
    9901556
    991 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    992 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    993 # put in front of it. If left blank `latex' will be used as the default path.
     1557# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
     1558# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1559# it.
     1560# The default directory is: latex.
     1561# This tag requires that the tag GENERATE_LATEX is set to YES.
    9941562
    9951563LATEX_OUTPUT           = latex
    9961564
    997 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    998 # invoked. If left blank `latex' will be used as the default command name.
     1565# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
     1566# invoked.
     1567#
     1568# Note that when enabling USE_PDFLATEX this option is only used for generating
     1569# bitmaps for formulas in the HTML output, but not in the Makefile that is
     1570# written to the output directory.
     1571# The default file is: latex.
     1572# This tag requires that the tag GENERATE_LATEX is set to YES.
    9991573
    10001574LATEX_CMD_NAME         = latex
    10011575
    1002 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    1003 # generate index for LaTeX. If left blank `makeindex' will be used as the
    1004 # default command name.
     1576# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
     1577# index for LaTeX.
     1578# The default file is: makeindex.
     1579# This tag requires that the tag GENERATE_LATEX is set to YES.
    10051580
    10061581MAKEINDEX_CMD_NAME     = makeindex
    10071582
    1008 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    1009 # LaTeX documents. This may be useful for small projects and may help to
    1010 # save some trees in general.
     1583# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
     1584# documents. This may be useful for small projects and may help to save some
     1585# trees in general.
     1586# The default value is: NO.
     1587# This tag requires that the tag GENERATE_LATEX is set to YES.
    10111588
    10121589COMPACT_LATEX          = YES
    10131590
    1014 # The PAPER_TYPE tag can be used to set the paper type that is used
    1015 # by the printer. Possible values are: a4, a4wide, letter, legal and
    1016 # executive. If left blank a4wide will be used.
     1591# The PAPER_TYPE tag can be used to set the paper type that is used by the
     1592# printer.
     1593# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
     1594# 14 inches) and executive (7.25 x 10.5 inches).
     1595# The default value is: a4.
     1596# This tag requires that the tag GENERATE_LATEX is set to YES.
    10171597
    10181598PAPER_TYPE             = a4wide
    10191599
    1020 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    1021 # packages that should be included in the LaTeX output.
    1022 
    1023 EXTRA_PACKAGES         =
    1024 
    1025 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    1026 # the generated latex document. The header should contain everything until
    1027 # the first chapter. If it is left blank doxygen will generate a
    1028 # standard header. Notice: only use this tag if you know what you are doing!
    1029 
    1030 LATEX_HEADER           =
    1031 
    1032 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    1033 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    1034 # contain links (just like the HTML output) instead of page references
    1035 # This makes the output suitable for online browsing using a pdf viewer.
     1600# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
     1601# that should be included in the LaTeX output. To get the times font for
     1602# instance you can specify
     1603# EXTRA_PACKAGES=times
     1604# If left blank no extra packages will be included.
     1605# This tag requires that the tag GENERATE_LATEX is set to YES.
     1606
     1607EXTRA_PACKAGES         =
     1608
     1609# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
     1610# generated LaTeX document. The header should contain everything until the first
     1611# chapter. If it is left blank doxygen will generate a standard header. See
     1612# section "Doxygen usage" for information on how to let doxygen write the
     1613# default header to a separate file.
     1614#
     1615# Note: Only use a user-defined header if you know what you are doing! The
     1616# following commands have a special meaning inside the header: $title,
     1617# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
     1618# replace them by respectively the title of the page, the current date and time,
     1619# only the current date, the version number of doxygen, the project name (see
     1620# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
     1621# This tag requires that the tag GENERATE_LATEX is set to YES.
     1622
     1623LATEX_HEADER           =
     1624
     1625# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
     1626# generated LaTeX document. The footer should contain everything after the last
     1627# chapter. If it is left blank doxygen will generate a standard footer.
     1628#
     1629# Note: Only use a user-defined footer if you know what you are doing!
     1630# This tag requires that the tag GENERATE_LATEX is set to YES.
     1631
     1632LATEX_FOOTER           =
     1633
     1634# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
     1635# other source files which should be copied to the LATEX_OUTPUT output
     1636# directory. Note that the files will be copied as-is; there are no commands or
     1637# markers available.
     1638# This tag requires that the tag GENERATE_LATEX is set to YES.
     1639
     1640LATEX_EXTRA_FILES      =
     1641
     1642# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
     1643# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
     1644# contain links (just like the HTML output) instead of page references. This
     1645# makes the output suitable for online browsing using a PDF viewer.
     1646# The default value is: YES.
     1647# This tag requires that the tag GENERATE_LATEX is set to YES.
    10361648
    10371649PDF_HYPERLINKS         = YES
    10381650
    1039 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    1040 # plain latex in the generated Makefile. Set this option to YES to get a
     1651# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
     1652# the PDF file directly from the LaTeX files. Set this option to YES to get a
    10411653# higher quality PDF documentation.
     1654# The default value is: YES.
     1655# This tag requires that the tag GENERATE_LATEX is set to YES.
    10421656
    10431657USE_PDFLATEX           = YES
    10441658
    1045 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    1046 # command to the generated LaTeX files. This will instruct LaTeX to keep
    1047 # running if errors occur, instead of asking the user for help.
    1048 # This option is also used when generating formulas in HTML.
     1659# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
     1660# command to the generated LaTeX files. This will instruct LaTeX to keep running
     1661# if errors occur, instead of asking the user for help. This option is also used
     1662# when generating formulas in HTML.
     1663# The default value is: NO.
     1664# This tag requires that the tag GENERATE_LATEX is set to YES.
    10491665
    10501666LATEX_BATCHMODE        = YES
    10511667
    1052 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    1053 # include the index chapters (such as File Index, Compound Index, etc.)
    1054 # in the output.
     1668# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
     1669# index chapters (such as File Index, Compound Index, etc.) in the output.
     1670# The default value is: NO.
     1671# This tag requires that the tag GENERATE_LATEX is set to YES.
    10551672
    10561673LATEX_HIDE_INDICES     = YES
    10571674
    1058 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
     1675# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
     1676# code with syntax highlighting in the LaTeX output.
     1677#
     1678# Note that which sources are shown also depends on other settings such as
     1679# SOURCE_BROWSER.
     1680# The default value is: NO.
     1681# This tag requires that the tag GENERATE_LATEX is set to YES.
    10591682
    10601683LATEX_SOURCE_CODE      = NO
    10611684
    1062 #---------------------------------------------------------------------------
    1063 # configuration options related to the RTF output
    1064 #---------------------------------------------------------------------------
    1065 
    1066 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    1067 # The RTF output is optimized for Word 97 and may not look very pretty with
    1068 # other RTF readers or editors.
     1685# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
     1686# bibliography, e.g. plainnat, or ieeetr. See
     1687# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
     1688# The default value is: plain.
     1689# This tag requires that the tag GENERATE_LATEX is set to YES.
     1690
     1691LATEX_BIB_STYLE        = plain
     1692
     1693#---------------------------------------------------------------------------
     1694# Configuration options related to the RTF output
     1695#---------------------------------------------------------------------------
     1696
     1697# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
     1698# RTF output is optimized for Word 97 and may not look too pretty with other RTF
     1699# readers/editors.
     1700# The default value is: NO.
    10691701
    10701702GENERATE_RTF           = NO
    10711703
    1072 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    1073 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1074 # put in front of it. If left blank `rtf' will be used as the default path.
     1704# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
     1705# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1706# it.
     1707# The default directory is: rtf.
     1708# This tag requires that the tag GENERATE_RTF is set to YES.
    10751709
    10761710RTF_OUTPUT             = rtf
    10771711
    1078 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    1079 # RTF documents. This may be useful for small projects and may help to
    1080 # save some trees in general.
     1712# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
     1713# documents. This may be useful for small projects and may help to save some
     1714# trees in general.
     1715# The default value is: NO.
     1716# This tag requires that the tag GENERATE_RTF is set to YES.
    10811717
    10821718COMPACT_RTF            = NO
    10831719
    1084 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    1085 # will contain hyperlink fields. The RTF file will
    1086 # contain links (just like the HTML output) instead of page references.
    1087 # This makes the output suitable for online browsing using WORD or other
    1088 # programs which support those fields.
    1089 # Note: wordpad (write) and others do not support links.
     1720# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
     1721# contain hyperlink fields. The RTF file will contain links (just like the HTML
     1722# output) instead of page references. This makes the output suitable for online
     1723# browsing using Word or some other Word compatible readers that support those
     1724# fields.
     1725#
     1726# Note: WordPad (write) and others do not support links.
     1727# The default value is: NO.
     1728# This tag requires that the tag GENERATE_RTF is set to YES.
    10901729
    10911730RTF_HYPERLINKS         = NO
    10921731
    1093 # Load stylesheet definitions from file. Syntax is similar to doxygen's
    1094 # config file, i.e. a series of assignments. You only have to provide
    1095 # replacements, missing definitions are set to their default value.
    1096 
    1097 RTF_STYLESHEET_FILE    =
    1098 
    1099 # Set optional variables used in the generation of an rtf document.
    1100 # Syntax is similar to doxygen's config file.
    1101 
    1102 RTF_EXTENSIONS_FILE    =
    1103 
    1104 #---------------------------------------------------------------------------
    1105 # configuration options related to the man page output
    1106 #---------------------------------------------------------------------------
    1107 
    1108 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    1109 # generate man pages
     1732# Load stylesheet definitions from file. Syntax is similar to doxygen's config
     1733# file, i.e. a series of assignments. You only have to provide replacements,
     1734# missing definitions are set to their default value.
     1735#
     1736# See also section "Doxygen usage" for information on how to generate the
     1737# default style sheet that doxygen normally uses.
     1738# This tag requires that the tag GENERATE_RTF is set to YES.
     1739
     1740RTF_STYLESHEET_FILE    =
     1741
     1742# Set optional variables used in the generation of an RTF document. Syntax is
     1743# similar to doxygen's config file. A template extensions file can be generated
     1744# using doxygen -e rtf extensionFile.
     1745# This tag requires that the tag GENERATE_RTF is set to YES.
     1746
     1747RTF_EXTENSIONS_FILE    =
     1748
     1749#---------------------------------------------------------------------------
     1750# Configuration options related to the man page output
     1751#---------------------------------------------------------------------------
     1752
     1753# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
     1754# classes and files.
     1755# The default value is: NO.
    11101756
    11111757GENERATE_MAN           = YES
    11121758
    1113 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    1114 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1115 # put in front of it. If left blank `man' will be used as the default path.
     1759# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
     1760# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1761# it. A directory man3 will be created inside the directory specified by
     1762# MAN_OUTPUT.
     1763# The default directory is: man.
     1764# This tag requires that the tag GENERATE_MAN is set to YES.
    11161765
    11171766MAN_OUTPUT             = man
    11181767
    1119 # The MAN_EXTENSION tag determines the extension that is added to
    1120 # the generated man pages (default is the subroutine's section .3)
     1768# The MAN_EXTENSION tag determines the extension that is added to the generated
     1769# man pages. In case the manual section does not start with a number, the number
     1770# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
     1771# optional.
     1772# The default value is: .3.
     1773# This tag requires that the tag GENERATE_MAN is set to YES.
    11211774
    11221775MAN_EXTENSION          = .3caca
    11231776
    1124 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    1125 # then it will generate one additional man file for each entity
    1126 # documented in the real man page(s). These additional files
    1127 # only source the real man page, but without them the man command
    1128 # would be unable to find the correct page. The default is NO.
     1777# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
     1778# will generate one additional man file for each entity documented in the real
     1779# man page(s). These additional files only source the real man page, but without
     1780# them the man command would be unable to find the correct page.
     1781# The default value is: NO.
     1782# This tag requires that the tag GENERATE_MAN is set to YES.
    11291783
    11301784MAN_LINKS              = YES
    11311785
    11321786#---------------------------------------------------------------------------
    1133 # configuration options related to the XML output
    1134 #---------------------------------------------------------------------------
    1135 
    1136 # If the GENERATE_XML tag is set to YES Doxygen will
    1137 # generate an XML file that captures the structure of
    1138 # the code including all documentation.
     1787# Configuration options related to the XML output
     1788#---------------------------------------------------------------------------
     1789
     1790# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
     1791# captures the structure of the code including all documentation.
     1792# The default value is: NO.
    11391793
    11401794GENERATE_XML           = NO
    11411795
    1142 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    1143 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1144 # put in front of it. If left blank `xml' will be used as the default path.
     1796# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
     1797# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1798# it.
     1799# The default directory is: xml.
     1800# This tag requires that the tag GENERATE_XML is set to YES.
    11451801
    11461802XML_OUTPUT             = xml
    11471803
    1148 # The XML_SCHEMA tag can be used to specify an XML schema,
    1149 # which can be used by a validating XML parser to check the
    1150 # syntax of the XML files.
    1151 
    1152 XML_SCHEMA             =
    1153 
    1154 # The XML_DTD tag can be used to specify an XML DTD,
    1155 # which can be used by a validating XML parser to check the
    1156 # syntax of the XML files.
    1157 
    1158 XML_DTD                =
    1159 
    1160 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    1161 # dump the program listings (including syntax highlighting
    1162 # and cross-referencing information) to the XML output. Note that
    1163 # enabling this will significantly increase the size of the XML output.
     1804# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
     1805# validating XML parser to check the syntax of the XML files.
     1806# This tag requires that the tag GENERATE_XML is set to YES.
     1807
     1808XML_SCHEMA             =
     1809
     1810# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
     1811# validating XML parser to check the syntax of the XML files.
     1812# This tag requires that the tag GENERATE_XML is set to YES.
     1813
     1814XML_DTD                =
     1815
     1816# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
     1817# listings (including syntax highlighting and cross-referencing information) to
     1818# the XML output. Note that enabling this will significantly increase the size
     1819# of the XML output.
     1820# The default value is: YES.
     1821# This tag requires that the tag GENERATE_XML is set to YES.
    11641822
    11651823XML_PROGRAMLISTING     = YES
    11661824
    11671825#---------------------------------------------------------------------------
    1168 # configuration options for the AutoGen Definitions output
    1169 #---------------------------------------------------------------------------
    1170 
    1171 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    1172 # generate an AutoGen Definitions (see autogen.sf.net) file
    1173 # that captures the structure of the code including all
    1174 # documentation. Note that this feature is still experimental
    1175 # and incomplete at the moment.
     1826# Configuration options related to the DOCBOOK output
     1827#---------------------------------------------------------------------------
     1828
     1829# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
     1830# that can be used to generate PDF.
     1831# The default value is: NO.
     1832
     1833GENERATE_DOCBOOK       = NO
     1834
     1835# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
     1836# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
     1837# front of it.
     1838# The default directory is: docbook.
     1839# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1840
     1841DOCBOOK_OUTPUT         = docbook
     1842
     1843#---------------------------------------------------------------------------
     1844# Configuration options for the AutoGen Definitions output
     1845#---------------------------------------------------------------------------
     1846
     1847# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
     1848# Definitions (see http://autogen.sf.net) file that captures the structure of
     1849# the code including all documentation. Note that this feature is still
     1850# experimental and incomplete at the moment.
     1851# The default value is: NO.
    11761852
    11771853GENERATE_AUTOGEN_DEF   = NO
    11781854
    11791855#---------------------------------------------------------------------------
    1180 # configuration options related to the Perl module output
    1181 #---------------------------------------------------------------------------
    1182 
    1183 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    1184 # generate a Perl module file that captures the structure of
    1185 # the code including all documentation. Note that this
    1186 # feature is still experimental and incomplete at the
    1187 # moment.
     1856# Configuration options related to the Perl module output
     1857#---------------------------------------------------------------------------
     1858
     1859# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
     1860# file that captures the structure of the code including all documentation.
     1861#
     1862# Note that this feature is still experimental and incomplete at the moment.
     1863# The default value is: NO.
    11881864
    11891865GENERATE_PERLMOD       = NO
    11901866
    1191 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    1192 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    1193 # to generate PDF and DVI output from the Perl module output.
     1867# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
     1868# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
     1869# output from the Perl module output.
     1870# The default value is: NO.
     1871# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    11941872
    11951873PERLMOD_LATEX          = NO
    11961874
    1197 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1198 # nicely formatted so it can be parsed by a human reader.
    1199 # This is useful
    1200 # if you want to understand what is going on.
    1201 # On the other hand, if this
    1202 # tag is set to NO the size of the Perl module output will be much smaller
    1203 # and Perl will parse it just the same.
     1875# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
     1876# formatted so it can be parsed by a human reader. This is useful if you want to
     1877# understand what is going on. On the other hand, if this tag is set to NO the
     1878# size of the Perl module output will be much smaller and Perl will parse it
     1879# just the same.
     1880# The default value is: YES.
     1881# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    12041882
    12051883PERLMOD_PRETTY         = YES
    12061884
    1207 # The names of the make variables in the generated doxyrules.make file
    1208 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    1209 # This is useful so different doxyrules.make files included by the same
    1210 # Makefile don't overwrite each other's variables.
    1211 
    1212 PERLMOD_MAKEVAR_PREFIX =
    1213 
    1214 #---------------------------------------------------------------------------
    1215 # Configuration options related to the preprocessor   
    1216 #---------------------------------------------------------------------------
    1217 
    1218 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    1219 # evaluate all C-preprocessor directives found in the sources and include
    1220 # files.
     1885# The names of the make variables in the generated doxyrules.make file are
     1886# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
     1887# so different doxyrules.make files included by the same Makefile don't
     1888# overwrite each other's variables.
     1889# This tag requires that the tag GENERATE_PERLMOD is set to YES.
     1890
     1891PERLMOD_MAKEVAR_PREFIX =
     1892
     1893#---------------------------------------------------------------------------
     1894# Configuration options related to the preprocessor
     1895#---------------------------------------------------------------------------
     1896
     1897# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
     1898# C-preprocessor directives found in the sources and include files.
     1899# The default value is: YES.
    12211900
    12221901ENABLE_PREPROCESSING   = YES
    12231902
    1224 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    1225 # names in the source code. If set to NO (the default) only conditional
    1226 # compilation will be performed. Macro expansion can be done in a controlled
    1227 # way by setting EXPAND_ONLY_PREDEF to YES.
     1903# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
     1904# in the source code. If set to NO only conditional compilation will be
     1905# performed. Macro expansion can be done in a controlled way by setting
     1906# EXPAND_ONLY_PREDEF to YES.
     1907# The default value is: NO.
     1908# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    12281909
    12291910MACRO_EXPANSION        = YES
    12301911
    1231 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    1232 # then the macro expansion is limited to the macros specified with the
    1233 # PREDEFINED and EXPAND_AS_DEFINED tags.
     1912# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
     1913# the macro expansion is limited to the macros specified with the PREDEFINED and
     1914# EXPAND_AS_DEFINED tags.
     1915# The default value is: NO.
     1916# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    12341917
    12351918EXPAND_ONLY_PREDEF     = YES
    12361919
    1237 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1238 # in the INCLUDE_PATH (see below) will be search if a #include is found.
     1920# If the SEARCH_INCLUDES tag is set to YES the includes files in the
     1921# INCLUDE_PATH will be searched if a #include is found.
     1922# The default value is: YES.
     1923# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    12391924
    12401925SEARCH_INCLUDES        = YES
    12411926
    1242 # The INCLUDE_PATH tag can be used to specify one or more directories that
    1243 # contain include files that are not input files but should be processed by
    1244 # the preprocessor.
    1245 
    1246 INCLUDE_PATH           =
    1247 
    1248 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    1249 # patterns (like *.h and *.hpp) to filter out the header-files in the
    1250 # directories. If left blank, the patterns specified with FILE_PATTERNS will
    1251 # be used.
    1252 
    1253 INCLUDE_FILE_PATTERNS  =
    1254 
    1255 # The PREDEFINED tag can be used to specify one or more macro names that
    1256 # are defined before the preprocessor is started (similar to the -D option of
    1257 # gcc). The argument of the tag is a list of macros of the form: name
    1258 # or name=definition (no spaces). If the definition and the = are
    1259 # omitted =1 is assumed. To prevent a macro definition from being
    1260 # undefined via #undef or recursively expanded use the := operator
    1261 # instead of the = operator.
    1262 
    1263 PREDEFINED             = _DOXYGEN_SKIP_ME __extern=
    1264 
    1265 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    1266 # this tag can be used to specify a list of macro names that should be expanded.
    1267 # The macro definition that is found in the sources will be used.
    1268 # Use the PREDEFINED tag if you want to use a different macro definition.
     1927# The INCLUDE_PATH tag can be used to specify one or more directories that
     1928# contain include files that are not input files but should be processed by the
     1929# preprocessor.
     1930# This tag requires that the tag SEARCH_INCLUDES is set to YES.
     1931
     1932INCLUDE_PATH           =
     1933
     1934# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1935# patterns (like *.h and *.hpp) to filter out the header-files in the
     1936# directories. If left blank, the patterns specified with FILE_PATTERNS will be
     1937# used.
     1938# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1939
     1940INCLUDE_FILE_PATTERNS  =
     1941
     1942# The PREDEFINED tag can be used to specify one or more macro names that are
     1943# defined before the preprocessor is started (similar to the -D option of e.g.
     1944# gcc). The argument of the tag is a list of macros of the form: name or
     1945# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
     1946# is assumed. To prevent a macro definition from being undefined via #undef or
     1947# recursively expanded use the := operator instead of the = operator.
     1948# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1949
     1950PREDEFINED             = _DOXYGEN_SKIP_ME \
     1951                         __extern=
     1952
     1953# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
     1954# tag can be used to specify a list of macro names that should be expanded. The
     1955# macro definition that is found in the sources will be used. Use the PREDEFINED
     1956# tag if you want to use a different macro definition that overrules the
     1957# definition found in the source code.
     1958# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    12691959
    12701960EXPAND_AS_DEFINED      = __extern \
    12711961                         __class
    12721962
    1273 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1274 # doxygen's preprocessor will remove all function-like macros that are alone
    1275 # on a line, have an all uppercase name, and do not end with a semicolon. Such
    1276 # function macros are typically used for boiler-plate code, and will confuse
    1277 # the parser if not removed.
     1963# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
     1964# remove all refrences to function-like macros that are alone on a line, have an
     1965# all uppercase name, and do not end with a semicolon. Such function macros are
     1966# typically used for boiler-plate code, and will confuse the parser if not
     1967# removed.
     1968# The default value is: YES.
     1969# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
    12781970
    12791971SKIP_FUNCTION_MACROS   = YES
    12801972
    12811973#---------------------------------------------------------------------------
    1282 # Configuration::additions related to external references   
    1283 #---------------------------------------------------------------------------
    1284 
    1285 # The TAGFILES option can be used to specify one or more tagfiles.
    1286 # Optionally an initial location of the external documentation
    1287 # can be added for each tagfile. The format of a tag file without
    1288 # this location is as follows:
    1289 
    1290 # TAGFILES = file1 file2 ...
    1291 # Adding location for the tag files is done as follows:
    1292 
    1293 # TAGFILES = file1=loc1 "file2 = loc2" ...
    1294 # where "loc1" and "loc2" can be relative or absolute paths or
    1295 # URLs. If a location is present for each tag, the installdox tool
    1296 # does not have to be run to correct the links.
    1297 # Note that each tag file must have a unique name
    1298 # (where the name does NOT include the path)
    1299 # If a tag file is not located in the directory in which doxygen
    1300 # is run, you must also specify the path to the tagfile here.
    1301 
    1302 TAGFILES               =
    1303 
    1304 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    1305 # a tag file that is based on the input files it reads.
    1306 
    1307 GENERATE_TAGFILE       =
    1308 
    1309 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    1310 # in the class index. If set to NO only the inherited external classes
    1311 # will be listed.
     1974# Configuration options related to external references
     1975#---------------------------------------------------------------------------
     1976
     1977# The TAGFILES tag can be used to specify one or more tag files. For each tag
     1978# file the location of the external documentation should be added. The format of
     1979# a tag file without this location is as follows:
     1980# TAGFILES = file1 file2 ...
     1981# Adding location for the tag files is done as follows:
     1982# TAGFILES = file1=loc1 "file2 = loc2" ...
     1983# where loc1 and loc2 can be relative or absolute paths or URLs. See the
     1984# section "Linking to external documentation" for more information about the use
     1985# of tag files.
     1986# Note: Each tag file must have an unique name (where the name does NOT include
     1987# the path). If a tag file is not located in the directory in which doxygen is
     1988# run, you must also specify the path to the tagfile here.
     1989
     1990TAGFILES               =
     1991
     1992# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
     1993# tag file that is based on the input files it reads. See section "Linking to
     1994# external documentation" for more information about the usage of tag files.
     1995
     1996GENERATE_TAGFILE       =
     1997
     1998# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
     1999# class index. If set to NO only the inherited external classes will be listed.
     2000# The default value is: NO.
    13122001
    13132002ALLEXTERNALS           = NO
    13142003
    1315 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    1316 # in the modules index. If set to NO, only the current project's groups will
     2004# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
     2005# the modules index. If set to NO, only the current project's groups will be
     2006# listed.
     2007# The default value is: YES.
     2008
     2009EXTERNAL_GROUPS        = YES
     2010
     2011# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
     2012# the related pages index. If set to NO, only the current project's pages will
    13172013# be listed.
    1318 
    1319 EXTERNAL_GROUPS        = YES
    1320 
    1321 # The PERL_PATH should be the absolute path and name of the perl script
    1322 # interpreter (i.e. the result of `which perl').
     2014# The default value is: YES.
     2015
     2016EXTERNAL_PAGES         = YES
     2017
     2018# The PERL_PATH should be the absolute path and name of the perl script
     2019# interpreter (i.e. the result of 'which perl').
     2020# The default file (with absolute path) is: /usr/bin/perl.
    13232021
    13242022PERL_PATH              = /usr/bin/perl
    13252023
    13262024#---------------------------------------------------------------------------
    1327 # Configuration options related to the dot tool   
    1328 #---------------------------------------------------------------------------
    1329 
    1330 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1331 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    1332 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    1333 # this option is superseded by the HAVE_DOT option below. This is only a
    1334 # fallback. It is recommended to install and use dot, since it yields more
     2025# Configuration options related to the dot tool
     2026#---------------------------------------------------------------------------
     2027
     2028# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
     2029# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
     2030# NO turns the diagrams off. Note that this option also works with HAVE_DOT
     2031# disabled, but it is recommended to install and use dot, since it yields more
    13352032# powerful graphs.
     2033# The default value is: YES.
    13362034
    13372035CLASS_DIAGRAMS         = YES
    13382036
    1339 # You can define message sequence charts within doxygen comments using the \msc 
    1340 # command. Doxygen will then run the mscgen tool (see 
    1341 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
    1342 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
    1343 # the mscgen tool resides. If left empty the tool is assumed to be found in the 
     2037# You can define message sequence charts within doxygen comments using the \msc
     2038# command. Doxygen will then run the mscgen tool (see:
     2039# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
     2040# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     2041# the mscgen tool resides. If left empty the tool is assumed to be found in the
    13442042# default search path.
    13452043
    1346 MSCGEN_PATH            =
    1347 
    1348 # If set to YES, the inheritance and collaboration graphs will hide
    1349 # inheritance and usage relations if the target is undocumented
    1350 # or is not a class.
     2044MSCGEN_PATH            =
     2045
     2046# You can include diagrams made with dia in doxygen documentation. Doxygen will
     2047# then run dia to produce the diagram and insert it in the documentation. The
     2048# DIA_PATH tag allows you to specify the directory where the dia binary resides.
     2049# If left empty dia is assumed to be found in the default search path.
     2050
     2051DIA_PATH               =
     2052
     2053# If set to YES, the inheritance and collaboration graphs will hide inheritance
     2054# and usage relations if the target is undocumented or is not a class.
     2055# The default value is: YES.
    13512056
    13522057HIDE_UNDOC_RELATIONS   = YES
    13532058
    1354 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    1355 # available from the path. This tool is part of Graphviz, a graph visualization
    1356 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    1357 # have no effect if this option is set to NO (the default)
     2059# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     2060# available from the path. This tool is part of Graphviz (see:
     2061# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
     2062# Bell Labs. The other options in this section have no effect if this option is
     2063# set to NO
     2064# The default value is: NO.
    13582065
    13592066HAVE_DOT               = NO
    13602067
    1361 # By default doxygen will write a font called FreeSans.ttf to the output
    1362 # directory and reference it in all dot files that doxygen generates. This
    1363 # font does not include all possible unicode characters however, so when you need
    1364 # these (or just want a differently looking font) you can specify the font name
    1365 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
    1366 # which can be done by putting it in a standard location or by setting the
    1367 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
    1368 # containing the font.
    1369 
    1370 DOT_FONTNAME           = FreeSans
    1371 
    1372 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    1373 # The default size is 10pt.
     2068# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
     2069# to run in parallel. When set to 0 doxygen will base this on the number of
     2070# processors available in the system. You can set it explicitly to a value
     2071# larger than 0 to get control over the balance between CPU load and processing
     2072# speed.
     2073# Minimum value: 0, maximum value: 32, default value: 0.
     2074# This tag requires that the tag HAVE_DOT is set to YES.
     2075
     2076DOT_NUM_THREADS        = 0
     2077
     2078# When you want a differently looking font n the dot files that doxygen
     2079# generates you can specify the font name using DOT_FONTNAME. You need to make
     2080# sure dot is able to find the font, which can be done by putting it in a
     2081# standard location or by setting the DOTFONTPATH environment variable or by
     2082# setting DOT_FONTPATH to the directory containing the font.
     2083# The default value is: Helvetica.
     2084# This tag requires that the tag HAVE_DOT is set to YES.
     2085
     2086#DOT_FONTNAME           = FreeSans
     2087
     2088# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
     2089# dot graphs.
     2090# Minimum value: 4, maximum value: 24, default value: 10.
     2091# This tag requires that the tag HAVE_DOT is set to YES.
    13742092
    13752093DOT_FONTSIZE           = 10
    13762094
    1377 # By default doxygen will tell dot to use the output directory to look for the
    1378 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
    1379 # different font using DOT_FONTNAME you can set the path where dot
    1380 # can find it using this tag.
    1381 
    1382 DOT_FONTPATH           =
    1383 
    1384 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1385 # will generate a graph for each documented class showing the direct and
    1386 # indirect inheritance relations. Setting this tag to YES will force the
    1387 # the CLASS_DIAGRAMS tag to NO.
     2095# By default doxygen will tell dot to use the default font as specified with
     2096# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
     2097# the path where dot can find it using this tag.
     2098# This tag requires that the tag HAVE_DOT is set to YES.
     2099
     2100DOT_FONTPATH           =
     2101
     2102# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
     2103# each documented class showing the direct and indirect inheritance relations.
     2104# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
     2105# The default value is: YES.
     2106# This tag requires that the tag HAVE_DOT is set to YES.
    13882107
    13892108CLASS_GRAPH            = YES
    13902109
    1391 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1392 # will generate a graph for each documented class showing the direct and
    1393 # indirect implementation dependencies (inheritance, containment, and
    1394 # class references variables) of the class with other documented classes.
     2110# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
     2111# graph for each documented class showing the direct and indirect implementation
     2112# dependencies (inheritance, containment, and class references variables) of the
     2113# class with other documented classes.
     2114# The default value is: YES.
     2115# This tag requires that the tag HAVE_DOT is set to YES.
    13952116
    13962117COLLABORATION_GRAPH    = YES
    13972118
    1398 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    1399 # will generate a graph for groups, showing the direct groups dependencies
     2119# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
     2120# groups, showing the direct groups dependencies.
     2121# The default value is: YES.
     2122# This tag requires that the tag HAVE_DOT is set to YES.
    14002123
    14012124GROUP_GRAPHS           = YES
    14022125
    1403 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
    1404 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
     2126# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     2127# collaboration diagrams in a style similar to the OMG's Unified Modeling
    14052128# Language.
     2129# The default value is: NO.
     2130# This tag requires that the tag HAVE_DOT is set to YES.
    14062131
    14072132UML_LOOK               = NO
    14082133
    1409 # If set to YES, the inheritance and collaboration graphs will show the
    1410 # relations between templates and their instances.
     2134# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
     2135# class node. If there are many fields or methods and many nodes the graph may
     2136# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
     2137# number of items for each type to make the size more manageable. Set this to 0
     2138# for no limit. Note that the threshold may be exceeded by 50% before the limit
     2139# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
     2140# but if the number exceeds 15, the total amount of fields shown is limited to
     2141# 10.
     2142# Minimum value: 0, maximum value: 100, default value: 10.
     2143# This tag requires that the tag HAVE_DOT is set to YES.
     2144
     2145UML_LIMIT_NUM_FIELDS   = 10
     2146
     2147# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
     2148# collaboration graphs will show the relations between templates and their
     2149# instances.
     2150# The default value is: NO.
     2151# This tag requires that the tag HAVE_DOT is set to YES.
    14112152
    14122153TEMPLATE_RELATIONS     = YES
    14132154
    1414 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    1415 # tags are set to YES then doxygen will generate a graph for each documented
    1416 # file showing the direct and indirect include dependencies of the file with
    1417 # other documented files.
     2155# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
     2156# YES then doxygen will generate a graph for each documented file showing the
     2157# direct and indirect include dependencies of the file with other documented
     2158# files.
     2159# The default value is: YES.
     2160# This tag requires that the tag HAVE_DOT is set to YES.
    14182161
    14192162INCLUDE_GRAPH          = YES
    14202163
    1421 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    1422 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    1423 # documented header file showing the documented files that directly or
    1424 # indirectly include this file.
     2164# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
     2165# set to YES then doxygen will generate a graph for each documented file showing
     2166# the direct and indirect include dependencies of the file with other documented
     2167# files.
     2168# The default value is: YES.
     2169# This tag requires that the tag HAVE_DOT is set to YES.
    14252170
    14262171INCLUDED_BY_GRAPH      = YES
    14272172
    1428 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    1429 # doxygen will generate a call dependency graph for every global function
    1430 # or class method. Note that enabling this option will significantly increase
    1431 # the time of a run. So in most cases it will be better to enable call graphs
    1432 # for selected functions only using the \callgraph command.
     2173# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
     2174# dependency graph for every global function or class method.
     2175#
     2176# Note that enabling this option will significantly increase the time of a run.
     2177# So in most cases it will be better to enable call graphs for selected
     2178# functions only using the \callgraph command.
     2179# The default value is: NO.
     2180# This tag requires that the tag HAVE_DOT is set to YES.
    14332181
    14342182CALL_GRAPH             = NO
    14352183
    1436 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    1437 # doxygen will generate a caller dependency graph for every global function
    1438 # or class method. Note that enabling this option will significantly increase
    1439 # the time of a run. So in most cases it will be better to enable caller
    1440 # graphs for selected functions only using the \callergraph command.
     2184# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
     2185# dependency graph for every global function or class method.
     2186#
     2187# Note that enabling this option will significantly increase the time of a run.
     2188# So in most cases it will be better to enable caller graphs for selected
     2189# functions only using the \callergraph command.
     2190# The default value is: NO.
     2191# This tag requires that the tag HAVE_DOT is set to YES.
    14412192
    14422193CALLER_GRAPH           = NO
    14432194
    1444 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1445 # will graphical hierarchy of all classes instead of a textual one.
     2195# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
     2196# hierarchy of all classes instead of a textual one.
     2197# The default value is: YES.
     2198# This tag requires that the tag HAVE_DOT is set to YES.
    14462199
    14472200GRAPHICAL_HIERARCHY    = YES
    14482201
    1449 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    1450 # then doxygen will show the dependencies a directory has on other directories
    1451 # in a graphical way. The dependency relations are determined by the #include
    1452 # relations between the files in the directories.
     2202# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
     2203# dependencies a directory has on other directories in a graphical way. The
     2204# dependency relations are determined by the #include relations between the
     2205# files in the directories.
     2206# The default value is: YES.
     2207# This tag requires that the tag HAVE_DOT is set to YES.
    14532208
    14542209DIRECTORY_GRAPH        = YES
    14552210
    1456 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1457 # generated by dot. Possible values are png, jpg, or gif
    1458 # If left blank png will be used.
     2211# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     2212# generated by dot.
     2213# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
     2214# to make the SVG files visible in IE 9+ (other browsers do not have this
     2215# requirement).
     2216# Possible values are: png, jpg, gif and svg.
     2217# The default value is: png.
     2218# This tag requires that the tag HAVE_DOT is set to YES.
    14592219
    14602220DOT_IMAGE_FORMAT       = png
    14612221
    1462 # The tag DOT_PATH can be used to specify the path where the dot tool can be
     2222# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
     2223# enable generation of interactive SVG images that allow zooming and panning.
     2224#
     2225# Note that this requires a modern browser other than Internet Explorer. Tested
     2226# and working are Firefox, Chrome, Safari, and Opera.
     2227# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
     2228# the SVG files visible. Older versions of IE do not have SVG support.
     2229# The default value is: NO.
     2230# This tag requires that the tag HAVE_DOT is set to YES.
     2231
     2232INTERACTIVE_SVG        = NO
     2233
     2234# The DOT_PATH tag can be used to specify the path where the dot tool can be
    14632235# found. If left blank, it is assumed the dot tool can be found in the path.
    1464 
    1465 DOT_PATH               =
    1466 
    1467 # The DOTFILE_DIRS tag can be used to specify one or more directories that
    1468 # contain dot files that are included in the documentation (see the
    1469 # \dotfile command).
     2236# This tag requires that the tag HAVE_DOT is set to YES.
     2237
     2238DOT_PATH               =
     2239
     2240# The DOTFILE_DIRS tag can be used to specify one or more directories that
     2241# contain dot files that are included in the documentation (see the \dotfile
     2242# command).
     2243# This tag requires that the tag HAVE_DOT is set to YES.
    14702244
    14712245DOTFILE_DIRS           = .
    14722246
    1473 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1474 # nodes that will be shown in the graph. If the number of nodes in a graph
    1475 # becomes larger than this value, doxygen will truncate the graph, which is
    1476 # visualized by representing a node as a red box. Note that doxygen if the
    1477 # number of direct children of the root node in a graph is already larger than
    1478 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    1479 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2247# The MSCFILE_DIRS tag can be used to specify one or more directories that
     2248# contain msc files that are included in the documentation (see the \mscfile
     2249# command).
     2250
     2251MSCFILE_DIRS           =
     2252
     2253# The DIAFILE_DIRS tag can be used to specify one or more directories that
     2254# contain dia files that are included in the documentation (see the \diafile
     2255# command).
     2256
     2257DIAFILE_DIRS           =
     2258
     2259# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
     2260# that will be shown in the graph. If the number of nodes in a graph becomes
     2261# larger than this value, doxygen will truncate the graph, which is visualized
     2262# by representing a node as a red box. Note that doxygen if the number of direct
     2263# children of the root node in a graph is already larger than
     2264# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
     2265# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2266# Minimum value: 0, maximum value: 10000, default value: 50.
     2267# This tag requires that the tag HAVE_DOT is set to YES.
    14802268
    14812269DOT_GRAPH_MAX_NODES    = 50
    14822270
    1483 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1484 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1485 # from the root by following a path via at most 3 edges will be shown. Nodes
    1486 # that lay further from the root node will be omitted. Note that setting this
    1487 # option to 1 or 2 may greatly reduce the computation time needed for large
    1488 # code bases. Also note that the size of a graph can be further restricted by
     2271# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
     2272# generated by dot. A depth value of 3 means that only nodes reachable from the
     2273# root by following a path via at most 3 edges will be shown. Nodes that lay
     2274# further from the root node will be omitted. Note that setting this option to 1
     2275# or 2 may greatly reduce the computation time needed for large code bases. Also
     2276# note that the size of a graph can be further restricted by
    14892277# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
     2278# Minimum value: 0, maximum value: 1000, default value: 0.
     2279# This tag requires that the tag HAVE_DOT is set to YES.
    14902280
    14912281MAX_DOT_GRAPH_DEPTH    = 0
    14922282
    1493 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1494 # background. This is disabled by default, because dot on Windows does not
    1495 # seem to support this out of the box. Warning: Depending on the platform used,
    1496 # enabling this option may lead to badly anti-aliased labels on the edges of
    1497 # a graph (i.e. they become hard to read).
     2283# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     2284# background. This is disabled by default, because dot on Windows does not seem
     2285# to support this out of the box.
     2286#
     2287# Warning: Depending on the platform used, enabling this option may lead to
     2288# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     2289# read).
     2290# The default value is: NO.
     2291# This tag requires that the tag HAVE_DOT is set to YES.
    14982292
    14992293DOT_TRANSPARENT        = NO
    15002294
    1501 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    1502 # files in one run (i.e. multiple -o and -T options on the command line). This
    1503 # makes dot run faster, but since only newer versions of dot (>1.8.10)
    1504 # support this, this feature is disabled by default.
     2295# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     2296# files in one run (i.e. multiple -o and -T options on the command line). This
     2297# makes dot run faster, but since only newer versions of dot (>1.8.10) support
     2298# this, this feature is disabled by default.
     2299# The default value is: NO.
     2300# This tag requires that the tag HAVE_DOT is set to YES.
    15052301
    15062302DOT_MULTI_TARGETS      = NO
    15072303
    1508 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1509 # generate a legend page explaining the meaning of the various boxes and
    1510 # arrows in the dot generated graphs.
     2304# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
     2305# explaining the meaning of the various boxes and arrows in the dot generated
     2306# graphs.
     2307# The default value is: YES.
     2308# This tag requires that the tag HAVE_DOT is set to YES.
    15112309
    15122310GENERATE_LEGEND        = YES
    15132311
    1514 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    1515 # remove the intermediate dot files that are used to generate
    1516 # the various graphs.
     2312# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
     2313# files that are used to generate the various graphs.
     2314# The default value is: YES.
     2315# This tag requires that the tag HAVE_DOT is set to YES.
    15172316
    15182317DOT_CLEANUP            = YES
    1519 
    1520 #---------------------------------------------------------------------------
    1521 # Options related to the search engine
    1522 #---------------------------------------------------------------------------
    1523 
    1524 # The SEARCHENGINE tag specifies whether or not a search engine should be
    1525 # used. If set to NO the values of all tags below this one will be ignored.
    1526 
    1527 SEARCHENGINE           = NO
Note: See TracChangeset for help on using the changeset viewer.