Changeset 8ddc7cd in git


Ignore:
Timestamp:
Jun 11, 2014, 6:02:16 PM (10 years ago)
Author:
Oleksandr Motsak <http://goo.gl/mcpzY>
Branches:
(u'fieker-DuVal', '117eb8c30fc9e991c4decca4832b1d19036c4c65')(u'spielwiese', '648d28f488f6ff08f5607ff229b9ad9e4a5b93c2')
Children:
8d5f057ba3ed745d85c4c290cc1e6209eccc20a1
Parents:
39d047ba9c30b974b3b6e5519be71627f12990a4
git-author:
Oleksandr Motsak <http://goo.gl/mcpzY>2014-06-11 18:02:16+02:00
git-committer:
Oleksandr Motsak <http://goo.gl/mcpzY>2014-06-11 18:03:03+02:00
Message:
Fixed Doxygen config
Location:
dox
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • dox/Doxyfile.html.all

    r39d047b r8ddc7cd  
    1 # This is the Doxygen (1.5.9) configuration for HTML with plenty of png graphs
    2 # Doxyfile 1.5.9
    3 
     1# Doxyfile 1.8.7
    42
    53# This file describes the settings to be used by the documentation system
    6 # doxygen (www.doxygen.org) for a project
    7 #
    8 # 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.
    910# The format is:
    10 #       TAG = value [value, ...]
    11 # For lists items can also be appended using:
    12 #       TAG += value [value, ...]
    13 # 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 (\" \").
    1415
    1516#---------------------------------------------------------------------------
     
    1718#---------------------------------------------------------------------------
    1819
    19 # This tag specifies the encoding used for all characters in the config file
    20 # that follow. The default is UTF-8 which is also the encoding used for all
    21 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
    22 # iconv built into libc) for the transcoding. See
    23 # 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.
    2426
    2527DOXYFILE_ENCODING      = UTF-8
    2628
    27 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    28 # 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.
    2934
    3035PROJECT_NAME           = Singular
    3136
    32 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
    33 # This could be handy for archiving the generated documentation or
    34 # 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.
    3540
    3641PROJECT_NUMBER         = $VERSION$
    3742
    38 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    39 # base path where the generated documentation will be put.
    40 # If a relative path is entered, it will be relative to the location
    41 # where doxygen was started. If left blank the current directory will be used.
    42 
    43 OUTPUT_DIRECTORY       =
    44 
    45 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
    46 # 4096 sub-directories (in 2 levels) under the output directory of each output
    47 # format and will distribute the generated files over these directories.
    48 # Enabling this option can be useful when feeding doxygen a huge amount of
    49 # source files, where putting all generated files in the same directory would
    50 # otherwise cause performance problems for the file system.
     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.
     60
     61OUTPUT_DIRECTORY       =
     62
     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.
    5170
    5271CREATE_SUBDIRS         = YES
    5372
    54 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    55 # documentation generated by doxygen is written. Doxygen will use this
    56 # information to generate all constant output in the proper language.
    57 # The default language is English, other supported languages are:
    58 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    59 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
    60 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
    61 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
    62 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
    63 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
     73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
     74# characters to appear in the names of generated files. If set to NO, non-ASCII
     75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
     76# U+3044.
     77# The default value is: NO.
     78
     79ALLOW_UNICODE_NAMES    = NO
     80
     81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     82# documentation generated by doxygen is written. Doxygen will use this
     83# information to generate all constant output in the proper language.
     84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
     85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
     86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
     87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
     88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
     89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
     90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
     91# Ukrainian and Vietnamese.
     92# The default value is: English.
    6493
    6594OUTPUT_LANGUAGE        = English
    6695
    67 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    68 # include brief member descriptions after the members that are listed in
    69 # the file and class documentation (similar to JavaDoc).
    70 # Set to NO to disable this.
     96# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
     97# descriptions after the members that are listed in the file and class
     98# documentation (similar to Javadoc). Set to NO to disable this.
     99# The default value is: YES.
    71100
    72101BRIEF_MEMBER_DESC      = YES
    73102
    74 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
    75 # the brief description of a member or function before the detailed description.
    76 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
     103# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
     104# description of a member or function before the detailed description
     105#
     106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    77107# brief descriptions will be completely suppressed.
     108# The default value is: YES.
    78109
    79110REPEAT_BRIEF           = YES
    80111
    81 # This tag implements a quasi-intelligent brief description abbreviator
    82 # that is used to form the text in various listings. Each string
    83 # in this list, if found as the leading text of the brief description, will be
    84 # stripped from the text and the result after processing the whole list, is
    85 # used as the annotated text. Otherwise, the brief description is used as-is.
    86 # If left blank, the following values are used ("$name" is automatically
    87 # replaced with the name of the entity): "The $name class" "The $name widget"
    88 # "The $name file" "is" "provides" "specifies" "contains"
    89 # "represents" "a" "an" "the"
    90 
    91 ABBREVIATE_BRIEF       = "The $name class"  "The $name widget"  "The $name file" \
    92                          is provides  specifies  contains   represents a an the
    93 
    94 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    95 # Doxygen will generate a detailed section even if there is only a brief
     112# This tag implements a quasi-intelligent brief description abbreviator that is
     113# used to form the text in various listings. Each string in this list, if found
     114# as the leading text of the brief description, will be stripped from the text
     115# and the result, after processing the whole list, is used as the annotated
     116# text. Otherwise, the brief description is used as-is. If left blank, the
     117# following values are used ($name is automatically replaced with the name of
     118# the entity):The $name class, The $name widget, The $name file, is, provides,
     119# specifies, contains, represents, a, an and the.
     120
     121ABBREVIATE_BRIEF       = "The $name class" \
     122                         "The $name widget" \
     123                         "The $name file" \
     124                         is \
     125                         provides \
     126                         specifies \
     127                         contains \
     128                         represents \
     129                         a \
     130                         an \
     131                         the
     132
     133# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     134# doxygen will generate a detailed section even if there is only a brief
    96135# description.
     136# The default value is: NO.
    97137
    98138ALWAYS_DETAILED_SEC    = NO
    99139
    100 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    101 # inherited members of a class in the documentation of that class as if those 
    102 # members were ordinary class members. Constructors, destructors and assignment 
     140# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     141# inherited members of a class in the documentation of that class as if those
     142# members were ordinary class members. Constructors, destructors and assignment
    103143# operators of the base classes will not be shown.
     144# The default value is: NO.
    104145
    105146INLINE_INHERITED_MEMB  = NO
    106147
    107 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
    108 # path before files name in the file list and in the header files. If set
    109 # to NO the shortest path that makes the file name unique will be used.
     148# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
     149# before files name in the file list and in the header files. If set to NO the
     150# shortest path that makes the file name unique will be used
     151# The default value is: YES.
    110152
    111153FULL_PATH_NAMES        = YES
    112154
    113 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    114 # can be used to strip a user-defined part of the path. Stripping is
    115 # only done if one of the specified strings matches the left-hand part of
    116 # the path. The tag can be used to show relative paths in the file list.
    117 # If left blank the directory from which doxygen is run is used as the
    118 # path to strip.
     155# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
     156# Stripping is only done if one of the specified strings matches the left-hand
     157# part of the path. The tag can be used to show relative paths in the file list.
     158# If left blank the directory from which doxygen is run is used as the path to
     159# strip.
     160#
     161# Note that you can specify absolute paths here, but also relative paths, which
     162# will be relative from the directory where doxygen is started.
     163# This tag requires that the tag FULL_PATH_NAMES is set to YES.
    119164
    120165STRIP_FROM_PATH        = ..
    121166
    122 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
    123 # the path mentioned in the documentation of a class, which tells
    124 # the reader which header file to include in order to use a class.
    125 # If left blank only the name of the header file containing the class
    126 # definition is used. Otherwise one should specify the include paths that
    127 # are normally passed to the compiler using the -I flag.
    128 
    129 STRIP_FROM_INC_PATH    =
    130 
    131 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    132 # (but less readable) file names. This can be useful is your file systems
    133 # doesn't support long names like on DOS, Mac, or CD-ROM.
     167# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
     168# path mentioned in the documentation of a class, which tells the reader which
     169# header file to include in order to use a class. If left blank only the name of
     170# the header file containing the class definition is used. Otherwise one should
     171# specify the list of include paths that are normally passed to the compiler
     172# using the -I flag.
     173
     174STRIP_FROM_INC_PATH    =
     175
     176# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
     177# less readable) file names. This can be useful is your file systems doesn't
     178# support long names like on DOS, Mac, or CD-ROM.
     179# The default value is: NO.
    134180
    135181SHORT_NAMES            = NO
    136182
    137 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
    138 # will interpret the first line (until the first dot) of a JavaDoc-style
    139 # comment as the brief description. If set to NO, the JavaDoc
    140 # comments will behave just like regular Qt-style comments
    141 # (thus requiring an explicit @brief command for a brief description.)
     183# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
     184# first line (until the first dot) of a Javadoc-style comment as the brief
     185# description. If set to NO, the Javadoc-style will behave just like regular Qt-
     186# style comments (thus requiring an explicit @brief command for a brief
     187# description.)
     188# The default value is: NO.
    142189
    143190JAVADOC_AUTOBRIEF      = NO
    144191
    145 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
    146 # interpret the first line (until the first dot) of a Qt-style
    147 # comment as the brief description. If set to NO, the comments
    148 # will behave just like regular Qt-style comments (thus requiring
    149 # an explicit \brief command for a brief description.)
     192# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
     193# line (until the first dot) of a Qt-style comment as the brief description. If
     194# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
     195# requiring an explicit \brief command for a brief description.)
     196# The default value is: NO.
    150197
    151198QT_AUTOBRIEF           = NO
    152199
    153 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    154 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    155 # comments) as a brief description. This used to be the default behaviour.
    156 # The new default is to treat a multi-line C++ comment block as a detailed
    157 # description. Set this tag to YES if you prefer the old behaviour instead.
     200# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
     201# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
     202# a brief description. This used to be the default behavior. The new default is
     203# to treat a multi-line C++ comment block as a detailed description. Set this
     204# tag to YES if you prefer the old behavior instead.
     205#
     206# Note that setting this tag to YES also means that rational rose comments are
     207# not recognized any more.
     208# The default value is: NO.
    158209
    159210MULTILINE_CPP_IS_BRIEF = NO
    160211
    161 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    162 # member inherits the documentation from any documented member that it
    163 # re-implements.
     212# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
     213# documentation from any documented member that it re-implements.
     214# The default value is: YES.
    164215
    165216INHERIT_DOCS           = YES
    166217
    167 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
    168 # a new page for each member. If set to NO, the documentation of a member will
    169 # be part of the file/class/namespace that contains it.
     218# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
     219# new page for each member. If set to NO, the documentation of a member will be
     220# part of the file/class/namespace that contains it.
     221# The default value is: NO.
    170222
    171223SEPARATE_MEMBER_PAGES  = YES
    172224
    173 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    174 # Doxygen uses this value to replace tabs by spaces in code fragments.
     225# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
     226# uses this value to replace tabs by spaces in code fragments.
     227# Minimum value: 1, maximum value: 16, default value: 4.
    175228
    176229TAB_SIZE               = 2
    177230
    178 # This tag can be used to specify a number of aliases that acts
    179 # as commands in the documentation. An alias has the form "name=value".
    180 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    181 # put the command \sideeffect (or @sideeffect) in the documentation, which
    182 # will result in a user-defined paragraph with heading "Side Effects:".
    183 # You can put \n's in the value part of an alias to insert newlines.
    184 
    185 ALIASES                =
    186 
    187 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    188 # sources only. Doxygen will then generate output that is more tailored for C.
    189 # For instance, some of the names that are used will be different. The list
    190 # of all members will be omitted, etc.
     231# This tag can be used to specify a number of aliases that act as commands in
     232# the documentation. An alias has the form:
     233# name=value
     234# For example adding
     235# "sideeffect=@par Side Effects:\n"
     236# will allow you to put the command \sideeffect (or @sideeffect) in the
     237# documentation, which will result in a user-defined paragraph with heading
     238# "Side Effects:". You can put \n's in the value part of an alias to insert
     239# newlines.
     240
     241ALIASES                =
     242
     243# This tag can be used to specify a number of word-keyword mappings (TCL only).
     244# A mapping has the form "name=value". For example adding "class=itcl::class"
     245# will allow you to use the command class in the itcl::class meaning.
     246
     247TCL_SUBST              =
     248
     249# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     250# only. Doxygen will then generate output that is more tailored for C. For
     251# instance, some of the names that are used will be different. The list of all
     252# members will be omitted, etc.
     253# The default value is: NO.
    191254
    192255OPTIMIZE_OUTPUT_FOR_C  = YES
    193256
    194 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
    195 # sources only. Doxygen will then generate output that is more tailored for
    196 # Java. For instance, namespaces will be presented as packages, qualified
    197 # scopes will look different, etc.
     257# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
     258# Python sources only. Doxygen will then generate output that is more tailored
     259# for that language. For instance, namespaces will be presented as packages,
     260# qualified scopes will look different, etc.
     261# The default value is: NO.
    198262
    199263OPTIMIZE_OUTPUT_JAVA   = NO
    200264
    201 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
    202 # sources only. Doxygen will then generate output that is more tailored for
    203 # Fortran.
     265# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     266# sources. Doxygen will then generate output that is tailored for Fortran.
     267# The default value is: NO.
    204268
    205269OPTIMIZE_FOR_FORTRAN   = NO
    206270
    207 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
    208 # sources. Doxygen will then generate output that is tailored for
    209 # VHDL.
     271# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     272# sources. Doxygen will then generate output that is tailored for VHDL.
     273# The default value is: NO.
    210274
    211275OPTIMIZE_OUTPUT_VHDL   = NO
    212276
    213 # Doxygen selects the parser to use depending on the extension of the files it parses.
    214 # With this tag you can assign which parser to use for a given extension.
    215 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
    216 # The format is ext=language, where ext is a file extension, and language is one of
    217 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
    218 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
    219 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
    220 # 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.
    221 
    222 EXTENSION_MAPPING      =
    223 
    224 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    225 # to include (a tag file for) the STL sources as input, then you should
    226 # set this tag to YES in order to let doxygen match functions declarations and
    227 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    228 # func(std::string) {}). This also make the inheritance and collaboration
     277# Doxygen selects the parser to use depending on the extension of the files it
     278# parses. With this tag you can assign which parser to use for a given
     279# extension. Doxygen has a built-in mapping, but you can override or extend it
     280# using this tag. The format is ext=language, where ext is a file extension, and
     281# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
     282# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
     283# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
     284# Fortran. In the later case the parser tries to guess whether the code is fixed
     285# or free formatted code, this is the default for Fortran type files), VHDL. For
     286# instance to make doxygen treat .inc files as Fortran files (default is PHP),
     287# and .f files as C (default is Fortran), use: inc=Fortran f=C.
     288#
     289# Note For files without extension you can use no_extension as a placeholder.
     290#
     291# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
     292# the files are not read by doxygen.
     293
     294EXTENSION_MAPPING      =
     295
     296# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
     297# according to the Markdown format, which allows for more readable
     298# documentation. See http://daringfireball.net/projects/markdown/ for details.
     299# The output of markdown processing is further processed by doxygen, so you can
     300# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
     301# case of backward compatibilities issues.
     302# The default value is: YES.
     303
     304MARKDOWN_SUPPORT       = YES
     305
     306# When enabled doxygen tries to link words that correspond to documented
     307# classes, or namespaces to their corresponding documentation. Such a link can
     308# be prevented in individual cases by by putting a % sign in front of the word
     309# or globally by setting AUTOLINK_SUPPORT to NO.
     310# The default value is: YES.
     311
     312AUTOLINK_SUPPORT       = YES
     313
     314# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     315# to include (a tag file for) the STL sources as input, then you should set this
     316# tag to YES in order to let doxygen match functions declarations and
     317# definitions whose arguments contain STL classes (e.g. func(std::string);
     318# versus func(std::string) {}). This also make the inheritance and collaboration
    229319# diagrams that involve STL classes more complete and accurate.
     320# The default value is: NO.
    230321
    231322BUILTIN_STL_SUPPORT    = YES
    232323
    233 # If you use Microsoft's C++/CLI language, you should set this option to YES to 
     324# If you use Microsoft's C++/CLI language, you should set this option to YES to
    234325# enable parsing support.
     326# The default value is: NO.
    235327
    236328CPP_CLI_SUPPORT        = NO
    237329
    238 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
    239 # Doxygen will parse them like normal C++ but will assume all classes use public
    240 # instead of private inheritance when no explicit protection keyword is present.
     330# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
     331# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
     332# will parse them like normal C++ but will assume all classes use public instead
     333# of private inheritance when no explicit protection keyword is present.
     334# The default value is: NO.
    241335
    242336SIP_SUPPORT            = NO
    243337
    244 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    245 # and setter methods for a property. Setting this option to YES (the default)
    246 # will make doxygen to replace the get and set methods by a property in the
    247 # documentation. This will only work if the methods are indeed getting or
    248 # setting a simple type. If this is not the case, or you want to show the
    249 # methods anyway, you should set this option to NO.
     338# For Microsoft's IDL there are propget and propput attributes to indicate
     339# getter and setter methods for a property. Setting this option to YES will make
     340# doxygen to replace the get and set methods by a property in the documentation.
     341# This will only work if the methods are indeed getting or setting a simple
     342# type. If this is not the case, or you want to show the methods anyway, you
     343# should set this option to NO.
     344# The default value is: YES.
    250345
    251346IDL_PROPERTY_SUPPORT   = NO
    252347
    253 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
    254 # tag is set to YES, then doxygen will reuse the documentation of the first 
    255 # member in the group (if any) for the other members of the group. By default 
     348# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     349# tag is set to YES, then doxygen will reuse the documentation of the first
     350# member in the group (if any) for the other members of the group. By default
    256351# all members of a group must be documented explicitly.
     352# The default value is: NO.
    257353
    258354DISTRIBUTE_GROUP_DOC   = YES
    259355
    260 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    261 # the same type (for instance a group of public functions) to be put as a
    262 # subgroup of that type (e.g. under the Public Functions section). Set it to
    263 # NO to prevent subgrouping. Alternatively, this can be done per class using
    264 # the \nosubgrouping command.
     356# Set the SUBGROUPING tag to YES to allow class member groups of the same type
     357# (for instance a group of public functions) to be put as a subgroup of that
     358# type (e.g. under the Public Functions section). Set it to NO to prevent
     359# subgrouping. Alternatively, this can be done per class using the
     360# \nosubgrouping command.
     361# The default value is: YES.
    265362
    266363SUBGROUPING            = YES
    267364
    268 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    269 # is documented as struct, union, or enum with the name of the typedef. So
    270 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    271 # with name TypeT. When disabled the typedef will appear as a member of a file,
    272 # namespace, or class. And the struct will be named TypeS. This can typically
    273 # be useful for C code in case the coding convention dictates that all compound
     365# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
     366# are shown inside the group in which they are included (e.g. using \ingroup)
     367# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
     368# and RTF).
     369#
     370# Note that this feature does not work in combination with
     371# SEPARATE_MEMBER_PAGES.
     372# The default value is: NO.
     373
     374INLINE_GROUPED_CLASSES = NO
     375
     376# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
     377# with only public data fields or simple typedef fields will be shown inline in
     378# the documentation of the scope in which they are defined (i.e. file,
     379# namespace, or group documentation), provided this scope is documented. If set
     380# to NO, structs, classes, and unions are shown on a separate page (for HTML and
     381# Man pages) or section (for LaTeX and RTF).
     382# The default value is: NO.
     383
     384INLINE_SIMPLE_STRUCTS  = NO
     385
     386# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
     387# enum is documented as struct, union, or enum with the name of the typedef. So
     388# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     389# with name TypeT. When disabled the typedef will appear as a member of a file,
     390# namespace, or class. And the struct will be named TypeS. This can typically be
     391# useful for C code in case the coding convention dictates that all compound
    274392# types are typedef'ed and only the typedef is referenced, never the tag name.
     393# The default value is: NO.
    275394
    276395TYPEDEF_HIDES_STRUCT   = NO
    277396
    278 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
    279 # determine which symbols to keep in memory and which to flush to disk.
    280 # When the cache is full, less often used symbols will be written to disk.
    281 # For small to medium size projects (<1000 input files) the default value is
    282 # probably good enough. For larger projects a too small cache size can cause
    283 # doxygen to be busy swapping symbols to and from disk most of the time
    284 # causing a significant performance penality.
    285 # If the system has enough physical memory increasing the cache will improve the
    286 # performance by keeping more symbols in memory. Note that the value works on
    287 # a logarithmic scale so increasing the size by one will rougly double the
    288 # memory usage. The cache size is given by this formula:
    289 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    290 # corresponding to a cache size of 2^16 = 65536 symbols
    291 
    292 SYMBOL_CACHE_SIZE      = 0
     397# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
     398# cache is used to resolve symbols given their name and scope. Since this can be
     399# an expensive process and often the same symbol appears multiple times in the
     400# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
     401# doxygen will become slower. If the cache is too large, memory is wasted. The
     402# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
     403# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
     404# symbols. At the end of a run doxygen will report the cache usage and suggest
     405# the optimal cache size from a speed point of view.
     406# Minimum value: 0, maximum value: 9, default value: 0.
     407
     408LOOKUP_CACHE_SIZE      = 0
    293409
    294410#---------------------------------------------------------------------------
     
    296412#---------------------------------------------------------------------------
    297413
    298 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    299 # documentation are documented, even if no documentation was available.
    300 # Private class members and static file members will be hidden unless
    301 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     414# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     415# documentation are documented, even if no documentation was available. Private
     416# class members and static file members will be hidden unless the
     417# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
     418# Note: This will also disable the warnings about undocumented members that are
     419# normally produced when WARNINGS is set to YES.
     420# The default value is: NO.
    302421
    303422EXTRACT_ALL            = YES
    304423
    305 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    306 # will be included in the documentation.
     424# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
     425# be included in the documentation.
     426# The default value is: NO.
    307427
    308428EXTRACT_PRIVATE        = YES
    309429
    310 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    311 # will be included in the documentation.
     430# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
     431# scope will be included in the documentation.
     432# The default value is: NO.
     433
     434EXTRACT_PACKAGE        = NO
     435
     436# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
     437# included in the documentation.
     438# The default value is: NO.
    312439
    313440EXTRACT_STATIC         = YES
    314441
    315 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    316 # defined locally in source files will be included in the documentation.
    317 # If set to NO only classes defined in header files are included.
     442# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
     443# locally in source files will be included in the documentation. If set to NO
     444# only classes defined in header files are included. Does not have any effect
     445# for Java sources.
     446# The default value is: YES.
    318447
    319448EXTRACT_LOCAL_CLASSES  = YES
    320449
    321 # This flag is only useful for Objective-C code. When set to YES local
    322 # methods, which are defined in the implementation section but not in
    323 # the interface are included in the documentation.
    324 # If set to NO (the default) only methods in the interface are included.
     450# This flag is only useful for Objective-C code. When set to YES local methods,
     451# which are defined in the implementation section but not in the interface are
     452# included in the documentation. If set to NO only methods in the interface are
     453# included.
     454# The default value is: NO.
    325455
    326456EXTRACT_LOCAL_METHODS  = YES
    327457
    328 # If this flag is set to YES, the members of anonymous namespaces will be
    329 # extracted and appear in the documentation as a namespace called
    330 # 'anonymous_namespace{file}', where file will be replaced with the base
    331 # name of the file that contains the anonymous namespace. By default
    332 # anonymous namespace are hidden.
     458# If this flag is set to YES, the members of anonymous namespaces will be
     459# extracted and appear in the documentation as a namespace called
     460# 'anonymous_namespace{file}', where file will be replaced with the base name of
     461# the file that contains the anonymous namespace. By default anonymous namespace
     462# are hidden.
     463# The default value is: NO.
    333464
    334465EXTRACT_ANON_NSPACES   = YES
    335466
    336 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    337 # undocumented members of documented classes, files or namespaces.
    338 # If set to NO (the default) these members will be included in the
    339 # various overviews, but no documentation section is generated.
    340 # This option has no effect if EXTRACT_ALL is enabled.
     467# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
     468# undocumented members inside documented classes or files. If set to NO these
     469# members will be included in the various overviews, but no documentation
     470# section is generated. This option has no effect if EXTRACT_ALL is enabled.
     471# The default value is: NO.
    341472
    342473HIDE_UNDOC_MEMBERS     = NO
    343474
    344 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    345 # undocumented classes that are normally visible in the class hierarchy.
    346 # If set to NO (the default) these classes will be included in the various
    347 # overviews. This option has no effect if EXTRACT_ALL is enabled.
     475# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
     476# undocumented classes that are normally visible in the class hierarchy. If set
     477# to NO these classes will be included in the various overviews. This option has
     478# no effect if EXTRACT_ALL is enabled.
     479# The default value is: NO.
    348480
    349481HIDE_UNDOC_CLASSES     = NO
    350482
    351 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    352 # friend (class|struct|union) declarations.
    353 # If set to NO (the default) these declarations will be included in the
     483# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
     484# (class|struct|union) declarations. If set to NO these declarations will be
     485# included in the documentation.
     486# The default value is: NO.
     487
     488HIDE_FRIEND_COMPOUNDS  = NO
     489
     490# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
     491# documentation blocks found inside the body of a function. If set to NO these
     492# blocks will be appended to the function's detailed documentation block.
     493# The default value is: NO.
     494
     495HIDE_IN_BODY_DOCS      = NO
     496
     497# The INTERNAL_DOCS tag determines if documentation that is typed after a
     498# \internal command is included. If the tag is set to NO then the documentation
     499# will be excluded. Set it to YES to include the internal documentation.
     500# The default value is: NO.
     501
     502INTERNAL_DOCS          = YES
     503
     504# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
     505# names in lower-case letters. If set to YES upper-case letters are also
     506# allowed. This is useful if you have classes or files whose names only differ
     507# in case and if your file system supports case sensitive file names. Windows
     508# and Mac users are advised to set this option to NO.
     509# The default value is: system dependent.
     510
     511CASE_SENSE_NAMES       = YES
     512
     513# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
     514# their full class and namespace scopes in the documentation. If set to YES the
     515# scope will be hidden.
     516# The default value is: NO.
     517
     518HIDE_SCOPE_NAMES       = NO
     519
     520# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
     521# the files that are included by a file in the documentation of that file.
     522# The default value is: YES.
     523
     524SHOW_INCLUDE_FILES     = YES
     525
     526# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
     527# grouped member an include statement to the documentation, telling the reader
     528# which file to include in order to use the member.
     529# The default value is: NO.
     530
     531SHOW_GROUPED_MEMB_INC  = NO
     532
     533# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
     534# files with double quotes in the documentation rather than with sharp brackets.
     535# The default value is: NO.
     536
     537FORCE_LOCAL_INCLUDES   = NO
     538
     539# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
     540# documentation for inline members.
     541# The default value is: YES.
     542
     543INLINE_INFO            = YES
     544
     545# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
     546# (detailed) documentation of file and class members alphabetically by member
     547# name. If set to NO the members will appear in declaration order.
     548# The default value is: YES.
     549
     550SORT_MEMBER_DOCS       = YES
     551
     552# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
     553# descriptions of file, namespace and class members alphabetically by member
     554# name. If set to NO the members will appear in declaration order. Note that
     555# this will also influence the order of the classes in the class list.
     556# The default value is: NO.
     557
     558SORT_BRIEF_DOCS        = NO
     559
     560# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
     561# (brief and detailed) documentation of class members so that constructors and
     562# destructors are listed first. If set to NO the constructors will appear in the
     563# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
     564# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
     565# member documentation.
     566# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
     567# detailed member documentation.
     568# The default value is: NO.
     569
     570SORT_MEMBERS_CTORS_1ST = NO
     571
     572# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
     573# of group names into alphabetical order. If set to NO the group names will
     574# appear in their defined order.
     575# The default value is: NO.
     576
     577SORT_GROUP_NAMES       = NO
     578
     579# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
     580# fully-qualified names, including namespaces. If set to NO, the class list will
     581# be sorted only by class name, not including the namespace part.
     582# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     583# Note: This option applies only to the class list, not to the alphabetical
     584# list.
     585# The default value is: NO.
     586
     587SORT_BY_SCOPE_NAME     = NO
     588
     589# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
     590# type resolution of all parameters of a function it will reject a match between
     591# the prototype and the implementation of a member function even if there is
     592# only one candidate or it is obvious which candidate to choose by doing a
     593# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
     594# accept a match between prototype and implementation in such cases.
     595# The default value is: NO.
     596
     597STRICT_PROTO_MATCHING  = NO
     598
     599# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
     600# todo list. This list is created by putting \todo commands in the
    354601# documentation.
    355 
    356 HIDE_FRIEND_COMPOUNDS  = NO
    357 
    358 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    359 # documentation blocks found inside the body of a function.
    360 # If set to NO (the default) these blocks will be appended to the
    361 # function's detailed documentation block.
    362 
    363 HIDE_IN_BODY_DOCS      = NO
    364 
    365 # The INTERNAL_DOCS tag determines if documentation
    366 # that is typed after a \internal command is included. If the tag is set
    367 # to NO (the default) then the documentation will be excluded.
    368 # Set it to YES to include the internal documentation.
    369 
    370 INTERNAL_DOCS          = YES
    371 
    372 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    373 # file names in lower-case letters. If set to YES upper-case letters are also
    374 # allowed. This is useful if you have classes or files whose names only differ
    375 # in case and if your file system supports case sensitive file names. Windows
    376 # and Mac users are advised to set this option to NO.
    377 
    378 CASE_SENSE_NAMES       = YES
    379 
    380 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    381 # will show members with their full class and namespace scopes in the
    382 # documentation. If set to YES the scope will be hidden.
    383 
    384 HIDE_SCOPE_NAMES       = NO
    385 
    386 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    387 # will put a list of the files that are included by a file in the documentation
    388 # of that file.
    389 
    390 SHOW_INCLUDE_FILES     = YES
    391 
    392 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    393 # is inserted in the documentation for inline members.
    394 
    395 INLINE_INFO            = YES
    396 
    397 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    398 # will sort the (detailed) documentation of file and class members
    399 # alphabetically by member name. If set to NO the members will appear in
    400 # declaration order.
    401 
    402 SORT_MEMBER_DOCS       = YES
    403 
    404 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
    405 # brief documentation of file, namespace and class members alphabetically
    406 # by member name. If set to NO (the default) the members will appear in
    407 # declaration order.
    408 
    409 SORT_BRIEF_DOCS        = NO
    410 
    411 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
    412 # hierarchy of group names into alphabetical order. If set to NO (the default)
    413 # the group names will appear in their defined order.
    414 
    415 SORT_GROUP_NAMES       = NO
    416 
    417 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    418 # sorted by fully-qualified names, including namespaces. If set to
    419 # NO (the default), the class list will be sorted only by class name,
    420 # not including the namespace part.
    421 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    422 # Note: This option applies only to the class list, not to the
    423 # alphabetical list.
    424 
    425 SORT_BY_SCOPE_NAME     = NO
    426 
    427 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    428 # disable (NO) the todo list. This list is created by putting \todo
    429 # commands in the documentation.
     602# The default value is: YES.
    430603
    431604GENERATE_TODOLIST      = YES
    432605
    433 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    434 # disable (NO) the test list. This list is created by putting \test
    435 # commands in the documentation.
     606# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
     607# test list. This list is created by putting \test commands in the
     608# documentation.
     609# The default value is: YES.
    436610
    437611GENERATE_TESTLIST      = YES
    438612
    439 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    440 # disable (NO) the bug list. This list is created by putting \bug
    441 # commands in the documentation.
     613# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
     614# list. This list is created by putting \bug commands in the documentation.
     615# The default value is: YES.
    442616
    443617GENERATE_BUGLIST       = YES
    444618
    445 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    446 # disable (NO) the deprecated list. This list is created by putting
    447 # \deprecated commands in the documentation.
     619# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
     620# the deprecated list. This list is created by putting \deprecated commands in
     621# the documentation.
     622# The default value is: YES.
    448623
    449624GENERATE_DEPRECATEDLIST= YES
    450625
    451 # The ENABLED_SECTIONS tag can be used to enable conditional
    452 # documentation sections, marked by \if sectionname ... \endif.
    453 
    454 ENABLED_SECTIONS       =
    455 
    456 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    457 # the initial value of a variable or define consists of for it to appear in
    458 # the documentation. If the initializer consists of more lines than specified
    459 # here it will be hidden. Use a value of 0 to hide initializers completely.
    460 # The appearance of the initializer of individual variables and defines in the
    461 # documentation can be controlled using \showinitializer or \hideinitializer
    462 # command in the documentation regardless of this setting.
     626# The ENABLED_SECTIONS tag can be used to enable conditional documentation
     627# sections, marked by \if <section_label> ... \endif and \cond <section_label>
     628# ... \endcond blocks.
     629
     630ENABLED_SECTIONS       =
     631
     632# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
     633# initial value of a variable or macro / define can have for it to appear in the
     634# documentation. If the initializer consists of more lines than specified here
     635# it will be hidden. Use a value of 0 to hide initializers completely. The
     636# appearance of the value of individual variables and macros / defines can be
     637# controlled using \showinitializer or \hideinitializer command in the
     638# documentation regardless of this setting.
     639# Minimum value: 0, maximum value: 10000, default value: 30.
    463640
    464641MAX_INITIALIZER_LINES  = 40
    465642
    466 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    467 # at the bottom of the documentation of classes and structs. If set to YES the
    468 # list will mention the files that were used to generate the documentation.
     643# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
     644# the bottom of the documentation of classes and structs. If set to YES the list
     645# will mention the files that were used to generate the documentation.
     646# The default value is: YES.
    469647
    470648SHOW_USED_FILES        = YES
    471649
    472 # If the sources in your project are distributed over multiple directories
    473 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    474 # in the documentation. The default is NO.
    475 
    476 SHOW_DIRECTORIES       = YES
    477 
    478 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    479 # This will remove the Files entry from the Quick Index and from the
    480 # Folder Tree View (if specified). The default is YES.
     650# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
     651# will remove the Files entry from the Quick Index and from the Folder Tree View
     652# (if specified).
     653# The default value is: YES.
    481654
    482655SHOW_FILES             = YES
    483656
    484 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    485 # Namespaces page.
    486 # This will remove the Namespaces entry from the Quick Index
    487 # and from the Folder Tree View (if specified). The default is YES.
     657# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
     658# page. This will remove the Namespaces entry from the Quick Index and from the
     659# Folder Tree View (if specified).
     660# The default value is: YES.
    488661
    489662SHOW_NAMESPACES        = YES
    490663
    491 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
    492 # doxygen should invoke to get the current version for each file (typically from
    493 # the version control system). Doxygen will invoke the program by executing (via
    494 # popen()) the command <command> <input-file>, where <command> is the value of
    495 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    496 # provided by doxygen. Whatever the program writes to standard output
    497 # is used as the file version. See the manual for examples.
    498 
    499 FILE_VERSION_FILTER    =
    500 
    501 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
    502 # doxygen. The layout file controls the global structure of the generated output files
    503 # in an output format independent way. The create the layout file that represents
    504 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
    505 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
    506 # of the layout file.
    507 
    508 LAYOUT_FILE            =
    509 
    510 #---------------------------------------------------------------------------
    511 # configuration options related to warning and progress messages
    512 #---------------------------------------------------------------------------
    513 
    514 # The QUIET tag can be used to turn on/off the messages that are generated
    515 # by doxygen. Possible values are YES and NO. If left blank NO is used.
     664# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     665# doxygen should invoke to get the current version for each file (typically from
     666# the version control system). Doxygen will invoke the program by executing (via
     667# popen()) the command command input-file, where command is the value of the
     668# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
     669# by doxygen. Whatever the program writes to standard output is used as the file
     670# version. For an example see the documentation.
     671
     672FILE_VERSION_FILTER    =
     673
     674# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
     675# by doxygen. The layout file controls the global structure of the generated
     676# output files in an output format independent way. To create the layout file
     677# that represents doxygen's defaults, run doxygen with the -l option. You can
     678# optionally specify a file name after the option, if omitted DoxygenLayout.xml
     679# will be used as the name of the layout file.
     680#
     681# Note that if you run doxygen from a directory containing a file called
     682# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
     683# tag is left empty.
     684
     685LAYOUT_FILE            =
     686
     687# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
     688# the reference definitions. This must be a list of .bib files. The .bib
     689# extension is automatically appended if omitted. This requires the bibtex tool
     690# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
     691# For LaTeX the style of the bibliography can be controlled using
     692# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
     693# search path. Do not use file names with spaces, bibtex cannot handle them. See
     694# also \cite for info how to create references.
     695
     696CITE_BIB_FILES         =
     697
     698#---------------------------------------------------------------------------
     699# Configuration options related to warning and progress messages
     700#---------------------------------------------------------------------------
     701
     702# The QUIET tag can be used to turn on/off the messages that are generated to
     703# standard output by doxygen. If QUIET is set to YES this implies that the
     704# messages are off.
     705# The default value is: NO.
    516706
    517707QUIET                  = NO
    518708
    519 # The WARNINGS tag can be used to turn on/off the warning messages that are
    520 # generated by doxygen. Possible values are YES and NO. If left blank
    521 # NO is used.
     709# The WARNINGS tag can be used to turn on/off the warning messages that are
     710# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
     711# this implies that the warnings are on.
     712#
     713# Tip: Turn warnings on while writing the documentation.
     714# The default value is: YES.
    522715
    523716WARNINGS               = YES
    524717
    525 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    526 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    527 # automatically be disabled.
     718# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
     719# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
     720# will automatically be disabled.
     721# The default value is: YES.
    528722
    529723WARN_IF_UNDOCUMENTED   = NO
    530724
    531 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    532 # potential errors in the documentation, such as not documenting some
    533 # parameters in a documented function, or documenting parameters that
    534 # don't exist or using markup commands wrongly.
     725# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
     726# potential errors in the documentation, such as not documenting some parameters
     727# in a documented function, or documenting parameters that don't exist or using
     728# markup commands wrongly.
     729# The default value is: YES.
    535730
    536731WARN_IF_DOC_ERROR      = YES
    537732
    538 # This WARN_NO_PARAMDOC option can be abled to get warnings for
    539 # functions that are documented, but have no documentation for their parameters
    540 # or return value. If set to NO (the default) doxygen will only warn about
    541 # wrong or incomplete parameter documentation, but not about the absence of
    542 # documentation.
     733# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
     734# are documented, but have no documentation for their parameters or return
     735# value. If set to NO doxygen will only warn about wrong or incomplete parameter
     736# documentation, but not about the absence of documentation.
     737# The default value is: NO.
    543738
    544739WARN_NO_PARAMDOC       = NO
    545740
    546 # The WARN_FORMAT tag determines the format of the warning messages that
    547 # doxygen can produce. The string should contain the $file, $line, and $text
    548 # tags, which will be replaced by the file and line number from which the
    549 # warning originated and the warning text. Optionally the format may contain
    550 # $version, which will be replaced by the version of the file (if it could
    551 # be obtained via FILE_VERSION_FILTER)
     741# The WARN_FORMAT tag determines the format of the warning messages that doxygen
     742# can produce. The string should contain the $file, $line, and $text tags, which
     743# will be replaced by the file and line number from which the warning originated
     744# and the warning text. Optionally the format may contain $version, which will
     745# be replaced by the version of the file (if it could be obtained via
     746# FILE_VERSION_FILTER)
     747# The default value is: $file:$line: $text.
    552748
    553749WARN_FORMAT            = "$file:$line: $text "
    554750
    555 # The WARN_LOGFILE tag can be used to specify a file to which warning
    556 # and error messages should be written. If left blank the output is written
    557 # to stderr.
     751# The WARN_LOGFILE tag can be used to specify a file to which warning and error
     752# messages should be written. If left blank the output is written to standard
     753# error (stderr).
    558754
    559755WARN_LOGFILE           = dox.html.log
    560756
    561757#---------------------------------------------------------------------------
    562 # configuration options related to the input files
    563 #---------------------------------------------------------------------------
    564 
    565 # The INPUT tag can be used to specify the files and/or directories that contain
    566 # documented source files. You may enter file names like "myfile.cpp" or
    567 # directories like "/usr/src/myproject". Separate the files or directories
    568 # with spaces.
    569 
    570 INPUT                  =    \
    571                          ../omalloc  ../svd  ../mpr  ../factory ../libfac  ../IntegerProgramming  ../ntl  ../MP \
    572                         ../kernel \
    573                         ../Singular
    574 
    575 
    576 # This tag can be used to specify the character encoding of the source files
    577 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    578 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    579 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    580 # the list of possible encodings.
     758# Configuration options related to the input files
     759#---------------------------------------------------------------------------
     760
     761# The INPUT tag is used to specify the files and/or directories that contain
     762# documented source files. You may enter file names like myfile.cpp or
     763# directories like /usr/src/myproject. Separate the files or directories with
     764# spaces.
     765# Note: If this tag is empty the current directory is searched.
     766
     767INPUT                  = ../omalloc \
     768                         ../svd \
     769                         ../mpr \
     770                         ../factory \
     771                         ../libfac \
     772                         ../IntegerProgramming \
     773                         ../ntl \
     774                         ../MP \
     775                         ../kernel \
     776                         ../Singular
     777
     778# This tag can be used to specify the character encoding of the source files
     779# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
     780# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
     781# documentation (see: http://www.gnu.org/software/libiconv) for the list of
     782# possible encodings.
     783# The default value is: UTF-8.
    581784
    582785INPUT_ENCODING         = UTF-8
    583786
    584 # If the value of the INPUT tag contains directories, you can use the
    585 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    586 # and *.h) to filter out the source-files in the directories. If left
    587 # blank the following patterns are tested:
    588 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
    589 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     787# If the value of the INPUT tag contains directories, you can use the
     788# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
     789# *.h) to filter out the source-files in the directories. If left blank the
     790# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
     791# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
     792# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
     793# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
     794# *.qsf, *.as and *.js.
    590795
    591796FILE_PATTERNS          = *.dox \
    592                          *.h *.hh *.hxx *.hpp *.h++ *.H *.HH *.H++ \
    593                          *.c *.cc *.cxx *.cpp *.c++ *.C *.CC *.C++
    594 
    595 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    596 # should be searched for input files as well. Possible values are YES and NO.
    597 # If left blank NO is used.
     797                         *.h \
     798                         *.hh \
     799                         *.hxx \
     800                         *.hpp \
     801                         *.h++ \
     802                         *.H \
     803                         *.HH \
     804                         *.H++ \
     805                         *.c \
     806                         *.cc \
     807                         *.cxx \
     808                         *.cpp \
     809                         *.c++ \
     810                         *.C \
     811                         *.CC \
     812                         *.C++
     813
     814# The RECURSIVE tag can be used to specify whether or not subdirectories should
     815# be searched for input files as well.
     816# The default value is: NO.
    598817
    599818RECURSIVE              = YES
    600819
    601 # The EXCLUDE tag can be used to specify files and/or directories that should
    602 # excluded from the INPUT source files. This way you can easily exclude a 
     820# The EXCLUDE tag can be used to specify files and/or directories that should be
     821# excluded from the INPUT source files. This way you can easily exclude a
    603822# subdirectory from a directory tree whose root is specified with the INPUT tag.
    604 
    605 
    606 EXCLUDE                = ../doc  ../Tst   ../emacs  ../singular_usr     ../Singular/LIB   ../Singular/Examples ../Singular++ \
     823#
     824# Note that relative paths are relative to the directory from which doxygen is
     825# run.
     826
     827EXCLUDE                = ../doc \
     828                         ../Tst \
     829                         ../emacs \
     830                         ../singular_usr \
     831                         ../Singular/LIB \
     832                         ../Singular/Examples \
     833                         ../Singular++ \
    607834                         CVS
    608835
    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
     836# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
     837# directories that are symbolic links (a Unix file system feature) are excluded
    611838# from the input.
     839# The default value is: NO.
    612840
    613841EXCLUDE_SYMLINKS       = NO
    614842
    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/*
    620 
    621 EXCLUDE_PATTERNS       =
    622 
    623 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    624 # (namespaces, classes, functions, etc.) that should be excluded from the
    625 # output. The symbol name can be a fully qualified name, a word, or if the
    626 # wildcard * is used, a substring. Examples: ANamespace, AClass,
     843# If the value of the INPUT tag contains directories, you can use the
     844# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     845# certain files from those directories.
     846#
     847# Note that the wildcards are matched against the file with absolute path, so to
     848# exclude all test directories for example use the pattern */test/*
     849
     850EXCLUDE_PATTERNS       =
     851
     852# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     853# (namespaces, classes, functions, etc.) that should be excluded from the
     854# output. The symbol name can be a fully qualified name, a word, or if the
     855# wildcard * is used, a substring. Examples: ANamespace, AClass,
    627856# AClass::ANamespace, ANamespace::*Test
    628 
    629 EXCLUDE_SYMBOLS        =
    630 
    631 # The EXAMPLE_PATH tag can be used to specify one or more files or
    632 # directories that contain example code fragments that are included (see
    633 # the \include command).
    634 
    635 EXAMPLE_PATH           =
    636 
    637 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
    638 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    639 # and *.h) to filter out the source-files in the directories. If left
    640 # blank all files are included.
    641 
    642 EXAMPLE_PATTERNS       =
    643 
    644 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
    645 # searched for input files to be used with the \include or \dontinclude
    646 # commands irrespective of the value of the RECURSIVE tag.
    647 # Possible values are YES and NO. If left blank NO is used.
     857#
     858# Note that the wildcards are matched against the file with absolute path, so to
     859# exclude all test directories use the pattern */test/*
     860
     861EXCLUDE_SYMBOLS        =
     862
     863# The EXAMPLE_PATH tag can be used to specify one or more files or directories
     864# that contain example code fragments that are included (see the \include
     865# command).
     866
     867EXAMPLE_PATH           =
     868
     869# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     870# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
     871# *.h) to filter out the source-files in the directories. If left blank all
     872# files are included.
     873
     874EXAMPLE_PATTERNS       =
     875
     876# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     877# searched for input files to be used with the \include or \dontinclude commands
     878# irrespective of the value of the RECURSIVE tag.
     879# The default value is: NO.
    648880
    649881EXAMPLE_RECURSIVE      = NO
    650882
    651 # The IMAGE_PATH tag can be used to specify one or more files or
    652 # directories that contain image that are included in the documentation (see
    653 # the \image command).
    654 
    655 IMAGE_PATH             =
    656 
    657 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    658 # invoke to filter for each input file. Doxygen will invoke the filter program
    659 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    660 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    661 # input file. Doxygen will then use the output that the filter program writes
    662 # to standard output.
    663 # If FILTER_PATTERNS is specified, this tag will be
    664 # ignored.
    665 
    666 INPUT_FILTER           =
    667 
    668 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    669 # basis.
    670 # Doxygen will compare the file name with each pattern and apply the
    671 # filter if there is a match.
    672 # The filters are a list of the form:
    673 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    674 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    675 # is applied to all files.
    676 
    677 FILTER_PATTERNS        =
    678 
    679 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    680 # INPUT_FILTER) will be used to filter the input files when producing source
    681 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
     883# The IMAGE_PATH tag can be used to specify one or more files or directories
     884# that contain images that are to be included in the documentation (see the
     885# \image command).
     886
     887IMAGE_PATH             =
     888
     889# The INPUT_FILTER tag can be used to specify a program that doxygen should
     890# invoke to filter for each input file. Doxygen will invoke the filter program
     891# by executing (via popen()) the command:
     892#
     893# <filter> <input-file>
     894#
     895# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
     896# name of an input file. Doxygen will then use the output that the filter
     897# program writes to standard output. If FILTER_PATTERNS is specified, this tag
     898# will be ignored.
     899#
     900# Note that the filter must not add or remove lines; it is applied before the
     901# code is scanned, but not when the output code is generated. If lines are added
     902# or removed, the anchors will not be placed correctly.
     903
     904INPUT_FILTER           =
     905
     906# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     907# basis. Doxygen will compare the file name with each pattern and apply the
     908# filter if there is a match. The filters are a list of the form: pattern=filter
     909# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
     910# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
     911# patterns match the file name, INPUT_FILTER is applied.
     912
     913FILTER_PATTERNS        =
     914
     915# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     916# INPUT_FILTER ) will also be used to filter the input files that are used for
     917# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
     918# The default value is: NO.
    682919
    683920FILTER_SOURCE_FILES    = NO
    684921
    685 #---------------------------------------------------------------------------
    686 # configuration options related to source browsing
    687 #---------------------------------------------------------------------------
    688 
    689 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    690 # be generated. Documented entities will be cross-referenced with these sources.
    691 # Note: To get rid of all source code in the generated output, make sure also
    692 # VERBATIM_HEADERS is set to NO.
     922# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
     923# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
     924# it is also possible to disable source filtering for a specific pattern using
     925# *.ext= (so without naming a filter).
     926# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
     927
     928FILTER_SOURCE_PATTERNS =
     929
     930# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
     931# is part of the input, its contents will be placed on the main page
     932# (index.html). This can be useful if you have a project on for instance GitHub
     933# and want to reuse the introduction page also for the doxygen output.
     934
     935USE_MDFILE_AS_MAINPAGE =
     936
     937#---------------------------------------------------------------------------
     938# Configuration options related to source browsing
     939#---------------------------------------------------------------------------
     940
     941# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
     942# generated. Documented entities will be cross-referenced with these sources.
     943#
     944# Note: To get rid of all source code in the generated output, make sure that
     945# also VERBATIM_HEADERS is set to NO.
     946# The default value is: NO.
    693947
    694948SOURCE_BROWSER         = YES
    695949
    696 # Setting the INLINE_SOURCES tag to YES will include the body
    697 # of functions and classes directly in the documentation.
     950# Setting the INLINE_SOURCES tag to YES will include the body of functions,
     951# classes and enums directly into the documentation.
     952# The default value is: NO.
    698953
    699954INLINE_SOURCES         = YES
    700955
    701 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    702 # doxygen to hide any special comment blocks from generated source code
    703 # fragments. Normal C and C++ comments will always remain visible.
     956# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
     957# special comment blocks from generated source code fragments. Normal C, C++ and
     958# Fortran comments will always remain visible.
     959# The default value is: YES.
    704960
    705961STRIP_CODE_COMMENTS    = NO
    706962
    707 # If the REFERENCED_BY_RELATION tag is set to YES
    708 # then for each documented function all documented
    709 # functions referencing it will be listed.
     963# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
     964# function all documented functions referencing it will be listed.
     965# The default value is: NO.
    710966
    711967REFERENCED_BY_RELATION = YES
    712968
    713 # If the REFERENCES_RELATION tag is set to YES
    714 # then for each documented function all documented entities
    715 # called/used by that function will be listed.
     969# If the REFERENCES_RELATION tag is set to YES then for each documented function
     970# all documented entities called/used by that function will be listed.
     971# The default value is: NO.
    716972
    717973REFERENCES_RELATION    = YES
    718974
    719 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    720 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    721 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    722 # link to the source code.
    723 # Otherwise they will link to the documentation.
     975# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
     976# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
     977# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
     978# link to the documentation.
     979# The default value is: YES.
    724980
    725981REFERENCES_LINK_SOURCE = YES
    726982
    727 # If the USE_HTAGS tag is set to YES then the references to source code
    728 # will point to the HTML generated by the htags(1) tool instead of doxygen
    729 # built-in source browser. The htags tool is part of GNU's global source
    730 # tagging system (see http://www.gnu.org/software/global/global.html). You
    731 # will need version 4.8.6 or higher.
     983# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
     984# source code will show a tooltip with additional information such as prototype,
     985# brief description and links to the definition and documentation. Since this
     986# will make the HTML file larger and loading of large files a bit slower, you
     987# can opt to disable this feature.
     988# The default value is: YES.
     989# This tag requires that the tag SOURCE_BROWSER is set to YES.
     990
     991SOURCE_TOOLTIPS        = YES
     992
     993# If the USE_HTAGS tag is set to YES then the references to source code will
     994# point to the HTML generated by the htags(1) tool instead of doxygen built-in
     995# source browser. The htags tool is part of GNU's global source tagging system
     996# (see http://www.gnu.org/software/global/global.html). You will need version
     997# 4.8.6 or higher.
     998#
     999# To use it do the following:
     1000# - Install the latest version of global
     1001# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
     1002# - Make sure the INPUT points to the root of the source tree
     1003# - Run doxygen as normal
     1004#
     1005# Doxygen will invoke htags (and that will in turn invoke gtags), so these
     1006# tools must be available from the command line (i.e. in the search path).
     1007#
     1008# The result: instead of the source browser generated by doxygen, the links to
     1009# source code will now point to the output of htags.
     1010# The default value is: NO.
     1011# This tag requires that the tag SOURCE_BROWSER is set to YES.
    7321012
    7331013USE_HTAGS              = NO
    7341014
    735 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    736 # will generate a verbatim copy of the header file for each class for
    737 # which an include is specified. Set to NO to disable this.
     1015# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
     1016# verbatim copy of the header file for each class for which an include is
     1017# specified. Set to NO to disable this.
     1018# See also: Section \class.
     1019# The default value is: YES.
    7381020
    7391021VERBATIM_HEADERS       = YES
    7401022
    7411023#---------------------------------------------------------------------------
    742 # configuration options related to the alphabetical class index
    743 #---------------------------------------------------------------------------
    744 
    745 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
    746 # of all compounds will be generated. Enable this if the project
    747 # contains a lot of classes, structs, unions or interfaces.
     1024# Configuration options related to the alphabetical class index
     1025#---------------------------------------------------------------------------
     1026
     1027# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
     1028# compounds will be generated. Enable this if the project contains a lot of
     1029# classes, structs, unions or interfaces.
     1030# The default value is: YES.
    7481031
    7491032ALPHABETICAL_INDEX     = YES
    7501033
    751 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
    752 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    753 # in which this list will be split (can be a number in the range [1..20])
     1034# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
     1035# which the alphabetical index list will be split.
     1036# Minimum value: 1, maximum value: 20, default value: 5.
     1037# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    7541038
    7551039COLS_IN_ALPHA_INDEX    = 4
    7561040
    757 # In case all classes in a project start with a common prefix, all
    758 # classes will be put under the same header in the alphabetical index.
    759 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    760 # should be ignored while generating the index headers.
     1041# In case all classes in a project start with a common prefix, all classes will
     1042# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
     1043# can be used to specify a prefix (or a list of prefixes) that should be ignored
     1044# while generating the index headers.
     1045# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
    7611046
    7621047IGNORE_PREFIX          = C
    7631048
    7641049#---------------------------------------------------------------------------
    765 # configuration options related to the HTML output
    766 #---------------------------------------------------------------------------
    767 
    768 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    769 # generate HTML output.
     1050# Configuration options related to the HTML output
     1051#---------------------------------------------------------------------------
     1052
     1053# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
     1054# The default value is: YES.
    7701055
    7711056GENERATE_HTML          = YES
    7721057
    773 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
    774 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    775 # put in front of it. If left blank `html' will be used as the default path.
     1058# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
     1059# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1060# it.
     1061# The default directory is: html.
     1062# This tag requires that the tag GENERATE_HTML is set to YES.
    7761063
    7771064HTML_OUTPUT            = html
    7781065
    779 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
    780 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    781 # doxygen will generate files with .html extension.
     1066# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
     1067# generated HTML page (for example: .htm, .php, .asp).
     1068# The default value is: .html.
     1069# This tag requires that the tag GENERATE_HTML is set to YES.
    7821070
    7831071HTML_FILE_EXTENSION    = .html
    7841072
    785 # The HTML_HEADER tag can be used to specify a personal HTML header for
    786 # each generated HTML page. If it is left blank doxygen will generate a
     1073# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
     1074# each generated HTML page. If the tag is left blank doxygen will generate a
    7871075# standard header.
    788 
    789 HTML_HEADER            =
    790 
    791 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    792 # each generated HTML page. If it is left blank doxygen will generate a
    793 # standard footer.
    794 
    795 HTML_FOOTER            =
    796 
    797 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    798 # style sheet that is used by each HTML page. It can be used to
    799 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    800 # will generate a default style sheet. Note that doxygen will try to copy
    801 # the style sheet file to the HTML output directory, so don't put your own
    802 # stylesheet in the HTML output directory as well, or it will be erased!
    803 
    804 HTML_STYLESHEET        =
    805 
    806 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    807 # files or namespaces will be aligned in HTML using tables. If set to
    808 # NO a bullet list will be used.
    809 
    810 HTML_ALIGN_MEMBERS     = YES
    811 
    812 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    813 # documentation will contain sections that can be hidden and shown after the
    814 # page has loaded. For this to work a browser that supports
    815 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    816 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     1076#
     1077# To get valid HTML the header file that includes any scripts and style sheets
     1078# that doxygen needs, which is dependent on the configuration options used (e.g.
     1079# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
     1080# default header using
     1081# doxygen -w html new_header.html new_footer.html new_stylesheet.css
     1082# YourConfigFile
     1083# and then modify the file new_header.html. See also section "Doxygen usage"
     1084# for information on how to generate the default header that doxygen normally
     1085# uses.
     1086# Note: The header is subject to change so you typically have to regenerate the
     1087# default header when upgrading to a newer version of doxygen. For a description
     1088# of the possible markers and block names see the documentation.
     1089# This tag requires that the tag GENERATE_HTML is set to YES.
     1090
     1091HTML_HEADER            =
     1092
     1093# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
     1094# generated HTML page. If the tag is left blank doxygen will generate a standard
     1095# footer. See HTML_HEADER for more information on how to generate a default
     1096# footer and what special commands can be used inside the footer. See also
     1097# section "Doxygen usage" for information on how to generate the default footer
     1098# that doxygen normally uses.
     1099# This tag requires that the tag GENERATE_HTML is set to YES.
     1100
     1101HTML_FOOTER            =
     1102
     1103# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
     1104# sheet that is used by each HTML page. It can be used to fine-tune the look of
     1105# the HTML output. If left blank doxygen will generate a default style sheet.
     1106# See also section "Doxygen usage" for information on how to generate the style
     1107# sheet that doxygen normally uses.
     1108# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
     1109# it is more robust and this tag (HTML_STYLESHEET) will in the future become
     1110# obsolete.
     1111# This tag requires that the tag GENERATE_HTML is set to YES.
     1112
     1113HTML_STYLESHEET        =
     1114
     1115# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
     1116# defined cascading style sheet that is included after the standard style sheets
     1117# created by doxygen. Using this option one can overrule certain style aspects.
     1118# This is preferred over using HTML_STYLESHEET since it does not replace the
     1119# standard style sheet and is therefor more robust against future updates.
     1120# Doxygen will copy the style sheet file to the output directory. For an example
     1121# see the documentation.
     1122# This tag requires that the tag GENERATE_HTML is set to YES.
     1123
     1124HTML_EXTRA_STYLESHEET  =
     1125
     1126# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
     1127# other source files which should be copied to the HTML output directory. Note
     1128# that these files will be copied to the base HTML output directory. Use the
     1129# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     1130# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
     1131# files will be copied as-is; there are no commands or markers available.
     1132# This tag requires that the tag GENERATE_HTML is set to YES.
     1133
     1134HTML_EXTRA_FILES       =
     1135
     1136# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
     1137# will adjust the colors in the stylesheet and background images according to
     1138# this color. Hue is specified as an angle on a colorwheel, see
     1139# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
     1140# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
     1141# purple, and 360 is red again.
     1142# Minimum value: 0, maximum value: 359, default value: 220.
     1143# This tag requires that the tag GENERATE_HTML is set to YES.
     1144
     1145HTML_COLORSTYLE_HUE    = 220
     1146
     1147# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
     1148# in the HTML output. For a value of 0 the output will use grayscales only. A
     1149# value of 255 will produce the most vivid colors.
     1150# Minimum value: 0, maximum value: 255, default value: 100.
     1151# This tag requires that the tag GENERATE_HTML is set to YES.
     1152
     1153HTML_COLORSTYLE_SAT    = 100
     1154
     1155# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
     1156# luminance component of the colors in the HTML output. Values below 100
     1157# gradually make the output lighter, whereas values above 100 make the output
     1158# darker. The value divided by 100 is the actual gamma applied, so 80 represents
     1159# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
     1160# change the gamma.
     1161# Minimum value: 40, maximum value: 240, default value: 80.
     1162# This tag requires that the tag GENERATE_HTML is set to YES.
     1163
     1164HTML_COLORSTYLE_GAMMA  = 80
     1165
     1166# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
     1167# page will contain the date and time when the page was generated. Setting this
     1168# to NO can help when comparing the output of multiple runs.
     1169# The default value is: YES.
     1170# This tag requires that the tag GENERATE_HTML is set to YES.
     1171
     1172HTML_TIMESTAMP         = YES
     1173
     1174# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     1175# documentation will contain sections that can be hidden and shown after the
     1176# page has loaded.
     1177# The default value is: NO.
     1178# This tag requires that the tag GENERATE_HTML is set to YES.
    8171179
    8181180HTML_DYNAMIC_SECTIONS  = YES
    8191181
    820 # If the GENERATE_DOCSET tag is set to YES, additional index files
    821 # will be generated that can be used as input for Apple's Xcode 3
    822 # integrated development environment, introduced with OSX 10.5 (Leopard).
    823 # To create a documentation set, doxygen will generate a Makefile in the
    824 # HTML output directory. Running make will produce the docset in that
    825 # directory and running "make install" will install the docset in
    826 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    827 # it at startup.
    828 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     1182# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
     1183# shown in the various tree structured indices initially; the user can expand
     1184# and collapse entries dynamically later on. Doxygen will expand the tree to
     1185# such a level that at most the specified number of entries are visible (unless
     1186# a fully collapsed tree already exceeds this amount). So setting the number of
     1187# entries 1 will produce a full collapsed tree by default. 0 is a special value
     1188# representing an infinite number of entries and will result in a full expanded
     1189# tree by default.
     1190# Minimum value: 0, maximum value: 9999, default value: 100.
     1191# This tag requires that the tag GENERATE_HTML is set to YES.
     1192
     1193HTML_INDEX_NUM_ENTRIES = 100
     1194
     1195# If the GENERATE_DOCSET tag is set to YES, additional index files will be
     1196# generated that can be used as input for Apple's Xcode 3 integrated development
     1197# environment (see: http://developer.apple.com/tools/xcode/), introduced with
     1198# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
     1199# Makefile in the HTML output directory. Running make will produce the docset in
     1200# that directory and running make install will install the docset in
     1201# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
     1202# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1203# for more information.
     1204# The default value is: NO.
     1205# This tag requires that the tag GENERATE_HTML is set to YES.
    8291206
    8301207GENERATE_DOCSET        = NO
    8311208
    832 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    833 # feed. A documentation feed provides an umbrella under which multiple
    834 # documentation sets from a single provider (such as a company or product suite)
    835 # can be grouped.
     1209# This tag determines the name of the docset feed. A documentation feed provides
     1210# an umbrella under which multiple documentation sets from a single provider
     1211# (such as a company or product suite) can be grouped.
     1212# The default value is: Doxygen generated docs.
     1213# This tag requires that the tag GENERATE_DOCSET is set to YES.
    8361214
    8371215DOCSET_FEEDNAME        = "Doxygen generated docs"
    8381216
    839 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    840 # should uniquely identify the documentation set bundle. This should be a
    841 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    842 # will append .docset to the name.
     1217# This tag specifies a string that should uniquely identify the documentation
     1218# set bundle. This should be a reverse domain-name style string, e.g.
     1219# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
     1220# The default value is: org.doxygen.Project.
     1221# This tag requires that the tag GENERATE_DOCSET is set to YES.
    8431222
    8441223DOCSET_BUNDLE_ID       = org.doxygen.Project
    8451224
    846 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    847 # will be generated that can be used as input for tools like the
    848 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    849 # of the generated HTML documentation.
     1225# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
     1226# the documentation publisher. This should be a reverse domain-name style
     1227# string, e.g. com.mycompany.MyDocSet.documentation.
     1228# The default value is: org.doxygen.Publisher.
     1229# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1230
     1231DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
     1232
     1233# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
     1234# The default value is: Publisher.
     1235# This tag requires that the tag GENERATE_DOCSET is set to YES.
     1236
     1237DOCSET_PUBLISHER_NAME  = Publisher
     1238
     1239# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
     1240# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
     1241# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
     1242# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
     1243# Windows.
     1244#
     1245# The HTML Help Workshop contains a compiler that can convert all HTML output
     1246# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
     1247# files are now used as the Windows 98 help format, and will replace the old
     1248# Windows help format (.hlp) on all Windows platforms in the future. Compressed
     1249# HTML files also contain an index, a table of contents, and you can search for
     1250# words in the documentation. The HTML workshop also contains a viewer for
     1251# compressed HTML files.
     1252# The default value is: NO.
     1253# This tag requires that the tag GENERATE_HTML is set to YES.
    8501254
    8511255GENERATE_HTMLHELP      = NO
    8521256
    853 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    854 # be used to specify the file name of the resulting .chm file. You
    855 # can add a path in front of the file if the result should not be
     1257# The CHM_FILE tag can be used to specify the file name of the resulting .chm
     1258# file. You can add a path in front of the file if the result should not be
    8561259# written to the html output directory.
     1260# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8571261
    8581262CHM_FILE               = Singular.chm
    8591263
    860 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    861 # be used to specify the location (absolute path including file name) of
    862 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    863 # the HTML help compiler on the generated index.hhp.
    864 
    865 HHC_LOCATION           =
    866 
    867 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    868 # controls if a separate .chi index file is generated (YES) or that
    869 # it should be included in the master .chm file (NO).
     1264# The HHC_LOCATION tag can be used to specify the location (absolute path
     1265# including file name) of the HTML help compiler ( hhc.exe). If non-empty
     1266# doxygen will try to run the HTML help compiler on the generated index.hhp.
     1267# The file has to be specified with full path.
     1268# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     1269
     1270HHC_LOCATION           =
     1271
     1272# The GENERATE_CHI flag controls if a separate .chi index file is generated (
     1273# YES) or that it should be included in the master .chm file ( NO).
     1274# The default value is: NO.
     1275# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8701276
    8711277GENERATE_CHI           = NO
    8721278
    873 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    874 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    875 # content.
    876 
    877 CHM_INDEX_ENCODING     =
    878 
    879 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    880 # controls whether a binary table of contents is generated (YES) or a
    881 # normal table of contents (NO) in the .chm file.
     1279# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
     1280# and project file content.
     1281# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     1282
     1283CHM_INDEX_ENCODING     =
     1284
     1285# The BINARY_TOC flag controls whether a binary table of contents is generated (
     1286# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
     1287# enables the Previous and Next buttons.
     1288# The default value is: NO.
     1289# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8821290
    8831291BINARY_TOC             = NO
    8841292
    885 # The TOC_EXPAND flag can be set to YES to add extra items for group members
    886 # to the contents of the HTML help documentation and to the tree view.
     1293# The TOC_EXPAND flag can be set to YES to add extra items for group members to
     1294# the table of contents of the HTML help documentation and to the tree view.
     1295# The default value is: NO.
     1296# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
    8871297
    8881298TOC_EXPAND             = NO
    8891299
    890 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
    891 # are set, an additional index file will be generated that can be used as input for
    892 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
    893 # HTML documentation.
     1300# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
     1301# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
     1302# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
     1303# (.qch) of the generated HTML documentation.
     1304# The default value is: NO.
     1305# This tag requires that the tag GENERATE_HTML is set to YES.
    8941306
    8951307GENERATE_QHP           = NO
    8961308
    897 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    898 # be used to specify the file name of the resulting .qch file.
    899 # The path specified is relative to the HTML output folder.
    900 
    901 QCH_FILE               =
    902 
    903 # The QHP_NAMESPACE tag specifies the namespace to use when generating
    904 # Qt Help Project output. For more information please see
    905 # http://doc.trolltech.com/qthelpproject.html#namespace
    906 
    907 QHP_NAMESPACE          =
    908 
    909 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    910 # Qt Help Project output. For more information please see
    911 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
     1309# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
     1310# the file name of the resulting .qch file. The path specified is relative to
     1311# the HTML output folder.
     1312# This tag requires that the tag GENERATE_QHP is set to YES.
     1313
     1314QCH_FILE               =
     1315
     1316# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
     1317# Project output. For more information please see Qt Help Project / Namespace
     1318# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
     1319# The default value is: org.doxygen.Project.
     1320# This tag requires that the tag GENERATE_QHP is set to YES.
     1321
     1322QHP_NAMESPACE          =
     1323
     1324# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
     1325# Help Project output. For more information please see Qt Help Project / Virtual
     1326# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
     1327# folders).
     1328# The default value is: doc.
     1329# This tag requires that the tag GENERATE_QHP is set to YES.
    9121330
    9131331QHP_VIRTUAL_FOLDER     = doc
    9141332
    915 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
    916 # For more information please see
    917 # http://doc.trolltech.com/qthelpproject.html#custom-filters
    918 
    919 QHP_CUST_FILTER_NAME   =
    920 
    921 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
    922 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
    923 
    924 QHP_CUST_FILTER_ATTRS  =
    925 
    926 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
    927 # filter section matches.
    928 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
    929 
    930 QHP_SECT_FILTER_ATTRS  =
    931 
    932 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    933 # be used to specify the location of Qt's qhelpgenerator.
    934 # If non-empty doxygen will try to run qhelpgenerator on the generated
    935 # .qhp file.
    936 
    937 QHG_LOCATION           =
    938 
    939 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    940 # top of each HTML page. The value NO (the default) enables the index and
    941 # the value YES disables it.
     1333# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
     1334# filter to add. For more information please see Qt Help Project / Custom
     1335# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1336# filters).
     1337# This tag requires that the tag GENERATE_QHP is set to YES.
     1338
     1339QHP_CUST_FILTER_NAME   =
     1340
     1341# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
     1342# custom filter to add. For more information please see Qt Help Project / Custom
     1343# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
     1344# filters).
     1345# This tag requires that the tag GENERATE_QHP is set to YES.
     1346
     1347QHP_CUST_FILTER_ATTRS  =
     1348
     1349# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
     1350# project's filter section matches. Qt Help Project / Filter Attributes (see:
     1351# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
     1352# This tag requires that the tag GENERATE_QHP is set to YES.
     1353
     1354QHP_SECT_FILTER_ATTRS  =
     1355
     1356# The QHG_LOCATION tag can be used to specify the location of Qt's
     1357# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
     1358# generated .qhp file.
     1359# This tag requires that the tag GENERATE_QHP is set to YES.
     1360
     1361QHG_LOCATION           =
     1362
     1363# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
     1364# generated, together with the HTML files, they form an Eclipse help plugin. To
     1365# install this plugin and make it available under the help contents menu in
     1366# Eclipse, the contents of the directory containing the HTML and XML files needs
     1367# to be copied into the plugins directory of eclipse. The name of the directory
     1368# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
     1369# After copying Eclipse needs to be restarted before the help appears.
     1370# The default value is: NO.
     1371# This tag requires that the tag GENERATE_HTML is set to YES.
     1372
     1373GENERATE_ECLIPSEHELP   = NO
     1374
     1375# A unique identifier for the Eclipse help plugin. When installing the plugin
     1376# the directory name containing the HTML and XML files should also have this
     1377# name. Each documentation set should have its own identifier.
     1378# The default value is: org.doxygen.Project.
     1379# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
     1380
     1381ECLIPSE_DOC_ID         = org.doxygen.Project
     1382
     1383# If you want full control over the layout of the generated HTML pages it might
     1384# be necessary to disable the index and replace it with your own. The
     1385# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
     1386# of each HTML page. A value of NO enables the index and the value YES disables
     1387# it. Since the tabs in the index contain the same information as the navigation
     1388# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
     1389# The default value is: NO.
     1390# This tag requires that the tag GENERATE_HTML is set to YES.
    9421391
    9431392DISABLE_INDEX          = NO
    9441393
    945 # This tag can be used to set the number of enum values (range [1..20])
    946 # that doxygen will group on one line in the generated HTML documentation.
     1394# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     1395# structure should be generated to display hierarchical information. If the tag
     1396# value is set to YES, a side panel will be generated containing a tree-like
     1397# index structure (just like the one that is generated for HTML Help). For this
     1398# to work a browser that supports JavaScript, DHTML, CSS and frames is required
     1399# (i.e. any modern browser). Windows users are probably better off using the
     1400# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
     1401# further fine-tune the look of the index. As an example, the default style
     1402# sheet generated by doxygen has an example that shows how to put an image at
     1403# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
     1404# the same information as the tab index, you could consider setting
     1405# DISABLE_INDEX to YES when enabling this option.
     1406# The default value is: NO.
     1407# This tag requires that the tag GENERATE_HTML is set to YES.
     1408
     1409GENERATE_TREEVIEW      = YES
     1410
     1411# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
     1412# doxygen will group on one line in the generated HTML documentation.
     1413#
     1414# Note that a value of 0 will completely suppress the enum values from appearing
     1415# in the overview section.
     1416# Minimum value: 0, maximum value: 20, default value: 4.
     1417# This tag requires that the tag GENERATE_HTML is set to YES.
    9471418
    9481419ENUM_VALUES_PER_LINE   = 4
    9491420
    950 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    951 # structure should be generated to display hierarchical information.
    952 # If the tag value is set to FRAME, a side panel will be generated
    953 # containing a tree-like index structure (just like the one that
    954 # is generated for HTML Help). For this to work a browser that supports
    955 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    956 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    957 # probably better off using the HTML help feature. Other possible values
    958 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
    959 # and Class Hierarchy pages using a tree view instead of an ordered list;
    960 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
    961 # disables this behavior completely. For backwards compatibility with previous
    962 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
    963 # respectively.
    964 
    965 GENERATE_TREEVIEW      = YES
    966 
    967 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    968 # used to set the initial width (in pixels) of the frame in which the tree
    969 # is shown.
     1421# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
     1422# to set the initial width (in pixels) of the frame in which the tree is shown.
     1423# Minimum value: 0, maximum value: 1500, default value: 250.
     1424# This tag requires that the tag GENERATE_HTML is set to YES.
    9701425
    9711426TREEVIEW_WIDTH         = 250
    9721427
    973 # Use this tag to change the font size of Latex formulas included
    974 # as images in the HTML documentation. The default is 10. Note that
    975 # when you change the font size after a successful doxygen run you need
    976 # to manually remove any form_*.png images from the HTML output directory
    977 # to force them to be regenerated.
     1428# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
     1429# external symbols imported via tag files in a separate window.
     1430# The default value is: NO.
     1431# This tag requires that the tag GENERATE_HTML is set to YES.
     1432
     1433EXT_LINKS_IN_WINDOW    = NO
     1434
     1435# Use this tag to change the font size of LaTeX formulas included as images in
     1436# the HTML documentation. When you change the font size after a successful
     1437# doxygen run you need to manually remove any form_*.png images from the HTML
     1438# output directory to force them to be regenerated.
     1439# Minimum value: 8, maximum value: 50, default value: 10.
     1440# This tag requires that the tag GENERATE_HTML is set to YES.
    9781441
    9791442FORMULA_FONTSIZE       = 8
    9801443
    981 #---------------------------------------------------------------------------
    982 # configuration options related to the LaTeX output
    983 #---------------------------------------------------------------------------
    984 
    985 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    986 # generate Latex output.
     1444# Use the FORMULA_TRANPARENT tag to determine whether or not the images
     1445# generated for formulas are transparent PNGs. Transparent PNGs are not
     1446# supported properly for IE 6.0, but are supported on all modern browsers.
     1447#
     1448# Note that when changing this option you need to delete any form_*.png files in
     1449# the HTML output directory before the changes have effect.
     1450# The default value is: YES.
     1451# This tag requires that the tag GENERATE_HTML is set to YES.
     1452
     1453FORMULA_TRANSPARENT    = YES
     1454
     1455# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
     1456# http://www.mathjax.org) which uses client side Javascript for the rendering
     1457# instead of using prerendered bitmaps. Use this if you do not have LaTeX
     1458# installed or if you want to formulas look prettier in the HTML output. When
     1459# enabled you may also need to install MathJax separately and configure the path
     1460# to it using the MATHJAX_RELPATH option.
     1461# The default value is: NO.
     1462# This tag requires that the tag GENERATE_HTML is set to YES.
     1463
     1464USE_MATHJAX            = NO
     1465
     1466# When MathJax is enabled you can set the default output format to be used for
     1467# the MathJax output. See the MathJax site (see:
     1468# http://docs.mathjax.org/en/latest/output.html) for more details.
     1469# Possible values are: HTML-CSS (which is slower, but has the best
     1470# compatibility), NativeMML (i.e. MathML) and SVG.
     1471# The default value is: HTML-CSS.
     1472# This tag requires that the tag USE_MATHJAX is set to YES.
     1473
     1474MATHJAX_FORMAT         = HTML-CSS
     1475
     1476# When MathJax is enabled you need to specify the location relative to the HTML
     1477# output directory using the MATHJAX_RELPATH option. The destination directory
     1478# should contain the MathJax.js script. For instance, if the mathjax directory
     1479# is located at the same level as the HTML output directory, then
     1480# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
     1481# Content Delivery Network so you can quickly see the result without installing
     1482# MathJax. However, it is strongly recommended to install a local copy of
     1483# MathJax from http://www.mathjax.org before deployment.
     1484# The default value is: http://cdn.mathjax.org/mathjax/latest.
     1485# This tag requires that the tag USE_MATHJAX is set to YES.
     1486
     1487MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1488
     1489# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
     1490# extension names that should be enabled during MathJax rendering. For example
     1491# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
     1492# This tag requires that the tag USE_MATHJAX is set to YES.
     1493
     1494MATHJAX_EXTENSIONS     =
     1495
     1496# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
     1497# of code that will be used on startup of the MathJax code. See the MathJax site
     1498# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
     1499# example see the documentation.
     1500# This tag requires that the tag USE_MATHJAX is set to YES.
     1501
     1502MATHJAX_CODEFILE       =
     1503
     1504# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
     1505# the HTML output. The underlying search engine uses javascript and DHTML and
     1506# should work on any modern browser. Note that when using HTML help
     1507# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
     1508# there is already a search function so this one should typically be disabled.
     1509# For large projects the javascript based search engine can be slow, then
     1510# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
     1511# search using the keyboard; to jump to the search box use <access key> + S
     1512# (what the <access key> is depends on the OS and browser, but it is typically
     1513# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
     1514# key> to jump into the search results window, the results can be navigated
     1515# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
     1516# the search. The filter options can be selected when the cursor is inside the
     1517# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
     1518# to select a filter and <Enter> or <escape> to activate or cancel the filter
     1519# option.
     1520# The default value is: YES.
     1521# This tag requires that the tag GENERATE_HTML is set to YES.
     1522
     1523SEARCHENGINE           = NO
     1524
     1525# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
     1526# implemented using a web server instead of a web client using Javascript. There
     1527# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
     1528# setting. When disabled, doxygen will generate a PHP script for searching and
     1529# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
     1530# and searching needs to be provided by external tools. See the section
     1531# "External Indexing and Searching" for details.
     1532# The default value is: NO.
     1533# This tag requires that the tag SEARCHENGINE is set to YES.
     1534
     1535SERVER_BASED_SEARCH    = NO
     1536
     1537# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
     1538# script for searching. Instead the search results are written to an XML file
     1539# which needs to be processed by an external indexer. Doxygen will invoke an
     1540# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
     1541# search results.
     1542#
     1543# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1544# (doxysearch.cgi) which are based on the open source search engine library
     1545# Xapian (see: http://xapian.org/).
     1546#
     1547# See the section "External Indexing and Searching" for details.
     1548# The default value is: NO.
     1549# This tag requires that the tag SEARCHENGINE is set to YES.
     1550
     1551EXTERNAL_SEARCH        = NO
     1552
     1553# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     1554# which will return the search results when EXTERNAL_SEARCH is enabled.
     1555#
     1556# Doxygen ships with an example indexer ( doxyindexer) and search engine
     1557# (doxysearch.cgi) which are based on the open source search engine library
     1558# Xapian (see: http://xapian.org/). See the section "External Indexing and
     1559# Searching" for details.
     1560# This tag requires that the tag SEARCHENGINE is set to YES.
     1561
     1562SEARCHENGINE_URL       =
     1563
     1564# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     1565# search data is written to a file for indexing by an external tool. With the
     1566# SEARCHDATA_FILE tag the name of this file can be specified.
     1567# The default file is: searchdata.xml.
     1568# This tag requires that the tag SEARCHENGINE is set to YES.
     1569
     1570SEARCHDATA_FILE        = searchdata.xml
     1571
     1572# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
     1573# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
     1574# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
     1575# projects and redirect the results back to the right project.
     1576# This tag requires that the tag SEARCHENGINE is set to YES.
     1577
     1578EXTERNAL_SEARCH_ID     =
     1579
     1580# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     1581# projects other than the one defined by this configuration file, but that are
     1582# all added to the same external search index. Each project needs to have a
     1583# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
     1584# to a relative location where the documentation can be found. The format is:
     1585# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
     1586# This tag requires that the tag SEARCHENGINE is set to YES.
     1587
     1588EXTRA_SEARCH_MAPPINGS  =
     1589
     1590#---------------------------------------------------------------------------
     1591# Configuration options related to the LaTeX output
     1592#---------------------------------------------------------------------------
     1593
     1594# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
     1595# The default value is: YES.
    9871596
    9881597GENERATE_LATEX         = NO
    9891598
    990 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    991 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    992 # put in front of it. If left blank `latex' will be used as the default path.
     1599# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
     1600# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1601# it.
     1602# The default directory is: latex.
     1603# This tag requires that the tag GENERATE_LATEX is set to YES.
    9931604
    9941605LATEX_OUTPUT           = latex
    9951606
    996 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    997 # invoked. If left blank `latex' will be used as the default command name.
     1607# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
     1608# invoked.
     1609#
     1610# Note that when enabling USE_PDFLATEX this option is only used for generating
     1611# bitmaps for formulas in the HTML output, but not in the Makefile that is
     1612# written to the output directory.
     1613# The default file is: latex.
     1614# This tag requires that the tag GENERATE_LATEX is set to YES.
    9981615
    9991616LATEX_CMD_NAME         = latex
    10001617
    1001 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    1002 # generate index for LaTeX. If left blank `makeindex' will be used as the
    1003 # default command name.
     1618# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
     1619# index for LaTeX.
     1620# The default file is: makeindex.
     1621# This tag requires that the tag GENERATE_LATEX is set to YES.
    10041622
    10051623MAKEINDEX_CMD_NAME     = makeindex
    10061624
    1007 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    1008 # LaTeX documents. This may be useful for small projects and may help to
    1009 # save some trees in general.
     1625# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
     1626# documents. This may be useful for small projects and may help to save some
     1627# trees in general.
     1628# The default value is: NO.
     1629# This tag requires that the tag GENERATE_LATEX is set to YES.
    10101630
    10111631COMPACT_LATEX          = YES
    10121632
    1013 # The PAPER_TYPE tag can be used to set the paper type that is used
    1014 # by the printer. Possible values are: a4, a4wide, letter, legal and
    1015 # executive. If left blank a4wide will be used.
     1633# The PAPER_TYPE tag can be used to set the paper type that is used by the
     1634# printer.
     1635# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
     1636# 14 inches) and executive (7.25 x 10.5 inches).
     1637# The default value is: a4.
     1638# This tag requires that the tag GENERATE_LATEX is set to YES.
    10161639
    10171640PAPER_TYPE             = a4wide
    10181641
    1019 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    1020 # packages that should be included in the LaTeX output.
    1021 
    1022 EXTRA_PACKAGES         =
    1023 
    1024 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    1025 # the generated latex document. The header should contain everything until
    1026 # the first chapter. If it is left blank doxygen will generate a
    1027 # standard header. Notice: only use this tag if you know what you are doing!
    1028 
    1029 LATEX_HEADER           =
    1030 
    1031 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    1032 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    1033 # contain links (just like the HTML output) instead of page references
    1034 # This makes the output suitable for online browsing using a pdf viewer.
     1642# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
     1643# that should be included in the LaTeX output. To get the times font for
     1644# instance you can specify
     1645# EXTRA_PACKAGES=times
     1646# If left blank no extra packages will be included.
     1647# This tag requires that the tag GENERATE_LATEX is set to YES.
     1648
     1649EXTRA_PACKAGES         =
     1650
     1651# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
     1652# generated LaTeX document. The header should contain everything until the first
     1653# chapter. If it is left blank doxygen will generate a standard header. See
     1654# section "Doxygen usage" for information on how to let doxygen write the
     1655# default header to a separate file.
     1656#
     1657# Note: Only use a user-defined header if you know what you are doing! The
     1658# following commands have a special meaning inside the header: $title,
     1659# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
     1660# replace them by respectively the title of the page, the current date and time,
     1661# only the current date, the version number of doxygen, the project name (see
     1662# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
     1663# This tag requires that the tag GENERATE_LATEX is set to YES.
     1664
     1665LATEX_HEADER           =
     1666
     1667# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
     1668# generated LaTeX document. The footer should contain everything after the last
     1669# chapter. If it is left blank doxygen will generate a standard footer.
     1670#
     1671# Note: Only use a user-defined footer if you know what you are doing!
     1672# This tag requires that the tag GENERATE_LATEX is set to YES.
     1673
     1674LATEX_FOOTER           =
     1675
     1676# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
     1677# other source files which should be copied to the LATEX_OUTPUT output
     1678# directory. Note that the files will be copied as-is; there are no commands or
     1679# markers available.
     1680# This tag requires that the tag GENERATE_LATEX is set to YES.
     1681
     1682LATEX_EXTRA_FILES      =
     1683
     1684# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
     1685# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
     1686# contain links (just like the HTML output) instead of page references. This
     1687# makes the output suitable for online browsing using a PDF viewer.
     1688# The default value is: YES.
     1689# This tag requires that the tag GENERATE_LATEX is set to YES.
    10351690
    10361691PDF_HYPERLINKS         = YES
    10371692
    1038 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    1039 # plain latex in the generated Makefile. Set this option to YES to get a
     1693# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
     1694# the PDF file directly from the LaTeX files. Set this option to YES to get a
    10401695# higher quality PDF documentation.
     1696# The default value is: YES.
     1697# This tag requires that the tag GENERATE_LATEX is set to YES.
    10411698
    10421699USE_PDFLATEX           = YES
    10431700
    1044 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    1045 # command to the generated LaTeX files. This will instruct LaTeX to keep
    1046 # running if errors occur, instead of asking the user for help.
    1047 # This option is also used when generating formulas in HTML.
     1701# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
     1702# command to the generated LaTeX files. This will instruct LaTeX to keep running
     1703# if errors occur, instead of asking the user for help. This option is also used
     1704# when generating formulas in HTML.
     1705# The default value is: NO.
     1706# This tag requires that the tag GENERATE_LATEX is set to YES.
    10481707
    10491708LATEX_BATCHMODE        = NO
    10501709
    1051 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    1052 # include the index chapters (such as File Index, Compound Index, etc.)
    1053 # in the output.
     1710# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
     1711# index chapters (such as File Index, Compound Index, etc.) in the output.
     1712# The default value is: NO.
     1713# This tag requires that the tag GENERATE_LATEX is set to YES.
    10541714
    10551715LATEX_HIDE_INDICES     = NO
    10561716
    1057 # 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.
     1717# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
     1718# code with syntax highlighting in the LaTeX output.
     1719#
     1720# Note that which sources are shown also depends on other settings such as
     1721# SOURCE_BROWSER.
     1722# The default value is: NO.
     1723# This tag requires that the tag GENERATE_LATEX is set to YES.
    10581724
    10591725LATEX_SOURCE_CODE      = YES
    10601726
    1061 #---------------------------------------------------------------------------
    1062 # configuration options related to the RTF output
    1063 #---------------------------------------------------------------------------
    1064 
    1065 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    1066 # The RTF output is optimized for Word 97 and may not look very pretty with
    1067 # other RTF readers or editors.
     1727# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
     1728# bibliography, e.g. plainnat, or ieeetr. See
     1729# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
     1730# The default value is: plain.
     1731# This tag requires that the tag GENERATE_LATEX is set to YES.
     1732
     1733LATEX_BIB_STYLE        = plain
     1734
     1735#---------------------------------------------------------------------------
     1736# Configuration options related to the RTF output
     1737#---------------------------------------------------------------------------
     1738
     1739# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
     1740# RTF output is optimized for Word 97 and may not look too pretty with other RTF
     1741# readers/editors.
     1742# The default value is: NO.
    10681743
    10691744GENERATE_RTF           = NO
    10701745
    1071 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    1072 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1073 # put in front of it. If left blank `rtf' will be used as the default path.
     1746# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
     1747# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1748# it.
     1749# The default directory is: rtf.
     1750# This tag requires that the tag GENERATE_RTF is set to YES.
    10741751
    10751752RTF_OUTPUT             = rtf
    10761753
    1077 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    1078 # RTF documents. This may be useful for small projects and may help to
    1079 # save some trees in general.
     1754# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
     1755# documents. This may be useful for small projects and may help to save some
     1756# trees in general.
     1757# The default value is: NO.
     1758# This tag requires that the tag GENERATE_RTF is set to YES.
    10801759
    10811760COMPACT_RTF            = NO
    10821761
    1083 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    1084 # will contain hyperlink fields. The RTF file will
    1085 # contain links (just like the HTML output) instead of page references.
    1086 # This makes the output suitable for online browsing using WORD or other
    1087 # programs which support those fields.
    1088 # Note: wordpad (write) and others do not support links.
     1762# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
     1763# contain hyperlink fields. The RTF file will contain links (just like the HTML
     1764# output) instead of page references. This makes the output suitable for online
     1765# browsing using Word or some other Word compatible readers that support those
     1766# fields.
     1767#
     1768# Note: WordPad (write) and others do not support links.
     1769# The default value is: NO.
     1770# This tag requires that the tag GENERATE_RTF is set to YES.
    10891771
    10901772RTF_HYPERLINKS         = NO
    10911773
    1092 # Load stylesheet definitions from file. Syntax is similar to doxygen's
    1093 # config file, i.e. a series of assignments. You only have to provide
    1094 # replacements, missing definitions are set to their default value.
    1095 
    1096 RTF_STYLESHEET_FILE    =
    1097 
    1098 # Set optional variables used in the generation of an rtf document.
    1099 # Syntax is similar to doxygen's config file.
    1100 
    1101 RTF_EXTENSIONS_FILE    =
    1102 
    1103 #---------------------------------------------------------------------------
    1104 # configuration options related to the man page output
    1105 #---------------------------------------------------------------------------
    1106 
    1107 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    1108 # generate man pages
     1774# Load stylesheet definitions from file. Syntax is similar to doxygen's config
     1775# file, i.e. a series of assignments. You only have to provide replacements,
     1776# missing definitions are set to their default value.
     1777#
     1778# See also section "Doxygen usage" for information on how to generate the
     1779# default style sheet that doxygen normally uses.
     1780# This tag requires that the tag GENERATE_RTF is set to YES.
     1781
     1782RTF_STYLESHEET_FILE    =
     1783
     1784# Set optional variables used in the generation of an RTF document. Syntax is
     1785# similar to doxygen's config file. A template extensions file can be generated
     1786# using doxygen -e rtf extensionFile.
     1787# This tag requires that the tag GENERATE_RTF is set to YES.
     1788
     1789RTF_EXTENSIONS_FILE    =
     1790
     1791#---------------------------------------------------------------------------
     1792# Configuration options related to the man page output
     1793#---------------------------------------------------------------------------
     1794
     1795# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
     1796# classes and files.
     1797# The default value is: NO.
    11091798
    11101799GENERATE_MAN           = NO
    11111800
    1112 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    1113 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1114 # put in front of it. If left blank `man' will be used as the default path.
     1801# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
     1802# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1803# it. A directory man3 will be created inside the directory specified by
     1804# MAN_OUTPUT.
     1805# The default directory is: man.
     1806# This tag requires that the tag GENERATE_MAN is set to YES.
    11151807
    11161808MAN_OUTPUT             = man
    11171809
    1118 # The MAN_EXTENSION tag determines the extension that is added to
    1119 # the generated man pages (default is the subroutine's section .3)
     1810# The MAN_EXTENSION tag determines the extension that is added to the generated
     1811# man pages. In case the manual section does not start with a number, the number
     1812# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
     1813# optional.
     1814# The default value is: .3.
     1815# This tag requires that the tag GENERATE_MAN is set to YES.
    11201816
    11211817MAN_EXTENSION          = .3
    11221818
    1123 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    1124 # then it will generate one additional man file for each entity
    1125 # documented in the real man page(s). These additional files
    1126 # only source the real man page, but without them the man command
    1127 # would be unable to find the correct page. The default is NO.
     1819# The MAN_SUBDIR tag determines the name of the directory created within
     1820# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
     1821# MAN_EXTENSION with the initial . removed.
     1822# This tag requires that the tag GENERATE_MAN is set to YES.
     1823
     1824MAN_SUBDIR             =
     1825
     1826# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
     1827# will generate one additional man file for each entity documented in the real
     1828# man page(s). These additional files only source the real man page, but without
     1829# them the man command would be unable to find the correct page.
     1830# The default value is: NO.
     1831# This tag requires that the tag GENERATE_MAN is set to YES.
    11281832
    11291833MAN_LINKS              = NO
    11301834
    11311835#---------------------------------------------------------------------------
    1132 # configuration options related to the XML output
    1133 #---------------------------------------------------------------------------
    1134 
    1135 # If the GENERATE_XML tag is set to YES Doxygen will
    1136 # generate an XML file that captures the structure of
    1137 # the code including all documentation.
     1836# Configuration options related to the XML output
     1837#---------------------------------------------------------------------------
     1838
     1839# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
     1840# captures the structure of the code including all documentation.
     1841# The default value is: NO.
    11381842
    11391843GENERATE_XML           = NO
    11401844
    1141 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    1142 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    1143 # put in front of it. If left blank `xml' will be used as the default path.
     1845# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
     1846# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
     1847# it.
     1848# The default directory is: xml.
     1849# This tag requires that the tag GENERATE_XML is set to YES.
    11441850
    11451851XML_OUTPUT             = xml
    11461852
    1147 # The XML_SCHEMA tag can be used to specify an XML schema,
    1148 # which can be used by a validating XML parser to check the
    1149 # syntax of the XML files.
    1150 
    1151 XML_SCHEMA             =
    1152 
    1153 # The XML_DTD tag can be used to specify an XML DTD,
    1154 # which can be used by a validating XML parser to check the
    1155 # syntax of the XML files.
    1156 
    1157 XML_DTD                =
    1158 
    1159 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    1160 # dump the program listings (including syntax highlighting
    1161 # and cross-referencing information) to the XML output. Note that
    1162 # enabling this will significantly increase the size of the XML output.
     1853# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
     1854# listings (including syntax highlighting and cross-referencing information) to
     1855# the XML output. Note that enabling this will significantly increase the size
     1856# of the XML output.
     1857# The default value is: YES.
     1858# This tag requires that the tag GENERATE_XML is set to YES.
    11631859
    11641860XML_PROGRAMLISTING     = YES
    11651861
    11661862#---------------------------------------------------------------------------
    1167 # configuration options for the AutoGen Definitions output
    1168 #---------------------------------------------------------------------------
    1169 
    1170 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    1171 # generate an AutoGen Definitions (see autogen.sf.net) file
    1172 # that captures the structure of the code including all
    1173 # documentation. Note that this feature is still experimental
    1174 # and incomplete at the moment.
     1863# Configuration options related to the DOCBOOK output
     1864#---------------------------------------------------------------------------
     1865
     1866# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
     1867# that can be used to generate PDF.
     1868# The default value is: NO.
     1869
     1870GENERATE_DOCBOOK       = NO
     1871
     1872# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
     1873# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
     1874# front of it.
     1875# The default directory is: docbook.
     1876# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1877
     1878DOCBOOK_OUTPUT         = docbook
     1879
     1880#---------------------------------------------------------------------------
     1881# Configuration options for the AutoGen Definitions output
     1882#---------------------------------------------------------------------------
     1883
     1884# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
     1885# Definitions (see http://autogen.sf.net) file that captures the structure of
     1886# the code including all documentation. Note that this feature is still
     1887# experimental and incomplete at the moment.
     1888# The default value is: NO.
    11751889
    11761890GENERATE_AUTOGEN_DEF   = NO
    11771891
    11781892#---------------------------------------------------------------------------
    1179 # configuration options related to the Perl module output
    1180 #---------------------------------------------------------------------------
    1181 
    1182 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    1183 # generate a Perl module file that captures the structure of
    1184 # the code including all documentation. Note that this
    1185 # feature is still experimental and incomplete at the
    1186 # moment.
     1893# Configuration options related to the Perl module output
     1894#---------------------------------------------------------------------------
     1895
     1896# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
     1897# file that captures the structure of the code including all documentation.
     1898#
     1899# Note that this feature is still experimental and incomplete at the moment.
     1900# The default value is: NO.
    11871901
    11881902GENERATE_PERLMOD       = NO
    11891903
    1190 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    1191 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    1192 # to generate PDF and DVI output from the Perl module output.
     1904# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
     1905# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
     1906# output from the Perl module output.
     1907# The default value is: NO.
     1908# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    11931909
    11941910PERLMOD_LATEX          = NO
    11951911
    1196 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1197 # nicely formatted so it can be parsed by a human reader.
    1198 # This is useful
    1199 # if you want to understand what is going on.
    1200 # On the other hand, if this
    1201 # tag is set to NO the size of the Perl module output will be much smaller
    1202 # and Perl will parse it just the same.
     1912# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
     1913# formatted so it can be parsed by a human reader. This is useful if you want to
     1914# understand what is going on. On the other hand, if this tag is set to NO the
     1915# size of the Perl module output will be much smaller and Perl will parse it
     1916# just the same.
     1917# The default value is: YES.
     1918# This tag requires that the tag GENERATE_PERLMOD is set to YES.
    12031919
    12041920PERLMOD_PRETTY         = YES
    12051921
    1206 # The names of the make variables in the generated doxyrules.make file
    1207 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    1208 # This is useful so different doxyrules.make files included by the same
    1209 # Makefile don't overwrite each other's variables.
    1210 
    1211 PERLMOD_MAKEVAR_PREFIX =
    1212 
    1213 #---------------------------------------------------------------------------
    1214 # Configuration options related to the preprocessor   
    1215 #---------------------------------------------------------------------------
    1216 
    1217 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    1218 # evaluate all C-preprocessor directives found in the sources and include
     1922# The names of the make variables in the generated doxyrules.make file are
     1923# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
     1924# so different doxyrules.make files included by the same Makefile don't
     1925# overwrite each other's variables.
     1926# This tag requires that the tag GENERATE_PERLMOD is set to YES.
     1927
     1928PERLMOD_MAKEVAR_PREFIX =
     1929
     1930#---------------------------------------------------------------------------
     1931# Configuration options related to the preprocessor
     1932#---------------------------------------------------------------------------
     1933
     1934# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
     1935# C-preprocessor directives found in the sources and include files.
     1936# The default value is: YES.
     1937
     1938ENABLE_PREPROCESSING   = YES
     1939
     1940# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
     1941# in the source code. If set to NO only conditional compilation will be
     1942# performed. Macro expansion can be done in a controlled way by setting
     1943# EXPAND_ONLY_PREDEF to YES.
     1944# The default value is: NO.
     1945# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1946
     1947MACRO_EXPANSION        = NO
     1948
     1949# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
     1950# the macro expansion is limited to the macros specified with the PREDEFINED and
     1951# EXPAND_AS_DEFINED tags.
     1952# The default value is: NO.
     1953# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1954
     1955EXPAND_ONLY_PREDEF     = NO
     1956
     1957# If the SEARCH_INCLUDES tag is set to YES the includes files in the
     1958# INCLUDE_PATH will be searched if a #include is found.
     1959# The default value is: YES.
     1960# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1961
     1962SEARCH_INCLUDES        = YES
     1963
     1964# The INCLUDE_PATH tag can be used to specify one or more directories that
     1965# contain include files that are not input files but should be processed by the
     1966# preprocessor.
     1967# This tag requires that the tag SEARCH_INCLUDES is set to YES.
     1968
     1969INCLUDE_PATH           =
     1970
     1971# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1972# patterns (like *.h and *.hpp) to filter out the header-files in the
     1973# directories. If left blank, the patterns specified with FILE_PATTERNS will be
     1974# used.
     1975# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1976
     1977INCLUDE_FILE_PATTERNS  =
     1978
     1979# The PREDEFINED tag can be used to specify one or more macro names that are
     1980# defined before the preprocessor is started (similar to the -D option of e.g.
     1981# gcc). The argument of the tag is a list of macros of the form: name or
     1982# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
     1983# is assumed. To prevent a macro definition from being undefined via #undef or
     1984# recursively expanded use the := operator instead of the = operator.
     1985# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1986
     1987PREDEFINED             = DOXYGEN_PARSE
     1988
     1989# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
     1990# tag can be used to specify a list of macro names that should be expanded. The
     1991# macro definition that is found in the sources will be used. Use the PREDEFINED
     1992# tag if you want to use a different macro definition that overrules the
     1993# definition found in the source code.
     1994# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     1995
     1996EXPAND_AS_DEFINED      = HAVE_PLURAL \
     1997                         HAVE_RINGS
     1998
     1999# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
     2000# remove all references to function-like macros that are alone on a line, have
     2001# an all uppercase name, and do not end with a semicolon. Such function macros
     2002# are typically used for boiler-plate code, and will confuse the parser if not
     2003# removed.
     2004# The default value is: YES.
     2005# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
     2006
     2007SKIP_FUNCTION_MACROS   = NO
     2008
     2009#---------------------------------------------------------------------------
     2010# Configuration options related to external references
     2011#---------------------------------------------------------------------------
     2012
     2013# The TAGFILES tag can be used to specify one or more tag files. For each tag
     2014# file the location of the external documentation should be added. The format of
     2015# a tag file without this location is as follows:
     2016# TAGFILES = file1 file2 ...
     2017# Adding location for the tag files is done as follows:
     2018# TAGFILES = file1=loc1 "file2 = loc2" ...
     2019# where loc1 and loc2 can be relative or absolute paths or URLs. See the
     2020# section "Linking to external documentation" for more information about the use
     2021# of tag files.
     2022# Note: Each tag file must have a unique name (where the name does NOT include
     2023# the path). If a tag file is not located in the directory in which doxygen is
     2024# run, you must also specify the path to the tagfile here.
     2025
     2026TAGFILES               =
     2027
     2028# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
     2029# tag file that is based on the input files it reads. See section "Linking to
     2030# external documentation" for more information about the usage of tag files.
     2031
     2032GENERATE_TAGFILE       =
     2033
     2034# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
     2035# class index. If set to NO only the inherited external classes will be listed.
     2036# The default value is: NO.
     2037
     2038ALLEXTERNALS           = NO
     2039
     2040# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
     2041# the modules index. If set to NO, only the current project's groups will be
     2042# listed.
     2043# The default value is: YES.
     2044
     2045EXTERNAL_GROUPS        = YES
     2046
     2047# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
     2048# the related pages index. If set to NO, only the current project's pages will
     2049# be listed.
     2050# The default value is: YES.
     2051
     2052EXTERNAL_PAGES         = YES
     2053
     2054# The PERL_PATH should be the absolute path and name of the perl script
     2055# interpreter (i.e. the result of 'which perl').
     2056# The default file (with absolute path) is: /usr/bin/perl.
     2057
     2058PERL_PATH              = /usr/bin/perl
     2059
     2060#---------------------------------------------------------------------------
     2061# Configuration options related to the dot tool
     2062#---------------------------------------------------------------------------
     2063
     2064# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
     2065# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
     2066# NO turns the diagrams off. Note that this option also works with HAVE_DOT
     2067# disabled, but it is recommended to install and use dot, since it yields more
     2068# powerful graphs.
     2069# The default value is: YES.
     2070
     2071CLASS_DIAGRAMS         = YES
     2072
     2073# You can define message sequence charts within doxygen comments using the \msc
     2074# command. Doxygen will then run the mscgen tool (see:
     2075# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
     2076# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     2077# the mscgen tool resides. If left empty the tool is assumed to be found in the
     2078# default search path.
     2079
     2080MSCGEN_PATH            =
     2081
     2082# You can include diagrams made with dia in doxygen documentation. Doxygen will
     2083# then run dia to produce the diagram and insert it in the documentation. The
     2084# DIA_PATH tag allows you to specify the directory where the dia binary resides.
     2085# If left empty dia is assumed to be found in the default search path.
     2086
     2087DIA_PATH               =
     2088
     2089# If set to YES, the inheritance and collaboration graphs will hide inheritance
     2090# and usage relations if the target is undocumented or is not a class.
     2091# The default value is: YES.
     2092
     2093HIDE_UNDOC_RELATIONS   = NO
     2094
     2095# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     2096# available from the path. This tool is part of Graphviz (see:
     2097# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
     2098# Bell Labs. The other options in this section have no effect if this option is
     2099# set to NO
     2100# The default value is: NO.
     2101
     2102HAVE_DOT               = YES
     2103
     2104# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
     2105# to run in parallel. When set to 0 doxygen will base this on the number of
     2106# processors available in the system. You can set it explicitly to a value
     2107# larger than 0 to get control over the balance between CPU load and processing
     2108# speed.
     2109# Minimum value: 0, maximum value: 32, default value: 0.
     2110# This tag requires that the tag HAVE_DOT is set to YES.
     2111
     2112DOT_NUM_THREADS        = 0
     2113
     2114# When you want a differently looking font n the dot files that doxygen
     2115# generates you can specify the font name using DOT_FONTNAME. You need to make
     2116# sure dot is able to find the font, which can be done by putting it in a
     2117# standard location or by setting the DOTFONTPATH environment variable or by
     2118# setting DOT_FONTPATH to the directory containing the font.
     2119# The default value is: Helvetica.
     2120# This tag requires that the tag HAVE_DOT is set to YES.
     2121
     2122DOT_FONTNAME           = FreeSans
     2123
     2124# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
     2125# dot graphs.
     2126# Minimum value: 4, maximum value: 24, default value: 10.
     2127# This tag requires that the tag HAVE_DOT is set to YES.
     2128
     2129DOT_FONTSIZE           = 8
     2130
     2131# By default doxygen will tell dot to use the default font as specified with
     2132# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
     2133# the path where dot can find it using this tag.
     2134# This tag requires that the tag HAVE_DOT is set to YES.
     2135
     2136DOT_FONTPATH           =
     2137
     2138# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
     2139# each documented class showing the direct and indirect inheritance relations.
     2140# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
     2141# The default value is: YES.
     2142# This tag requires that the tag HAVE_DOT is set to YES.
     2143
     2144CLASS_GRAPH            = YES
     2145
     2146# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
     2147# graph for each documented class showing the direct and indirect implementation
     2148# dependencies (inheritance, containment, and class references variables) of the
     2149# class with other documented classes.
     2150# The default value is: YES.
     2151# This tag requires that the tag HAVE_DOT is set to YES.
     2152
     2153COLLABORATION_GRAPH    = YES
     2154
     2155# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
     2156# groups, showing the direct groups dependencies.
     2157# The default value is: YES.
     2158# This tag requires that the tag HAVE_DOT is set to YES.
     2159
     2160GROUP_GRAPHS           = YES
     2161
     2162# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     2163# collaboration diagrams in a style similar to the OMG's Unified Modeling
     2164# Language.
     2165# The default value is: NO.
     2166# This tag requires that the tag HAVE_DOT is set to YES.
     2167
     2168UML_LOOK               = YES
     2169
     2170# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
     2171# class node. If there are many fields or methods and many nodes the graph may
     2172# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
     2173# number of items for each type to make the size more manageable. Set this to 0
     2174# for no limit. Note that the threshold may be exceeded by 50% before the limit
     2175# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
     2176# but if the number exceeds 15, the total amount of fields shown is limited to
     2177# 10.
     2178# Minimum value: 0, maximum value: 100, default value: 10.
     2179# This tag requires that the tag HAVE_DOT is set to YES.
     2180
     2181UML_LIMIT_NUM_FIELDS   = 10
     2182
     2183# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
     2184# collaboration graphs will show the relations between templates and their
     2185# instances.
     2186# The default value is: NO.
     2187# This tag requires that the tag HAVE_DOT is set to YES.
     2188
     2189TEMPLATE_RELATIONS     = YES
     2190
     2191# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
     2192# YES then doxygen will generate a graph for each documented file showing the
     2193# direct and indirect include dependencies of the file with other documented
    12192194# files.
    1220 
    1221 ENABLE_PREPROCESSING   = YES
    1222 
    1223 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    1224 # names in the source code. If set to NO (the default) only conditional
    1225 # compilation will be performed. Macro expansion can be done in a controlled
    1226 # way by setting EXPAND_ONLY_PREDEF to YES.
    1227 
    1228 MACRO_EXPANSION        = NO
    1229 
    1230 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    1231 # then the macro expansion is limited to the macros specified with the
    1232 # PREDEFINED and EXPAND_AS_DEFINED tags.
    1233 
    1234 EXPAND_ONLY_PREDEF     = NO
    1235 
    1236 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1237 # in the INCLUDE_PATH (see below) will be search if a #include is found.
    1238 
    1239 SEARCH_INCLUDES        = YES
    1240 
    1241 # The INCLUDE_PATH tag can be used to specify one or more directories that
    1242 # contain include files that are not input files but should be processed by
    1243 # the preprocessor.
    1244 
    1245 INCLUDE_PATH           =
    1246 
    1247 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    1248 # patterns (like *.h and *.hpp) to filter out the header-files in the
    1249 # directories. If left blank, the patterns specified with FILE_PATTERNS will
    1250 # be used.
    1251 
    1252 INCLUDE_FILE_PATTERNS  =
    1253 
    1254 # The PREDEFINED tag can be used to specify one or more macro names that
    1255 # are defined before the preprocessor is started (similar to the -D option of
    1256 # gcc). The argument of the tag is a list of macros of the form: name
    1257 # or name=definition (no spaces). If the definition and the = are
    1258 # omitted =1 is assumed. To prevent a macro definition from being
    1259 # undefined via #undef or recursively expanded use the := operator
    1260 # instead of the = operator.
    1261 
    1262 PREDEFINED             = DOXYGEN_PARSE
    1263 
    1264 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    1265 # this tag can be used to specify a list of macro names that should be expanded.
    1266 # The macro definition that is found in the sources will be used.
    1267 # Use the PREDEFINED tag if you want to use a different macro definition.
    1268 
    1269 EXPAND_AS_DEFINED      = HAVE_PLURAL HAVE_RINGS
    1270 
    1271 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1272 # doxygen's preprocessor will remove all function-like macros that are alone
    1273 # on a line, have an all uppercase name, and do not end with a semicolon. Such
    1274 # function macros are typically used for boiler-plate code, and will confuse
    1275 # the parser if not removed.
    1276 
    1277 SKIP_FUNCTION_MACROS   = NO
    1278 
    1279 #---------------------------------------------------------------------------
    1280 # Configuration::additions related to external references   
    1281 #---------------------------------------------------------------------------
    1282 
    1283 # The TAGFILES option can be used to specify one or more tagfiles.
    1284 # Optionally an initial location of the external documentation
    1285 # can be added for each tagfile. The format of a tag file without
    1286 # this location is as follows:
    1287 
    1288 # TAGFILES = file1 file2 ...
    1289 # Adding location for the tag files is done as follows:
    1290 
    1291 # TAGFILES = file1=loc1 "file2 = loc2" ...
    1292 # where "loc1" and "loc2" can be relative or absolute paths or
    1293 # URLs. If a location is present for each tag, the installdox tool
    1294 # does not have to be run to correct the links.
    1295 # Note that each tag file must have a unique name
    1296 # (where the name does NOT include the path)
    1297 # If a tag file is not located in the directory in which doxygen
    1298 # is run, you must also specify the path to the tagfile here.
    1299 
    1300 TAGFILES               =
    1301 
    1302 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    1303 # a tag file that is based on the input files it reads.
    1304 
    1305 GENERATE_TAGFILE       =
    1306 
    1307 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    1308 # in the class index. If set to NO only the inherited external classes
    1309 # will be listed.
    1310 
    1311 ALLEXTERNALS           = NO
    1312 
    1313 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    1314 # in the modules index. If set to NO, only the current project's groups will
    1315 # be listed.
    1316 
    1317 EXTERNAL_GROUPS        = YES
    1318 
    1319 # The PERL_PATH should be the absolute path and name of the perl script
    1320 # interpreter (i.e. the result of `which perl').
    1321 
    1322 PERL_PATH              = /usr/bin/perl
    1323 
    1324 #---------------------------------------------------------------------------
    1325 # Configuration options related to the dot tool   
    1326 #---------------------------------------------------------------------------
    1327 
    1328 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1329 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    1330 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    1331 # this option is superseded by the HAVE_DOT option below. This is only a
    1332 # fallback. It is recommended to install and use dot, since it yields more
    1333 # powerful graphs.
    1334 
    1335 CLASS_DIAGRAMS         = YES
    1336 
    1337 # You can define message sequence charts within doxygen comments using the \msc
    1338 # command. Doxygen will then run the mscgen tool (see
    1339 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
    1340 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
    1341 # the mscgen tool resides. If left empty the tool is assumed to be found in the
    1342 # default search path.
    1343 
    1344 MSCGEN_PATH            =
    1345 
    1346 # If set to YES, the inheritance and collaboration graphs will hide
    1347 # inheritance and usage relations if the target is undocumented
    1348 # or is not a class.
    1349 
    1350 HIDE_UNDOC_RELATIONS   = NO
    1351 
    1352 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    1353 # available from the path. This tool is part of Graphviz, a graph visualization
    1354 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    1355 # have no effect if this option is set to NO (the default)
    1356 
    1357 HAVE_DOT               = YES
    1358 
    1359 # By default doxygen will write a font called FreeSans.ttf to the output
    1360 # directory and reference it in all dot files that doxygen generates. This
    1361 # font does not include all possible unicode characters however, so when you need
    1362 # these (or just want a differently looking font) you can specify the font name
    1363 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
    1364 # which can be done by putting it in a standard location or by setting the
    1365 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
    1366 # containing the font.
    1367 
    1368 DOT_FONTNAME           = FreeSans
    1369 
    1370 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    1371 # The default size is 10pt.
    1372 
    1373 DOT_FONTSIZE           = 8
    1374 
    1375 # By default doxygen will tell dot to use the output directory to look for the
    1376 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
    1377 # different font using DOT_FONTNAME you can set the path where dot
    1378 # can find it using this tag.
    1379 
    1380 DOT_FONTPATH           =
    1381 
    1382 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1383 # will generate a graph for each documented class showing the direct and
    1384 # indirect inheritance relations. Setting this tag to YES will force the
    1385 # the CLASS_DIAGRAMS tag to NO.
    1386 
    1387 CLASS_GRAPH            = YES
    1388 
    1389 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1390 # will generate a graph for each documented class showing the direct and
    1391 # indirect implementation dependencies (inheritance, containment, and
    1392 # class references variables) of the class with other documented classes.
    1393 
    1394 COLLABORATION_GRAPH    = YES
    1395 
    1396 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    1397 # will generate a graph for groups, showing the direct groups dependencies
    1398 
    1399 GROUP_GRAPHS           = YES
    1400 
    1401 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    1402 # collaboration diagrams in a style similar to the OMG's Unified Modeling
    1403 # Language.
    1404 
    1405 UML_LOOK               = YES
    1406 
    1407 # If set to YES, the inheritance and collaboration graphs will show the
    1408 # relations between templates and their instances.
    1409 
    1410 TEMPLATE_RELATIONS     = YES
    1411 
    1412 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    1413 # tags are set to YES then doxygen will generate a graph for each documented
    1414 # file showing the direct and indirect include dependencies of the file with
    1415 # other documented files.
     2195# The default value is: YES.
     2196# This tag requires that the tag HAVE_DOT is set to YES.
    14162197
    14172198INCLUDE_GRAPH          = YES
    14182199
    1419 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    1420 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    1421 # documented header file showing the documented files that directly or
    1422 # indirectly include this file.
     2200# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
     2201# set to YES then doxygen will generate a graph for each documented file showing
     2202# the direct and indirect include dependencies of the file with other documented
     2203# files.
     2204# The default value is: YES.
     2205# This tag requires that the tag HAVE_DOT is set to YES.
    14232206
    14242207INCLUDED_BY_GRAPH      = YES
    14252208
    1426 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    1427 # doxygen will generate a call dependency graph for every global function
    1428 # or class method. Note that enabling this option will significantly increase
    1429 # the time of a run. So in most cases it will be better to enable call graphs
    1430 # for selected functions only using the \callgraph command.
     2209# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
     2210# dependency graph for every global function or class method.
     2211#
     2212# Note that enabling this option will significantly increase the time of a run.
     2213# So in most cases it will be better to enable call graphs for selected
     2214# functions only using the \callgraph command.
     2215# The default value is: NO.
     2216# This tag requires that the tag HAVE_DOT is set to YES.
    14312217
    14322218CALL_GRAPH             = YES
    14332219
    1434 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    1435 # doxygen will generate a caller dependency graph for every global function
    1436 # or class method. Note that enabling this option will significantly increase
    1437 # the time of a run. So in most cases it will be better to enable caller
    1438 # graphs for selected functions only using the \callergraph command.
     2220# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
     2221# dependency graph for every global function or class method.
     2222#
     2223# Note that enabling this option will significantly increase the time of a run.
     2224# So in most cases it will be better to enable caller graphs for selected
     2225# functions only using the \callergraph command.
     2226# The default value is: NO.
     2227# This tag requires that the tag HAVE_DOT is set to YES.
    14392228
    14402229CALLER_GRAPH           = YES
    14412230
    1442 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1443 # will graphical hierarchy of all classes instead of a textual one.
     2231# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
     2232# hierarchy of all classes instead of a textual one.
     2233# The default value is: YES.
     2234# This tag requires that the tag HAVE_DOT is set to YES.
    14442235
    14452236GRAPHICAL_HIERARCHY    = YES
    14462237
    1447 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    1448 # then doxygen will show the dependencies a directory has on other directories
    1449 # in a graphical way. The dependency relations are determined by the #include
    1450 # relations between the files in the directories.
     2238# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
     2239# dependencies a directory has on other directories in a graphical way. The
     2240# dependency relations are determined by the #include relations between the
     2241# files in the directories.
     2242# The default value is: YES.
     2243# This tag requires that the tag HAVE_DOT is set to YES.
    14512244
    14522245DIRECTORY_GRAPH        = YES
    14532246
    1454 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1455 # generated by dot. Possible values are png, jpg, or gif
    1456 # If left blank png will be used.
     2247# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     2248# generated by dot.
     2249# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
     2250# to make the SVG files visible in IE 9+ (other browsers do not have this
     2251# requirement).
     2252# Possible values are: png, jpg, gif and svg.
     2253# The default value is: png.
     2254# This tag requires that the tag HAVE_DOT is set to YES.
    14572255
    14582256DOT_IMAGE_FORMAT       = png
    14592257
    1460 # The tag DOT_PATH can be used to specify the path where the dot tool can be
     2258# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
     2259# enable generation of interactive SVG images that allow zooming and panning.
     2260#
     2261# Note that this requires a modern browser other than Internet Explorer. Tested
     2262# and working are Firefox, Chrome, Safari, and Opera.
     2263# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
     2264# the SVG files visible. Older versions of IE do not have SVG support.
     2265# The default value is: NO.
     2266# This tag requires that the tag HAVE_DOT is set to YES.
     2267
     2268INTERACTIVE_SVG        = NO
     2269
     2270# The DOT_PATH tag can be used to specify the path where the dot tool can be
    14612271# found. If left blank, it is assumed the dot tool can be found in the path.
    1462 
    1463 DOT_PATH               =
    1464 
    1465 # The DOTFILE_DIRS tag can be used to specify one or more directories that
    1466 # contain dot files that are included in the documentation (see the
    1467 # \dotfile command).
    1468 
    1469 DOTFILE_DIRS           =
    1470 
    1471 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1472 # nodes that will be shown in the graph. If the number of nodes in a graph
    1473 # becomes larger than this value, doxygen will truncate the graph, which is
    1474 # visualized by representing a node as a red box. Note that doxygen if the
    1475 # number of direct children of the root node in a graph is already larger than
    1476 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    1477 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2272# This tag requires that the tag HAVE_DOT is set to YES.
     2273
     2274DOT_PATH               =
     2275
     2276# The DOTFILE_DIRS tag can be used to specify one or more directories that
     2277# contain dot files that are included in the documentation (see the \dotfile
     2278# command).
     2279# This tag requires that the tag HAVE_DOT is set to YES.
     2280
     2281DOTFILE_DIRS           =
     2282
     2283# The MSCFILE_DIRS tag can be used to specify one or more directories that
     2284# contain msc files that are included in the documentation (see the \mscfile
     2285# command).
     2286
     2287MSCFILE_DIRS           =
     2288
     2289# The DIAFILE_DIRS tag can be used to specify one or more directories that
     2290# contain dia files that are included in the documentation (see the \diafile
     2291# command).
     2292
     2293DIAFILE_DIRS           =
     2294
     2295# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
     2296# that will be shown in the graph. If the number of nodes in a graph becomes
     2297# larger than this value, doxygen will truncate the graph, which is visualized
     2298# by representing a node as a red box. Note that doxygen if the number of direct
     2299# children of the root node in a graph is already larger than
     2300# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
     2301# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     2302# Minimum value: 0, maximum value: 10000, default value: 50.
     2303# This tag requires that the tag HAVE_DOT is set to YES.
    14782304
    14792305DOT_GRAPH_MAX_NODES    = 70
    14802306
    1481 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1482 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1483 # from the root by following a path via at most 3 edges will be shown. Nodes
    1484 # that lay further from the root node will be omitted. Note that setting this
    1485 # option to 1 or 2 may greatly reduce the computation time needed for large
    1486 # code bases. Also note that the size of a graph can be further restricted by
     2307# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
     2308# generated by dot. A depth value of 3 means that only nodes reachable from the
     2309# root by following a path via at most 3 edges will be shown. Nodes that lay
     2310# further from the root node will be omitted. Note that setting this option to 1
     2311# or 2 may greatly reduce the computation time needed for large code bases. Also
     2312# note that the size of a graph can be further restricted by
    14872313# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
     2314# Minimum value: 0, maximum value: 1000, default value: 0.
     2315# This tag requires that the tag HAVE_DOT is set to YES.
    14882316
    14892317MAX_DOT_GRAPH_DEPTH    = 20
    14902318
    1491 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1492 # background. This is disabled by default, because dot on Windows does not
    1493 # seem to support this out of the box. Warning: Depending on the platform used,
    1494 # enabling this option may lead to badly anti-aliased labels on the edges of
    1495 # a graph (i.e. they become hard to read).
     2319# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     2320# background. This is disabled by default, because dot on Windows does not seem
     2321# to support this out of the box.
     2322#
     2323# Warning: Depending on the platform used, enabling this option may lead to
     2324# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
     2325# read).
     2326# The default value is: NO.
     2327# This tag requires that the tag HAVE_DOT is set to YES.
    14962328
    14972329DOT_TRANSPARENT        = YES
    14982330
    1499 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    1500 # files in one run (i.e. multiple -o and -T options on the command line). This
    1501 # makes dot run faster, but since only newer versions of dot (>1.8.10)
    1502 # support this, this feature is disabled by default.
     2331# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     2332# files in one run (i.e. multiple -o and -T options on the command line). This
     2333# makes dot run faster, but since only newer versions of dot (>1.8.10) support
     2334# this, this feature is disabled by default.
     2335# The default value is: NO.
     2336# This tag requires that the tag HAVE_DOT is set to YES.
    15032337
    15042338DOT_MULTI_TARGETS      = YES
    15052339
    1506 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1507 # generate a legend page explaining the meaning of the various boxes and
    1508 # arrows in the dot generated graphs.
     2340# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
     2341# explaining the meaning of the various boxes and arrows in the dot generated
     2342# graphs.
     2343# The default value is: YES.
     2344# This tag requires that the tag HAVE_DOT is set to YES.
    15092345
    15102346GENERATE_LEGEND        = YES
    15112347
    1512 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    1513 # remove the intermediate dot files that are used to generate
    1514 # the various graphs.
     2348# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
     2349# files that are used to generate the various graphs.
     2350# The default value is: YES.
     2351# This tag requires that the tag HAVE_DOT is set to YES.
    15152352
    15162353DOT_CLEANUP            = YES
    1517 
    1518 #---------------------------------------------------------------------------
    1519 # Options related to the search engine
    1520 #---------------------------------------------------------------------------
    1521 
    1522 # The SEARCHENGINE tag specifies whether or not a search engine should be
    1523 # used. If set to NO the values of all tags below this one will be ignored.
    1524 
    1525 SEARCHENGINE           = NO
  • dox/Doxyfile.in

    r39d047b r8ddc7cd  
    3333# The default value is: My Project.
    3434
    35 PROJECT_NAME           =
     35PROJECT_NAME           = Singular
    3636
    3737# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
     
    982982# This tag requires that the tag SOURCE_BROWSER is set to YES.
    983983
    984 USE_HTAGS              = YES
     984USE_HTAGS              = NO
    985985
    986986# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
     
    18391839# The default value is: NO.
    18401840
    1841 GENERATE_DOCBOOK       = YES
     1841GENERATE_DOCBOOK       = NO
    18421842
    18431843# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
Note: See TracChangeset for help on using the changeset viewer.