Changeset 703a0720ce in tspsg


Ignore:
Timestamp:
Aug 10, 2012, 7:13:33 PM (12 years ago)
Author:
Oleksii Serdiuk
Branches:
appveyor, imgbot, master, readme
Children:
697a9dc08f
Parents:
4a5e9a66d4
Message:

Removed obsolete entries from Doxyfile.

By running 'doxygen -u'.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Doxyfile

    r4a5e9a66d4 r703a0720ce  
    1 ######################################################################
     1# Doxyfile 1.8.1.2
     2
     3# This file describes the settings to be used by the documentation system
     4# doxygen (www.doxygen.org) for a project.
    25#
    3 # TSPSG: TSP Solver and Generator
    4 # Copyright (C) 2007-2012 Oleksii Serdiuk <contacts[at]oleksii[dot]name>
    5 #
    6 # $Id: $Format:%h %ai %an$ $
    7 # $URL: http://tspsg.info/ $
    8 #
    9 # This file is part of TSPSG.
    10 #
    11 ######################################################################
    12 
    13 # Doxyfile 1.6.1
    14 
    15 # This file describes the settings to be used by the documentation system
    16 # doxygen (www.doxygen.org) for a project
    17 #
    18 # All text after a hash (#) is considered a comment and will be ignored
     6# All text after a hash (#) is considered a comment and will be ignored.
    197# The format is:
    208#       TAG = value [value, ...]
    219# For lists items can also be appended using:
    2210#       TAG += value [value, ...]
    23 # Values that contain spaces should be placed between quotes (" ")
     11# Values that contain spaces should be placed between quotes (" ").
    2412
    2513#---------------------------------------------------------------------------
     
    2715#---------------------------------------------------------------------------
    2816
    29 # This tag specifies the encoding used for all characters in the config file 
    30 # that follow. The default is UTF-8 which is also the encoding used for all 
    31 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 
    32 # iconv built into libc) for the transcoding. See 
     17# This tag specifies the encoding used for all characters in the config file
     18# that follow. The default is UTF-8 which is also the encoding used for all
     19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     20# iconv built into libc) for the transcoding. See
    3321# http://www.gnu.org/software/libiconv for the list of possible encodings.
    3422
    3523DOXYFILE_ENCODING      = UTF-8
    3624
    37 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    38 # by quotes) that should identify the project.
     25# The PROJECT_NAME tag is a single word (or sequence of words) that should
     26# identify the project. Note that if you do not use Doxywizard you need
     27# to put quotes around the project name if it contains spaces.
    3928
    4029PROJECT_NAME           = "TSP Solver and Generator"
    4130
    42 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    43 # This could be handy for archiving the generated documentation or 
     31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     32# This could be handy for archiving the generated documentation or
    4433# if some version control system is used.
    4534
    46 PROJECT_NUMBER         =
    47 
    48 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
    49 # base path where the generated documentation will be put.
    50 # If a relative path is entered, it will be relative to the location
     35PROJECT_NUMBER         =
     36
     37# Using the PROJECT_BRIEF tag one can provide an optional one line description
     38# for a project that appears at the top of each page and should give viewer
     39# a quick idea about the purpose of the project. Keep the description short.
     40
     41PROJECT_BRIEF          =
     42
     43# With the PROJECT_LOGO tag one can specify an logo or icon that is
     44# included in the documentation. The maximum height of the logo should not
     45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
     46# Doxygen will copy the logo to the output directory.
     47
     48PROJECT_LOGO           =
     49
     50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     51# base path where the generated documentation will be put.
     52# If a relative path is entered, it will be relative to the location
    5153# where doxygen was started. If left blank the current directory will be used.
    5254
    5355OUTPUT_DIRECTORY       = doc
    5456
    55 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    56 # 4096 sub-directories (in 2 levels) under the output directory of each output 
    57 # format and will distribute the generated files over these directories. 
    58 # Enabling this option can be useful when feeding doxygen a huge amount of 
    59 # source files, where putting all generated files in the same directory would 
     57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     58# 4096 sub-directories (in 2 levels) under the output directory of each output
     59# format and will distribute the generated files over these directories.
     60# Enabling this option can be useful when feeding doxygen a huge amount of
     61# source files, where putting all generated files in the same directory would
    6062# otherwise cause performance problems for the file system.
    6163
    6264CREATE_SUBDIRS         = NO
    6365
    64 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    65 # documentation generated by doxygen is written. Doxygen will use this 
    66 # information to generate all constant output in the proper language. 
    67 # The default language is English, other supported languages are: 
    68 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
    69 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
    70 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
    71 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
    72 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
     66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     67# documentation generated by doxygen is written. Doxygen will use this
     68# information to generate all constant output in the proper language.
     69# The default language is English, other supported languages are:
     70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
     72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
     73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
     74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
    7375# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    7476
    7577OUTPUT_LANGUAGE        = English
    7678
    77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
    78 # include brief member descriptions after the members that are listed in 
    79 # the file and class documentation (similar to JavaDoc). 
     79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     80# include brief member descriptions after the members that are listed in
     81# the file and class documentation (similar to JavaDoc).
    8082# Set to NO to disable this.
    8183
    8284BRIEF_MEMBER_DESC      = YES
    8385
    84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    85 # the brief description of a member or function before the detailed description. 
    86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     87# the brief description of a member or function before the detailed description.
     88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    8789# brief descriptions will be completely suppressed.
    8890
    8991REPEAT_BRIEF           = YES
    9092
    91 # This tag implements a quasi-intelligent brief description abbreviator 
    92 # that is used to form the text in various listings. Each string 
    93 # in this list, if found as the leading text of the brief description, will be 
    94 # stripped from the text and the result after processing the whole list, is 
    95 # used as the annotated text. Otherwise, the brief description is used as-is. 
    96 # If left blank, the following values are used ("$name" is automatically 
    97 # replaced with the name of the entity): "The $name class" "The $name widget" 
    98 # "The $name file" "is" "provides" "specifies" "contains" 
     93# This tag implements a quasi-intelligent brief description abbreviator
     94# that is used to form the text in various listings. Each string
     95# in this list, if found as the leading text of the brief description, will be
     96# stripped from the text and the result after processing the whole list, is
     97# used as the annotated text. Otherwise, the brief description is used as-is.
     98# If left blank, the following values are used ("$name" is automatically
     99# replaced with the name of the entity): "The $name class" "The $name widget"
     100# "The $name file" "is" "provides" "specifies" "contains"
    99101# "represents" "a" "an" "the"
    100102
     
    111113                         the
    112114
    113 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
    114 # Doxygen will generate a detailed section even if there is only a brief 
     115# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     116# Doxygen will generate a detailed section even if there is only a brief
    115117# description.
    116118
    117119ALWAYS_DETAILED_SEC    = NO
    118120
    119 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    120 # inherited members of a class in the documentation of that class as if those 
    121 # members were ordinary class members. Constructors, destructors and assignment 
     121# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     122# inherited members of a class in the documentation of that class as if those
     123# members were ordinary class members. Constructors, destructors and assignment
    122124# operators of the base classes will not be shown.
    123125
    124126INLINE_INHERITED_MEMB  = NO
    125127
    126 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    127 # path before files name in the file list and in the header files. If set 
     128# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     129# path before files name in the file list and in the header files. If set
    128130# to NO the shortest path that makes the file name unique will be used.
    129131
    130132FULL_PATH_NAMES        = YES
    131133
    132 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    133 # can be used to strip a user-defined part of the path. Stripping is 
    134 # only done if one of the specified strings matches the left-hand part of 
    135 # the path. The tag can be used to show relative paths in the file list. 
    136 # If left blank the directory from which doxygen is run is used as the 
     134# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     135# can be used to strip a user-defined part of the path. Stripping is
     136# only done if one of the specified strings matches the left-hand part of
     137# the path. The tag can be used to show relative paths in the file list.
     138# If left blank the directory from which doxygen is run is used as the
    137139# path to strip.
    138140
    139 STRIP_FROM_PATH        = 
    140 
    141 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
    142 # the path mentioned in the documentation of a class, which tells 
    143 # the reader which header file to include in order to use a class. 
    144 # If left blank only the name of the header file containing the class 
    145 # definition is used. Otherwise one should specify the include paths that 
     141STRIP_FROM_PATH        =
     142
     143# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     144# the path mentioned in the documentation of a class, which tells
     145# the reader which header file to include in order to use a class.
     146# If left blank only the name of the header file containing the class
     147# definition is used. Otherwise one should specify the include paths that
    146148# are normally passed to the compiler using the -I flag.
    147149
    148 STRIP_FROM_INC_PATH    = 
    149 
    150 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    151 # (but less readable) file names. This can be useful is your file systems
     150STRIP_FROM_INC_PATH    =
     151
     152# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     153# (but less readable) file names. This can be useful if your file system
    152154# doesn't support long names like on DOS, Mac, or CD-ROM.
    153155
    154156SHORT_NAMES            = NO
    155157
    156 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    157 # will interpret the first line (until the first dot) of a JavaDoc-style 
    158 # comment as the brief description. If set to NO, the JavaDoc 
    159 # comments will behave just like regular Qt-style comments 
     158# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     159# will interpret the first line (until the first dot) of a JavaDoc-style
     160# comment as the brief description. If set to NO, the JavaDoc
     161# comments will behave just like regular Qt-style comments
    160162# (thus requiring an explicit @brief command for a brief description.)
    161163
    162164JAVADOC_AUTOBRIEF      = NO
    163165
    164 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
    165 # interpret the first line (until the first dot) of a Qt-style 
    166 # comment as the brief description. If set to NO, the comments 
    167 # will behave just like regular Qt-style comments (thus requiring 
     166# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     167# interpret the first line (until the first dot) of a Qt-style
     168# comment as the brief description. If set to NO, the comments
     169# will behave just like regular Qt-style comments (thus requiring
    168170# an explicit \brief command for a brief description.)
    169171
    170172QT_AUTOBRIEF           = YES
    171173
    172 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
    173 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
    174 # comments) as a brief description. This used to be the default behaviour. 
    175 # The new default is to treat a multi-line C++ comment block as a detailed 
     174# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     175# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     176# comments) as a brief description. This used to be the default behaviour.
     177# The new default is to treat a multi-line C++ comment block as a detailed
    176178# description. Set this tag to YES if you prefer the old behaviour instead.
    177179
    178180MULTILINE_CPP_IS_BRIEF = NO
    179181
    180 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
    181 # member inherits the documentation from any documented member that it 
     182# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     183# member inherits the documentation from any documented member that it
    182184# re-implements.
    183185
    184186INHERIT_DOCS           = YES
    185187
    186 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
    187 # a new page for each member. If set to NO, the documentation of a member will 
     188# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     189# a new page for each member. If set to NO, the documentation of a member will
    188190# be part of the file/class/namespace that contains it.
    189191
    190192SEPARATE_MEMBER_PAGES  = NO
    191193
    192 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
     194# The TAB_SIZE tag can be used to set the number of spaces in a tab.
    193195# Doxygen uses this value to replace tabs by spaces in code fragments.
    194196
    195197TAB_SIZE               = 4
    196198
    197 # This tag can be used to specify a number of aliases that acts 
    198 # as commands in the documentation. An alias has the form "name=value". 
    199 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
    200 # put the command \sideeffect (or @sideeffect) in the documentation, which 
    201 # will result in a user-defined paragraph with heading "Side Effects:". 
     199# This tag can be used to specify a number of aliases that acts
     200# as commands in the documentation. An alias has the form "name=value".
     201# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     202# put the command \sideeffect (or @sideeffect) in the documentation, which
     203# will result in a user-defined paragraph with heading "Side Effects:".
    202204# You can put \n's in the value part of an alias to insert newlines.
    203205
    204 ALIASES                = "hack=\xrefitem hacks \"Hack\" \"Hack List\""
    205 ALIASES               += "ticket{2}=<a href=\"http://bugs.tspsg.info/ticket/\1\">\2</a>"
    206 
    207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    208 # sources only. Doxygen will then generate output that is more tailored for C.
    209 # For instance, some of the names that are used will be different. The list
     206ALIASES                = "hack=\xrefitem hacks \"Hack\" \"Hack List\"" \
     207                         "ticket{2}=<a href=\"http://bugs.tspsg.info/ticket/\1\">\2</a>"
     208
     209# This tag can be used to specify a number of word-keyword mappings (TCL only).
     210# A mapping has the form "name=value". For example adding
     211# "class=itcl::class" will allow you to use the command class in the
     212# itcl::class meaning.
     213
     214TCL_SUBST              =
     215
     216# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     217# sources only. Doxygen will then generate output that is more tailored for C.
     218# For instance, some of the names that are used will be different. The list
    210219# of all members will be omitted, etc.
    211220
    212221OPTIMIZE_OUTPUT_FOR_C  = NO
    213222
    214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
    215 # sources only. Doxygen will then generate output that is more tailored for 
    216 # Java. For instance, namespaces will be presented as packages, qualified 
     223# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     224# sources only. Doxygen will then generate output that is more tailored for
     225# Java. For instance, namespaces will be presented as packages, qualified
    217226# scopes will look different, etc.
    218227
    219228OPTIMIZE_OUTPUT_JAVA   = NO
    220229
    221 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
    222 # sources only. Doxygen will then generate output that is more tailored for 
     230# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     231# sources only. Doxygen will then generate output that is more tailored for
    223232# Fortran.
    224233
    225234OPTIMIZE_FOR_FORTRAN   = NO
    226235
    227 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
    228 # sources. Doxygen will then generate output that is tailored for 
     236# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     237# sources. Doxygen will then generate output that is tailored for
    229238# VHDL.
    230239
    231240OPTIMIZE_OUTPUT_VHDL   = NO
    232241
    233 # Doxygen selects the parser to use depending on the extension of the files it parses.
    234 # With this tag you can assign which parser to use for a given extension.
    235 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
    236 # The format is ext=language, where ext is a file extension, and language is one of
    237 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
    238 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
    239 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
    240 # use: inc=Fortran f=C. Note that for custom extensions you also need to set
    241 # FILE_PATTERNS otherwise the files are not read by doxygen.
    242 
    243 EXTENSION_MAPPING      =
    244 
    245 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
    246 # to include (a tag file for) the STL sources as input, then you should
    247 # set this tag to YES in order to let doxygen match functions declarations and
    248 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    249 # func(std::string) {}). This also make the inheritance and collaboration
     242# Doxygen selects the parser to use depending on the extension of the files it
     243# parses. With this tag you can assign which parser to use for a given extension.
     244# Doxygen has a built-in mapping, but you can override or extend it using this
     245# tag. The format is ext=language, where ext is a file extension, and language
     246# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
     247# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
     248# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
     249# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
     250# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     251
     252EXTENSION_MAPPING      =
     253
     254# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
     255# comments according to the Markdown format, which allows for more readable
     256# documentation. See http://daringfireball.net/projects/markdown/ for details.
     257# The output of markdown processing is further processed by doxygen, so you
     258# can mix doxygen, HTML, and XML commands with Markdown formatting.
     259# Disable only in case of backward compatibilities issues.
     260
     261MARKDOWN_SUPPORT       = YES
     262
     263# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     264# to include (a tag file for) the STL sources as input, then you should
     265# set this tag to YES in order to let doxygen match functions declarations and
     266# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     267# func(std::string) {}). This also makes the inheritance and collaboration
    250268# diagrams that involve STL classes more complete and accurate.
    251269
    252270BUILTIN_STL_SUPPORT    = NO
    253271
    254 # If you use Microsoft's C++/CLI language, you should set this option to YES to 
     272# If you use Microsoft's C++/CLI language, you should set this option to YES to
    255273# enable parsing support.
    256274
    257275CPP_CLI_SUPPORT        = NO
    258276
    259 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
    260 # Doxygen will parse them like normal C++ but will assume all classes use public 
     277# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     278# Doxygen will parse them like normal C++ but will assume all classes use public
    261279# instead of private inheritance when no explicit protection keyword is present.
    262280
    263281SIP_SUPPORT            = NO
    264282
    265 # For Microsoft's IDL there are propget and propput attributes to indicate getter 
    266 # and setter methods for a property. Setting this option to YES (the default) 
    267 # will make doxygen to replace the get and set methods by a property in the
    268 # documentation. This will only work if the methods are indeed getting or 
    269 # setting a simple type. If this is not the case, or you want to show the 
     283# For Microsoft's IDL there are propget and propput attributes to indicate getter
     284# and setter methods for a property. Setting this option to YES (the default)
     285# will make doxygen replace the get and set methods by a property in the
     286# documentation. This will only work if the methods are indeed getting or
     287# setting a simple type. If this is not the case, or you want to show the
    270288# methods anyway, you should set this option to NO.
    271289
    272290IDL_PROPERTY_SUPPORT   = YES
    273291
    274 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
    275 # tag is set to YES, then doxygen will reuse the documentation of the first 
    276 # member in the group (if any) for the other members of the group. By default 
     292# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     293# tag is set to YES, then doxygen will reuse the documentation of the first
     294# member in the group (if any) for the other members of the group. By default
    277295# all members of a group must be documented explicitly.
    278296
    279297DISTRIBUTE_GROUP_DOC   = NO
    280298
    281 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
    282 # the same type (for instance a group of public functions) to be put as a 
    283 # subgroup of that type (e.g. under the Public Functions section). Set it to 
    284 # NO to prevent subgrouping. Alternatively, this can be done per class using 
     299# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     300# the same type (for instance a group of public functions) to be put as a
     301# subgroup of that type (e.g. under the Public Functions section). Set it to
     302# NO to prevent subgrouping. Alternatively, this can be done per class using
    285303# the \nosubgrouping command.
    286304
    287305SUBGROUPING            = YES
    288306
    289 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
    290 # is documented as struct, union, or enum with the name of the typedef. So
    291 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
    292 # with name TypeT. When disabled the typedef will appear as a member of a file,
    293 # namespace, or class. And the struct will be named TypeS. This can typically
    294 # be useful for C code in case the coding convention dictates that all compound
     307# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
     308# unions are shown inside the group in which they are included (e.g. using
     309# @ingroup) instead of on a separate page (for HTML and Man pages) or
     310# section (for LaTeX and RTF).
     311
     312INLINE_GROUPED_CLASSES = NO
     313
     314# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
     315# unions with only public data fields will be shown inline in the documentation
     316# of the scope in which they are defined (i.e. file, namespace, or group
     317# documentation), provided this scope is documented. If set to NO (the default),
     318# structs, classes, and unions are shown on a separate page (for HTML and Man
     319# pages) or section (for LaTeX and RTF).
     320
     321INLINE_SIMPLE_STRUCTS  = NO
     322
     323# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     324# is documented as struct, union, or enum with the name of the typedef. So
     325# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     326# with name TypeT. When disabled the typedef will appear as a member of a file,
     327# namespace, or class. And the struct will be named TypeS. This can typically
     328# be useful for C code in case the coding convention dictates that all compound
    295329# types are typedef'ed and only the typedef is referenced, never the tag name.
    296330
    297331TYPEDEF_HIDES_STRUCT   = NO
    298332
    299 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
    300 # determine which symbols to keep in memory and which to flush to disk. 
    301 # When the cache is full, less often used symbols will be written to disk. 
    302 # For small to medium size projects (<1000 input files) the default value is 
    303 # probably good enough. For larger projects a too small cache size can cause 
    304 # doxygen to be busy swapping symbols to and from disk most of the time 
    305 # causing a significant performance penality.
    306 # If the system has enough physical memory increasing the cache will improve the 
    307 # performance by keeping more symbols in memory. Note that the value works on 
    308 # a logarithmic scale so increasing the size by one will rougly double the
    309 # memory usage. The cache size is given by this formula: 
    310 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
    311 # corresponding to a cache size of 2^16 = 65536 symbols
     333# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
     334# determine which symbols to keep in memory and which to flush to disk.
     335# When the cache is full, less often used symbols will be written to disk.
     336# For small to medium size projects (<1000 input files) the default value is
     337# probably good enough. For larger projects a too small cache size can cause
     338# doxygen to be busy swapping symbols to and from disk most of the time
     339# causing a significant performance penalty.
     340# If the system has enough physical memory increasing the cache will improve the
     341# performance by keeping more symbols in memory. Note that the value works on
     342# a logarithmic scale so increasing the size by one will roughly double the
     343# memory usage. The cache size is given by this formula:
     344# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
     345# corresponding to a cache size of 2^16 = 65536 symbols.
    312346
    313347SYMBOL_CACHE_SIZE      = 0
    314348
     349# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
     350# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
     351# their name and scope. Since this can be an expensive process and often the
     352# same symbol appear multiple times in the code, doxygen keeps a cache of
     353# pre-resolved symbols. If the cache is too small doxygen will become slower.
     354# If the cache is too large, memory is wasted. The cache size is given by this
     355# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
     356# corresponding to a cache size of 2^16 = 65536 symbols.
     357
     358LOOKUP_CACHE_SIZE      = 0
     359
    315360#---------------------------------------------------------------------------
    316361# Build related configuration options
    317362#---------------------------------------------------------------------------
    318363
    319 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    320 # documentation are documented, even if no documentation was available. 
    321 # Private class members and static file members will be hidden unless 
     364# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     365# documentation are documented, even if no documentation was available.
     366# Private class members and static file members will be hidden unless
    322367# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    323368
    324369EXTRACT_ALL            = NO
    325370
    326 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
     371# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    327372# will be included in the documentation.
    328373
    329374EXTRACT_PRIVATE        = NO
    330375
    331 # If the EXTRACT_STATIC tag is set to YES all static members of a file
     376# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
     377
     378EXTRACT_PACKAGE        = NO
     379
     380# If the EXTRACT_STATIC tag is set to YES all static members of a file
    332381# will be included in the documentation.
    333382
    334383EXTRACT_STATIC         = NO
    335384
    336 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
    337 # defined locally in source files will be included in the documentation. 
     385# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     386# defined locally in source files will be included in the documentation.
    338387# If set to NO only classes defined in header files are included.
    339388
    340389EXTRACT_LOCAL_CLASSES  = YES
    341390
    342 # This flag is only useful for Objective-C code. When set to YES local 
    343 # methods, which are defined in the implementation section but not in 
    344 # the interface are included in the documentation. 
     391# This flag is only useful for Objective-C code. When set to YES local
     392# methods, which are defined in the implementation section but not in
     393# the interface are included in the documentation.
    345394# If set to NO (the default) only methods in the interface are included.
    346395
    347396EXTRACT_LOCAL_METHODS  = NO
    348397
    349 # If this flag is set to YES, the members of anonymous namespaces will be 
    350 # extracted and appear in the documentation as a namespace called 
    351 # 'anonymous_namespace{file}', where file will be replaced with the base 
    352 # name of the file that contains the anonymous namespace. By default 
    353 # anonymous namespace are hidden.
     398# If this flag is set to YES, the members of anonymous namespaces will be
     399# extracted and appear in the documentation as a namespace called
     400# 'anonymous_namespace{file}', where file will be replaced with the base
     401# name of the file that contains the anonymous namespace. By default
     402# anonymous namespaces are hidden.
    354403
    355404EXTRACT_ANON_NSPACES   = NO
    356405
    357 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
    358 # undocumented members of documented classes, files or namespaces. 
    359 # If set to NO (the default) these members will be included in the 
    360 # various overviews, but no documentation section is generated. 
     406# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     407# undocumented members of documented classes, files or namespaces.
     408# If set to NO (the default) these members will be included in the
     409# various overviews, but no documentation section is generated.
    361410# This option has no effect if EXTRACT_ALL is enabled.
    362411
    363412HIDE_UNDOC_MEMBERS     = NO
    364413
    365 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    366 # undocumented classes that are normally visible in the class hierarchy. 
    367 # If set to NO (the default) these classes will be included in the various 
     414# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     415# undocumented classes that are normally visible in the class hierarchy.
     416# If set to NO (the default) these classes will be included in the various
    368417# overviews. This option has no effect if EXTRACT_ALL is enabled.
    369418
    370419HIDE_UNDOC_CLASSES     = NO
    371420
    372 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
    373 # friend (class|struct|union) declarations. 
    374 # If set to NO (the default) these declarations will be included in the 
     421# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     422# friend (class|struct|union) declarations.
     423# If set to NO (the default) these declarations will be included in the
    375424# documentation.
    376425
    377426HIDE_FRIEND_COMPOUNDS  = NO
    378427
    379 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
    380 # documentation blocks found inside the body of a function. 
    381 # If set to NO (the default) these blocks will be appended to the 
     428# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
     429# documentation blocks found inside the body of a function.
     430# If set to NO (the default) these blocks will be appended to the
    382431# function's detailed documentation block.
    383432
    384433HIDE_IN_BODY_DOCS      = NO
    385434
    386 # The INTERNAL_DOCS tag determines if documentation 
    387 # that is typed after a \internal command is included. If the tag is set 
    388 # to NO (the default) then the documentation will be excluded. 
     435# The INTERNAL_DOCS tag determines if documentation
     436# that is typed after a \internal command is included. If the tag is set
     437# to NO (the default) then the documentation will be excluded.
    389438# Set it to YES to include the internal documentation.
    390439
    391440INTERNAL_DOCS          = YES
    392441
    393 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
    394 # file names in lower-case letters. If set to YES upper-case letters are also 
    395 # allowed. This is useful if you have classes or files whose names only differ 
    396 # in case and if your file system supports case sensitive file names. Windows 
     442# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     443# file names in lower-case letters. If set to YES upper-case letters are also
     444# allowed. This is useful if you have classes or files whose names only differ
     445# in case and if your file system supports case sensitive file names. Windows
    397446# and Mac users are advised to set this option to NO.
    398447
    399448CASE_SENSE_NAMES       = NO
    400449
    401 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
    402 # will show members with their full class and namespace scopes in the 
     450# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     451# will show members with their full class and namespace scopes in the
    403452# documentation. If set to YES the scope will be hidden.
    404453
    405454HIDE_SCOPE_NAMES       = NO
    406455
    407 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
    408 # will put a list of the files that are included by a file in the documentation 
     456# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     457# will put a list of the files that are included by a file in the documentation
    409458# of that file.
    410459
    411460SHOW_INCLUDE_FILES     = YES
    412461
    413 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     462# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
     463# will list include files with double quotes in the documentation
     464# rather than with sharp brackets.
     465
     466FORCE_LOCAL_INCLUDES   = NO
     467
     468# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    414469# is inserted in the documentation for inline members.
    415470
    416471INLINE_INFO            = YES
    417472
    418 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
    419 # will sort the (detailed) documentation of file and class members 
    420 # alphabetically by member name. If set to NO the members will appear in 
     473# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     474# will sort the (detailed) documentation of file and class members
     475# alphabetically by member name. If set to NO the members will appear in
    421476# declaration order.
    422477
    423478SORT_MEMBER_DOCS       = YES
    424479
    425 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
    426 # brief documentation of file, namespace and class members alphabetically 
    427 # by member name. If set to NO (the default) the members will appear in 
     480# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     481# brief documentation of file, namespace and class members alphabetically
     482# by member name. If set to NO (the default) the members will appear in
    428483# declaration order.
    429484
     
    440495SORT_MEMBERS_CTORS_1ST = NO
    441496
    442 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
    443 # hierarchy of group names into alphabetical order. If set to NO (the default) 
     497# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
     498# hierarchy of group names into alphabetical order. If set to NO (the default)
    444499# the group names will appear in their defined order.
    445500
    446501SORT_GROUP_NAMES       = NO
    447502
    448 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
    449 # sorted by fully-qualified names, including namespaces. If set to 
    450 # NO (the default), the class list will be sorted only by class name, 
    451 # not including the namespace part. 
    452 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
    453 # Note: This option applies only to the class list, not to the 
     503# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     504# sorted by fully-qualified names, including namespaces. If set to
     505# NO (the default), the class list will be sorted only by class name,
     506# not including the namespace part.
     507# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     508# Note: This option applies only to the class list, not to the
    454509# alphabetical list.
    455510
    456511SORT_BY_SCOPE_NAME     = NO
    457512
    458 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    459 # disable (NO) the todo list. This list is created by putting \todo
     513# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
     514# do proper type resolution of all parameters of a function it will reject a
     515# match between the prototype and the implementation of a member function even
     516# if there is only one candidate or it is obvious which candidate to choose
     517# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
     518# will still accept a match between prototype and implementation in such cases.
     519
     520STRICT_PROTO_MATCHING  = NO
     521
     522# The GENERATE_TODOLIST tag can be used to enable (YES) or
     523# disable (NO) the todo list. This list is created by putting \todo
    460524# commands in the documentation.
    461525
    462526GENERATE_TODOLIST      = YES
    463527
    464 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
    465 # disable (NO) the test list. This list is created by putting \test 
     528# The GENERATE_TESTLIST tag can be used to enable (YES) or
     529# disable (NO) the test list. This list is created by putting \test
    466530# commands in the documentation.
    467531
    468532GENERATE_TESTLIST      = YES
    469533
    470 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
    471 # disable (NO) the bug list. This list is created by putting \bug 
     534# The GENERATE_BUGLIST tag can be used to enable (YES) or
     535# disable (NO) the bug list. This list is created by putting \bug
    472536# commands in the documentation.
    473537
    474538GENERATE_BUGLIST       = YES
    475539
    476 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
    477 # disable (NO) the deprecated list. This list is created by putting 
     540# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
     541# disable (NO) the deprecated list. This list is created by putting
    478542# \deprecated commands in the documentation.
    479543
    480544GENERATE_DEPRECATEDLIST= YES
    481545
    482 # The ENABLED_SECTIONS tag can be used to enable conditional 
     546# The ENABLED_SECTIONS tag can be used to enable conditional
    483547# documentation sections, marked by \if sectionname ... \endif.
    484548
    485 ENABLED_SECTIONS       = 
    486 
    487 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
    488 # the initial value of a variable or define consists of for it to appear in
    489 # the documentation. If the initializer consists of more lines than specified 
    490 # here it will be hidden. Use a value of 0 to hide initializers completely. 
    491 # The appearance of the initializer of individual variables and defines in the
    492 # documentation can be controlled using \showinitializer or \hideinitializer 
     549ENABLED_SECTIONS       =
     550
     551# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     552# the initial value of a variable or macro consists of for it to appear in
     553# the documentation. If the initializer consists of more lines than specified
     554# here it will be hidden. Use a value of 0 to hide initializers completely.
     555# The appearance of the initializer of individual variables and macros in the
     556# documentation can be controlled using \showinitializer or \hideinitializer
    493557# command in the documentation regardless of this setting.
    494558
    495559MAX_INITIALIZER_LINES  = 30
    496560
    497 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
    498 # at the bottom of the documentation of classes and structs. If set to YES the 
     561# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
     562# at the bottom of the documentation of classes and structs. If set to YES the
    499563# list will mention the files that were used to generate the documentation.
    500564
    501565SHOW_USED_FILES        = YES
    502566
    503 # If the sources in your project are distributed over multiple directories
    504 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    505 # in the documentation. The default is NO.
    506 
    507 SHOW_DIRECTORIES       = NO
    508 
    509 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    510 # This will remove the Files entry from the Quick Index and from the
     567# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
     568# This will remove the Files entry from the Quick Index and from the
    511569# Folder Tree View (if specified). The default is YES.
    512570
    513571SHOW_FILES             = YES
    514572
    515 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
    516 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
     573# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
     574# Namespaces page.
     575# This will remove the Namespaces entry from the Quick Index
    517576# and from the Folder Tree View (if specified). The default is YES.
    518577
    519578SHOW_NAMESPACES        = YES
    520579
    521 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
    522 # doxygen should invoke to get the current version for each file (typically from 
    523 # the version control system). Doxygen will invoke the program by executing (via 
    524 # popen()) the command <command> <input-file>, where <command> is the value of 
    525 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
    526 # provided by doxygen. Whatever the program writes to standard output 
     580# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     581# doxygen should invoke to get the current version for each file (typically from
     582# the version control system). Doxygen will invoke the program by executing (via
     583# popen()) the command <command> <input-file>, where <command> is the value of
     584# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     585# provided by doxygen. Whatever the program writes to standard output
    527586# is used as the file version. See the manual for examples.
    528587
    529 FILE_VERSION_FILTER    =
    530 
    531 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
    532 # doxygen. The layout file controls the global structure of the generated output files
    533 # in an output format independent way. The create the layout file that represents
    534 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
    535 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
    536 # of the layout file.
    537 
    538 LAYOUT_FILE            =
     588FILE_VERSION_FILTER    =
     589
     590# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
     591# by doxygen. The layout file controls the global structure of the generated
     592# output files in an output format independent way. To create the layout file
     593# that represents doxygen's defaults, run doxygen with the -l option.
     594# You can optionally specify a file name after the option, if omitted
     595# DoxygenLayout.xml will be used as the name of the layout file.
     596
     597LAYOUT_FILE            =
     598
     599# The CITE_BIB_FILES tag can be used to specify one or more bib files
     600# containing the references data. This must be a list of .bib files. The
     601# .bib extension is automatically appended if omitted. Using this command
     602# requires the bibtex tool to be installed. See also
     603# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
     604# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
     605# feature you need bibtex and perl available in the search path.
     606
     607CITE_BIB_FILES         =
    539608
    540609#---------------------------------------------------------------------------
     
    542611#---------------------------------------------------------------------------
    543612
    544 # The QUIET tag can be used to turn on/off the messages that are generated 
     613# The QUIET tag can be used to turn on/off the messages that are generated
    545614# by doxygen. Possible values are YES and NO. If left blank NO is used.
    546615
    547616QUIET                  = NO
    548617
    549 # The WARNINGS tag can be used to turn on/off the warning messages that are 
    550 # generated by doxygen. Possible values are YES and NO. If left blank 
     618# The WARNINGS tag can be used to turn on/off the warning messages that are
     619# generated by doxygen. Possible values are YES and NO. If left blank
    551620# NO is used.
    552621
    553622WARNINGS               = YES
    554623
    555 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
    556 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
     624# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     625# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    557626# automatically be disabled.
    558627
    559628WARN_IF_UNDOCUMENTED   = YES
    560629
    561 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
    562 # potential errors in the documentation, such as not documenting some 
    563 # parameters in a documented function, or documenting parameters that 
     630# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
     631# potential errors in the documentation, such as not documenting some
     632# parameters in a documented function, or documenting parameters that
    564633# don't exist or using markup commands wrongly.
    565634
    566635WARN_IF_DOC_ERROR      = YES
    567636
    568 # This WARN_NO_PARAMDOC option can be abled to get warnings for
    569 # functions that are documented, but have no documentation for their parameters 
    570 # or return value. If set to NO (the default) doxygen will only warn about 
    571 # wrong or incomplete parameter documentation, but not about the absence of 
     637# The WARN_NO_PARAMDOC option can be enabled to get warnings for
     638# functions that are documented, but have no documentation for their parameters
     639# or return value. If set to NO (the default) doxygen will only warn about
     640# wrong or incomplete parameter documentation, but not about the absence of
    572641# documentation.
    573642
    574643WARN_NO_PARAMDOC       = NO
    575644
    576 # The WARN_FORMAT tag determines the format of the warning messages that 
    577 # doxygen can produce. The string should contain the $file, $line, and $text 
    578 # tags, which will be replaced by the file and line number from which the 
    579 # warning originated and the warning text. Optionally the format may contain 
    580 # $version, which will be replaced by the version of the file (if it could 
     645# The WARN_FORMAT tag determines the format of the warning messages that
     646# doxygen can produce. The string should contain the $file, $line, and $text
     647# tags, which will be replaced by the file and line number from which the
     648# warning originated and the warning text. Optionally the format may contain
     649# $version, which will be replaced by the version of the file (if it could
    581650# be obtained via FILE_VERSION_FILTER)
    582651
    583652WARN_FORMAT            = "$file:$line: $text"
    584653
    585 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    586 # and error messages should be written. If left blank the output is written 
     654# The WARN_LOGFILE tag can be used to specify a file to which warning
     655# and error messages should be written. If left blank the output is written
    587656# to stderr.
    588657
    589 WARN_LOGFILE           = 
     658WARN_LOGFILE           =
    590659
    591660#---------------------------------------------------------------------------
     
    593662#---------------------------------------------------------------------------
    594663
    595 # The INPUT tag can be used to specify the files and/or directories that contain 
    596 # documented source files. You may enter file names like "myfile.cpp" or 
    597 # directories like "/usr/src/myproject". Separate the files or directories 
     664# The INPUT tag can be used to specify the files and/or directories that contain
     665# documented source files. You may enter file names like "myfile.cpp" or
     666# directories like "/usr/src/myproject". Separate the files or directories
    598667# with spaces.
    599668
    600 INPUT                  = src doc/dox
    601 
    602 # This tag can be used to specify the character encoding of the source files
    603 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
    604 # also the default input encoding. Doxygen uses libiconv (or the iconv built
    605 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     669INPUT                  = src \
     670                         doc/dox
     671
     672# This tag can be used to specify the character encoding of the source files
     673# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     674# also the default input encoding. Doxygen uses libiconv (or the iconv built
     675# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
    606676# the list of possible encodings.
    607677
    608678INPUT_ENCODING         = UTF-8
    609679
    610 # If the value of the INPUT tag contains directories, you can use the
    611 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    612 # and *.h) to filter out the source-files in the directories. If left
    613 # blank the following patterns are tested:
    614 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
    615 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     680# If the value of the INPUT tag contains directories, you can use the
     681# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     682# and *.h) to filter out the source-files in the directories. If left
     683# blank the following patterns are tested:
     684# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
     685# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
     686# *.f90 *.f *.for *.vhd *.vhdl
    616687
    617688FILE_PATTERNS          = *.c \
     
    647718                         *.vhdl
    648719
    649 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
    650 # should be searched for input files as well. Possible values are YES and NO. 
     720# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     721# should be searched for input files as well. Possible values are YES and NO.
    651722# If left blank NO is used.
    652723
    653724RECURSIVE              = NO
    654725
    655 # The EXCLUDE tag can be used to specify files and/or directories that should
    656 # excluded from the INPUT source files. This way you can easily exclude a 
     726# The EXCLUDE tag can be used to specify files and/or directories that should be
     727# excluded from the INPUT source files. This way you can easily exclude a
    657728# subdirectory from a directory tree whose root is specified with the INPUT tag.
     729# Note that relative paths are relative to the directory from which doxygen is
     730# run.
    658731
    659732EXCLUDE                = src/_.h
    660733
    661 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    662 # directories that are symbolic links (a Unix filesystem feature) are excluded
     734# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
     735# directories that are symbolic links (a Unix file system feature) are excluded
    663736# from the input.
    664737
    665738EXCLUDE_SYMLINKS       = NO
    666739
    667 # If the value of the INPUT tag contains directories, you can use the 
    668 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
    669 # certain files from those directories. Note that the wildcards are matched 
    670 # against the file with absolute path, so to exclude all test directories 
     740# If the value of the INPUT tag contains directories, you can use the
     741# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     742# certain files from those directories. Note that the wildcards are matched
     743# against the file with absolute path, so to exclude all test directories
    671744# for example use the pattern */test/*
    672745
    673 EXCLUDE_PATTERNS       = 
    674 
    675 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
    676 # (namespaces, classes, functions, etc.) that should be excluded from the 
    677 # output. The symbol name can be a fully qualified name, a word, or if the 
    678 # wildcard * is used, a substring. Examples: ANamespace, AClass, 
     746EXCLUDE_PATTERNS       =
     747
     748# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     749# (namespaces, classes, functions, etc.) that should be excluded from the
     750# output. The symbol name can be a fully qualified name, a word, or if the
     751# wildcard * is used, a substring. Examples: ANamespace, AClass,
    679752# AClass::ANamespace, ANamespace::*Test
    680753
    681 EXCLUDE_SYMBOLS        = 
    682 
    683 # The EXAMPLE_PATH tag can be used to specify one or more files or 
    684 # directories that contain example code fragments that are included (see 
     754EXCLUDE_SYMBOLS        =
     755
     756# The EXAMPLE_PATH tag can be used to specify one or more files or
     757# directories that contain example code fragments that are included (see
    685758# the \include command).
    686759
    687760EXAMPLE_PATH           = .
    688761
    689 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    690 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    691 # and *.h) to filter out the source-files in the directories. If left 
     762# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     763# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     764# and *.h) to filter out the source-files in the directories. If left
    692765# blank all files are included.
    693766
    694767EXAMPLE_PATTERNS       = *
    695768
    696 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    697 # searched for input files to be used with the \include or \dontinclude 
    698 # commands irrespective of the value of the RECURSIVE tag. 
     769# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     770# searched for input files to be used with the \include or \dontinclude
     771# commands irrespective of the value of the RECURSIVE tag.
    699772# Possible values are YES and NO. If left blank NO is used.
    700773
    701774EXAMPLE_RECURSIVE      = NO
    702775
    703 # The IMAGE_PATH tag can be used to specify one or more files or 
    704 # directories that contain image that are included in the documentation (see 
     776# The IMAGE_PATH tag can be used to specify one or more files or
     777# directories that contain image that are included in the documentation (see
    705778# the \image command).
    706779
    707780IMAGE_PATH             = resources
    708781
    709 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    710 # invoke to filter for each input file. Doxygen will invoke the filter program
    711 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    712 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    713 # input file. Doxygen will then use the output that the filter program writes
    714 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
     782# The INPUT_FILTER tag can be used to specify a program that doxygen should
     783# invoke to filter for each input file. Doxygen will invoke the filter program
     784# by executing (via popen()) the command <filter> <input-file>, where <filter>
     785# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     786# input file. Doxygen will then use the output that the filter program writes
     787# to standard output.
     788# If FILTER_PATTERNS is specified, this tag will be
    715789# ignored.
    716790
    717 INPUT_FILTER           =
    718 
    719 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    720 # basis.  Doxygen will compare the file name with each pattern and apply the
    721 # filter if there is a match.  The filters are a list of the form:
    722 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    723 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    724 # is applied to all files.
    725 
    726 FILTER_PATTERNS        =
    727 
    728 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    729 # INPUT_FILTER) will be used to filter the input files when producing source
     791INPUT_FILTER           =
     792
     793# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     794# basis.
     795# Doxygen will compare the file name with each pattern and apply the
     796# filter if there is a match.
     797# The filters are a list of the form:
     798# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     799# info on how filters are used. If FILTER_PATTERNS is empty or if
     800# non of the patterns match the file name, INPUT_FILTER is applied.
     801
     802FILTER_PATTERNS        =
     803
     804# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     805# INPUT_FILTER) will be used to filter the input files when producing source
    730806# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    731807
    732808FILTER_SOURCE_FILES    = NO
    733809
     810# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
     811# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
     812# and it is also possible to disable source filtering for a specific pattern
     813# using *.ext= (so without naming a filter). This option only has effect when
     814# FILTER_SOURCE_FILES is enabled.
     815
     816FILTER_SOURCE_PATTERNS =
     817
    734818#---------------------------------------------------------------------------
    735819# configuration options related to source browsing
    736820#---------------------------------------------------------------------------
    737821
    738 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
    739 # be generated. Documented entities will be cross-referenced with these sources. 
    740 # Note: To get rid of all source code in the generated output, make sure also 
     822# If the SOURCE_BROWSER tag is set to YES then a list of source files will
     823# be generated. Documented entities will be cross-referenced with these sources.
     824# Note: To get rid of all source code in the generated output, make sure also
    741825# VERBATIM_HEADERS is set to NO.
    742826
    743827SOURCE_BROWSER         = NO
    744828
    745 # Setting the INLINE_SOURCES tag to YES will include the body 
     829# Setting the INLINE_SOURCES tag to YES will include the body
    746830# of functions and classes directly in the documentation.
    747831
    748832INLINE_SOURCES         = NO
    749833
    750 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    751 # doxygen to hide any special comment blocks from generated source code 
    752 # fragments. Normal C and C++ comments will always remain visible.
     834# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     835# doxygen to hide any special comment blocks from generated source code
     836# fragments. Normal C, C++ and Fortran comments will always remain visible.
    753837
    754838STRIP_CODE_COMMENTS    = YES
    755839
    756 # If the REFERENCED_BY_RELATION tag is set to YES 
    757 # then for each documented function all documented 
     840# If the REFERENCED_BY_RELATION tag is set to YES
     841# then for each documented function all documented
    758842# functions referencing it will be listed.
    759843
    760844REFERENCED_BY_RELATION = NO
    761845
    762 # If the REFERENCES_RELATION tag is set to YES 
    763 # then for each documented function all documented entities 
     846# If the REFERENCES_RELATION tag is set to YES
     847# then for each documented function all documented entities
    764848# called/used by that function will be listed.
    765849
    766850REFERENCES_RELATION    = NO
    767851
    768 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
    769 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    770 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    771 # link to the source code.  Otherwise they will link to the documentation.
     852# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     853# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     854# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     855# link to the source code.
     856# Otherwise they will link to the documentation.
    772857
    773858REFERENCES_LINK_SOURCE = YES
    774859
    775 # If the USE_HTAGS tag is set to YES then the references to source code 
    776 # will point to the HTML generated by the htags(1) tool instead of doxygen 
    777 # built-in source browser. The htags tool is part of GNU's global source 
    778 # tagging system (see http://www.gnu.org/software/global/global.html). You 
     860# If the USE_HTAGS tag is set to YES then the references to source code
     861# will point to the HTML generated by the htags(1) tool instead of doxygen
     862# built-in source browser. The htags tool is part of GNU's global source
     863# tagging system (see http://www.gnu.org/software/global/global.html). You
    779864# will need version 4.8.6 or higher.
    780865
    781866USE_HTAGS              = NO
    782867
    783 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
    784 # will generate a verbatim copy of the header file for each class for 
     868# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     869# will generate a verbatim copy of the header file for each class for
    785870# which an include is specified. Set to NO to disable this.
    786871
     
    791876#---------------------------------------------------------------------------
    792877
    793 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    794 # of all compounds will be generated. Enable this if the project 
     878# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     879# of all compounds will be generated. Enable this if the project
    795880# contains a lot of classes, structs, unions or interfaces.
    796881
    797882ALPHABETICAL_INDEX     = NO
    798883
    799 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    800 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     884# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     885# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    801886# in which this list will be split (can be a number in the range [1..20])
    802887
    803888COLS_IN_ALPHA_INDEX    = 5
    804889
    805 # In case all classes in a project start with a common prefix, all 
    806 # classes will be put under the same header in the alphabetical index. 
    807 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     890# In case all classes in a project start with a common prefix, all
     891# classes will be put under the same header in the alphabetical index.
     892# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    808893# should be ignored while generating the index headers.
    809894
    810 IGNORE_PREFIX          = 
     895IGNORE_PREFIX          =
    811896
    812897#---------------------------------------------------------------------------
     
    814899#---------------------------------------------------------------------------
    815900
    816 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     901# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    817902# generate HTML output.
    818903
    819904GENERATE_HTML          = YES
    820905
    821 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    822 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     906# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     907# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    823908# put in front of it. If left blank `html' will be used as the default path.
    824909
    825910HTML_OUTPUT            = html
    826911
    827 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    828 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
     912# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     913# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    829914# doxygen will generate files with .html extension.
    830915
    831916HTML_FILE_EXTENSION    = .html
    832917
    833 # The HTML_HEADER tag can be used to specify a personal HTML header for
    834 # each generated HTML page. If it is left blank doxygen will generate a
    835 # standard header.
    836 
    837 HTML_HEADER            =
    838 
    839 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
    840 # each generated HTML page. If it is left blank doxygen will generate a
     918# The HTML_HEADER tag can be used to specify a personal HTML header for
     919# each generated HTML page. If it is left blank doxygen will generate a
     920# standard header. Note that when using a custom header you are responsible
     921#  for the proper inclusion of any scripts and style sheets that doxygen
     922# needs, which is dependent on the configuration options used.
     923# It is advised to generate a default header using "doxygen -w html
     924# header.html footer.html stylesheet.css YourConfigFile" and then modify
     925# that header. Note that the header is subject to change so you typically
     926# have to redo this when upgrading to a newer version of doxygen or when
     927# changing the value of configuration settings such as GENERATE_TREEVIEW!
     928
     929HTML_HEADER            =
     930
     931# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     932# each generated HTML page. If it is left blank doxygen will generate a
    841933# standard footer.
    842934
    843 HTML_FOOTER            =
    844 
    845 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    846 # style sheet that is used by each HTML page. It can be used to
    847 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    848 # will generate a default style sheet. Note that doxygen will try to copy
    849 # the style sheet file to the HTML output directory, so don't put your own
    850 # stylesheet in the HTML output directory as well, or it will be erased!
    851 
    852 HTML_STYLESHEET        =
    853 
    854 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    855 # files or namespaces will be aligned in HTML using tables. If set to
    856 # NO a bullet list will be used.
    857 
    858 HTML_ALIGN_MEMBERS     = YES
    859 
    860 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    861 # documentation will contain sections that can be hidden and shown after the
    862 # page has loaded. For this to work a browser that supports
    863 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    864 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     935HTML_FOOTER            =
     936
     937# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     938# style sheet that is used by each HTML page. It can be used to
     939# fine-tune the look of the HTML output. If the tag is left blank doxygen
     940# will generate a default style sheet. Note that doxygen will try to copy
     941# the style sheet file to the HTML output directory, so don't put your own
     942# style sheet in the HTML output directory as well, or it will be erased!
     943
     944HTML_STYLESHEET        =
     945
     946# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
     947# other source files which should be copied to the HTML output directory. Note
     948# that these files will be copied to the base HTML output directory. Use the
     949# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     950# files. In the HTML_STYLESHEET file, use the file name only. Also note that
     951# the files will be copied as-is; there are no commands or markers available.
     952
     953HTML_EXTRA_FILES       =
     954
     955# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
     956# Doxygen will adjust the colors in the style sheet and background images
     957# according to this color. Hue is specified as an angle on a colorwheel,
     958# see http://en.wikipedia.org/wiki/Hue for more information.
     959# For instance the value 0 represents red, 60 is yellow, 120 is green,
     960# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
     961# The allowed range is 0 to 359.
     962
     963HTML_COLORSTYLE_HUE    = 220
     964
     965# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
     966# the colors in the HTML output. For a value of 0 the output will use
     967# grayscales only. A value of 255 will produce the most vivid colors.
     968
     969HTML_COLORSTYLE_SAT    = 100
     970
     971# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
     972# the luminance component of the colors in the HTML output. Values below
     973# 100 gradually make the output lighter, whereas values above 100 make
     974# the output darker. The value divided by 100 is the actual gamma applied,
     975# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
     976# and 100 does not change the gamma.
     977
     978HTML_COLORSTYLE_GAMMA  = 80
     979
     980# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
     981# page will contain the date and time when the page was generated. Setting
     982# this to NO can help when comparing the output of multiple runs.
     983
     984HTML_TIMESTAMP         = YES
     985
     986# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     987# documentation will contain sections that can be hidden and shown after the
     988# page has loaded.
    865989
    866990HTML_DYNAMIC_SECTIONS  = YES
    867991
    868 # If the GENERATE_DOCSET tag is set to YES, additional index files
    869 # will be generated that can be used as input for Apple's Xcode 3
    870 # integrated development environment, introduced with OSX 10.5 (Leopard).
    871 # To create a documentation set, doxygen will generate a Makefile in the
    872 # HTML output directory. Running make will produce the docset in that
    873 # directory and running "make install" will install the docset in
    874 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    875 # it at startup.
    876 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     992# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
     993# entries shown in the various tree structured indices initially; the user
     994# can expand and collapse entries dynamically later on. Doxygen will expand
     995# the tree to such a level that at most the specified number of entries are
     996# visible (unless a fully collapsed tree already exceeds this amount).
     997# So setting the number of entries 1 will produce a full collapsed tree by
     998# default. 0 is a special value representing an infinite number of entries
     999# and will result in a full expanded tree by default.
     1000
     1001HTML_INDEX_NUM_ENTRIES = 100
     1002
     1003# If the GENERATE_DOCSET tag is set to YES, additional index files
     1004# will be generated that can be used as input for Apple's Xcode 3
     1005# integrated development environment, introduced with OSX 10.5 (Leopard).
     1006# To create a documentation set, doxygen will generate a Makefile in the
     1007# HTML output directory. Running make will produce the docset in that
     1008# directory and running "make install" will install the docset in
     1009# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     1010# it at startup.
     1011# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1012# for more information.
    8771013
    8781014GENERATE_DOCSET        = NO
    8791015
    880 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
    881 # feed. A documentation feed provides an umbrella under which multiple 
    882 # documentation sets from a single provider (such as a company or product suite) 
     1016# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     1017# feed. A documentation feed provides an umbrella under which multiple
     1018# documentation sets from a single provider (such as a company or product suite)
    8831019# can be grouped.
    8841020
    8851021DOCSET_FEEDNAME        = "Doxygen generated docs"
    8861022
    887 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
    888 # should uniquely identify the documentation set bundle. This should be a 
    889 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
     1023# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     1024# should uniquely identify the documentation set bundle. This should be a
     1025# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    8901026# will append .docset to the name.
    8911027
    8921028DOCSET_BUNDLE_ID       = org.doxygen.Project
    8931029
    894 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    895 # will be generated that can be used as input for tools like the
    896 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
     1030# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
     1031# the documentation publisher. This should be a reverse domain-name style
     1032# string, e.g. com.mycompany.MyDocSet.documentation.
     1033
     1034DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
     1035
     1036# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
     1037
     1038DOCSET_PUBLISHER_NAME  = Publisher
     1039
     1040# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     1041# will be generated that can be used as input for tools like the
     1042# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    8971043# of the generated HTML documentation.
    8981044
    8991045GENERATE_HTMLHELP      = NO
    9001046
    901 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
    902 # be used to specify the file name of the resulting .chm file. You 
    903 # can add a path in front of the file if the result should not be 
     1047# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     1048# be used to specify the file name of the resulting .chm file. You
     1049# can add a path in front of the file if the result should not be
    9041050# written to the html output directory.
    9051051
    906 CHM_FILE               = 
    907 
    908 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    909 # be used to specify the location (absolute path including file name) of 
    910 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
     1052CHM_FILE               =
     1053
     1054# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     1055# be used to specify the location (absolute path including file name) of
     1056# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    9111057# the HTML help compiler on the generated index.hhp.
    9121058
    913 HHC_LOCATION           = 
    914 
    915 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    916 # controls if a separate .chi index file is generated (YES) or that 
     1059HHC_LOCATION           =
     1060
     1061# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     1062# controls if a separate .chi index file is generated (YES) or that
    9171063# it should be included in the master .chm file (NO).
    9181064
    9191065GENERATE_CHI           = NO
    9201066
    921 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
    922 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 
     1067# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     1068# is used to encode HtmlHelp index (hhk), content (hhc) and project file
    9231069# content.
    9241070
    925 CHM_INDEX_ENCODING     = 
    926 
    927 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
    928 # controls whether a binary table of contents is generated (YES) or a 
     1071CHM_INDEX_ENCODING     =
     1072
     1073# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     1074# controls whether a binary table of contents is generated (YES) or a
    9291075# normal table of contents (NO) in the .chm file.
    9301076
    9311077BINARY_TOC             = NO
    9321078
    933 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     1079# The TOC_EXPAND flag can be set to YES to add extra items for group members
    9341080# to the contents of the HTML help documentation and to the tree view.
    9351081
    9361082TOC_EXPAND             = NO
    9371083
    938 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
    939 # are set, an additional index file will be generated that can be used as input for
    940 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
    941 # HTML documentation.
     1084# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
     1085# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
     1086# that can be used as input for Qt's qhelpgenerator to generate a
     1087# Qt Compressed Help (.qch) of the generated HTML documentation.
    9421088
    9431089GENERATE_QHP           = NO
    9441090
    945 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
    946 # be used to specify the file name of the resulting .qch file. 
     1091# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     1092# be used to specify the file name of the resulting .qch file.
    9471093# The path specified is relative to the HTML output folder.
    9481094
    949 QCH_FILE               = 
    950 
    951 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
    952 # Qt Help Project output. For more information please see 
     1095QCH_FILE               =
     1096
     1097# The QHP_NAMESPACE tag specifies the namespace to use when generating
     1098# Qt Help Project output. For more information please see
    9531099# http://doc.trolltech.com/qthelpproject.html#namespace
    9541100
    955 QHP_NAMESPACE          = 
    956 
    957 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
    958 # Qt Help Project output. For more information please see 
     1101QHP_NAMESPACE          =
     1102
     1103# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     1104# Qt Help Project output. For more information please see
    9591105# http://doc.trolltech.com/qthelpproject.html#virtual-folders
    9601106
    9611107QHP_VIRTUAL_FOLDER     = doc
    9621108
    963 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
    964 # For more information please see
     1109# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
     1110# add. For more information please see
    9651111# http://doc.trolltech.com/qthelpproject.html#custom-filters
    9661112
    967 QHP_CUST_FILTER_NAME   =
    968 
    969 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
    970 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
    971 
    972 QHP_CUST_FILTER_ATTRS  =
    973 
    974 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
    975 # filter section matches.
    976 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
    977 
    978 QHP_SECT_FILTER_ATTRS  =
    979 
    980 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    981 # be used to specify the location of Qt's qhelpgenerator.
    982 # If non-empty doxygen will try to run qhelpgenerator on the generated
     1113QHP_CUST_FILTER_NAME   =
     1114
     1115# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
     1116# custom filter to add. For more information please see
     1117# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
     1118# Qt Help Project / Custom Filters</a>.
     1119
     1120QHP_CUST_FILTER_ATTRS  =
     1121
     1122# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
     1123# project's
     1124# filter section matches.
     1125# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
     1126# Qt Help Project / Filter Attributes</a>.
     1127
     1128QHP_SECT_FILTER_ATTRS  =
     1129
     1130# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     1131# be used to specify the location of Qt's qhelpgenerator.
     1132# If non-empty doxygen will try to run qhelpgenerator on the generated
    9831133# .qhp file.
    9841134
    985 QHG_LOCATION           =
    986 
    987 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    988 # top of each HTML page. The value NO (the default) enables the index and
    989 # the value YES disables it.
     1135QHG_LOCATION           =
     1136
     1137# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
     1138#  will be generated, which together with the HTML files, form an Eclipse help
     1139# plugin. To install this plugin and make it available under the help contents
     1140# menu in Eclipse, the contents of the directory containing the HTML and XML
     1141# files needs to be copied into the plugins directory of eclipse. The name of
     1142# the directory within the plugins directory should be the same as
     1143# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
     1144# the help appears.
     1145
     1146GENERATE_ECLIPSEHELP   = NO
     1147
     1148# A unique identifier for the eclipse help plugin. When installing the plugin
     1149# the directory name containing the HTML and XML files should also have
     1150# this name.
     1151
     1152ECLIPSE_DOC_ID         = org.doxygen.Project
     1153
     1154# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
     1155# at top of each HTML page. The value NO (the default) enables the index and
     1156# the value YES disables it. Since the tabs have the same information as the
     1157# navigation tree you can set this option to NO if you already set
     1158# GENERATE_TREEVIEW to YES.
    9901159
    9911160DISABLE_INDEX          = NO
    9921161
    993 # This tag can be used to set the number of enum values (range [1..20])
    994 # that doxygen will group on one line in the generated HTML documentation.
     1162# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     1163# structure should be generated to display hierarchical information.
     1164# If the tag value is set to YES, a side panel will be generated
     1165# containing a tree-like index structure (just like the one that
     1166# is generated for HTML Help). For this to work a browser that supports
     1167# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
     1168# Windows users are probably better off using the HTML help feature.
     1169# Since the tree basically has the same information as the tab index you
     1170# could consider to set DISABLE_INDEX to NO when enabling this option.
     1171
     1172GENERATE_TREEVIEW      = NO
     1173
     1174# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
     1175# (range [0,1..20]) that doxygen will group on one line in the generated HTML
     1176# documentation. Note that a value of 0 will completely suppress the enum
     1177# values from appearing in the overview section.
    9951178
    9961179ENUM_VALUES_PER_LINE   = 4
    9971180
    998 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    999 # structure should be generated to display hierarchical information.
    1000 # If the tag value is set to YES, a side panel will be generated
    1001 # containing a tree-like index structure (just like the one that
    1002 # is generated for HTML Help). For this to work a browser that supports
    1003 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    1004 # Windows users are probably better off using the HTML help feature.
    1005 
    1006 GENERATE_TREEVIEW      = NO
    1007 
    1008 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
    1009 # and Class Hierarchy pages using a tree view instead of an ordered list.
    1010 
    1011 USE_INLINE_TREES       = NO
    1012 
    1013 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    1014 # used to set the initial width (in pixels) of the frame in which the tree
     1181# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     1182# used to set the initial width (in pixels) of the frame in which the tree
    10151183# is shown.
    10161184
    10171185TREEVIEW_WIDTH         = 250
    10181186
    1019 # Use this tag to change the font size of Latex formulas included
    1020 # as images in the HTML documentation. The default is 10. Note that
    1021 # when you change the font size after a successful doxygen run you need
    1022 # to manually remove any form_*.png images from the HTML output directory
     1187# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
     1188# links to external symbols imported via tag files in a separate window.
     1189
     1190EXT_LINKS_IN_WINDOW    = NO
     1191
     1192# Use this tag to change the font size of Latex formulas included
     1193# as images in the HTML documentation. The default is 10. Note that
     1194# when you change the font size after a successful doxygen run you need
     1195# to manually remove any form_*.png images from the HTML output directory
    10231196# to force them to be regenerated.
    10241197
    10251198FORMULA_FONTSIZE       = 10
    10261199
    1027 # When the SEARCHENGINE tag is enable doxygen will generate a search box
    1028 # for the HTML output. The underlying search engine uses javascript
     1200# Use the FORMULA_TRANPARENT tag to determine whether or not the images
     1201# generated for formulas are transparent PNGs. Transparent PNGs are
     1202# not supported properly for IE 6.0, but are supported on all modern browsers.
     1203# Note that when changing this option you need to delete any form_*.png files
     1204# in the HTML output before the changes have effect.
     1205
     1206FORMULA_TRANSPARENT    = YES
     1207
     1208# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
     1209# (see http://www.mathjax.org) which uses client side Javascript for the
     1210# rendering instead of using prerendered bitmaps. Use this if you do not
     1211# have LaTeX installed or if you want to formulas look prettier in the HTML
     1212# output. When enabled you may also need to install MathJax separately and
     1213# configure the path to it using the MATHJAX_RELPATH option.
     1214
     1215USE_MATHJAX            = NO
     1216
     1217# When MathJax is enabled you need to specify the location relative to the
     1218# HTML output directory using the MATHJAX_RELPATH option. The destination
     1219# directory should contain the MathJax.js script. For instance, if the mathjax
     1220# directory is located at the same level as the HTML output directory, then
     1221# MATHJAX_RELPATH should be ../mathjax. The default value points to
     1222# the MathJax Content Delivery Network so you can quickly see the result without
     1223# installing MathJax.
     1224# However, it is strongly recommended to install a local
     1225# copy of MathJax from http://www.mathjax.org before deployment.
     1226
     1227MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1228
     1229# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
     1230# names that should be enabled during MathJax rendering.
     1231
     1232MATHJAX_EXTENSIONS     =
     1233
     1234# When the SEARCHENGINE tag is enabled doxygen will generate a search box
     1235# for the HTML output. The underlying search engine uses javascript
    10291236# and DHTML and should work on any modern browser. Note that when using
    1030 # HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
    1031 # there is already a search function so this one should typically
    1032 # be disabled.
     1237# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
     1238# (GENERATE_DOCSET) there is already a search function so this one should
     1239# typically be disabled. For large projects the javascript based search engine
     1240# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
    10331241
    10341242SEARCHENGINE           = YES
    10351243
     1244# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
     1245# implemented using a PHP enabled web server instead of at the web client
     1246# using Javascript. Doxygen will generate the search PHP script and index
     1247# file to put on the web server. The advantage of the server
     1248# based approach is that it scales better to large projects and allows
     1249# full text search. The disadvantages are that it is more difficult to setup
     1250# and does not have live searching capabilities.
     1251
     1252SERVER_BASED_SEARCH    = NO
     1253
    10361254#---------------------------------------------------------------------------
    10371255# configuration options related to the LaTeX output
    10381256#---------------------------------------------------------------------------
    10391257
    1040 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     1258# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    10411259# generate Latex output.
    10421260
    10431261GENERATE_LATEX         = NO
    10441262
    1045 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    1046 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1263# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     1264# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    10471265# put in front of it. If left blank `latex' will be used as the default path.
    10481266
    10491267LATEX_OUTPUT           = latex
    10501268
    1051 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
     1269# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    10521270# invoked. If left blank `latex' will be used as the default command name.
     1271# Note that when enabling USE_PDFLATEX this option is only used for
     1272# generating bitmaps for formulas in the HTML output, but not in the
     1273# Makefile that is written to the output directory.
    10531274
    10541275LATEX_CMD_NAME         = latex
    10551276
    1056 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
    1057 # generate index for LaTeX. If left blank `makeindex' will be used as the 
     1277# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     1278# generate index for LaTeX. If left blank `makeindex' will be used as the
    10581279# default command name.
    10591280
    10601281MAKEINDEX_CMD_NAME     = makeindex
    10611282
    1062 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    1063 # LaTeX documents. This may be useful for small projects and may help to 
     1283# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     1284# LaTeX documents. This may be useful for small projects and may help to
    10641285# save some trees in general.
    10651286
    10661287COMPACT_LATEX          = NO
    10671288
    1068 # The PAPER_TYPE tag can be used to set the paper type that is used 
    1069 # by the printer. Possible values are: a4, a4wide, letter, legal and
     1289# The PAPER_TYPE tag can be used to set the paper type that is used
     1290# by the printer. Possible values are: a4, letter, legal and
    10701291# executive. If left blank a4wide will be used.
    10711292
    10721293PAPER_TYPE             = a4wide
    10731294
    1074 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     1295# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    10751296# packages that should be included in the LaTeX output.
    10761297
    1077 EXTRA_PACKAGES         = 
    1078 
    1079 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    1080 # the generated latex document. The header should contain everything until 
    1081 # the first chapter. If it is left blank doxygen will generate a 
     1298EXTRA_PACKAGES         =
     1299
     1300# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     1301# the generated latex document. The header should contain everything until
     1302# the first chapter. If it is left blank doxygen will generate a
    10821303# standard header. Notice: only use this tag if you know what you are doing!
    10831304
    1084 LATEX_HEADER           =
    1085 
    1086 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    1087 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    1088 # contain links (just like the HTML output) instead of page references
     1305LATEX_HEADER           =
     1306
     1307# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
     1308# the generated latex document. The footer should contain everything after
     1309# the last chapter. If it is left blank doxygen will generate a
     1310# standard footer. Notice: only use this tag if you know what you are doing!
     1311
     1312LATEX_FOOTER           =
     1313
     1314# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     1315# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     1316# contain links (just like the HTML output) instead of page references
    10891317# This makes the output suitable for online browsing using a pdf viewer.
    10901318
    10911319PDF_HYPERLINKS         = YES
    10921320
    1093 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    1094 # plain latex in the generated Makefile. Set this option to YES to get a 
     1321# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     1322# plain latex in the generated Makefile. Set this option to YES to get a
    10951323# higher quality PDF documentation.
    10961324
    10971325USE_PDFLATEX           = YES
    10981326
    1099 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    1100 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    1101 # running if errors occur, instead of asking the user for help. 
     1327# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     1328# command to the generated LaTeX files. This will instruct LaTeX to keep
     1329# running if errors occur, instead of asking the user for help.
    11021330# This option is also used when generating formulas in HTML.
    11031331
    11041332LATEX_BATCHMODE        = NO
    11051333
    1106 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
    1107 # include the index chapters (such as File Index, Compound Index, etc.) 
     1334# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     1335# include the index chapters (such as File Index, Compound Index, etc.)
    11081336# in the output.
    11091337
     
    11171345LATEX_SOURCE_CODE      = NO
    11181346
     1347# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
     1348# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
     1349# http://en.wikipedia.org/wiki/BibTeX for more info.
     1350
     1351LATEX_BIB_STYLE        = plain
     1352
    11191353#---------------------------------------------------------------------------
    11201354# configuration options related to the RTF output
    11211355#---------------------------------------------------------------------------
    11221356
    1123 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    1124 # The RTF output is optimized for Word 97 and may not look very pretty with 
     1357# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     1358# The RTF output is optimized for Word 97 and may not look very pretty with
    11251359# other RTF readers or editors.
    11261360
    11271361GENERATE_RTF           = NO
    11281362
    1129 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    1130 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1363# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     1364# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    11311365# put in front of it. If left blank `rtf' will be used as the default path.
    11321366
    11331367RTF_OUTPUT             = rtf
    11341368
    1135 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    1136 # RTF documents. This may be useful for small projects and may help to 
     1369# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     1370# RTF documents. This may be useful for small projects and may help to
    11371371# save some trees in general.
    11381372
    11391373COMPACT_RTF            = NO
    11401374
    1141 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    1142 # will contain hyperlink fields. The RTF file will 
    1143 # contain links (just like the HTML output) instead of page references. 
    1144 # This makes the output suitable for online browsing using WORD or other 
    1145 # programs which support those fields. 
     1375# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     1376# will contain hyperlink fields. The RTF file will
     1377# contain links (just like the HTML output) instead of page references.
     1378# This makes the output suitable for online browsing using WORD or other
     1379# programs which support those fields.
    11461380# Note: wordpad (write) and others do not support links.
    11471381
    11481382RTF_HYPERLINKS         = NO
    11491383
    1150 # Load stylesheet definitions from file. Syntax is similar to doxygen's
    1151 # config file, i.e. a series of assignments. You only have to provide 
     1384# Load style sheet definitions from file. Syntax is similar to doxygen's
     1385# config file, i.e. a series of assignments. You only have to provide
    11521386# replacements, missing definitions are set to their default value.
    11531387
    1154 RTF_STYLESHEET_FILE    = 
    1155 
    1156 # Set optional variables used in the generation of an rtf document. 
     1388RTF_STYLESHEET_FILE    =
     1389
     1390# Set optional variables used in the generation of an rtf document.
    11571391# Syntax is similar to doxygen's config file.
    11581392
    1159 RTF_EXTENSIONS_FILE    = 
     1393RTF_EXTENSIONS_FILE    =
    11601394
    11611395#---------------------------------------------------------------------------
     
    11631397#---------------------------------------------------------------------------
    11641398
    1165 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     1399# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    11661400# generate man pages
    11671401
    11681402GENERATE_MAN           = NO
    11691403
    1170 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
    1171 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1404# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     1405# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    11721406# put in front of it. If left blank `man' will be used as the default path.
    11731407
    11741408MAN_OUTPUT             = man
    11751409
    1176 # The MAN_EXTENSION tag determines the extension that is added to 
     1410# The MAN_EXTENSION tag determines the extension that is added to
    11771411# the generated man pages (default is the subroutine's section .3)
    11781412
    11791413MAN_EXTENSION          = .3
    11801414
    1181 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
    1182 # then it will generate one additional man file for each entity 
    1183 # documented in the real man page(s). These additional files 
    1184 # only source the real man page, but without them the man command 
     1415# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     1416# then it will generate one additional man file for each entity
     1417# documented in the real man page(s). These additional files
     1418# only source the real man page, but without them the man command
    11851419# would be unable to find the correct page. The default is NO.
    11861420
     
    11911425#---------------------------------------------------------------------------
    11921426
    1193 # If the GENERATE_XML tag is set to YES Doxygen will 
    1194 # generate an XML file that captures the structure of 
     1427# If the GENERATE_XML tag is set to YES Doxygen will
     1428# generate an XML file that captures the structure of
    11951429# the code including all documentation.
    11961430
    11971431GENERATE_XML           = NO
    11981432
    1199 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
    1200 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1433# The XML_OUTPUT tag is used to specify where the XML pages will be put.
     1434# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    12011435# put in front of it. If left blank `xml' will be used as the default path.
    12021436
    12031437XML_OUTPUT             = xml
    12041438
    1205 # The XML_SCHEMA tag can be used to specify an XML schema, 
    1206 # which can be used by a validating XML parser to check the 
     1439# The XML_SCHEMA tag can be used to specify an XML schema,
     1440# which can be used by a validating XML parser to check the
    12071441# syntax of the XML files.
    12081442
    1209 XML_SCHEMA             = 
    1210 
    1211 # The XML_DTD tag can be used to specify an XML DTD, 
    1212 # which can be used by a validating XML parser to check the 
     1443XML_SCHEMA             =
     1444
     1445# The XML_DTD tag can be used to specify an XML DTD,
     1446# which can be used by a validating XML parser to check the
    12131447# syntax of the XML files.
    12141448
    1215 XML_DTD                = 
    1216 
    1217 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
    1218 # dump the program listings (including syntax highlighting 
    1219 # and cross-referencing information) to the XML output. Note that 
     1449XML_DTD                =
     1450
     1451# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     1452# dump the program listings (including syntax highlighting
     1453# and cross-referencing information) to the XML output. Note that
    12201454# enabling this will significantly increase the size of the XML output.
    12211455
     
    12261460#---------------------------------------------------------------------------
    12271461
    1228 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
    1229 # generate an AutoGen Definitions (see autogen.sf.net) file 
    1230 # that captures the structure of the code including all 
    1231 # documentation. Note that this feature is still experimental 
     1462# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     1463# generate an AutoGen Definitions (see autogen.sf.net) file
     1464# that captures the structure of the code including all
     1465# documentation. Note that this feature is still experimental
    12321466# and incomplete at the moment.
    12331467
     
    12381472#---------------------------------------------------------------------------
    12391473
    1240 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
    1241 # generate a Perl module file that captures the structure of 
    1242 # the code including all documentation. Note that this 
    1243 # feature is still experimental and incomplete at the 
     1474# If the GENERATE_PERLMOD tag is set to YES Doxygen will
     1475# generate a Perl module file that captures the structure of
     1476# the code including all documentation. Note that this
     1477# feature is still experimental and incomplete at the
    12441478# moment.
    12451479
    12461480GENERATE_PERLMOD       = NO
    12471481
    1248 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
    1249 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
     1482# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
     1483# the necessary Makefile rules, Perl scripts and LaTeX code to be able
    12501484# to generate PDF and DVI output from the Perl module output.
    12511485
    12521486PERLMOD_LATEX          = NO
    12531487
    1254 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1255 # nicely formatted so it can be parsed by a human reader.  This is useful
    1256 # if you want to understand what is going on.  On the other hand, if this
    1257 # tag is set to NO the size of the Perl module output will be much smaller
     1488# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
     1489# nicely formatted so it can be parsed by a human reader.
     1490# This is useful
     1491# if you want to understand what is going on.
     1492# On the other hand, if this
     1493# tag is set to NO the size of the Perl module output will be much smaller
    12581494# and Perl will parse it just the same.
    12591495
    12601496PERLMOD_PRETTY         = YES
    12611497
    1262 # The names of the make variables in the generated doxyrules.make file 
    1263 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
    1264 # This is useful so different doxyrules.make files included by the same 
     1498# The names of the make variables in the generated doxyrules.make file
     1499# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
     1500# This is useful so different doxyrules.make files included by the same
    12651501# Makefile don't overwrite each other's variables.
    12661502
    1267 PERLMOD_MAKEVAR_PREFIX = 
     1503PERLMOD_MAKEVAR_PREFIX =
    12681504
    12691505#---------------------------------------------------------------------------
     
    12711507#---------------------------------------------------------------------------
    12721508
    1273 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
    1274 # evaluate all C-preprocessor directives found in the sources and include 
     1509# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     1510# evaluate all C-preprocessor directives found in the sources and include
    12751511# files.
    12761512
    12771513ENABLE_PREPROCESSING   = YES
    12781514
    1279 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
    1280 # names in the source code. If set to NO (the default) only conditional 
    1281 # compilation will be performed. Macro expansion can be done in a controlled 
     1515# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     1516# names in the source code. If set to NO (the default) only conditional
     1517# compilation will be performed. Macro expansion can be done in a controlled
    12821518# way by setting EXPAND_ONLY_PREDEF to YES.
    12831519
    12841520MACRO_EXPANSION        = NO
    12851521
    1286 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
    1287 # then the macro expansion is limited to the macros specified with the 
     1522# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     1523# then the macro expansion is limited to the macros specified with the
    12881524# PREDEFINED and EXPAND_AS_DEFINED tags.
    12891525
    12901526EXPAND_ONLY_PREDEF     = NO
    12911527
    1292 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
    1293 # in the INCLUDE_PATH (see below) will be search if a #include is found.
     1528# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
     1529# pointed to by INCLUDE_PATH will be searched when a #include is found.
    12941530
    12951531SEARCH_INCLUDES        = YES
    12961532
    1297 # The INCLUDE_PATH tag can be used to specify one or more directories that 
    1298 # contain include files that are not input files but should be processed by 
     1533# The INCLUDE_PATH tag can be used to specify one or more directories that
     1534# contain include files that are not input files but should be processed by
    12991535# the preprocessor.
    13001536
    1301 INCLUDE_PATH           = 
    1302 
    1303 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
    1304 # patterns (like *.h and *.hpp) to filter out the header-files in the 
    1305 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
     1537INCLUDE_PATH           =
     1538
     1539# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1540# patterns (like *.h and *.hpp) to filter out the header-files in the
     1541# directories. If left blank, the patterns specified with FILE_PATTERNS will
    13061542# be used.
    13071543
    1308 INCLUDE_FILE_PATTERNS  = 
    1309 
    1310 # The PREDEFINED tag can be used to specify one or more macro names that 
    1311 # are defined before the preprocessor is started (similar to the -D option of 
    1312 # gcc). The argument of the tag is a list of macros of the form: name 
    1313 # or name=definition (no spaces). If the definition and the = are 
    1314 # omitted =1 is assumed. To prevent a macro definition from being 
    1315 # undefined via #undef or recursively expanded use the := operator 
     1544INCLUDE_FILE_PATTERNS  =
     1545
     1546# The PREDEFINED tag can be used to specify one or more macro names that
     1547# are defined before the preprocessor is started (similar to the -D option of
     1548# gcc). The argument of the tag is a list of macros of the form: name
     1549# or name=definition (no spaces). If the definition and the = are
     1550# omitted =1 is assumed. To prevent a macro definition from being
     1551# undefined via #undef or recursively expanded use the := operator
    13161552# instead of the = operator.
    13171553
    1318 PREDEFINED             = __i386__ Q_OS_WIN32 DOXYGEN_EXCLUDE
    1319 
    1320 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    1321 # this tag can be used to specify a list of macro names that should be expanded.
    1322 # The macro definition that is found in the sources will be used.
    1323 # Use the PREDEFINED tag if you want to use a different macro definition.
    1324 
    1325 EXPAND_AS_DEFINED      =
    1326 
    1327 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1328 # doxygen's preprocessor will remove all function-like macros that are alone
    1329 # on a line, have an all uppercase name, and do not end with a semicolon. Such
    1330 # function macros are typically used for boiler-plate code, and will confuse
    1331 # the parser if not removed.
     1554PREDEFINED             = __i386__ \
     1555                         Q_OS_WIN32 \
     1556                         DOXYGEN_EXCLUDE
     1557
     1558# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     1559# this tag can be used to specify a list of macro names that should be expanded.
     1560# The macro definition that is found in the sources will be used.
     1561# Use the PREDEFINED tag if you want to use a different macro definition that
     1562# overrules the definition found in the source code.
     1563
     1564EXPAND_AS_DEFINED      =
     1565
     1566# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     1567# doxygen's preprocessor will remove all references to function-like macros
     1568# that are alone on a line, have an all uppercase name, and do not end with a
     1569# semicolon, because these will confuse the parser if not removed.
    13321570
    13331571SKIP_FUNCTION_MACROS   = YES
     
    13371575#---------------------------------------------------------------------------
    13381576
    1339 # The TAGFILES option can be used to specify one or more tagfiles.
    1340 # Optionally an initial location of the external documentation
    1341 # can be added for each tagfile. The format of a tag file without
    1342 # this location is as follows:
    1343 #   TAGFILES = file1 file2 ...
    1344 # Adding location for the tag files is done as follows:
    1345 #   TAGFILES = file1=loc1 "file2 = loc2" ...
    1346 # where "loc1" and "loc2" can be relative or absolute paths or
    1347 # URLs. If a location is present for each tag, the installdox tool
    1348 # does not have to be run to correct the links.
    1349 # Note that each tag file must have a unique name
    1350 # (where the name does NOT include the path)
    1351 # If a tag file is not located in the directory in which doxygen
    1352 # is run, you must also specify the path to the tagfile here.
     1577# The TAGFILES option can be used to specify one or more tagfiles. For each
     1578# tag file the location of the external documentation should be added. The
     1579# format of a tag file without this location is as follows:
     1580#
     1581# TAGFILES = file1 file2 ...
     1582# Adding location for the tag files is done as follows:
     1583#
     1584# TAGFILES = file1=loc1 "file2 = loc2" ...
     1585# where "loc1" and "loc2" can be relative or absolute paths
     1586# or URLs. Note that each tag file must have a unique name (where the name does
     1587# NOT include the path). If a tag file is not located in the directory in which
     1588# doxygen is run, you must also specify the path to the tagfile here.
    13531589
    13541590TAGFILES               = doc/qt-4.8.tags=http://qt-project.org/doc/qt-4.8
    13551591
    1356 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
     1592# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    13571593# a tag file that is based on the input files it reads.
    13581594
    13591595GENERATE_TAGFILE       = doc/tspsg.tags
    13601596
    1361 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    1362 # in the class index. If set to NO only the inherited external classes 
     1597# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     1598# in the class index. If set to NO only the inherited external classes
    13631599# will be listed.
    13641600
    13651601ALLEXTERNALS           = NO
    13661602
    1367 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
    1368 # in the modules index. If set to NO, only the current project's groups will 
     1603# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
     1604# in the modules index. If set to NO, only the current project's groups will
    13691605# be listed.
    13701606
    13711607EXTERNAL_GROUPS        = YES
    13721608
    1373 # The PERL_PATH should be the absolute path and name of the perl script 
     1609# The PERL_PATH should be the absolute path and name of the perl script
    13741610# interpreter (i.e. the result of `which perl').
    13751611
     
    13801616#---------------------------------------------------------------------------
    13811617
    1382 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    1383 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    1384 # or super classes. Setting the tag to NO turns the diagrams off. Note that
    1385 # this option is superseded by the HAVE_DOT option below. This is only a
    1386 # fallback. It is recommended to install and use dot, since it yields more
    1387 # powerful graphs.
     1618# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     1619# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1620# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1621# this option also works with HAVE_DOT disabled, but it is recommended to
     1622# install and use dot, since it yields more powerful graphs.
    13881623
    13891624CLASS_DIAGRAMS         = YES
    13901625
    1391 # You can define message sequence charts within doxygen comments using the \msc 
    1392 # command. Doxygen will then run the mscgen tool (see 
    1393 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
    1394 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
    1395 # the mscgen tool resides. If left empty the tool is assumed to be found in the 
     1626# You can define message sequence charts within doxygen comments using the \msc
     1627# command. Doxygen will then run the mscgen tool (see
     1628# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1629# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1630# the mscgen tool resides. If left empty the tool is assumed to be found in the
    13961631# default search path.
    13971632
    1398 MSCGEN_PATH            = 
    1399 
    1400 # If set to YES, the inheritance and collaboration graphs will hide 
    1401 # inheritance and usage relations if the target is undocumented 
     1633MSCGEN_PATH            =
     1634
     1635# If set to YES, the inheritance and collaboration graphs will hide
     1636# inheritance and usage relations if the target is undocumented
    14021637# or is not a class.
    14031638
    14041639HIDE_UNDOC_RELATIONS   = YES
    14051640
    1406 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
    1407 # available from the path. This tool is part of Graphviz, a graph visualization 
    1408 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
     1641# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     1642# available from the path. This tool is part of Graphviz, a graph visualization
     1643# toolkit from AT&T and Lucent Bell Labs. The other options in this section
    14091644# have no effect if this option is set to NO (the default)
    14101645
    14111646HAVE_DOT               = YES
    14121647
    1413 # By default doxygen will write a font called FreeSans.ttf to the output
    1414 # directory and reference it in all dot files that doxygen generates. This
    1415 # font does not include all possible unicode characters however, so when you need
    1416 # these (or just want a differently looking font) you can specify the font name
    1417 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
    1418 # which can be done by putting it in a standard location or by setting the
    1419 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
    1420 # containing the font.
     1648# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
     1649# allowed to run in parallel. When set to 0 (the default) doxygen will
     1650# base this on the number of processors available in the system. You can set it
     1651# explicitly to a value larger than 0 to get control over the balance
     1652# between CPU load and processing speed.
     1653
     1654DOT_NUM_THREADS        = 0
     1655
     1656# By default doxygen will use the Helvetica font for all dot files that
     1657# doxygen generates. When you want a differently looking font you can specify
     1658# the font name using DOT_FONTNAME. You need to make sure dot is able to find
     1659# the font, which can be done by putting it in a standard location or by setting
     1660# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
     1661# directory containing the font.
    14211662
    14221663DOT_FONTNAME           = FreeSans
    14231664
    1424 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
     1665# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    14251666# The default size is 10pt.
    14261667
    14271668DOT_FONTSIZE           = 10
    14281669
    1429 # By default doxygen will tell dot to use the output directory to look for the
    1430 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
    1431 # different font using DOT_FONTNAME you can set the path where dot
    1432 # can find it using this tag.
    1433 
    1434 DOT_FONTPATH           =
    1435 
    1436 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1437 # will generate a graph for each documented class showing the direct and
    1438 # indirect inheritance relations. Setting this tag to YES will force the
    1439 # the CLASS_DIAGRAMS tag to NO.
     1670# By default doxygen will tell dot to use the Helvetica font.
     1671# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
     1672# set the path where dot can find it.
     1673
     1674DOT_FONTPATH           =
     1675
     1676# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1677# will generate a graph for each documented class showing the direct and
     1678# indirect inheritance relations. Setting this tag to YES will force the
     1679# CLASS_DIAGRAMS tag to NO.
    14401680
    14411681CLASS_GRAPH            = YES
    14421682
    1443 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    1444 # will generate a graph for each documented class showing the direct and 
    1445 # indirect implementation dependencies (inheritance, containment, and 
     1683# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1684# will generate a graph for each documented class showing the direct and
     1685# indirect implementation dependencies (inheritance, containment, and
    14461686# class references variables) of the class with other documented classes.
    14471687
    14481688COLLABORATION_GRAPH    = YES
    14491689
    1450 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
     1690# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    14511691# will generate a graph for groups, showing the direct groups dependencies
    14521692
    14531693GROUP_GRAPHS           = YES
    14541694
    1455 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
    1456 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
     1695# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     1696# collaboration diagrams in a style similar to the OMG's Unified Modeling
    14571697# Language.
    14581698
    14591699UML_LOOK               = NO
    14601700
    1461 # If set to YES, the inheritance and collaboration graphs will show the
     1701# If the UML_LOOK tag is enabled, the fields and methods are shown inside
     1702# the class node. If there are many fields or methods and many nodes the
     1703# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
     1704# threshold limits the number of items for each type to make the size more
     1705# managable. Set this to 0 for no limit. Note that the threshold may be
     1706# exceeded by 50% before the limit is enforced.
     1707
     1708UML_LIMIT_NUM_FIELDS   = 10
     1709
     1710# If set to YES, the inheritance and collaboration graphs will show the
    14621711# relations between templates and their instances.
    14631712
    14641713TEMPLATE_RELATIONS     = NO
    14651714
    1466 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    1467 # tags are set to YES then doxygen will generate a graph for each documented 
    1468 # file showing the direct and indirect include dependencies of the file with 
     1715# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     1716# tags are set to YES then doxygen will generate a graph for each documented
     1717# file showing the direct and indirect include dependencies of the file with
    14691718# other documented files.
    14701719
    14711720INCLUDE_GRAPH          = YES
    14721721
    1473 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    1474 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    1475 # documented header file showing the documented files that directly or 
     1722# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     1723# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     1724# documented header file showing the documented files that directly or
    14761725# indirectly include this file.
    14771726
    14781727INCLUDED_BY_GRAPH      = YES
    14791728
    1480 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
    1481 # doxygen will generate a call dependency graph for every global function 
    1482 # or class method. Note that enabling this option will significantly increase 
    1483 # the time of a run. So in most cases it will be better to enable call graphs 
     1729# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1730# doxygen will generate a call dependency graph for every global function
     1731# or class method. Note that enabling this option will significantly increase
     1732# the time of a run. So in most cases it will be better to enable call graphs
    14841733# for selected functions only using the \callgraph command.
    14851734
    14861735CALL_GRAPH             = YES
    14871736
    1488 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
    1489 # doxygen will generate a caller dependency graph for every global function 
    1490 # or class method. Note that enabling this option will significantly increase 
    1491 # the time of a run. So in most cases it will be better to enable caller 
     1737# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1738# doxygen will generate a caller dependency graph for every global function
     1739# or class method. Note that enabling this option will significantly increase
     1740# the time of a run. So in most cases it will be better to enable caller
    14921741# graphs for selected functions only using the \callergraph command.
    14931742
    14941743CALLER_GRAPH           = YES
    14951744
    1496 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
    1497 # will graphical hierarchy of all classes instead of a textual one.
     1745# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
     1746# will generate a graphical hierarchy of all classes instead of a textual one.
    14981747
    14991748GRAPHICAL_HIERARCHY    = YES
    15001749
    1501 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
    1502 # then doxygen will show the dependencies a directory has on other directories 
    1503 # in a graphical way. The dependency relations are determined by the #include 
     1750# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
     1751# then doxygen will show the dependencies a directory has on other directories
     1752# in a graphical way. The dependency relations are determined by the #include
    15041753# relations between the files in the directories.
    15051754
    15061755DIRECTORY_GRAPH        = YES
    15071756
    1508 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1509 # generated by dot. Possible values are png, jpg, or gif
    1510 # If left blank png will be used.
     1757# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     1758# generated by dot. Possible values are svg, png, jpg, or gif.
     1759# If left blank png will be used. If you choose svg you need to set
     1760# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
     1761# visible in IE 9+ (other browsers do not have this requirement).
    15111762
    15121763DOT_IMAGE_FORMAT       = png
    15131764
    1514 # The tag DOT_PATH can be used to specify the path where the dot tool can be
     1765# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
     1766# enable generation of interactive SVG images that allow zooming and panning.
     1767# Note that this requires a modern browser other than Internet Explorer.
     1768# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
     1769# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
     1770# visible. Older versions of IE do not have SVG support.
     1771
     1772INTERACTIVE_SVG        = NO
     1773
     1774# The tag DOT_PATH can be used to specify the path where the dot tool can be
    15151775# found. If left blank, it is assumed the dot tool can be found in the path.
    15161776
    1517 DOT_PATH               = 
    1518 
    1519 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
    1520 # contain dot files that are included in the documentation (see the 
     1777DOT_PATH               =
     1778
     1779# The DOTFILE_DIRS tag can be used to specify one or more directories that
     1780# contain dot files that are included in the documentation (see the
    15211781# \dotfile command).
    15221782
    1523 DOTFILE_DIRS           =
    1524 
    1525 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1526 # nodes that will be shown in the graph. If the number of nodes in a graph
    1527 # becomes larger than this value, doxygen will truncate the graph, which is
    1528 # visualized by representing a node as a red box. Note that doxygen if the
    1529 # number of direct children of the root node in a graph is already larger than
    1530 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
     1783DOTFILE_DIRS           =
     1784
     1785# The MSCFILE_DIRS tag can be used to specify one or more directories that
     1786# contain msc files that are included in the documentation (see the
     1787# \mscfile command).
     1788
     1789MSCFILE_DIRS           =
     1790
     1791# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1792# nodes that will be shown in the graph. If the number of nodes in a graph
     1793# becomes larger than this value, doxygen will truncate the graph, which is
     1794# visualized by representing a node as a red box. Note that doxygen if the
     1795# number of direct children of the root node in a graph is already larger than
     1796# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    15311797# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    15321798
    15331799DOT_GRAPH_MAX_NODES    = 50
    15341800
    1535 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
    1536 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
    1537 # from the root by following a path via at most 3 edges will be shown. Nodes 
    1538 # that lay further from the root node will be omitted. Note that setting this 
    1539 # option to 1 or 2 may greatly reduce the computation time needed for large 
    1540 # code bases. Also note that the size of a graph can be further restricted by 
     1801# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     1802# graphs generated by dot. A depth value of 3 means that only nodes reachable
     1803# from the root by following a path via at most 3 edges will be shown. Nodes
     1804# that lay further from the root node will be omitted. Note that setting this
     1805# option to 1 or 2 may greatly reduce the computation time needed for large
     1806# code bases. Also note that the size of a graph can be further restricted by
    15411807# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    15421808
    15431809MAX_DOT_GRAPH_DEPTH    = 0
    15441810
    1545 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
    1546 # background. This is disabled by default, because dot on Windows does not 
    1547 # seem to support this out of the box. Warning: Depending on the platform used, 
    1548 # enabling this option may lead to badly anti-aliased labels on the edges of 
     1811# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1812# background. This is disabled by default, because dot on Windows does not
     1813# seem to support this out of the box. Warning: Depending on the platform used,
     1814# enabling this option may lead to badly anti-aliased labels on the edges of
    15491815# a graph (i.e. they become hard to read).
    15501816
    15511817DOT_TRANSPARENT        = YES
    15521818
    1553 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
    1554 # files in one run (i.e. multiple -o and -T options on the command line). This 
    1555 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
     1819# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1820# files in one run (i.e. multiple -o and -T options on the command line). This
     1821# makes dot run faster, but since only newer versions of dot (>1.8.10)
    15561822# support this, this feature is disabled by default.
    15571823
    15581824DOT_MULTI_TARGETS      = YES
    15591825
    1560 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
    1561 # generate a legend page explaining the meaning of the various boxes and 
     1826# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     1827# generate a legend page explaining the meaning of the various boxes and
    15621828# arrows in the dot generated graphs.
    15631829
    15641830GENERATE_LEGEND        = YES
    15651831
    1566 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    1567 # remove the intermediate dot files that are used to generate 
     1832# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     1833# remove the intermediate dot files that are used to generate
    15681834# the various graphs.
    15691835
Note: See TracChangeset for help on using the changeset viewer.