Changeset f00088f


Ignore:
Timestamp:
Sep 25, 2009, 11:08:08 PM (11 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
c698d1b
Parents:
46044ed
Message:

doc/*.cfg: update with doxygen -u (debian package 1.6.1-1)

Location:
doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/devel.cfg

    r46044ed rf00088f  
    1 # Doxyfile 1.5.3-20071008
     1# Doxyfile 1.6.1
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
    17 # This tag specifies the encoding used for all characters in the config file that
    18 # follow. The default is UTF-8 which is also the encoding used for all text before
    19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
    20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
    21 # possible encodings.
     17# This tag specifies the encoding used for all characters in the config file
     18# that follow. The default is UTF-8 which is also the encoding used for all
     19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     20# iconv built into libc) for the transcoding. See
     21# http://www.gnu.org/software/libiconv for the list of possible encodings.
    2222
    2323DOXYFILE_ENCODING      = UTF-8
    2424
    25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
     25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    2626# by quotes) that should identify the project.
    2727
    2828PROJECT_NAME           = aubio
    2929
    30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    31 # This could be handy for archiving the generated documentation or 
     30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     31# This could be handy for archiving the generated documentation or
    3232# if some version control system is used.
    3333
    34 PROJECT_NUMBER         = 
    35 
    36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    37 # base path where the generated documentation will be put. 
    38 # If a relative path is entered, it will be relative to the location 
     34PROJECT_NUMBER         =
     35
     36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     37# base path where the generated documentation will be put.
     38# If a relative path is entered, it will be relative to the location
    3939# where doxygen was started. If left blank the current directory will be used.
    4040
    4141OUTPUT_DIRECTORY       = devel
    4242
    43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    44 # 4096 sub-directories (in 2 levels) under the output directory of each output 
    45 # format and will distribute the generated files over these directories. 
    46 # Enabling this option can be useful when feeding doxygen a huge amount of 
    47 # source files, where putting all generated files in the same directory would 
     43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     44# 4096 sub-directories (in 2 levels) under the output directory of each output
     45# format and will distribute the generated files over these directories.
     46# Enabling this option can be useful when feeding doxygen a huge amount of
     47# source files, where putting all generated files in the same directory would
    4848# otherwise cause performance problems for the file system.
    4949
    5050CREATE_SUBDIRS         = NO
    5151
    52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    53 # documentation generated by doxygen is written. Doxygen will use this
    54 # information to generate all constant output in the proper language.
    55 # The default language is English, other supported languages are:
    56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
    58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
    59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
    60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
     52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     53# documentation generated by doxygen is written. Doxygen will use this
     54# information to generate all constant output in the proper language.
     55# The default language is English, other supported languages are:
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
     58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
     59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
     60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
     61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    6162
    6263OUTPUT_LANGUAGE        = English
    6364
    64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
    65 # include brief member descriptions after the members that are listed in 
    66 # the file and class documentation (similar to JavaDoc). 
     65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     66# include brief member descriptions after the members that are listed in
     67# the file and class documentation (similar to JavaDoc).
    6768# Set to NO to disable this.
    6869
    6970BRIEF_MEMBER_DESC      = YES
    7071
    71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    72 # the brief description of a member or function before the detailed description. 
    73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     73# the brief description of a member or function before the detailed description.
     74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    7475# brief descriptions will be completely suppressed.
    7576
    7677REPEAT_BRIEF           = YES
    7778
    78 # This tag implements a quasi-intelligent brief description abbreviator 
    79 # that is used to form the text in various listings. Each string 
    80 # in this list, if found as the leading text of the brief description, will be 
    81 # stripped from the text and the result after processing the whole list, is 
    82 # used as the annotated text. Otherwise, the brief description is used as-is. 
    83 # If left blank, the following values are used ("$name" is automatically 
    84 # replaced with the name of the entity): "The $name class" "The $name widget" 
    85 # "The $name file" "is" "provides" "specifies" "contains" 
     79# This tag implements a quasi-intelligent brief description abbreviator
     80# that is used to form the text in various listings. Each string
     81# in this list, if found as the leading text of the brief description, will be
     82# stripped from the text and the result after processing the whole list, is
     83# used as the annotated text. Otherwise, the brief description is used as-is.
     84# If left blank, the following values are used ("$name" is automatically
     85# replaced with the name of the entity): "The $name class" "The $name widget"
     86# "The $name file" "is" "provides" "specifies" "contains"
    8687# "represents" "a" "an" "the"
    8788
    88 ABBREVIATE_BRIEF       = 
    89 
    90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
    91 # Doxygen will generate a detailed section even if there is only a brief 
     89ABBREVIATE_BRIEF       =
     90
     91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     92# Doxygen will generate a detailed section even if there is only a brief
    9293# description.
    9394
    9495ALWAYS_DETAILED_SEC    = NO
    9596
    96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    97 # inherited members of a class in the documentation of that class as if those 
    98 # members were ordinary class members. Constructors, destructors and assignment 
     97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     98# inherited members of a class in the documentation of that class as if those
     99# members were ordinary class members. Constructors, destructors and assignment
    99100# operators of the base classes will not be shown.
    100101
    101102INLINE_INHERITED_MEMB  = NO
    102103
    103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    104 # path before files name in the file list and in the header files. If set 
     104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     105# path before files name in the file list and in the header files. If set
    105106# to NO the shortest path that makes the file name unique will be used.
    106107
    107108FULL_PATH_NAMES        = YES
    108109
    109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    110 # can be used to strip a user-defined part of the path. Stripping is 
    111 # only done if one of the specified strings matches the left-hand part of 
    112 # the path. The tag can be used to show relative paths in the file list. 
    113 # If left blank the directory from which doxygen is run is used as the 
     110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     111# can be used to strip a user-defined part of the path. Stripping is
     112# only done if one of the specified strings matches the left-hand part of
     113# the path. The tag can be used to show relative paths in the file list.
     114# If left blank the directory from which doxygen is run is used as the
    114115# path to strip.
    115116
    116117STRIP_FROM_PATH        = ..
    117118
    118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
    119 # the path mentioned in the documentation of a class, which tells 
    120 # the reader which header file to include in order to use a class. 
    121 # If left blank only the name of the header file containing the class 
    122 # definition is used. Otherwise one should specify the include paths that 
     119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     120# the path mentioned in the documentation of a class, which tells
     121# the reader which header file to include in order to use a class.
     122# If left blank only the name of the header file containing the class
     123# definition is used. Otherwise one should specify the include paths that
    123124# are normally passed to the compiler using the -I flag.
    124125
    125 STRIP_FROM_INC_PATH    = 
    126 
    127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    128 # (but less readable) file names. This can be useful is your file systems 
     126STRIP_FROM_INC_PATH    =
     127
     128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     129# (but less readable) file names. This can be useful is your file systems
    129130# doesn't support long names like on DOS, Mac, or CD-ROM.
    130131
    131132SHORT_NAMES            = NO
    132133
    133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    134 # will interpret the first line (until the first dot) of a JavaDoc-style 
    135 # comment as the brief description. If set to NO, the JavaDoc 
    136 # comments will behave just like regular Qt-style comments 
     134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     135# will interpret the first line (until the first dot) of a JavaDoc-style
     136# comment as the brief description. If set to NO, the JavaDoc
     137# comments will behave just like regular Qt-style comments
    137138# (thus requiring an explicit @brief command for a brief description.)
    138139
    139140JAVADOC_AUTOBRIEF      = YES
    140141
    141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
    142 # interpret the first line (until the first dot) of a Qt-style 
    143 # comment as the brief description. If set to NO, the comments 
    144 # will behave just like regular Qt-style comments (thus requiring 
     142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     143# interpret the first line (until the first dot) of a Qt-style
     144# comment as the brief description. If set to NO, the comments
     145# will behave just like regular Qt-style comments (thus requiring
    145146# an explicit \brief command for a brief description.)
    146147
    147148QT_AUTOBRIEF           = NO
    148149
    149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
    150 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
    151 # comments) as a brief description. This used to be the default behaviour. 
    152 # The new default is to treat a multi-line C++ comment block as a detailed 
     150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     152# comments) as a brief description. This used to be the default behaviour.
     153# The new default is to treat a multi-line C++ comment block as a detailed
    153154# description. Set this tag to YES if you prefer the old behaviour instead.
    154155
    155156MULTILINE_CPP_IS_BRIEF = NO
    156157
    157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
    158 # will output the detailed description near the top, like JavaDoc.
    159 # If set to NO, the detailed description appears after the member
    160 # documentation.
    161 
    162 DETAILS_AT_TOP         = NO
    163 
    164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    165 # member inherits the documentation from any documented member that it
     158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     159# member inherits the documentation from any documented member that it
    166160# re-implements.
    167161
    168162INHERIT_DOCS           = YES
    169163
    170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
    171 # a new page for each member. If set to NO, the documentation of a member will 
     164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     165# a new page for each member. If set to NO, the documentation of a member will
    172166# be part of the file/class/namespace that contains it.
    173167
    174168SEPARATE_MEMBER_PAGES  = NO
    175169
    176 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
     170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
    177171# Doxygen uses this value to replace tabs by spaces in code fragments.
    178172
    179173TAB_SIZE               = 4
    180174
    181 # This tag can be used to specify a number of aliases that acts 
    182 # as commands in the documentation. An alias has the form "name=value". 
    183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
    184 # put the command \sideeffect (or @sideeffect) in the documentation, which 
    185 # will result in a user-defined paragraph with heading "Side Effects:". 
     175# This tag can be used to specify a number of aliases that acts
     176# as commands in the documentation. An alias has the form "name=value".
     177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     178# put the command \sideeffect (or @sideeffect) in the documentation, which
     179# will result in a user-defined paragraph with heading "Side Effects:".
    186180# You can put \n's in the value part of an alias to insert newlines.
    187181
    188 ALIASES                = 
    189 
    190 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
    191 # sources only. Doxygen will then generate output that is more tailored for C. 
    192 # For instance, some of the names that are used will be different. The list 
     182ALIASES                =
     183
     184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     185# sources only. Doxygen will then generate output that is more tailored for C.
     186# For instance, some of the names that are used will be different. The list
    193187# of all members will be omitted, etc.
    194188
    195189OPTIMIZE_OUTPUT_FOR_C  = YES
    196190
    197 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
    198 # sources only. Doxygen will then generate output that is more tailored for Java.
    199 # For instance, namespaces will be presented as packages, qualified scopes
    200 # will look different, etc.
     191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     192# sources only. Doxygen will then generate output that is more tailored for
     193# Java. For instance, namespaces will be presented as packages, qualified
     194# scopes will look different, etc.
    201195
    202196OPTIMIZE_OUTPUT_JAVA   = NO
    203197
    204 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
    205 # include (a tag file for) the STL sources as input, then you should
    206 # set this tag to YES in order to let doxygen match functions declarations and
    207 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    208 # func(std::string) {}). This also make the inheritance and collaboration
     198# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     199# sources only. Doxygen will then generate output that is more tailored for
     200# Fortran.
     201
     202OPTIMIZE_FOR_FORTRAN   = NO
     203
     204# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     205# sources. Doxygen will then generate output that is tailored for
     206# VHDL.
     207
     208OPTIMIZE_OUTPUT_VHDL   = NO
     209
     210# Doxygen selects the parser to use depending on the extension of the files it parses.
     211# With this tag you can assign which parser to use for a given extension.
     212# Doxygen has a built-in mapping, but you can override or extend it using this tag.
     213# The format is ext=language, where ext is a file extension, and language is one of
     214# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
     215# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
     216# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
     217# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     218
     219EXTENSION_MAPPING      =
     220
     221# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     222# to include (a tag file for) the STL sources as input, then you should
     223# set this tag to YES in order to let doxygen match functions declarations and
     224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     225# func(std::string) {}). This also make the inheritance and collaboration
    209226# diagrams that involve STL classes more complete and accurate.
    210227
     
    216233CPP_CLI_SUPPORT        = NO
    217234
    218 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
    219 # Doxygen will parse them like normal C++ but will assume all classes use public 
     235# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     236# Doxygen will parse them like normal C++ but will assume all classes use public
    220237# instead of private inheritance when no explicit protection keyword is present.
    221238
    222239SIP_SUPPORT            = NO
    223240
    224 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    225 # tag is set to YES, then doxygen will reuse the documentation of the first
    226 # member in the group (if any) for the other members of the group. By default
     241# For Microsoft's IDL there are propget and propput attributes to indicate getter
     242# and setter methods for a property. Setting this option to YES (the default)
     243# will make doxygen to replace the get and set methods by a property in the
     244# documentation. This will only work if the methods are indeed getting or
     245# setting a simple type. If this is not the case, or you want to show the
     246# methods anyway, you should set this option to NO.
     247
     248IDL_PROPERTY_SUPPORT   = YES
     249
     250# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     251# tag is set to YES, then doxygen will reuse the documentation of the first
     252# member in the group (if any) for the other members of the group. By default
    227253# all members of a group must be documented explicitly.
    228254
    229255DISTRIBUTE_GROUP_DOC   = NO
    230256
    231 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
    232 # the same type (for instance a group of public functions) to be put as a 
    233 # subgroup of that type (e.g. under the Public Functions section). Set it to 
    234 # NO to prevent subgrouping. Alternatively, this can be done per class using 
     257# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     258# the same type (for instance a group of public functions) to be put as a
     259# subgroup of that type (e.g. under the Public Functions section). Set it to
     260# NO to prevent subgrouping. Alternatively, this can be done per class using
    235261# the \nosubgrouping command.
    236262
    237263SUBGROUPING            = YES
    238264
     265# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     266# is documented as struct, union, or enum with the name of the typedef. So
     267# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     268# with name TypeT. When disabled the typedef will appear as a member of a file,
     269# namespace, or class. And the struct will be named TypeS. This can typically
     270# be useful for C code in case the coding convention dictates that all compound
     271# types are typedef'ed and only the typedef is referenced, never the tag name.
     272
     273TYPEDEF_HIDES_STRUCT   = NO
     274
     275# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
     276# determine which symbols to keep in memory and which to flush to disk.
     277# When the cache is full, less often used symbols will be written to disk.
     278# For small to medium size projects (<1000 input files) the default value is
     279# probably good enough. For larger projects a too small cache size can cause
     280# doxygen to be busy swapping symbols to and from disk most of the time
     281# causing a significant performance penality.
     282# If the system has enough physical memory increasing the cache will improve the
     283# performance by keeping more symbols in memory. Note that the value works on
     284# a logarithmic scale so increasing the size by one will rougly double the
     285# memory usage. The cache size is given by this formula:
     286# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
     287# corresponding to a cache size of 2^16 = 65536 symbols
     288
     289SYMBOL_CACHE_SIZE      = 0
     290
    239291#---------------------------------------------------------------------------
    240292# Build related configuration options
    241293#---------------------------------------------------------------------------
    242294
    243 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    244 # documentation are documented, even if no documentation was available. 
    245 # Private class members and static file members will be hidden unless 
     295# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     296# documentation are documented, even if no documentation was available.
     297# Private class members and static file members will be hidden unless
    246298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    247299
    248300EXTRACT_ALL            = YES
    249301
    250 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
     302# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    251303# will be included in the documentation.
    252304
    253305EXTRACT_PRIVATE        = YES
    254306
    255 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
     307# If the EXTRACT_STATIC tag is set to YES all static members of a file
    256308# will be included in the documentation.
    257309
    258310EXTRACT_STATIC         = YES
    259311
    260 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
    261 # defined locally in source files will be included in the documentation. 
     312# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     313# defined locally in source files will be included in the documentation.
    262314# If set to NO only classes defined in header files are included.
    263315
    264316EXTRACT_LOCAL_CLASSES  = YES
    265317
    266 # This flag is only useful for Objective-C code. When set to YES local 
    267 # methods, which are defined in the implementation section but not in 
    268 # the interface are included in the documentation. 
     318# This flag is only useful for Objective-C code. When set to YES local
     319# methods, which are defined in the implementation section but not in
     320# the interface are included in the documentation.
    269321# If set to NO (the default) only methods in the interface are included.
    270322
    271323EXTRACT_LOCAL_METHODS  = NO
    272324
    273 # If this flag is set to YES, the members of anonymous namespaces will be extracted
    274 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
    275 # where file will be replaced with the base name of the file that contains the anonymous
    276 # namespace. By default anonymous namespace are hidden.
     325# If this flag is set to YES, the members of anonymous namespaces will be
     326# extracted and appear in the documentation as a namespace called
     327# 'anonymous_namespace{file}', where file will be replaced with the base
     328# name of the file that contains the anonymous namespace. By default
     329# anonymous namespace are hidden.
    277330
    278331EXTRACT_ANON_NSPACES   = NO
    279332
    280 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
    281 # undocumented members of documented classes, files or namespaces. 
    282 # If set to NO (the default) these members will be included in the 
    283 # various overviews, but no documentation section is generated. 
     333# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     334# undocumented members of documented classes, files or namespaces.
     335# If set to NO (the default) these members will be included in the
     336# various overviews, but no documentation section is generated.
    284337# This option has no effect if EXTRACT_ALL is enabled.
    285338
    286339HIDE_UNDOC_MEMBERS     = NO
    287340
    288 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    289 # undocumented classes that are normally visible in the class hierarchy. 
    290 # If set to NO (the default) these classes will be included in the various 
     341# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     342# undocumented classes that are normally visible in the class hierarchy.
     343# If set to NO (the default) these classes will be included in the various
    291344# overviews. This option has no effect if EXTRACT_ALL is enabled.
    292345
    293346HIDE_UNDOC_CLASSES     = NO
    294347
    295 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
    296 # friend (class|struct|union) declarations. 
    297 # If set to NO (the default) these declarations will be included in the 
     348# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     349# friend (class|struct|union) declarations.
     350# If set to NO (the default) these declarations will be included in the
    298351# documentation.
    299352
    300353HIDE_FRIEND_COMPOUNDS  = NO
    301354
    302 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
    303 # documentation blocks found inside the body of a function. 
    304 # If set to NO (the default) these blocks will be appended to the 
     355# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
     356# documentation blocks found inside the body of a function.
     357# If set to NO (the default) these blocks will be appended to the
    305358# function's detailed documentation block.
    306359
    307360HIDE_IN_BODY_DOCS      = NO
    308361
    309 # The INTERNAL_DOCS tag determines if documentation 
    310 # that is typed after a \internal command is included. If the tag is set 
    311 # to NO (the default) then the documentation will be excluded. 
     362# The INTERNAL_DOCS tag determines if documentation
     363# that is typed after a \internal command is included. If the tag is set
     364# to NO (the default) then the documentation will be excluded.
    312365# Set it to YES to include the internal documentation.
    313366
    314367INTERNAL_DOCS          = NO
    315368
    316 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
    317 # file names in lower-case letters. If set to YES upper-case letters are also 
    318 # allowed. This is useful if you have classes or files whose names only differ 
    319 # in case and if your file system supports case sensitive file names. Windows 
     369# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     370# file names in lower-case letters. If set to YES upper-case letters are also
     371# allowed. This is useful if you have classes or files whose names only differ
     372# in case and if your file system supports case sensitive file names. Windows
    320373# and Mac users are advised to set this option to NO.
    321374
    322375CASE_SENSE_NAMES       = YES
    323376
    324 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
    325 # will show members with their full class and namespace scopes in the 
     377# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     378# will show members with their full class and namespace scopes in the
    326379# documentation. If set to YES the scope will be hidden.
    327380
    328381HIDE_SCOPE_NAMES       = NO
    329382
    330 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
    331 # will put a list of the files that are included by a file in the documentation 
     383# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     384# will put a list of the files that are included by a file in the documentation
    332385# of that file.
    333386
    334387SHOW_INCLUDE_FILES     = YES
    335388
    336 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
     389# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    337390# is inserted in the documentation for inline members.
    338391
    339392INLINE_INFO            = YES
    340393
    341 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
    342 # will sort the (detailed) documentation of file and class members 
    343 # alphabetically by member name. If set to NO the members will appear in 
     394# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     395# will sort the (detailed) documentation of file and class members
     396# alphabetically by member name. If set to NO the members will appear in
    344397# declaration order.
    345398
    346399SORT_MEMBER_DOCS       = YES
    347400
    348 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
    349 # brief documentation of file, namespace and class members alphabetically 
    350 # by member name. If set to NO (the default) the members will appear in 
     401# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     402# brief documentation of file, namespace and class members alphabetically
     403# by member name. If set to NO (the default) the members will appear in
    351404# declaration order.
    352405
    353406SORT_BRIEF_DOCS        = NO
    354407
    355 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    356 # sorted by fully-qualified names, including namespaces. If set to
    357 # NO (the default), the class list will be sorted only by class name,
    358 # not including the namespace part.
     408# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     409
     410SORT_MEMBERS_CTORS_1ST = NO
     411
     412# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
     413# hierarchy of group names into alphabetical order. If set to NO (the default)
     414# the group names will appear in their defined order.
     415
     416SORT_GROUP_NAMES       = NO
     417
     418# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     419# sorted by fully-qualified names, including namespaces. If set to
     420# NO (the default), the class list will be sorted only by class name,
     421# not including the namespace part.
    359422# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    360 # Note: This option applies only to the class list, not to the 
     423# Note: This option applies only to the class list, not to the
    361424# alphabetical list.
    362425
    363426SORT_BY_SCOPE_NAME     = NO
    364427
    365 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
    366 # disable (NO) the todo list. This list is created by putting \todo 
     428# The GENERATE_TODOLIST tag can be used to enable (YES) or
     429# disable (NO) the todo list. This list is created by putting \todo
    367430# commands in the documentation.
    368431
    369432GENERATE_TODOLIST      = YES
    370433
    371 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
    372 # disable (NO) the test list. This list is created by putting \test 
     434# The GENERATE_TESTLIST tag can be used to enable (YES) or
     435# disable (NO) the test list. This list is created by putting \test
    373436# commands in the documentation.
    374437
    375438GENERATE_TESTLIST      = YES
    376439
    377 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
    378 # disable (NO) the bug list. This list is created by putting \bug 
     440# The GENERATE_BUGLIST tag can be used to enable (YES) or
     441# disable (NO) the bug list. This list is created by putting \bug
    379442# commands in the documentation.
    380443
    381444GENERATE_BUGLIST       = YES
    382445
    383 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
    384 # disable (NO) the deprecated list. This list is created by putting 
     446# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
     447# disable (NO) the deprecated list. This list is created by putting
    385448# \deprecated commands in the documentation.
    386449
    387450GENERATE_DEPRECATEDLIST= YES
    388451
    389 # The ENABLED_SECTIONS tag can be used to enable conditional 
     452# The ENABLED_SECTIONS tag can be used to enable conditional
    390453# documentation sections, marked by \if sectionname ... \endif.
    391454
    392 ENABLED_SECTIONS       = 
    393 
    394 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
    395 # the initial value of a variable or define consists of for it to appear in 
    396 # the documentation. If the initializer consists of more lines than specified 
    397 # here it will be hidden. Use a value of 0 to hide initializers completely. 
    398 # The appearance of the initializer of individual variables and defines in the 
    399 # documentation can be controlled using \showinitializer or \hideinitializer 
     455ENABLED_SECTIONS       =
     456
     457# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     458# the initial value of a variable or define consists of for it to appear in
     459# the documentation. If the initializer consists of more lines than specified
     460# here it will be hidden. Use a value of 0 to hide initializers completely.
     461# The appearance of the initializer of individual variables and defines in the
     462# documentation can be controlled using \showinitializer or \hideinitializer
    400463# command in the documentation regardless of this setting.
    401464
    402465MAX_INITIALIZER_LINES  = 30
    403466
    404 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
    405 # at the bottom of the documentation of classes and structs. If set to YES the 
     467# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
     468# at the bottom of the documentation of classes and structs. If set to YES the
    406469# list will mention the files that were used to generate the documentation.
    407470
    408471SHOW_USED_FILES        = YES
    409472
    410 # If the sources in your project are distributed over multiple directories 
    411 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
     473# If the sources in your project are distributed over multiple directories
     474# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    412475# in the documentation. The default is NO.
    413476
    414477SHOW_DIRECTORIES       = YES
    415478
    416 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
    417 # doxygen should invoke to get the current version for each file (typically from the
    418 # version control system). Doxygen will invoke the program by executing (via
    419 # popen()) the command <command> <input-file>, where <command> is the value of
    420 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    421 # provided by doxygen. Whatever the program writes to standard output
     479# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
     480# This will remove the Files entry from the Quick Index and from the
     481# Folder Tree View (if specified). The default is YES.
     482
     483SHOW_FILES             = YES
     484
     485# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
     486# Namespaces page.
     487# This will remove the Namespaces entry from the Quick Index
     488# and from the Folder Tree View (if specified). The default is YES.
     489
     490SHOW_NAMESPACES        = YES
     491
     492# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     493# doxygen should invoke to get the current version for each file (typically from
     494# the version control system). Doxygen will invoke the program by executing (via
     495# popen()) the command <command> <input-file>, where <command> is the value of
     496# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     497# provided by doxygen. Whatever the program writes to standard output
    422498# is used as the file version. See the manual for examples.
    423499
    424 FILE_VERSION_FILTER    =
     500FILE_VERSION_FILTER    =
     501
     502# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
     503# doxygen. The layout file controls the global structure of the generated output files
     504# in an output format independent way. The create the layout file that represents
     505# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
     506# file name after the option, if omitted DoxygenLayout.xml will be used as the name
     507# of the layout file.
     508
     509LAYOUT_FILE            =
    425510
    426511#---------------------------------------------------------------------------
     
    428513#---------------------------------------------------------------------------
    429514
    430 # The QUIET tag can be used to turn on/off the messages that are generated 
     515# The QUIET tag can be used to turn on/off the messages that are generated
    431516# by doxygen. Possible values are YES and NO. If left blank NO is used.
    432517
    433518QUIET                  = NO
    434519
    435 # The WARNINGS tag can be used to turn on/off the warning messages that are 
    436 # generated by doxygen. Possible values are YES and NO. If left blank 
     520# The WARNINGS tag can be used to turn on/off the warning messages that are
     521# generated by doxygen. Possible values are YES and NO. If left blank
    437522# NO is used.
    438523
    439524WARNINGS               = YES
    440525
    441 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
    442 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
     526# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     527# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    443528# automatically be disabled.
    444529
    445530WARN_IF_UNDOCUMENTED   = YES
    446531
    447 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
    448 # potential errors in the documentation, such as not documenting some 
    449 # parameters in a documented function, or documenting parameters that 
     532# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
     533# potential errors in the documentation, such as not documenting some
     534# parameters in a documented function, or documenting parameters that
    450535# don't exist or using markup commands wrongly.
    451536
    452537WARN_IF_DOC_ERROR      = YES
    453538
    454 # This WARN_NO_PARAMDOC option can be abled to get warnings for 
    455 # functions that are documented, but have no documentation for their parameters 
    456 # or return value. If set to NO (the default) doxygen will only warn about 
    457 # wrong or incomplete parameter documentation, but not about the absence of 
     539# This WARN_NO_PARAMDOC option can be abled to get warnings for
     540# functions that are documented, but have no documentation for their parameters
     541# or return value. If set to NO (the default) doxygen will only warn about
     542# wrong or incomplete parameter documentation, but not about the absence of
    458543# documentation.
    459544
    460545WARN_NO_PARAMDOC       = NO
    461546
    462 # The WARN_FORMAT tag determines the format of the warning messages that 
    463 # doxygen can produce. The string should contain the $file, $line, and $text 
    464 # tags, which will be replaced by the file and line number from which the 
    465 # warning originated and the warning text. Optionally the format may contain 
    466 # $version, which will be replaced by the version of the file (if it could 
     547# The WARN_FORMAT tag determines the format of the warning messages that
     548# doxygen can produce. The string should contain the $file, $line, and $text
     549# tags, which will be replaced by the file and line number from which the
     550# warning originated and the warning text. Optionally the format may contain
     551# $version, which will be replaced by the version of the file (if it could
    467552# be obtained via FILE_VERSION_FILTER)
    468553
    469554WARN_FORMAT            = "$file:$line: $text "
    470555
    471 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    472 # and error messages should be written. If left blank the output is written 
     556# The WARN_LOGFILE tag can be used to specify a file to which warning
     557# and error messages should be written. If left blank the output is written
    473558# to stderr.
    474559
    475 WARN_LOGFILE           = 
     560WARN_LOGFILE           =
    476561
    477562#---------------------------------------------------------------------------
     
    479564#---------------------------------------------------------------------------
    480565
    481 # The INPUT tag can be used to specify the files and/or directories that contain 
    482 # documented source files. You may enter file names like "myfile.cpp" or 
    483 # directories like "/usr/src/myproject". Separate the files or directories 
     566# The INPUT tag can be used to specify the files and/or directories that contain
     567# documented source files. You may enter file names like "myfile.cpp" or
     568# directories like "/usr/src/myproject". Separate the files or directories
    484569# with spaces.
    485570
    486 INPUT                  = ../src ../ext
    487 
    488 # This tag can be used to specify the character encoding of the source files that
    489 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
    490 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
    491 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
     571INPUT                  = ../src \
     572                         ../ext
     573
     574# This tag can be used to specify the character encoding of the source files
     575# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     576# also the default input encoding. Doxygen uses libiconv (or the iconv built
     577# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     578# the list of possible encodings.
    492579
    493580INPUT_ENCODING         = UTF-8
    494581
    495 # If the value of the INPUT tag contains directories, you can use the 
    496 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    497 # and *.h) to filter out the source-files in the directories. If left 
    498 # blank the following patterns are tested: 
    499 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
    500 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
    501 
    502 FILE_PATTERNS          = 
    503 
    504 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
    505 # should be searched for input files as well. Possible values are YES and NO. 
     582# If the value of the INPUT tag contains directories, you can use the
     583# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     584# and *.h) to filter out the source-files in the directories. If left
     585# blank the following patterns are tested:
     586# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     587# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     588
     589FILE_PATTERNS          =
     590
     591# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     592# should be searched for input files as well. Possible values are YES and NO.
    506593# If left blank NO is used.
    507594
    508595RECURSIVE              = YES
    509596
    510 # The EXCLUDE tag can be used to specify files and/or directories that should 
    511 # excluded from the INPUT source files. This way you can easily exclude a 
     597# The EXCLUDE tag can be used to specify files and/or directories that should
     598# excluded from the INPUT source files. This way you can easily exclude a
    512599# subdirectory from a directory tree whose root is specified with the INPUT tag.
    513600
    514 EXCLUDE                = 
    515 
    516 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
    517 # directories that are symbolic links (a Unix filesystem feature) are excluded 
     601EXCLUDE                =
     602
     603# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     604# directories that are symbolic links (a Unix filesystem feature) are excluded
    518605# from the input.
    519606
    520607EXCLUDE_SYMLINKS       = NO
    521608
    522 # If the value of the INPUT tag contains directories, you can use the 
    523 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
    524 # certain files from those directories. Note that the wildcards are matched 
    525 # against the file with absolute path, so to exclude all test directories 
     609# If the value of the INPUT tag contains directories, you can use the
     610# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     611# certain files from those directories. Note that the wildcards are matched
     612# against the file with absolute path, so to exclude all test directories
    526613# for example use the pattern */test/*
    527614
    528 EXCLUDE_PATTERNS       =
    529 
    530 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    531 # (namespaces, classes, functions, etc.) that should be excluded from the output.
    532 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
    533 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
    534 
    535 EXCLUDE_SYMBOLS        =
    536 
    537 # The EXAMPLE_PATH tag can be used to specify one or more files or
    538 # directories that contain example code fragments that are included (see
     615EXCLUDE_PATTERNS       =
     616
     617# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     618# (namespaces, classes, functions, etc.) that should be excluded from the
     619# output. The symbol name can be a fully qualified name, a word, or if the
     620# wildcard * is used, a substring. Examples: ANamespace, AClass,
     621# AClass::ANamespace, ANamespace::*Test
     622
     623EXCLUDE_SYMBOLS        =
     624
     625# The EXAMPLE_PATH tag can be used to specify one or more files or
     626# directories that contain example code fragments that are included (see
    539627# the \include command).
    540628
     
    542630                         ../
    543631
    544 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    545 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    546 # and *.h) to filter out the source-files in the directories. If left 
     632# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     633# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     634# and *.h) to filter out the source-files in the directories. If left
    547635# blank all files are included.
    548636
    549 EXAMPLE_PATTERNS       = 
    550 
    551 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    552 # searched for input files to be used with the \include or \dontinclude 
    553 # commands irrespective of the value of the RECURSIVE tag. 
     637EXAMPLE_PATTERNS       =
     638
     639# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     640# searched for input files to be used with the \include or \dontinclude
     641# commands irrespective of the value of the RECURSIVE tag.
    554642# Possible values are YES and NO. If left blank NO is used.
    555643
    556644EXAMPLE_RECURSIVE      = NO
    557645
    558 # The IMAGE_PATH tag can be used to specify one or more files or 
    559 # directories that contain image that are included in the documentation (see 
     646# The IMAGE_PATH tag can be used to specify one or more files or
     647# directories that contain image that are included in the documentation (see
    560648# the \image command).
    561649
    562 IMAGE_PATH             =
    563 
    564 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    565 # invoke to filter for each input file. Doxygen will invoke the filter program
    566 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    567 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    568 # input file. Doxygen will then use the output that the filter program writes
    569 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
     650IMAGE_PATH             =
     651
     652# The INPUT_FILTER tag can be used to specify a program that doxygen should
     653# invoke to filter for each input file. Doxygen will invoke the filter program
     654# by executing (via popen()) the command <filter> <input-file>, where <filter>
     655# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     656# input file. Doxygen will then use the output that the filter program writes
     657# to standard output.
     658# If FILTER_PATTERNS is specified, this tag will be
    570659# ignored.
    571660
    572 INPUT_FILTER           =
    573 
    574 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    575 # basis.  Doxygen will compare the file name with each pattern and apply the
    576 # filter if there is a match.  The filters are a list of the form:
    577 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    578 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     661INPUT_FILTER           =
     662
     663# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     664# basis.
     665# Doxygen will compare the file name with each pattern and apply the
     666# filter if there is a match.
     667# The filters are a list of the form:
     668# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     669# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    579670# is applied to all files.
    580671
    581 FILTER_PATTERNS        = 
    582 
    583 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
    584 # INPUT_FILTER) will be used to filter the input files when producing source 
     672FILTER_PATTERNS        =
     673
     674# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     675# INPUT_FILTER) will be used to filter the input files when producing source
    585676# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    586677
     
    591682#---------------------------------------------------------------------------
    592683
    593 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    594 # be generated. Documented entities will be cross-referenced with these sources.
    595 # Note: To get rid of all source code in the generated output, make sure also
    596 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
    597 # then you must also enable this option. If you don't then doxygen will produce
    598 # a warning and turn it on anyway
     684# If the SOURCE_BROWSER tag is set to YES then a list of source files will
     685# be generated. Documented entities will be cross-referenced with these sources.
     686# Note: To get rid of all source code in the generated output, make sure also
     687# VERBATIM_HEADERS is set to NO.
    599688
    600689SOURCE_BROWSER         = YES
    601690
    602 # Setting the INLINE_SOURCES tag to YES will include the body 
     691# Setting the INLINE_SOURCES tag to YES will include the body
    603692# of functions and classes directly in the documentation.
    604693
    605694INLINE_SOURCES         = NO
    606695
    607 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    608 # doxygen to hide any special comment blocks from generated source code 
     696# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     697# doxygen to hide any special comment blocks from generated source code
    609698# fragments. Normal C and C++ comments will always remain visible.
    610699
    611700STRIP_CODE_COMMENTS    = YES
    612701
    613 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
    614 # then for each documented function all documented 
     702# If the REFERENCED_BY_RELATION tag is set to YES
     703# then for each documented function all documented
    615704# functions referencing it will be listed.
    616705
    617706REFERENCED_BY_RELATION = YES
    618707
    619 # If the REFERENCES_RELATION tag is set to YES (the default)
    620 # then for each documented function all documented entities 
     708# If the REFERENCES_RELATION tag is set to YES
     709# then for each documented function all documented entities
    621710# called/used by that function will be listed.
    622711
     
    626715# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    627716# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    628 # link to the source code.  Otherwise they will link to the documentstion.
     717# link to the source code.
     718# Otherwise they will link to the documentation.
    629719
    630720REFERENCES_LINK_SOURCE = YES
    631721
    632 # If the USE_HTAGS tag is set to YES then the references to source code 
    633 # will point to the HTML generated by the htags(1) tool instead of doxygen 
    634 # built-in source browser. The htags tool is part of GNU's global source 
    635 # tagging system (see http://www.gnu.org/software/global/global.html). You 
     722# If the USE_HTAGS tag is set to YES then the references to source code
     723# will point to the HTML generated by the htags(1) tool instead of doxygen
     724# built-in source browser. The htags tool is part of GNU's global source
     725# tagging system (see http://www.gnu.org/software/global/global.html). You
    636726# will need version 4.8.6 or higher.
    637727
    638728USE_HTAGS              = NO
    639729
    640 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
    641 # will generate a verbatim copy of the header file for each class for 
     730# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     731# will generate a verbatim copy of the header file for each class for
    642732# which an include is specified. Set to NO to disable this.
    643733
     
    648738#---------------------------------------------------------------------------
    649739
    650 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    651 # of all compounds will be generated. Enable this if the project 
     740# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     741# of all compounds will be generated. Enable this if the project
    652742# contains a lot of classes, structs, unions or interfaces.
    653743
    654744ALPHABETICAL_INDEX     = NO
    655745
    656 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    657 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     746# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     747# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    658748# in which this list will be split (can be a number in the range [1..20])
    659749
    660750COLS_IN_ALPHA_INDEX    = 5
    661751
    662 # In case all classes in a project start with a common prefix, all 
    663 # classes will be put under the same header in the alphabetical index. 
    664 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     752# In case all classes in a project start with a common prefix, all
     753# classes will be put under the same header in the alphabetical index.
     754# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    665755# should be ignored while generating the index headers.
    666756
    667 IGNORE_PREFIX          = 
     757IGNORE_PREFIX          =
    668758
    669759#---------------------------------------------------------------------------
     
    671761#---------------------------------------------------------------------------
    672762
    673 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     763# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    674764# generate HTML output.
    675765
    676766GENERATE_HTML          = YES
    677767
    678 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    679 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     768# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     769# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    680770# put in front of it. If left blank `html' will be used as the default path.
    681771
    682772HTML_OUTPUT            = html
    683773
    684 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    685 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
     774# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     775# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    686776# doxygen will generate files with .html extension.
    687777
    688778HTML_FILE_EXTENSION    = .html
    689779
    690 # The HTML_HEADER tag can be used to specify a personal HTML header for 
    691 # each generated HTML page. If it is left blank doxygen will generate a 
     780# The HTML_HEADER tag can be used to specify a personal HTML header for
     781# each generated HTML page. If it is left blank doxygen will generate a
    692782# standard header.
    693783
    694 HTML_HEADER            = 
    695 
    696 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    697 # each generated HTML page. If it is left blank doxygen will generate a 
     784HTML_HEADER            =
     785
     786# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     787# each generated HTML page. If it is left blank doxygen will generate a
    698788# standard footer.
    699789
    700 HTML_FOOTER            = 
    701 
    702 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
    703 # style sheet that is used by each HTML page. It can be used to 
    704 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
    705 # will generate a default style sheet. Note that doxygen will try to copy 
    706 # the style sheet file to the HTML output directory, so don't put your own 
     790HTML_FOOTER            =
     791
     792# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     793# style sheet that is used by each HTML page. It can be used to
     794# fine-tune the look of the HTML output. If the tag is left blank doxygen
     795# will generate a default style sheet. Note that doxygen will try to copy
     796# the style sheet file to the HTML output directory, so don't put your own
    707797# stylesheet in the HTML output directory as well, or it will be erased!
    708798
    709799HTML_STYLESHEET        = aubio.css
    710800
    711 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
    712 # files or namespaces will be aligned in HTML using tables. If set to 
     801# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     802# files or namespaces will be aligned in HTML using tables. If set to
    713803# NO a bullet list will be used.
    714804
    715805HTML_ALIGN_MEMBERS     = YES
    716806
    717 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    718 # will be generated that can be used as input for tools like the
    719 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     807# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     808# documentation will contain sections that can be hidden and shown after the
     809# page has loaded. For this to work a browser that supports
     810# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     811# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     812
     813HTML_DYNAMIC_SECTIONS  = NO
     814
     815# If the GENERATE_DOCSET tag is set to YES, additional index files
     816# will be generated that can be used as input for Apple's Xcode 3
     817# integrated development environment, introduced with OSX 10.5 (Leopard).
     818# To create a documentation set, doxygen will generate a Makefile in the
     819# HTML output directory. Running make will produce the docset in that
     820# directory and running "make install" will install the docset in
     821# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     822# it at startup.
     823# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     824
     825GENERATE_DOCSET        = NO
     826
     827# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     828# feed. A documentation feed provides an umbrella under which multiple
     829# documentation sets from a single provider (such as a company or product suite)
     830# can be grouped.
     831
     832DOCSET_FEEDNAME        = "Doxygen generated docs"
     833
     834# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     835# should uniquely identify the documentation set bundle. This should be a
     836# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     837# will append .docset to the name.
     838
     839DOCSET_BUNDLE_ID       = org.doxygen.Project
     840
     841# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     842# will be generated that can be used as input for tools like the
     843# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    720844# of the generated HTML documentation.
    721845
    722846GENERATE_HTMLHELP      = NO
    723847
    724 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    725 # documentation will contain sections that can be hidden and shown after the
    726 # page has loaded. For this to work a browser that supports
    727 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    728 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
    729 
    730 HTML_DYNAMIC_SECTIONS  = NO
    731 
    732 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    733 # be used to specify the file name of the resulting .chm file. You
    734 # can add a path in front of the file if the result should not be
     848# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     849# be used to specify the file name of the resulting .chm file. You
     850# can add a path in front of the file if the result should not be
    735851# written to the html output directory.
    736852
    737 CHM_FILE               = 
    738 
    739 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    740 # be used to specify the location (absolute path including file name) of 
    741 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
     853CHM_FILE               =
     854
     855# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     856# be used to specify the location (absolute path including file name) of
     857# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    742858# the HTML help compiler on the generated index.hhp.
    743859
    744 HHC_LOCATION           = 
    745 
    746 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    747 # controls if a separate .chi index file is generated (YES) or that 
     860HHC_LOCATION           =
     861
     862# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     863# controls if a separate .chi index file is generated (YES) or that
    748864# it should be included in the master .chm file (NO).
    749865
    750866GENERATE_CHI           = NO
    751867
    752 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    753 # controls whether a binary table of contents is generated (YES) or a
     868# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     869# is used to encode HtmlHelp index (hhk), content (hhc) and project file
     870# content.
     871
     872CHM_INDEX_ENCODING     =
     873
     874# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     875# controls whether a binary table of contents is generated (YES) or a
    754876# normal table of contents (NO) in the .chm file.
    755877
    756878BINARY_TOC             = NO
    757879
    758 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     880# The TOC_EXPAND flag can be set to YES to add extra items for group members
    759881# to the contents of the HTML help documentation and to the tree view.
    760882
    761883TOC_EXPAND             = NO
    762884
    763 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    764 # top of each HTML page. The value NO (the default) enables the index and
     885# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
     886# are set, an additional index file will be generated that can be used as input for
     887# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
     888# HTML documentation.
     889
     890GENERATE_QHP           = NO
     891
     892# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     893# be used to specify the file name of the resulting .qch file.
     894# The path specified is relative to the HTML output folder.
     895
     896QCH_FILE               =
     897
     898# The QHP_NAMESPACE tag specifies the namespace to use when generating
     899# Qt Help Project output. For more information please see
     900# http://doc.trolltech.com/qthelpproject.html#namespace
     901
     902QHP_NAMESPACE          =
     903
     904# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     905# Qt Help Project output. For more information please see
     906# http://doc.trolltech.com/qthelpproject.html#virtual-folders
     907
     908QHP_VIRTUAL_FOLDER     = doc
     909
     910# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
     911# For more information please see
     912# http://doc.trolltech.com/qthelpproject.html#custom-filters
     913
     914QHP_CUST_FILTER_NAME   =
     915
     916# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
     917# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     918
     919QHP_CUST_FILTER_ATTRS  =
     920
     921# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     922# filter section matches.
     923# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     924
     925QHP_SECT_FILTER_ATTRS  =
     926
     927# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     928# be used to specify the location of Qt's qhelpgenerator.
     929# If non-empty doxygen will try to run qhelpgenerator on the generated
     930# .qhp file.
     931
     932QHG_LOCATION           =
     933
     934# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     935# top of each HTML page. The value NO (the default) enables the index and
    765936# the value YES disables it.
    766937
    767938DISABLE_INDEX          = NO
    768939
    769 # This tag can be used to set the number of enum values (range [1..20]) 
     940# This tag can be used to set the number of enum values (range [1..20])
    770941# that doxygen will group on one line in the generated HTML documentation.
    771942
    772943ENUM_VALUES_PER_LINE   = 4
    773944
    774 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    775 # generated containing a tree-like index structure (just like the one that
    776 # is generated for HTML Help). For this to work a browser that supports
    777 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    778 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    779 # probably better off using the HTML help feature.
     945# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     946# structure should be generated to display hierarchical information.
     947# If the tag value is set to YES, a side panel will be generated
     948# containing a tree-like index structure (just like the one that
     949# is generated for HTML Help). For this to work a browser that supports
     950# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
     951# Windows users are probably better off using the HTML help feature.
    780952
    781953GENERATE_TREEVIEW      = NO
    782954
    783 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    784 # used to set the initial width (in pixels) of the frame in which the tree
     955# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
     956# and Class Hierarchy pages using a tree view instead of an ordered list.
     957
     958USE_INLINE_TREES       = NO
     959
     960# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     961# used to set the initial width (in pixels) of the frame in which the tree
    785962# is shown.
    786963
    787964TREEVIEW_WIDTH         = 250
    788965
     966# Use this tag to change the font size of Latex formulas included
     967# as images in the HTML documentation. The default is 10. Note that
     968# when you change the font size after a successful doxygen run you need
     969# to manually remove any form_*.png images from the HTML output directory
     970# to force them to be regenerated.
     971
     972FORMULA_FONTSIZE       = 10
     973
     974# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
     975# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
     976# there is already a search function so this one should typically
     977# be disabled.
     978
     979SEARCHENGINE           = YES
     980
    789981#---------------------------------------------------------------------------
    790982# configuration options related to the LaTeX output
    791983#---------------------------------------------------------------------------
    792984
    793 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     985# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    794986# generate Latex output.
    795987
    796988GENERATE_LATEX         = NO
    797989
    798 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    799 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     990# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     991# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    800992# put in front of it. If left blank `latex' will be used as the default path.
    801993
    802994LATEX_OUTPUT           = latex
    803995
    804 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
     996# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    805997# invoked. If left blank `latex' will be used as the default command name.
    806998
    807999LATEX_CMD_NAME         = latex
    8081000
    809 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
    810 # generate index for LaTeX. If left blank `makeindex' will be used as the 
     1001# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     1002# generate index for LaTeX. If left blank `makeindex' will be used as the
    8111003# default command name.
    8121004
    8131005MAKEINDEX_CMD_NAME     = makeindex
    8141006
    815 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    816 # LaTeX documents. This may be useful for small projects and may help to 
     1007# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     1008# LaTeX documents. This may be useful for small projects and may help to
    8171009# save some trees in general.
    8181010
    8191011COMPACT_LATEX          = NO
    8201012
    821 # The PAPER_TYPE tag can be used to set the paper type that is used 
    822 # by the printer. Possible values are: a4, a4wide, letter, legal and 
     1013# The PAPER_TYPE tag can be used to set the paper type that is used
     1014# by the printer. Possible values are: a4, a4wide, letter, legal and
    8231015# executive. If left blank a4wide will be used.
    8241016
    8251017PAPER_TYPE             = a4wide
    8261018
    827 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     1019# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    8281020# packages that should be included in the LaTeX output.
    8291021
    830 EXTRA_PACKAGES         = 
    831 
    832 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    833 # the generated latex document. The header should contain everything until 
    834 # the first chapter. If it is left blank doxygen will generate a 
     1022EXTRA_PACKAGES         =
     1023
     1024# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     1025# the generated latex document. The header should contain everything until
     1026# the first chapter. If it is left blank doxygen will generate a
    8351027# standard header. Notice: only use this tag if you know what you are doing!
    8361028
    837 LATEX_HEADER           = 
    838 
    839 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
    840 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
    841 # contain links (just like the HTML output) instead of page references 
     1029LATEX_HEADER           =
     1030
     1031# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     1032# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     1033# contain links (just like the HTML output) instead of page references
    8421034# This makes the output suitable for online browsing using a pdf viewer.
    8431035
    8441036PDF_HYPERLINKS         = NO
    8451037
    846 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    847 # plain latex in the generated Makefile. Set this option to YES to get a 
     1038# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     1039# plain latex in the generated Makefile. Set this option to YES to get a
    8481040# higher quality PDF documentation.
    8491041
    8501042USE_PDFLATEX           = NO
    8511043
    852 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    853 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    854 # running if errors occur, instead of asking the user for help. 
     1044# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     1045# command to the generated LaTeX files. This will instruct LaTeX to keep
     1046# running if errors occur, instead of asking the user for help.
    8551047# This option is also used when generating formulas in HTML.
    8561048
    8571049LATEX_BATCHMODE        = NO
    8581050
    859 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
    860 # include the index chapters (such as File Index, Compound Index, etc.) 
     1051# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     1052# include the index chapters (such as File Index, Compound Index, etc.)
    8611053# in the output.
    8621054
    8631055LATEX_HIDE_INDICES     = NO
    8641056
     1057# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
     1058
     1059LATEX_SOURCE_CODE      = NO
     1060
    8651061#---------------------------------------------------------------------------
    8661062# configuration options related to the RTF output
    8671063#---------------------------------------------------------------------------
    8681064
    869 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    870 # The RTF output is optimized for Word 97 and may not look very pretty with 
     1065# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     1066# The RTF output is optimized for Word 97 and may not look very pretty with
    8711067# other RTF readers or editors.
    8721068
    8731069GENERATE_RTF           = NO
    8741070
    875 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    876 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1071# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     1072# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    8771073# put in front of it. If left blank `rtf' will be used as the default path.
    8781074
    8791075RTF_OUTPUT             = rtf
    8801076
    881 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    882 # RTF documents. This may be useful for small projects and may help to 
     1077# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     1078# RTF documents. This may be useful for small projects and may help to
    8831079# save some trees in general.
    8841080
    8851081COMPACT_RTF            = NO
    8861082
    887 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    888 # will contain hyperlink fields. The RTF file will 
    889 # contain links (just like the HTML output) instead of page references. 
    890 # This makes the output suitable for online browsing using WORD or other 
    891 # programs which support those fields. 
     1083# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     1084# will contain hyperlink fields. The RTF file will
     1085# contain links (just like the HTML output) instead of page references.
     1086# This makes the output suitable for online browsing using WORD or other
     1087# programs which support those fields.
    8921088# Note: wordpad (write) and others do not support links.
    8931089
    8941090RTF_HYPERLINKS         = NO
    8951091
    896 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
    897 # config file, i.e. a series of assignments. You only have to provide 
     1092# Load stylesheet definitions from file. Syntax is similar to doxygen's
     1093# config file, i.e. a series of assignments. You only have to provide
    8981094# replacements, missing definitions are set to their default value.
    8991095
    900 RTF_STYLESHEET_FILE    = 
    901 
    902 # Set optional variables used in the generation of an rtf document. 
     1096RTF_STYLESHEET_FILE    =
     1097
     1098# Set optional variables used in the generation of an rtf document.
    9031099# Syntax is similar to doxygen's config file.
    9041100
    905 RTF_EXTENSIONS_FILE    = 
     1101RTF_EXTENSIONS_FILE    =
    9061102
    9071103#---------------------------------------------------------------------------
     
    9091105#---------------------------------------------------------------------------
    9101106
    911 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     1107# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    9121108# generate man pages
    9131109
    9141110GENERATE_MAN           = NO
    9151111
    916 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
    917 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1112# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     1113# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    9181114# put in front of it. If left blank `man' will be used as the default path.
    9191115
    9201116MAN_OUTPUT             = man
    9211117
    922 # The MAN_EXTENSION tag determines the extension that is added to 
     1118# The MAN_EXTENSION tag determines the extension that is added to
    9231119# the generated man pages (default is the subroutine's section .3)
    9241120
    9251121MAN_EXTENSION          = .3
    9261122
    927 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
    928 # then it will generate one additional man file for each entity 
    929 # documented in the real man page(s). These additional files 
    930 # only source the real man page, but without them the man command 
     1123# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     1124# then it will generate one additional man file for each entity
     1125# documented in the real man page(s). These additional files
     1126# only source the real man page, but without them the man command
    9311127# would be unable to find the correct page. The default is NO.
    9321128
     
    9371133#---------------------------------------------------------------------------
    9381134
    939 # If the GENERATE_XML tag is set to YES Doxygen will 
    940 # generate an XML file that captures the structure of 
     1135# If the GENERATE_XML tag is set to YES Doxygen will
     1136# generate an XML file that captures the structure of
    9411137# the code including all documentation.
    9421138
    9431139GENERATE_XML           = NO
    9441140
    945 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
    946 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1141# The XML_OUTPUT tag is used to specify where the XML pages will be put.
     1142# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    9471143# put in front of it. If left blank `xml' will be used as the default path.
    9481144
    9491145XML_OUTPUT             = xml
    9501146
    951 # The XML_SCHEMA tag can be used to specify an XML schema, 
    952 # which can be used by a validating XML parser to check the 
     1147# The XML_SCHEMA tag can be used to specify an XML schema,
     1148# which can be used by a validating XML parser to check the
    9531149# syntax of the XML files.
    9541150
    955 XML_SCHEMA             = 
    956 
    957 # The XML_DTD tag can be used to specify an XML DTD, 
    958 # which can be used by a validating XML parser to check the 
     1151XML_SCHEMA             =
     1152
     1153# The XML_DTD tag can be used to specify an XML DTD,
     1154# which can be used by a validating XML parser to check the
    9591155# syntax of the XML files.
    9601156
    961 XML_DTD                = 
    962 
    963 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
    964 # dump the program listings (including syntax highlighting 
    965 # and cross-referencing information) to the XML output. Note that 
     1157XML_DTD                =
     1158
     1159# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     1160# dump the program listings (including syntax highlighting
     1161# and cross-referencing information) to the XML output. Note that
    9661162# enabling this will significantly increase the size of the XML output.
    9671163
     
    9721168#---------------------------------------------------------------------------
    9731169
    974 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
    975 # generate an AutoGen Definitions (see autogen.sf.net) file 
    976 # that captures the structure of the code including all 
    977 # documentation. Note that this feature is still experimental 
     1170# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     1171# generate an AutoGen Definitions (see autogen.sf.net) file
     1172# that captures the structure of the code including all
     1173# documentation. Note that this feature is still experimental
    9781174# and incomplete at the moment.
    9791175
     
    9841180#---------------------------------------------------------------------------
    9851181
    986 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
    987 # generate a Perl module file that captures the structure of 
    988 # the code including all documentation. Note that this 
    989 # feature is still experimental and incomplete at the 
     1182# If the GENERATE_PERLMOD tag is set to YES Doxygen will
     1183# generate a Perl module file that captures the structure of
     1184# the code including all documentation. Note that this
     1185# feature is still experimental and incomplete at the
    9901186# moment.
    9911187
    9921188GENERATE_PERLMOD       = NO
    9931189
    994 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
    995 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
     1190# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
     1191# the necessary Makefile rules, Perl scripts and LaTeX code to be able
    9961192# to generate PDF and DVI output from the Perl module output.
    9971193
    9981194PERLMOD_LATEX          = NO
    9991195
    1000 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    1001 # nicely formatted so it can be parsed by a human reader.  This is useful
    1002 # if you want to understand what is going on.  On the other hand, if this
    1003 # tag is set to NO the size of the Perl module output will be much smaller
     1196# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
     1197# nicely formatted so it can be parsed by a human reader.
     1198# This is useful
     1199# if you want to understand what is going on.
     1200# On the other hand, if this
     1201# tag is set to NO the size of the Perl module output will be much smaller
    10041202# and Perl will parse it just the same.
    10051203
    10061204PERLMOD_PRETTY         = YES
    10071205
    1008 # The names of the make variables in the generated doxyrules.make file 
    1009 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
    1010 # This is useful so different doxyrules.make files included by the same 
     1206# The names of the make variables in the generated doxyrules.make file
     1207# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
     1208# This is useful so different doxyrules.make files included by the same
    10111209# Makefile don't overwrite each other's variables.
    10121210
    1013 PERLMOD_MAKEVAR_PREFIX = 
    1014 
    1015 #---------------------------------------------------------------------------
    1016 # Configuration options related to the preprocessor   
    1017 #---------------------------------------------------------------------------
    1018 
    1019 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
    1020 # evaluate all C-preprocessor directives found in the sources and include 
     1211PERLMOD_MAKEVAR_PREFIX =
     1212
     1213#---------------------------------------------------------------------------
     1214# Configuration options related to the preprocessor
     1215#---------------------------------------------------------------------------
     1216
     1217# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     1218# evaluate all C-preprocessor directives found in the sources and include
    10211219# files.
    10221220
    10231221ENABLE_PREPROCESSING   = YES
    10241222
    1025 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
    1026 # names in the source code. If set to NO (the default) only conditional 
    1027 # compilation will be performed. Macro expansion can be done in a controlled 
     1223# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     1224# names in the source code. If set to NO (the default) only conditional
     1225# compilation will be performed. Macro expansion can be done in a controlled
    10281226# way by setting EXPAND_ONLY_PREDEF to YES.
    10291227
    10301228MACRO_EXPANSION        = NO
    10311229
    1032 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
    1033 # then the macro expansion is limited to the macros specified with the 
     1230# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     1231# then the macro expansion is limited to the macros specified with the
    10341232# PREDEFINED and EXPAND_AS_DEFINED tags.
    10351233
    10361234EXPAND_ONLY_PREDEF     = NO
    10371235
    1038 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
     1236# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    10391237# in the INCLUDE_PATH (see below) will be search if a #include is found.
    10401238
    10411239SEARCH_INCLUDES        = YES
    10421240
    1043 # The INCLUDE_PATH tag can be used to specify one or more directories that 
    1044 # contain include files that are not input files but should be processed by 
     1241# The INCLUDE_PATH tag can be used to specify one or more directories that
     1242# contain include files that are not input files but should be processed by
    10451243# the preprocessor.
    10461244
    1047 INCLUDE_PATH           = 
    1048 
    1049 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
    1050 # patterns (like *.h and *.hpp) to filter out the header-files in the 
    1051 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
     1245INCLUDE_PATH           =
     1246
     1247# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1248# patterns (like *.h and *.hpp) to filter out the header-files in the
     1249# directories. If left blank, the patterns specified with FILE_PATTERNS will
    10521250# be used.
    10531251
    1054 INCLUDE_FILE_PATTERNS  = 
    1055 
    1056 # The PREDEFINED tag can be used to specify one or more macro names that 
    1057 # are defined before the preprocessor is started (similar to the -D option of 
    1058 # gcc). The argument of the tag is a list of macros of the form: name 
    1059 # or name=definition (no spaces). If the definition and the = are 
    1060 # omitted =1 is assumed. To prevent a macro definition from being 
    1061 # undefined via #undef or recursively expanded use the := operator 
     1252INCLUDE_FILE_PATTERNS  =
     1253
     1254# The PREDEFINED tag can be used to specify one or more macro names that
     1255# are defined before the preprocessor is started (similar to the -D option of
     1256# gcc). The argument of the tag is a list of macros of the form: name
     1257# or name=definition (no spaces). If the definition and the = are
     1258# omitted =1 is assumed. To prevent a macro definition from being
     1259# undefined via #undef or recursively expanded use the := operator
    10621260# instead of the = operator.
    10631261
    1064 PREDEFINED             = 
    1065 
    1066 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
    1067 # this tag can be used to specify a list of macro names that should be expanded. 
    1068 # The macro definition that is found in the sources will be used. 
     1262PREDEFINED             =
     1263
     1264# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     1265# this tag can be used to specify a list of macro names that should be expanded.
     1266# The macro definition that is found in the sources will be used.
    10691267# Use the PREDEFINED tag if you want to use a different macro definition.
    10701268
    1071 EXPAND_AS_DEFINED      = 
    1072 
    1073 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    1074 # doxygen's preprocessor will remove all function-like macros that are alone 
    1075 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
    1076 # function macros are typically used for boiler-plate code, and will confuse 
     1269EXPAND_AS_DEFINED      =
     1270
     1271# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     1272# doxygen's preprocessor will remove all function-like macros that are alone
     1273# on a line, have an all uppercase name, and do not end with a semicolon. Such
     1274# function macros are typically used for boiler-plate code, and will confuse
    10771275# the parser if not removed.
    10781276
     
    10801278
    10811279#---------------------------------------------------------------------------
    1082 # Configuration::additions related to external references   
    1083 #---------------------------------------------------------------------------
    1084 
    1085 # The TAGFILES option can be used to specify one or more tagfiles.
    1086 # Optionally an initial location of the external documentation
    1087 # can be added for each tagfile. The format of a tag file without
    1088 # this location is as follows:
    1089 #   TAGFILES = file1 file2 ...
    1090 # Adding location for the tag files is done as follows:
    1091 #   TAGFILES = file1=loc1 "file2 = loc2" ...
    1092 # where "loc1" and "loc2" can be relative or absolute paths or
    1093 # URLs. If a location is present for each tag, the installdox tool
     1280# Configuration::additions related to external references
     1281#---------------------------------------------------------------------------
     1282
     1283# The TAGFILES option can be used to specify one or more tagfiles.
     1284# Optionally an initial location of the external documentation
     1285# can be added for each tagfile. The format of a tag file without
     1286# this location is as follows:
     1287#
     1288# TAGFILES = file1 file2 ...
     1289# Adding location for the tag files is done as follows:
     1290#
     1291# TAGFILES = file1=loc1 "file2 = loc2" ...
     1292# where "loc1" and "loc2" can be relative or absolute paths or
     1293# URLs. If a location is present for each tag, the installdox tool
    10941294# does not have to be run to correct the links.
    10951295# Note that each tag file must have a unique name
    10961296# (where the name does NOT include the path)
    1097 # If a tag file is not located in the directory in which doxygen 
     1297# If a tag file is not located in the directory in which doxygen
    10981298# is run, you must also specify the path to the tagfile here.
    10991299
    1100 TAGFILES               = 
    1101 
    1102 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
     1300TAGFILES               =
     1301
     1302# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    11031303# a tag file that is based on the input files it reads.
    11041304
    1105 GENERATE_TAGFILE       = 
    1106 
    1107 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    1108 # in the class index. If set to NO only the inherited external classes 
     1305GENERATE_TAGFILE       =
     1306
     1307# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     1308# in the class index. If set to NO only the inherited external classes
    11091309# will be listed.
    11101310
    11111311ALLEXTERNALS           = NO
    11121312
    1113 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
    1114 # in the modules index. If set to NO, only the current project's groups will 
     1313# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
     1314# in the modules index. If set to NO, only the current project's groups will
    11151315# be listed.
    11161316
    11171317EXTERNAL_GROUPS        = YES
    11181318
    1119 # The PERL_PATH should be the absolute path and name of the perl script 
     1319# The PERL_PATH should be the absolute path and name of the perl script
    11201320# interpreter (i.e. the result of `which perl').
    11211321
     
    11231323
    11241324#---------------------------------------------------------------------------
    1125 # Configuration options related to the dot tool   
    1126 #---------------------------------------------------------------------------
    1127 
    1128 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
    1129 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
    1130 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
    1131 # this option is superseded by the HAVE_DOT option below. This is only a 
    1132 # fallback. It is recommended to install and use dot, since it yields more 
     1325# Configuration options related to the dot tool
     1326#---------------------------------------------------------------------------
     1327
     1328# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     1329# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1330# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1331# this option is superseded by the HAVE_DOT option below. This is only a
     1332# fallback. It is recommended to install and use dot, since it yields more
    11331333# powerful graphs.
    11341334
    11351335CLASS_DIAGRAMS         = YES
    11361336
    1137 # You can define message sequence charts within doxygen comments using the \msc
    1138 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
    1139 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
    1140 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
    1141 # be found in the default search path.
    1142 
    1143 MSCGEN_PATH            =
    1144 
    1145 # If set to YES, the inheritance and collaboration graphs will hide
    1146 # inheritance and usage relations if the target is undocumented
     1337# You can define message sequence charts within doxygen comments using the \msc
     1338# command. Doxygen will then run the mscgen tool (see
     1339# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1340# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1341# the mscgen tool resides. If left empty the tool is assumed to be found in the
     1342# default search path.
     1343
     1344MSCGEN_PATH            =
     1345
     1346# If set to YES, the inheritance and collaboration graphs will hide
     1347# inheritance and usage relations if the target is undocumented
    11471348# or is not a class.
    11481349
    11491350HIDE_UNDOC_RELATIONS   = NO
    11501351
    1151 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
    1152 # available from the path. This tool is part of Graphviz, a graph visualization 
    1153 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
     1352# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     1353# available from the path. This tool is part of Graphviz, a graph visualization
     1354# toolkit from AT&T and Lucent Bell Labs. The other options in this section
    11541355# have no effect if this option is set to NO (the default)
    11551356
    11561357HAVE_DOT               = YES
    11571358
    1158 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1159 # will generate a graph for each documented class showing the direct and
    1160 # indirect inheritance relations. Setting this tag to YES will force the
     1359# By default doxygen will write a font called FreeSans.ttf to the output
     1360# directory and reference it in all dot files that doxygen generates. This
     1361# font does not include all possible unicode characters however, so when you need
     1362# these (or just want a differently looking font) you can specify the font name
     1363# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
     1364# which can be done by putting it in a standard location or by setting the
     1365# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
     1366# containing the font.
     1367
     1368DOT_FONTNAME           = FreeSans
     1369
     1370# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
     1371# The default size is 10pt.
     1372
     1373DOT_FONTSIZE           = 10
     1374
     1375# By default doxygen will tell dot to use the output directory to look for the
     1376# FreeSans.ttf font (which doxygen will put there itself). If you specify a
     1377# different font using DOT_FONTNAME you can set the path where dot
     1378# can find it using this tag.
     1379
     1380DOT_FONTPATH           =
     1381
     1382# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1383# will generate a graph for each documented class showing the direct and
     1384# indirect inheritance relations. Setting this tag to YES will force the
    11611385# the CLASS_DIAGRAMS tag to NO.
    11621386
    11631387CLASS_GRAPH            = YES
    11641388
    1165 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    1166 # will generate a graph for each documented class showing the direct and 
    1167 # indirect implementation dependencies (inheritance, containment, and 
     1389# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1390# will generate a graph for each documented class showing the direct and
     1391# indirect implementation dependencies (inheritance, containment, and
    11681392# class references variables) of the class with other documented classes.
    11691393
    11701394COLLABORATION_GRAPH    = YES
    11711395
    1172 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
     1396# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    11731397# will generate a graph for groups, showing the direct groups dependencies
    11741398
    11751399GROUP_GRAPHS           = YES
    11761400
    1177 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
    1178 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
     1401# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     1402# collaboration diagrams in a style similar to the OMG's Unified Modeling
    11791403# Language.
    11801404
    11811405UML_LOOK               = NO
    11821406
    1183 # If set to YES, the inheritance and collaboration graphs will show the 
     1407# If set to YES, the inheritance and collaboration graphs will show the
    11841408# relations between templates and their instances.
    11851409
    11861410TEMPLATE_RELATIONS     = NO
    11871411
    1188 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    1189 # tags are set to YES then doxygen will generate a graph for each documented 
    1190 # file showing the direct and indirect include dependencies of the file with 
     1412# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     1413# tags are set to YES then doxygen will generate a graph for each documented
     1414# file showing the direct and indirect include dependencies of the file with
    11911415# other documented files.
    11921416
    11931417INCLUDE_GRAPH          = YES
    11941418
    1195 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    1196 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    1197 # documented header file showing the documented files that directly or 
     1419# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     1420# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     1421# documented header file showing the documented files that directly or
    11981422# indirectly include this file.
    11991423
    12001424INCLUDED_BY_GRAPH      = YES
    12011425
    1202 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    1203 # generate a call dependency graph for every global function or class method.
    1204 # Note that enabling this option will significantly increase the time of a run.
    1205 # So in most cases it will be better to enable call graphs for selected
    1206 # functions only using the \callgraph command.
     1426# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1427# doxygen will generate a call dependency graph for every global function
     1428# or class method. Note that enabling this option will significantly increase
     1429# the time of a run. So in most cases it will be better to enable call graphs
     1430# for selected functions only using the \callgraph command.
    12071431
    12081432CALL_GRAPH             = NO
    12091433
    1210 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    1211 # generate a caller dependency graph for every global function or class method.
    1212 # Note that enabling this option will significantly increase the time of a run.
    1213 # So in most cases it will be better to enable caller graphs for selected
    1214 # functions only using the \callergraph command.
     1434# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1435# doxygen will generate a caller dependency graph for every global function
     1436# or class method. Note that enabling this option will significantly increase
     1437# the time of a run. So in most cases it will be better to enable caller
     1438# graphs for selected functions only using the \callergraph command.
    12151439
    12161440CALLER_GRAPH           = NO
    12171441
    1218 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
     1442# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    12191443# will graphical hierarchy of all classes instead of a textual one.
    12201444
    12211445GRAPHICAL_HIERARCHY    = YES
    12221446
    1223 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
    1224 # then doxygen will show the dependencies a directory has on other directories 
     1447# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1448# then doxygen will show the dependencies a directory has on other directories
    12251449# in a graphical way. The dependency relations are determined by the #include
    12261450# relations between the files in the directories.
     
    12281452DIRECTORY_GRAPH        = YES
    12291453
    1230 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
     1454# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    12311455# generated by dot. Possible values are png, jpg, or gif
    12321456# If left blank png will be used.
     
    12341458DOT_IMAGE_FORMAT       = png
    12351459
    1236 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
     1460# The tag DOT_PATH can be used to specify the path where the dot tool can be
    12371461# found. If left blank, it is assumed the dot tool can be found in the path.
    12381462
    1239 DOT_PATH               = 
    1240 
    1241 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
    1242 # contain dot files that are included in the documentation (see the 
     1463DOT_PATH               =
     1464
     1465# The DOTFILE_DIRS tag can be used to specify one or more directories that
     1466# contain dot files that are included in the documentation (see the
    12431467# \dotfile command).
    12441468
    1245 DOTFILE_DIRS           = 
    1246 
    1247 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1248 # nodes that will be shown in the graph. If the number of nodes in a graph 
    1249 # becomes larger than this value, doxygen will truncate the graph, which is 
    1250 # visualized by representing a node as a red box. Note that doxygen if the number
    1251 # of direct children of the root node in a graph is already larger than
    1252 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
     1469DOTFILE_DIRS           =
     1470
     1471# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1472# nodes that will be shown in the graph. If the number of nodes in a graph
     1473# becomes larger than this value, doxygen will truncate the graph, which is
     1474# visualized by representing a node as a red box. Note that doxygen if the
     1475# number of direct children of the root node in a graph is already larger than
     1476# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    12531477# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    12541478
    12551479DOT_GRAPH_MAX_NODES    = 50
    12561480
    1257 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
    1258 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
    1259 # from the root by following a path via at most 3 edges will be shown. Nodes 
    1260 # that lay further from the root node will be omitted. Note that setting this 
    1261 # option to 1 or 2 may greatly reduce the computation time needed for large 
    1262 # code bases. Also note that the size of a graph can be further restricted by 
     1481# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     1482# graphs generated by dot. A depth value of 3 means that only nodes reachable
     1483# from the root by following a path via at most 3 edges will be shown. Nodes
     1484# that lay further from the root node will be omitted. Note that setting this
     1485# option to 1 or 2 may greatly reduce the computation time needed for large
     1486# code bases. Also note that the size of a graph can be further restricted by
    12631487# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    12641488
    12651489MAX_DOT_GRAPH_DEPTH    = 0
    12661490
    1267 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
    1268 # background. This is disabled by default, which results in a white background.
    1269 # Warning: Depending on the platform used, enabling this option may lead to
    1270 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
    1271 # read).
     1491# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1492# background. This is disabled by default, because dot on Windows does not
     1493# seem to support this out of the box. Warning: Depending on the platform used,
     1494# enabling this option may lead to badly anti-aliased labels on the edges of
     1495# a graph (i.e. they become hard to read).
    12721496
    12731497DOT_TRANSPARENT        = NO
    12741498
    1275 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
    1276 # files in one run (i.e. multiple -o and -T options on the command line). This 
    1277 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
     1499# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1500# files in one run (i.e. multiple -o and -T options on the command line). This
     1501# makes dot run faster, but since only newer versions of dot (>1.8.10)
    12781502# support this, this feature is disabled by default.
    12791503
    12801504DOT_MULTI_TARGETS      = NO
    12811505
    1282 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
    1283 # generate a legend page explaining the meaning of the various boxes and 
     1506# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     1507# generate a legend page explaining the meaning of the various boxes and
    12841508# arrows in the dot generated graphs.
    12851509
    12861510GENERATE_LEGEND        = YES
    12871511
    1288 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    1289 # remove the intermediate dot files that are used to generate 
     1512# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     1513# remove the intermediate dot files that are used to generate
    12901514# the various graphs.
    12911515
    12921516DOT_CLEANUP            = YES
    1293 
    1294 #---------------------------------------------------------------------------
    1295 # Configuration::additions related to the search engine   
    1296 #---------------------------------------------------------------------------
    1297 
    1298 # The SEARCHENGINE tag specifies whether or not a search engine should be
    1299 # used. If set to NO the values of all tags below this one will be ignored.
    1300 
    1301 SEARCHENGINE           = YES
  • doc/examples.cfg

    r46044ed rf00088f  
    1 # Doxyfile 1.3.4
     1# Doxyfile 1.6.1
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
    17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
     17# This tag specifies the encoding used for all characters in the config file
     18# that follow. The default is UTF-8 which is also the encoding used for all
     19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     20# iconv built into libc) for the transcoding. See
     21# http://www.gnu.org/software/libiconv for the list of possible encodings.
     22
     23DOXYFILE_ENCODING      = UTF-8
     24
     25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    1826# by quotes) that should identify the project.
    1927
    2028PROJECT_NAME           = aubio
    2129
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    23 # This could be handy for archiving the generated documentation or 
     30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     31# This could be handy for archiving the generated documentation or
    2432# if some version control system is used.
    2533
    26 #PROJECT_NUMBER         = 0.2.0
    27 
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    29 # base path where the generated documentation will be put. 
    30 # If a relative path is entered, it will be relative to the location 
     34PROJECT_NUMBER         =
     35
     36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     37# base path where the generated documentation will be put.
     38# If a relative path is entered, it will be relative to the location
    3139# where doxygen was started. If left blank the current directory will be used.
    3240
    3341OUTPUT_DIRECTORY       = examples
    3442
    35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    36 # documentation generated by doxygen is written. Doxygen will use this
    37 # information to generate all constant output in the proper language.
    38 # The default language is English, other supported languages are:
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
    41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
    42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
     43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     44# 4096 sub-directories (in 2 levels) under the output directory of each output
     45# format and will distribute the generated files over these directories.
     46# Enabling this option can be useful when feeding doxygen a huge amount of
     47# source files, where putting all generated files in the same directory would
     48# otherwise cause performance problems for the file system.
     49
     50CREATE_SUBDIRS         = NO
     51
     52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     53# documentation generated by doxygen is written. Doxygen will use this
     54# information to generate all constant output in the proper language.
     55# The default language is English, other supported languages are:
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
     58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
     59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
     60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
     61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    4362
    4463OUTPUT_LANGUAGE        = English
    4564
    46 # This tag can be used to specify the encoding used in the generated output.
    47 # The encoding is not always determined by the language that is chosen,
    48 # but also whether or not the output is meant for Windows or non-Windows users.
    49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
    50 # forces the Windows encoding (this is the default for the Windows binary),
    51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
    52 # all platforms other than Windows).
    53 
    54 USE_WINDOWS_ENCODING   = NO
    55 
    56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    57 # include brief member descriptions after the members that are listed in
    58 # the file and class documentation (similar to JavaDoc).
     65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     66# include brief member descriptions after the members that are listed in
     67# the file and class documentation (similar to JavaDoc).
    5968# Set to NO to disable this.
    6069
    6170BRIEF_MEMBER_DESC      = YES
    6271
    63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    64 # the brief description of a member or function before the detailed description. 
    65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     73# the brief description of a member or function before the detailed description.
     74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    6675# brief descriptions will be completely suppressed.
    6776
    6877REPEAT_BRIEF           = YES
    6978
    70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    71 # Doxygen will generate a detailed section even if there is only a brief
     79# This tag implements a quasi-intelligent brief description abbreviator
     80# that is used to form the text in various listings. Each string
     81# in this list, if found as the leading text of the brief description, will be
     82# stripped from the text and the result after processing the whole list, is
     83# used as the annotated text. Otherwise, the brief description is used as-is.
     84# If left blank, the following values are used ("$name" is automatically
     85# replaced with the name of the entity): "The $name class" "The $name widget"
     86# "The $name file" "is" "provides" "specifies" "contains"
     87# "represents" "a" "an" "the"
     88
     89ABBREVIATE_BRIEF       =
     90
     91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     92# Doxygen will generate a detailed section even if there is only a brief
    7293# description.
    7394
    7495ALWAYS_DETAILED_SEC    = NO
    7596
    76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
    77 # members of a class in the documentation of that class as if those members were
    78 # ordinary class members. Constructors, destructors and assignment operators of
    79 # the base classes will not be shown.
     97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     98# inherited members of a class in the documentation of that class as if those
     99# members were ordinary class members. Constructors, destructors and assignment
     100# operators of the base classes will not be shown.
    80101
    81102INLINE_INHERITED_MEMB  = NO
    82103
    83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    84 # path before files name in the file list and in the header files. If set 
     104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     105# path before files name in the file list and in the header files. If set
    85106# to NO the shortest path that makes the file name unique will be used.
    86107
    87108FULL_PATH_NAMES        = NO
    88109
    89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    90 # can be used to strip a user-defined part of the path. Stripping is
    91 # only done if one of the specified strings matches the left-hand part of
    92 # the path. It is allowed to use relative paths in the argument list.
    93 
    94 STRIP_FROM_PATH        =
    95 
    96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    97 # (but less readable) file names. This can be useful is your file systems
     110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     111# can be used to strip a user-defined part of the path. Stripping is
     112# only done if one of the specified strings matches the left-hand part of
     113# the path. The tag can be used to show relative paths in the file list.
     114# If left blank the directory from which doxygen is run is used as the
     115# path to strip.
     116
     117STRIP_FROM_PATH        =
     118
     119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     120# the path mentioned in the documentation of a class, which tells
     121# the reader which header file to include in order to use a class.
     122# If left blank only the name of the header file containing the class
     123# definition is used. Otherwise one should specify the include paths that
     124# are normally passed to the compiler using the -I flag.
     125
     126STRIP_FROM_INC_PATH    =
     127
     128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     129# (but less readable) file names. This can be useful is your file systems
    98130# doesn't support long names like on DOS, Mac, or CD-ROM.
    99131
    100132SHORT_NAMES            = NO
    101133
    102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    103 # will interpret the first line (until the first dot) of a JavaDoc-style 
    104 # comment as the brief description. If set to NO, the JavaDoc 
    105 # comments will behave just like the Qt-style comments (thus requiring an
    106 # explict @brief command for a brief description.
     134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     135# will interpret the first line (until the first dot) of a JavaDoc-style
     136# comment as the brief description. If set to NO, the JavaDoc
     137# comments will behave just like regular Qt-style comments
     138# (thus requiring an explicit @brief command for a brief description.)
    107139
    108140JAVADOC_AUTOBRIEF      = NO
    109141
    110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    111 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    112 # comments) as a brief description. This used to be the default behaviour.
    113 # The new default is to treat a multi-line C++ comment block as a detailed
     142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     143# interpret the first line (until the first dot) of a Qt-style
     144# comment as the brief description. If set to NO, the comments
     145# will behave just like regular Qt-style comments (thus requiring
     146# an explicit \brief command for a brief description.)
     147
     148QT_AUTOBRIEF           = NO
     149
     150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     152# comments) as a brief description. This used to be the default behaviour.
     153# The new default is to treat a multi-line C++ comment block as a detailed
    114154# description. Set this tag to YES if you prefer the old behaviour instead.
    115155
    116156MULTILINE_CPP_IS_BRIEF = NO
    117157
    118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
    119 # will output the detailed description near the top, like JavaDoc.
    120 # If set to NO, the detailed description appears after the member
     158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     159# member inherits the documentation from any documented member that it
     160# re-implements.
     161
     162INHERIT_DOCS           = YES
     163
     164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     165# a new page for each member. If set to NO, the documentation of a member will
     166# be part of the file/class/namespace that contains it.
     167
     168SEPARATE_MEMBER_PAGES  = NO
     169
     170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
     171# Doxygen uses this value to replace tabs by spaces in code fragments.
     172
     173TAB_SIZE               = 4
     174
     175# This tag can be used to specify a number of aliases that acts
     176# as commands in the documentation. An alias has the form "name=value".
     177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     178# put the command \sideeffect (or @sideeffect) in the documentation, which
     179# will result in a user-defined paragraph with heading "Side Effects:".
     180# You can put \n's in the value part of an alias to insert newlines.
     181
     182ALIASES                =
     183
     184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     185# sources only. Doxygen will then generate output that is more tailored for C.
     186# For instance, some of the names that are used will be different. The list
     187# of all members will be omitted, etc.
     188
     189OPTIMIZE_OUTPUT_FOR_C  = YES
     190
     191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     192# sources only. Doxygen will then generate output that is more tailored for
     193# Java. For instance, namespaces will be presented as packages, qualified
     194# scopes will look different, etc.
     195
     196OPTIMIZE_OUTPUT_JAVA   = NO
     197
     198# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     199# sources only. Doxygen will then generate output that is more tailored for
     200# Fortran.
     201
     202OPTIMIZE_FOR_FORTRAN   = NO
     203
     204# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     205# sources. Doxygen will then generate output that is tailored for
     206# VHDL.
     207
     208OPTIMIZE_OUTPUT_VHDL   = NO
     209
     210# Doxygen selects the parser to use depending on the extension of the files it parses.
     211# With this tag you can assign which parser to use for a given extension.
     212# Doxygen has a built-in mapping, but you can override or extend it using this tag.
     213# The format is ext=language, where ext is a file extension, and language is one of
     214# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
     215# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
     216# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
     217# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     218
     219EXTENSION_MAPPING      =
     220
     221# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     222# to include (a tag file for) the STL sources as input, then you should
     223# set this tag to YES in order to let doxygen match functions declarations and
     224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     225# func(std::string) {}). This also make the inheritance and collaboration
     226# diagrams that involve STL classes more complete and accurate.
     227
     228BUILTIN_STL_SUPPORT    = NO
     229
     230# If you use Microsoft's C++/CLI language, you should set this option to YES to
     231# enable parsing support.
     232
     233CPP_CLI_SUPPORT        = NO
     234
     235# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     236# Doxygen will parse them like normal C++ but will assume all classes use public
     237# instead of private inheritance when no explicit protection keyword is present.
     238
     239SIP_SUPPORT            = NO
     240
     241# For Microsoft's IDL there are propget and propput attributes to indicate getter
     242# and setter methods for a property. Setting this option to YES (the default)
     243# will make doxygen to replace the get and set methods by a property in the
     244# documentation. This will only work if the methods are indeed getting or
     245# setting a simple type. If this is not the case, or you want to show the
     246# methods anyway, you should set this option to NO.
     247
     248IDL_PROPERTY_SUPPORT   = YES
     249
     250# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     251# tag is set to YES, then doxygen will reuse the documentation of the first
     252# member in the group (if any) for the other members of the group. By default
     253# all members of a group must be documented explicitly.
     254
     255DISTRIBUTE_GROUP_DOC   = NO
     256
     257# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     258# the same type (for instance a group of public functions) to be put as a
     259# subgroup of that type (e.g. under the Public Functions section). Set it to
     260# NO to prevent subgrouping. Alternatively, this can be done per class using
     261# the \nosubgrouping command.
     262
     263SUBGROUPING            = YES
     264
     265# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     266# is documented as struct, union, or enum with the name of the typedef. So
     267# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     268# with name TypeT. When disabled the typedef will appear as a member of a file,
     269# namespace, or class. And the struct will be named TypeS. This can typically
     270# be useful for C code in case the coding convention dictates that all compound
     271# types are typedef'ed and only the typedef is referenced, never the tag name.
     272
     273TYPEDEF_HIDES_STRUCT   = NO
     274
     275# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
     276# determine which symbols to keep in memory and which to flush to disk.
     277# When the cache is full, less often used symbols will be written to disk.
     278# For small to medium size projects (<1000 input files) the default value is
     279# probably good enough. For larger projects a too small cache size can cause
     280# doxygen to be busy swapping symbols to and from disk most of the time
     281# causing a significant performance penality.
     282# If the system has enough physical memory increasing the cache will improve the
     283# performance by keeping more symbols in memory. Note that the value works on
     284# a logarithmic scale so increasing the size by one will rougly double the
     285# memory usage. The cache size is given by this formula:
     286# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
     287# corresponding to a cache size of 2^16 = 65536 symbols
     288
     289SYMBOL_CACHE_SIZE      = 0
     290
     291#---------------------------------------------------------------------------
     292# Build related configuration options
     293#---------------------------------------------------------------------------
     294
     295# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     296# documentation are documented, even if no documentation was available.
     297# Private class members and static file members will be hidden unless
     298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     299
     300EXTRACT_ALL            = YES
     301
     302# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
     303# will be included in the documentation.
     304
     305EXTRACT_PRIVATE        = YES
     306
     307# If the EXTRACT_STATIC tag is set to YES all static members of a file
     308# will be included in the documentation.
     309
     310EXTRACT_STATIC         = YES
     311
     312# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     313# defined locally in source files will be included in the documentation.
     314# If set to NO only classes defined in header files are included.
     315
     316EXTRACT_LOCAL_CLASSES  = YES
     317
     318# This flag is only useful for Objective-C code. When set to YES local
     319# methods, which are defined in the implementation section but not in
     320# the interface are included in the documentation.
     321# If set to NO (the default) only methods in the interface are included.
     322
     323EXTRACT_LOCAL_METHODS  = NO
     324
     325# If this flag is set to YES, the members of anonymous namespaces will be
     326# extracted and appear in the documentation as a namespace called
     327# 'anonymous_namespace{file}', where file will be replaced with the base
     328# name of the file that contains the anonymous namespace. By default
     329# anonymous namespace are hidden.
     330
     331EXTRACT_ANON_NSPACES   = NO
     332
     333# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     334# undocumented members of documented classes, files or namespaces.
     335# If set to NO (the default) these members will be included in the
     336# various overviews, but no documentation section is generated.
     337# This option has no effect if EXTRACT_ALL is enabled.
     338
     339HIDE_UNDOC_MEMBERS     = NO
     340
     341# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     342# undocumented classes that are normally visible in the class hierarchy.
     343# If set to NO (the default) these classes will be included in the various
     344# overviews. This option has no effect if EXTRACT_ALL is enabled.
     345
     346HIDE_UNDOC_CLASSES     = NO
     347
     348# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     349# friend (class|struct|union) declarations.
     350# If set to NO (the default) these declarations will be included in the
    121351# documentation.
    122352
    123 DETAILS_AT_TOP         = NO
    124 
    125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    126 # member inherits the documentation from any documented member that it
    127 # reimplements.
    128 
    129 INHERIT_DOCS           = YES
    130 
    131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    132 # tag is set to YES, then doxygen will reuse the documentation of the first
    133 # member in the group (if any) for the other members of the group. By default
    134 # all members of a group must be documented explicitly.
    135 
    136 DISTRIBUTE_GROUP_DOC   = NO
    137 
    138 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    139 # Doxygen uses this value to replace tabs by spaces in code fragments.
    140 
    141 TAB_SIZE               = 4
    142 
    143 # This tag can be used to specify a number of aliases that acts
    144 # as commands in the documentation. An alias has the form "name=value".
    145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    146 # put the command \sideeffect (or @sideeffect) in the documentation, which
    147 # will result in a user-defined paragraph with heading "Side Effects:".
    148 # You can put \n's in the value part of an alias to insert newlines.
    149 
    150 ALIASES                =
    151 
    152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    153 # only. Doxygen will then generate output that is more tailored for C.
    154 # For instance, some of the names that are used will be different. The list
    155 # of all members will be omitted, etc.
    156 
    157 OPTIMIZE_OUTPUT_FOR_C  = YES
    158 
    159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
    160 # only. Doxygen will then generate output that is more tailored for Java.
    161 # For instance, namespaces will be presented as packages, qualified scopes
    162 # will look different, etc.
    163 
    164 OPTIMIZE_OUTPUT_JAVA   = NO
    165 
    166 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    167 # the same type (for instance a group of public functions) to be put as a
    168 # subgroup of that type (e.g. under the Public Functions section). Set it to
    169 # NO to prevent subgrouping. Alternatively, this can be done per class using
    170 # the \nosubgrouping command.
    171 
    172 SUBGROUPING            = YES
    173 
    174 #---------------------------------------------------------------------------
    175 # Build related configuration options
    176 #---------------------------------------------------------------------------
    177 
    178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    179 # documentation are documented, even if no documentation was available.
    180 # Private class members and static file members will be hidden unless
    181 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    182 
    183 EXTRACT_ALL            = YES
    184 
    185 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    186 # will be included in the documentation.
    187 
    188 EXTRACT_PRIVATE        = YES
    189 
    190 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    191 # will be included in the documentation.
    192 
    193 EXTRACT_STATIC         = YES
    194 
    195 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    196 # defined locally in source files will be included in the documentation.
    197 # If set to NO only classes defined in header files are included.
    198 
    199 EXTRACT_LOCAL_CLASSES  = YES
    200 
    201 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    202 # undocumented members of documented classes, files or namespaces.
    203 # If set to NO (the default) these members will be included in the
    204 # various overviews, but no documentation section is generated.
    205 # This option has no effect if EXTRACT_ALL is enabled.
    206 
    207 HIDE_UNDOC_MEMBERS     = NO
    208 
    209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    210 # undocumented classes that are normally visible in the class hierarchy.
    211 # If set to NO (the default) these classes will be included in the various
    212 # overviews. This option has no effect if EXTRACT_ALL is enabled.
    213 
    214 HIDE_UNDOC_CLASSES     = NO
    215 
    216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    217 # friend (class|struct|union) declarations.
    218 # If set to NO (the default) these declarations will be included in the
     353HIDE_FRIEND_COMPOUNDS  = NO
     354
     355# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
     356# documentation blocks found inside the body of a function.
     357# If set to NO (the default) these blocks will be appended to the
     358# function's detailed documentation block.
     359
     360HIDE_IN_BODY_DOCS      = NO
     361
     362# The INTERNAL_DOCS tag determines if documentation
     363# that is typed after a \internal command is included. If the tag is set
     364# to NO (the default) then the documentation will be excluded.
     365# Set it to YES to include the internal documentation.
     366
     367INTERNAL_DOCS          = NO
     368
     369# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     370# file names in lower-case letters. If set to YES upper-case letters are also
     371# allowed. This is useful if you have classes or files whose names only differ
     372# in case and if your file system supports case sensitive file names. Windows
     373# and Mac users are advised to set this option to NO.
     374
     375CASE_SENSE_NAMES       = YES
     376
     377# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     378# will show members with their full class and namespace scopes in the
     379# documentation. If set to YES the scope will be hidden.
     380
     381HIDE_SCOPE_NAMES       = NO
     382
     383# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     384# will put a list of the files that are included by a file in the documentation
     385# of that file.
     386
     387SHOW_INCLUDE_FILES     = YES
     388
     389# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     390# is inserted in the documentation for inline members.
     391
     392INLINE_INFO            = YES
     393
     394# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     395# will sort the (detailed) documentation of file and class members
     396# alphabetically by member name. If set to NO the members will appear in
     397# declaration order.
     398
     399SORT_MEMBER_DOCS       = YES
     400
     401# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     402# brief documentation of file, namespace and class members alphabetically
     403# by member name. If set to NO (the default) the members will appear in
     404# declaration order.
     405
     406SORT_BRIEF_DOCS        = NO
     407
     408# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     409
     410SORT_MEMBERS_CTORS_1ST = NO
     411
     412# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
     413# hierarchy of group names into alphabetical order. If set to NO (the default)
     414# the group names will appear in their defined order.
     415
     416SORT_GROUP_NAMES       = NO
     417
     418# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     419# sorted by fully-qualified names, including namespaces. If set to
     420# NO (the default), the class list will be sorted only by class name,
     421# not including the namespace part.
     422# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     423# Note: This option applies only to the class list, not to the
     424# alphabetical list.
     425
     426SORT_BY_SCOPE_NAME     = NO
     427
     428# The GENERATE_TODOLIST tag can be used to enable (YES) or
     429# disable (NO) the todo list. This list is created by putting \todo
     430# commands in the documentation.
     431
     432GENERATE_TODOLIST      = YES
     433
     434# The GENERATE_TESTLIST tag can be used to enable (YES) or
     435# disable (NO) the test list. This list is created by putting \test
     436# commands in the documentation.
     437
     438GENERATE_TESTLIST      = YES
     439
     440# The GENERATE_BUGLIST tag can be used to enable (YES) or
     441# disable (NO) the bug list. This list is created by putting \bug
     442# commands in the documentation.
     443
     444GENERATE_BUGLIST       = YES
     445
     446# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
     447# disable (NO) the deprecated list. This list is created by putting
     448# \deprecated commands in the documentation.
     449
     450GENERATE_DEPRECATEDLIST= YES
     451
     452# The ENABLED_SECTIONS tag can be used to enable conditional
     453# documentation sections, marked by \if sectionname ... \endif.
     454
     455ENABLED_SECTIONS       =
     456
     457# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     458# the initial value of a variable or define consists of for it to appear in
     459# the documentation. If the initializer consists of more lines than specified
     460# here it will be hidden. Use a value of 0 to hide initializers completely.
     461# The appearance of the initializer of individual variables and defines in the
     462# documentation can be controlled using \showinitializer or \hideinitializer
     463# command in the documentation regardless of this setting.
     464
     465MAX_INITIALIZER_LINES  = 30
     466
     467# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
     468# at the bottom of the documentation of classes and structs. If set to YES the
     469# list will mention the files that were used to generate the documentation.
     470
     471SHOW_USED_FILES        = YES
     472
     473# If the sources in your project are distributed over multiple directories
     474# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
     475# in the documentation. The default is NO.
     476
     477SHOW_DIRECTORIES       = NO
     478
     479# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
     480# This will remove the Files entry from the Quick Index and from the
     481# Folder Tree View (if specified). The default is YES.
     482
     483SHOW_FILES             = YES
     484
     485# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
     486# Namespaces page.
     487# This will remove the Namespaces entry from the Quick Index
     488# and from the Folder Tree View (if specified). The default is YES.
     489
     490SHOW_NAMESPACES        = YES
     491
     492# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     493# doxygen should invoke to get the current version for each file (typically from
     494# the version control system). Doxygen will invoke the program by executing (via
     495# popen()) the command <command> <input-file>, where <command> is the value of
     496# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     497# provided by doxygen. Whatever the program writes to standard output
     498# is used as the file version. See the manual for examples.
     499
     500FILE_VERSION_FILTER    =
     501
     502# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
     503# doxygen. The layout file controls the global structure of the generated output files
     504# in an output format independent way. The create the layout file that represents
     505# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
     506# file name after the option, if omitted DoxygenLayout.xml will be used as the name
     507# of the layout file.
     508
     509LAYOUT_FILE            =
     510
     511#---------------------------------------------------------------------------
     512# configuration options related to warning and progress messages
     513#---------------------------------------------------------------------------
     514
     515# The QUIET tag can be used to turn on/off the messages that are generated
     516# by doxygen. Possible values are YES and NO. If left blank NO is used.
     517
     518QUIET                  = NO
     519
     520# The WARNINGS tag can be used to turn on/off the warning messages that are
     521# generated by doxygen. Possible values are YES and NO. If left blank
     522# NO is used.
     523
     524WARNINGS               = YES
     525
     526# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     527# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
     528# automatically be disabled.
     529
     530WARN_IF_UNDOCUMENTED   = YES
     531
     532# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
     533# potential errors in the documentation, such as not documenting some
     534# parameters in a documented function, or documenting parameters that
     535# don't exist or using markup commands wrongly.
     536
     537WARN_IF_DOC_ERROR      = YES
     538
     539# This WARN_NO_PARAMDOC option can be abled to get warnings for
     540# functions that are documented, but have no documentation for their parameters
     541# or return value. If set to NO (the default) doxygen will only warn about
     542# wrong or incomplete parameter documentation, but not about the absence of
    219543# documentation.
    220544
    221 HIDE_FRIEND_COMPOUNDS  = NO
    222 
    223 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    224 # documentation blocks found inside the body of a function.
    225 # If set to NO (the default) these blocks will be appended to the
    226 # function's detailed documentation block.
    227 
    228 HIDE_IN_BODY_DOCS      = NO
    229 
    230 # The INTERNAL_DOCS tag determines if documentation
    231 # that is typed after a \internal command is included. If the tag is set
    232 # to NO (the default) then the documentation will be excluded.
    233 # Set it to YES to include the internal documentation.
    234 
    235 INTERNAL_DOCS          = NO
    236 
    237 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    238 # file names in lower-case letters. If set to YES upper-case letters are also
    239 # allowed. This is useful if you have classes or files whose names only differ
    240 # in case and if your file system supports case sensitive file names. Windows
    241 # users are advised to set this option to NO.
    242 
    243 CASE_SENSE_NAMES       = YES
    244 
    245 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    246 # will show members with their full class and namespace scopes in the
    247 # documentation. If set to YES the scope will be hidden.
    248 
    249 HIDE_SCOPE_NAMES       = NO
    250 
    251 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    252 # will put a list of the files that are included by a file in the documentation
    253 # of that file.
    254 
    255 SHOW_INCLUDE_FILES     = YES
    256 
    257 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    258 # is inserted in the documentation for inline members.
    259 
    260 INLINE_INFO            = YES
    261 
    262 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    263 # will sort the (detailed) documentation of file and class members
    264 # alphabetically by member name. If set to NO the members will appear in
    265 # declaration order.
    266 
    267 SORT_MEMBER_DOCS       = YES
    268 
    269 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    270 # disable (NO) the todo list. This list is created by putting \todo
    271 # commands in the documentation.
    272 
    273 GENERATE_TODOLIST      = YES
    274 
    275 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    276 # disable (NO) the test list. This list is created by putting \test
    277 # commands in the documentation.
    278 
    279 GENERATE_TESTLIST      = YES
    280 
    281 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    282 # disable (NO) the bug list. This list is created by putting \bug
    283 # commands in the documentation.
    284 
    285 GENERATE_BUGLIST       = YES
    286 
    287 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    288 # disable (NO) the deprecated list. This list is created by putting
    289 # \deprecated commands in the documentation.
    290 
    291 GENERATE_DEPRECATEDLIST= YES
    292 
    293 # The ENABLED_SECTIONS tag can be used to enable conditional
    294 # documentation sections, marked by \if sectionname ... \endif.
    295 
    296 ENABLED_SECTIONS       =
    297 
    298 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    299 # the initial value of a variable or define consists of for it to appear in
    300 # the documentation. If the initializer consists of more lines than specified
    301 # here it will be hidden. Use a value of 0 to hide initializers completely.
    302 # The appearance of the initializer of individual variables and defines in the
    303 # documentation can be controlled using \showinitializer or \hideinitializer
    304 # command in the documentation regardless of this setting.
    305 
    306 MAX_INITIALIZER_LINES  = 30
    307 
    308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    309 # at the bottom of the documentation of classes and structs. If set to YES the
    310 # list will mention the files that were used to generate the documentation.
    311 
    312 SHOW_USED_FILES        = YES
    313 
    314 #---------------------------------------------------------------------------
    315 # configuration options related to warning and progress messages
    316 #---------------------------------------------------------------------------
    317 
    318 # The QUIET tag can be used to turn on/off the messages that are generated
    319 # by doxygen. Possible values are YES and NO. If left blank NO is used.
    320 
    321 QUIET                  = NO
    322 
    323 # The WARNINGS tag can be used to turn on/off the warning messages that are
    324 # generated by doxygen. Possible values are YES and NO. If left blank
    325 # NO is used.
    326 
    327 WARNINGS               = YES
    328 
    329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    331 # automatically be disabled.
    332 
    333 WARN_IF_UNDOCUMENTED   = YES
    334 
    335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    336 # potential errors in the documentation, such as not documenting some
    337 # parameters in a documented function, or documenting parameters that
    338 # don't exist or using markup commands wrongly.
    339 
    340 WARN_IF_DOC_ERROR      = YES
    341 
    342 # The WARN_FORMAT tag determines the format of the warning messages that
    343 # doxygen can produce. The string should contain the $file, $line, and $text
    344 # tags, which will be replaced by the file and line number from which the
    345 # warning originated and the warning text.
     545WARN_NO_PARAMDOC       = NO
     546
     547# The WARN_FORMAT tag determines the format of the warning messages that
     548# doxygen can produce. The string should contain the $file, $line, and $text
     549# tags, which will be replaced by the file and line number from which the
     550# warning originated and the warning text. Optionally the format may contain
     551# $version, which will be replaced by the version of the file (if it could
     552# be obtained via FILE_VERSION_FILTER)
    346553
    347554WARN_FORMAT            = "$file:$line: $text"
    348555
    349 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    350 # and error messages should be written. If left blank the output is written 
     556# The WARN_LOGFILE tag can be used to specify a file to which warning
     557# and error messages should be written. If left blank the output is written
    351558# to stderr.
    352559
    353 WARN_LOGFILE           = 
     560WARN_LOGFILE           =
    354561
    355562#---------------------------------------------------------------------------
     
    357564#---------------------------------------------------------------------------
    358565
    359 # The INPUT tag can be used to specify the files and/or directories that contain 
    360 # documented source files. You may enter file names like "myfile.cpp" or 
    361 # directories like "/usr/src/myproject". Separate the files or directories 
     566# The INPUT tag can be used to specify the files and/or directories that contain
     567# documented source files. You may enter file names like "myfile.cpp" or
     568# directories like "/usr/src/myproject". Separate the files or directories
    362569# with spaces.
    363570
    364 #INPUT                  = src examples
    365 #INPUT                  = src
    366571INPUT                  = ../examples
    367572
    368 # If the value of the INPUT tag contains directories, you can use the
    369 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    370 # and *.h) to filter out the source-files in the directories. If left
    371 # blank the following patterns are tested:
    372 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
    373 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
    374 
    375 FILE_PATTERNS          =
    376 
    377 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    378 # should be searched for input files as well. Possible values are YES and NO.
     573# This tag can be used to specify the character encoding of the source files
     574# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     575# also the default input encoding. Doxygen uses libiconv (or the iconv built
     576# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     577# the list of possible encodings.
     578
     579INPUT_ENCODING         = UTF-8
     580
     581# If the value of the INPUT tag contains directories, you can use the
     582# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     583# and *.h) to filter out the source-files in the directories. If left
     584# blank the following patterns are tested:
     585# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     586# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     587
     588FILE_PATTERNS          =
     589
     590# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     591# should be searched for input files as well. Possible values are YES and NO.
    379592# If left blank NO is used.
    380593
    381594RECURSIVE              = NO
    382595
    383 # The EXCLUDE tag can be used to specify files and/or directories that should 
    384 # excluded from the INPUT source files. This way you can easily exclude a 
     596# The EXCLUDE tag can be used to specify files and/or directories that should
     597# excluded from the INPUT source files. This way you can easily exclude a
    385598# subdirectory from a directory tree whose root is specified with the INPUT tag.
    386599
    387 EXCLUDE                =
    388 
    389 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
    390 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
     600EXCLUDE                =
     601
     602# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     603# directories that are symbolic links (a Unix filesystem feature) are excluded
     604# from the input.
    391605
    392606EXCLUDE_SYMLINKS       = NO
    393607
    394 # If the value of the INPUT tag contains directories, you can use the
    395 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    396 # certain files from those directories.
    397 
    398 EXCLUDE_PATTERNS       =
    399 
    400 # The EXAMPLE_PATH tag can be used to specify one or more files or
    401 # directories that contain example code fragments that are included (see
     608# If the value of the INPUT tag contains directories, you can use the
     609# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     610# certain files from those directories. Note that the wildcards are matched
     611# against the file with absolute path, so to exclude all test directories
     612# for example use the pattern */test/*
     613
     614EXCLUDE_PATTERNS       =
     615
     616# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     617# (namespaces, classes, functions, etc.) that should be excluded from the
     618# output. The symbol name can be a fully qualified name, a word, or if the
     619# wildcard * is used, a substring. Examples: ANamespace, AClass,
     620# AClass::ANamespace, ANamespace::*Test
     621
     622EXCLUDE_SYMBOLS        =
     623
     624# The EXAMPLE_PATH tag can be used to specify one or more files or
     625# directories that contain example code fragments that are included (see
    402626# the \include command).
    403627
    404 EXAMPLE_PATH           = 
    405 
    406 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    407 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    408 # and *.h) to filter out the source-files in the directories. If left 
     628EXAMPLE_PATH           =
     629
     630# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     631# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     632# and *.h) to filter out the source-files in the directories. If left
    409633# blank all files are included.
    410634
    411 EXAMPLE_PATTERNS       = 
    412 
    413 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    414 # searched for input files to be used with the \include or \dontinclude 
    415 # commands irrespective of the value of the RECURSIVE tag. 
     635EXAMPLE_PATTERNS       =
     636
     637# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     638# searched for input files to be used with the \include or \dontinclude
     639# commands irrespective of the value of the RECURSIVE tag.
    416640# Possible values are YES and NO. If left blank NO is used.
    417641
    418642EXAMPLE_RECURSIVE      = NO
    419643
    420 # The IMAGE_PATH tag can be used to specify one or more files or 
    421 # directories that contain image that are included in the documentation (see 
     644# The IMAGE_PATH tag can be used to specify one or more files or
     645# directories that contain image that are included in the documentation (see
    422646# the \image command).
    423647
    424 IMAGE_PATH             = 
    425 
    426 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
    427 # invoke to filter for each input file. Doxygen will invoke the filter program 
    428 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
    429 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
    430 # input file. Doxygen will then use the output that the filter program writes 
     648IMAGE_PATH             =
     649
     650# The INPUT_FILTER tag can be used to specify a program that doxygen should
     651# invoke to filter for each input file. Doxygen will invoke the filter program
     652# by executing (via popen()) the command <filter> <input-file>, where <filter>
     653# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     654# input file. Doxygen will then use the output that the filter program writes
    431655# to standard output.
    432 
    433 INPUT_FILTER           =
    434 
    435 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    436 # INPUT_FILTER) will be used to filter the input files when producing source
     656# If FILTER_PATTERNS is specified, this tag will be
     657# ignored.
     658
     659INPUT_FILTER           =
     660
     661# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     662# basis.
     663# Doxygen will compare the file name with each pattern and apply the
     664# filter if there is a match.
     665# The filters are a list of the form:
     666# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     667# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     668# is applied to all files.
     669
     670FILTER_PATTERNS        =
     671
     672# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     673# INPUT_FILTER) will be used to filter the input files when producing source
    437674# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    438675
     
    443680#---------------------------------------------------------------------------
    444681
    445 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
     682# If the SOURCE_BROWSER tag is set to YES then a list of source files will
    446683# be generated. Documented entities will be cross-referenced with these sources.
    447 
    448 #SOURCE_BROWSER         = NO
     684# Note: To get rid of all source code in the generated output, make sure also
     685# VERBATIM_HEADERS is set to NO.
     686
    449687SOURCE_BROWSER         = YES
    450688
    451 # Setting the INLINE_SOURCES tag to YES will include the body 
     689# Setting the INLINE_SOURCES tag to YES will include the body
    452690# of functions and classes directly in the documentation.
    453691
    454692INLINE_SOURCES         = NO
    455693
    456 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    457 # doxygen to hide any special comment blocks from generated source code 
     694# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     695# doxygen to hide any special comment blocks from generated source code
    458696# fragments. Normal C and C++ comments will always remain visible.
    459697
    460698STRIP_CODE_COMMENTS    = YES
    461699
    462 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
    463 # then for each documented function all documented 
     700# If the REFERENCED_BY_RELATION tag is set to YES
     701# then for each documented function all documented
    464702# functions referencing it will be listed.
    465703
    466704REFERENCED_BY_RELATION = YES
    467705
    468 # If the REFERENCES_RELATION tag is set to YES (the default)
    469 # then for each documented function all documented entities 
     706# If the REFERENCES_RELATION tag is set to YES
     707# then for each documented function all documented entities
    470708# called/used by that function will be listed.
    471709
    472710REFERENCES_RELATION    = YES
    473711
    474 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    475 # will generate a verbatim copy of the header file for each class for
     712# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     713# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     714# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     715# link to the source code.
     716# Otherwise they will link to the documentation.
     717
     718REFERENCES_LINK_SOURCE = YES
     719
     720# If the USE_HTAGS tag is set to YES then the references to source code
     721# will point to the HTML generated by the htags(1) tool instead of doxygen
     722# built-in source browser. The htags tool is part of GNU's global source
     723# tagging system (see http://www.gnu.org/software/global/global.html). You
     724# will need version 4.8.6 or higher.
     725
     726USE_HTAGS              = NO
     727
     728# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     729# will generate a verbatim copy of the header file for each class for
    476730# which an include is specified. Set to NO to disable this.
    477731
     
    482736#---------------------------------------------------------------------------
    483737
    484 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    485 # of all compounds will be generated. Enable this if the project 
     738# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     739# of all compounds will be generated. Enable this if the project
    486740# contains a lot of classes, structs, unions or interfaces.
    487741
    488742ALPHABETICAL_INDEX     = NO
    489743
    490 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    491 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     744# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     745# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    492746# in which this list will be split (can be a number in the range [1..20])
    493747
    494748COLS_IN_ALPHA_INDEX    = 5
    495749
    496 # In case all classes in a project start with a common prefix, all 
    497 # classes will be put under the same header in the alphabetical index. 
    498 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     750# In case all classes in a project start with a common prefix, all
     751# classes will be put under the same header in the alphabetical index.
     752# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    499753# should be ignored while generating the index headers.
    500754
    501 IGNORE_PREFIX          = 
     755IGNORE_PREFIX          =
    502756
    503757#---------------------------------------------------------------------------
     
    505759#---------------------------------------------------------------------------
    506760
    507 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     761# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    508762# generate HTML output.
    509763
    510764GENERATE_HTML          = YES
    511765
    512 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    513 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     766# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     767# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    514768# put in front of it. If left blank `html' will be used as the default path.
    515769
    516770HTML_OUTPUT            = html
    517771
    518 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    519 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
     772# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     773# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    520774# doxygen will generate files with .html extension.
    521775
    522776HTML_FILE_EXTENSION    = .html
    523777
    524 # The HTML_HEADER tag can be used to specify a personal HTML header for 
    525 # each generated HTML page. If it is left blank doxygen will generate a 
     778# The HTML_HEADER tag can be used to specify a personal HTML header for
     779# each generated HTML page. If it is left blank doxygen will generate a
    526780# standard header.
    527781
    528 HTML_HEADER            = 
    529 
    530 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    531 # each generated HTML page. If it is left blank doxygen will generate a 
     782HTML_HEADER            =
     783
     784# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     785# each generated HTML page. If it is left blank doxygen will generate a
    532786# standard footer.
    533787
    534 HTML_FOOTER            =
    535 
    536 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    537 # style sheet that is used by each HTML page. It can be used to
    538 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    539 # will generate a default style sheet
    540 
    541 #TML_STYLESHEET        =
     788HTML_FOOTER            =
     789
     790# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     791# style sheet that is used by each HTML page. It can be used to
     792# fine-tune the look of the HTML output. If the tag is left blank doxygen
     793# will generate a default style sheet. Note that doxygen will try to copy
     794# the style sheet file to the HTML output directory, so don't put your own
     795# stylesheet in the HTML output directory as well, or it will be erased!
     796
    542797HTML_STYLESHEET        = aubio.css
    543798
    544 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
    545 # files or namespaces will be aligned in HTML using tables. If set to 
     799# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     800# files or namespaces will be aligned in HTML using tables. If set to
    546801# NO a bullet list will be used.
    547802
    548803HTML_ALIGN_MEMBERS     = YES
    549804
    550 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    551 # will be generated that can be used as input for tools like the
    552 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     805# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     806# documentation will contain sections that can be hidden and shown after the
     807# page has loaded. For this to work a browser that supports
     808# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     809# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     810
     811HTML_DYNAMIC_SECTIONS  = NO
     812
     813# If the GENERATE_DOCSET tag is set to YES, additional index files
     814# will be generated that can be used as input for Apple's Xcode 3
     815# integrated development environment, introduced with OSX 10.5 (Leopard).
     816# To create a documentation set, doxygen will generate a Makefile in the
     817# HTML output directory. Running make will produce the docset in that
     818# directory and running "make install" will install the docset in
     819# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     820# it at startup.
     821# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     822
     823GENERATE_DOCSET        = NO
     824
     825# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     826# feed. A documentation feed provides an umbrella under which multiple
     827# documentation sets from a single provider (such as a company or product suite)
     828# can be grouped.
     829
     830DOCSET_FEEDNAME        = "Doxygen generated docs"
     831
     832# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     833# should uniquely identify the documentation set bundle. This should be a
     834# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     835# will append .docset to the name.
     836
     837DOCSET_BUNDLE_ID       = org.doxygen.Project
     838
     839# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     840# will be generated that can be used as input for tools like the
     841# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    553842# of the generated HTML documentation.
    554843
    555844GENERATE_HTMLHELP      = NO
    556845
    557 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
    558 # be used to specify the file name of the resulting .chm file. You 
    559 # can add a path in front of the file if the result should not be 
    560 # written to the html output dir.
    561 
    562 CHM_FILE               = 
    563 
    564 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    565 # be used to specify the location (absolute path including file name) of 
    566 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
     846# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     847# be used to specify the file name of the resulting .chm file. You
     848# can add a path in front of the file if the result should not be
     849# written to the html output directory.
     850
     851CHM_FILE               =
     852
     853# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     854# be used to specify the location (absolute path including file name) of
     855# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    567856# the HTML help compiler on the generated index.hhp.
    568857
    569 HHC_LOCATION           = 
    570 
    571 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    572 # controls if a separate .chi index file is generated (YES) or that 
     858HHC_LOCATION           =
     859
     860# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     861# controls if a separate .chi index file is generated (YES) or that
    573862# it should be included in the master .chm file (NO).
    574863
    575864GENERATE_CHI           = NO
    576865
    577 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    578 # controls whether a binary table of contents is generated (YES) or a
     866# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     867# is used to encode HtmlHelp index (hhk), content (hhc) and project file
     868# content.
     869
     870CHM_INDEX_ENCODING     =
     871
     872# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     873# controls whether a binary table of contents is generated (YES) or a
    579874# normal table of contents (NO) in the .chm file.
    580875
    581876BINARY_TOC             = NO
    582877
    583 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     878# The TOC_EXPAND flag can be set to YES to add extra items for group members
    584879# to the contents of the HTML help documentation and to the tree view.
    585880
    586881TOC_EXPAND             = NO
    587882
    588 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    589 # top of each HTML page. The value NO (the default) enables the index and
     883# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
     884# are set, an additional index file will be generated that can be used as input for
     885# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
     886# HTML documentation.
     887
     888GENERATE_QHP           = NO
     889
     890# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     891# be used to specify the file name of the resulting .qch file.
     892# The path specified is relative to the HTML output folder.
     893
     894QCH_FILE               =
     895
     896# The QHP_NAMESPACE tag specifies the namespace to use when generating
     897# Qt Help Project output. For more information please see
     898# http://doc.trolltech.com/qthelpproject.html#namespace
     899
     900QHP_NAMESPACE          =
     901
     902# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     903# Qt Help Project output. For more information please see
     904# http://doc.trolltech.com/qthelpproject.html#virtual-folders
     905
     906QHP_VIRTUAL_FOLDER     = doc
     907
     908# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
     909# For more information please see
     910# http://doc.trolltech.com/qthelpproject.html#custom-filters
     911
     912QHP_CUST_FILTER_NAME   =
     913
     914# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
     915# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     916
     917QHP_CUST_FILTER_ATTRS  =
     918
     919# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     920# filter section matches.
     921# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     922
     923QHP_SECT_FILTER_ATTRS  =
     924
     925# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     926# be used to specify the location of Qt's qhelpgenerator.
     927# If non-empty doxygen will try to run qhelpgenerator on the generated
     928# .qhp file.
     929
     930QHG_LOCATION           =
     931
     932# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     933# top of each HTML page. The value NO (the default) enables the index and
    590934# the value YES disables it.
    591935
    592936DISABLE_INDEX          = NO
    593937
    594 # This tag can be used to set the number of enum values (range [1..20]) 
     938# This tag can be used to set the number of enum values (range [1..20])
    595939# that doxygen will group on one line in the generated HTML documentation.
    596940
    597941ENUM_VALUES_PER_LINE   = 4
    598942
    599 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    600 # generated containing a tree-like index structure (just like the one that
    601 # is generated for HTML Help). For this to work a browser that supports
    602 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    603 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    604 # probably better off using the HTML help feature.
     943# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     944# structure should be generated to display hierarchical information.
     945# If the tag value is set to YES, a side panel will be generated
     946# containing a tree-like index structure (just like the one that
     947# is generated for HTML Help). For this to work a browser that supports
     948# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
     949# Windows users are probably better off using the HTML help feature.
    605950
    606951GENERATE_TREEVIEW      = NO
    607952
    608 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    609 # used to set the initial width (in pixels) of the frame in which the tree
     953# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
     954# and Class Hierarchy pages using a tree view instead of an ordered list.
     955
     956USE_INLINE_TREES       = NO
     957
     958# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     959# used to set the initial width (in pixels) of the frame in which the tree
    610960# is shown.
    611961
    612962TREEVIEW_WIDTH         = 250
    613963
     964# Use this tag to change the font size of Latex formulas included
     965# as images in the HTML documentation. The default is 10. Note that
     966# when you change the font size after a successful doxygen run you need
     967# to manually remove any form_*.png images from the HTML output directory
     968# to force them to be regenerated.
     969
     970FORMULA_FONTSIZE       = 10
     971
     972# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
     973# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
     974# there is already a search function so this one should typically
     975# be disabled.
     976
     977SEARCHENGINE           = YES
     978
    614979#---------------------------------------------------------------------------
    615980# configuration options related to the LaTeX output
    616981#---------------------------------------------------------------------------
    617982
    618 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     983# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    619984# generate Latex output.
    620985
    621986GENERATE_LATEX         = YES
    622987
    623 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    624 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     988# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     989# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    625990# put in front of it. If left blank `latex' will be used as the default path.
    626991
    627992LATEX_OUTPUT           = latex
    628993
    629 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
     994# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    630995# invoked. If left blank `latex' will be used as the default command name.
    631996
    632997LATEX_CMD_NAME         = latex
    633998
    634 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
    635 # generate index for LaTeX. If left blank `makeindex' will be used as the 
     999# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     1000# generate index for LaTeX. If left blank `makeindex' will be used as the
    6361001# default command name.
    6371002
    6381003MAKEINDEX_CMD_NAME     = makeindex
    6391004
    640 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    641 # LaTeX documents. This may be useful for small projects and may help to 
     1005# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     1006# LaTeX documents. This may be useful for small projects and may help to
    6421007# save some trees in general.
    6431008
    6441009COMPACT_LATEX          = NO
    6451010
    646 # The PAPER_TYPE tag can be used to set the paper type that is used 
    647 # by the printer. Possible values are: a4, a4wide, letter, legal and 
     1011# The PAPER_TYPE tag can be used to set the paper type that is used
     1012# by the printer. Possible values are: a4, a4wide, letter, legal and
    6481013# executive. If left blank a4wide will be used.
    6491014
    6501015PAPER_TYPE             = a4wide
    6511016
    652 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     1017# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    6531018# packages that should be included in the LaTeX output.
    6541019
    655 EXTRA_PACKAGES         = 
    656 
    657 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    658 # the generated latex document. The header should contain everything until 
    659 # the first chapter. If it is left blank doxygen will generate a 
     1020EXTRA_PACKAGES         =
     1021
     1022# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     1023# the generated latex document. The header should contain everything until
     1024# the first chapter. If it is left blank doxygen will generate a
    6601025# standard header. Notice: only use this tag if you know what you are doing!
    6611026
    662 LATEX_HEADER           = 
    663 
    664 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
    665 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
    666 # contain links (just like the HTML output) instead of page references 
     1027LATEX_HEADER           =
     1028
     1029# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     1030# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     1031# contain links (just like the HTML output) instead of page references
    6671032# This makes the output suitable for online browsing using a pdf viewer.
    6681033
    6691034PDF_HYPERLINKS         = NO
    6701035
    671 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    672 # plain latex in the generated Makefile. Set this option to YES to get a 
     1036# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     1037# plain latex in the generated Makefile. Set this option to YES to get a
    6731038# higher quality PDF documentation.
    6741039
    6751040USE_PDFLATEX           = NO
    6761041
    677 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    678 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    679 # running if errors occur, instead of asking the user for help. 
     1042# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     1043# command to the generated LaTeX files. This will instruct LaTeX to keep
     1044# running if errors occur, instead of asking the user for help.
    6801045# This option is also used when generating formulas in HTML.
    6811046
    6821047LATEX_BATCHMODE        = NO
    6831048
    684 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
    685 # include the index chapters (such as File Index, Compound Index, etc.) 
     1049# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     1050# include the index chapters (such as File Index, Compound Index, etc.)
    6861051# in the output.
    6871052
    6881053LATEX_HIDE_INDICES     = NO
    6891054
     1055# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
     1056
     1057LATEX_SOURCE_CODE      = NO
     1058
    6901059#---------------------------------------------------------------------------
    6911060# configuration options related to the RTF output
    6921061#---------------------------------------------------------------------------
    6931062
    694 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    695 # The RTF output is optimised for Word 97 and may not look very pretty with
     1063# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     1064# The RTF output is optimized for Word 97 and may not look very pretty with
    6961065# other RTF readers or editors.
    6971066
    6981067GENERATE_RTF           = NO
    6991068
    700 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    701 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1069# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     1070# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    7021071# put in front of it. If left blank `rtf' will be used as the default path.
    7031072
    7041073RTF_OUTPUT             = rtf
    7051074
    706 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    707 # RTF documents. This may be useful for small projects and may help to 
     1075# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     1076# RTF documents. This may be useful for small projects and may help to
    7081077# save some trees in general.
    7091078
    7101079COMPACT_RTF            = NO
    7111080
    712 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    713 # will contain hyperlink fields. The RTF file will 
    714 # contain links (just like the HTML output) instead of page references. 
    715 # This makes the output suitable for online browsing using WORD or other 
    716 # programs which support those fields. 
     1081# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     1082# will contain hyperlink fields. The RTF file will
     1083# contain links (just like the HTML output) instead of page references.
     1084# This makes the output suitable for online browsing using WORD or other
     1085# programs which support those fields.
    7171086# Note: wordpad (write) and others do not support links.
    7181087
    7191088RTF_HYPERLINKS         = NO
    7201089
    721 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
    722 # config file, i.e. a series of assigments. You only have to provide
     1090# Load stylesheet definitions from file. Syntax is similar to doxygen's
     1091# config file, i.e. a series of assignments. You only have to provide
    7231092# replacements, missing definitions are set to their default value.
    7241093
    725 RTF_STYLESHEET_FILE    = 
    726 
    727 # Set optional variables used in the generation of an rtf document. 
     1094RTF_STYLESHEET_FILE    =
     1095
     1096# Set optional variables used in the generation of an rtf document.
    7281097# Syntax is similar to doxygen's config file.
    7291098
    730 RTF_EXTENSIONS_FILE    = 
     1099RTF_EXTENSIONS_FILE    =
    7311100
    7321101#---------------------------------------------------------------------------
     
    7341103#---------------------------------------------------------------------------
    7351104
    736 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     1105# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    7371106# generate man pages
    7381107
    7391108GENERATE_MAN           = NO
    7401109
    741 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
    742 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1110# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     1111# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    7431112# put in front of it. If left blank `man' will be used as the default path.
    7441113
    7451114MAN_OUTPUT             = man
    7461115
    747 # The MAN_EXTENSION tag determines the extension that is added to 
     1116# The MAN_EXTENSION tag determines the extension that is added to
    7481117# the generated man pages (default is the subroutine's section .3)
    7491118
    7501119MAN_EXTENSION          = .3
    7511120
    752 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
    753 # then it will generate one additional man file for each entity 
    754 # documented in the real man page(s). These additional files 
    755 # only source the real man page, but without them the man command 
     1121# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     1122# then it will generate one additional man file for each entity
     1123# documented in the real man page(s). These additional files
     1124# only source the real man page, but without them the man command
    7561125# would be unable to find the correct page. The default is NO.
    7571126
     
    7621131#---------------------------------------------------------------------------
    7631132
    764 # If the GENERATE_XML tag is set to YES Doxygen will
    765 # generate an XML file that captures the structure of
    766 # the code including all documentation. Note that this
    767 # feature is still experimental and incomplete at the
     1133# If the GENERATE_XML tag is set to YES Doxygen will
     1134# generate an XML file that captures the structure of
     1135# the code including all documentation.
     1136
     1137GENERATE_XML           = NO
     1138
     1139# The XML_OUTPUT tag is used to specify where the XML pages will be put.
     1140# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     1141# put in front of it. If left blank `xml' will be used as the default path.
     1142
     1143XML_OUTPUT             = xml
     1144
     1145# The XML_SCHEMA tag can be used to specify an XML schema,
     1146# which can be used by a validating XML parser to check the
     1147# syntax of the XML files.
     1148
     1149XML_SCHEMA             =
     1150
     1151# The XML_DTD tag can be used to specify an XML DTD,
     1152# which can be used by a validating XML parser to check the
     1153# syntax of the XML files.
     1154
     1155XML_DTD                =
     1156
     1157# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     1158# dump the program listings (including syntax highlighting
     1159# and cross-referencing information) to the XML output. Note that
     1160# enabling this will significantly increase the size of the XML output.
     1161
     1162XML_PROGRAMLISTING     = YES
     1163
     1164#---------------------------------------------------------------------------
     1165# configuration options for the AutoGen Definitions output
     1166#---------------------------------------------------------------------------
     1167
     1168# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     1169# generate an AutoGen Definitions (see autogen.sf.net) file
     1170# that captures the structure of the code including all
     1171# documentation. Note that this feature is still experimental
     1172# and incomplete at the moment.
     1173
     1174GENERATE_AUTOGEN_DEF   = NO
     1175
     1176#---------------------------------------------------------------------------
     1177# configuration options related to the Perl module output
     1178#---------------------------------------------------------------------------
     1179
     1180# If the GENERATE_PERLMOD tag is set to YES Doxygen will
     1181# generate a Perl module file that captures the structure of
     1182# the code including all documentation. Note that this
     1183# feature is still experimental and incomplete at the
    7681184# moment.
    7691185
    770 GENERATE_XML           = NO
    771 
    772 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    773 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    774 # put in front of it. If left blank `xml' will be used as the default path.
    775 
    776 XML_OUTPUT             = xml
    777 
    778 # The XML_SCHEMA tag can be used to specify an XML schema,
    779 # which can be used by a validating XML parser to check the
    780 # syntax of the XML files.
    781 
    782 XML_SCHEMA             =
    783 
    784 # The XML_DTD tag can be used to specify an XML DTD,
    785 # which can be used by a validating XML parser to check the
    786 # syntax of the XML files.
    787 
    788 XML_DTD                =
    789 
    790 #---------------------------------------------------------------------------
    791 # configuration options for the AutoGen Definitions output
    792 #---------------------------------------------------------------------------
    793 
    794 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    795 # generate an AutoGen Definitions (see autogen.sf.net) file
    796 # that captures the structure of the code including all
    797 # documentation. Note that this feature is still experimental
    798 # and incomplete at the moment.
    799 
    800 GENERATE_AUTOGEN_DEF   = NO
    801 
    802 #---------------------------------------------------------------------------
    803 # configuration options related to the Perl module output
    804 #---------------------------------------------------------------------------
    805 
    806 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    807 # generate a Perl module file that captures the structure of
    808 # the code including all documentation. Note that this
    809 # feature is still experimental and incomplete at the
    810 # moment.
    811 
    8121186GENERATE_PERLMOD       = NO
    8131187
    814 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
    815 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
     1188# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
     1189# the necessary Makefile rules, Perl scripts and LaTeX code to be able
    8161190# to generate PDF and DVI output from the Perl module output.
    8171191
    8181192PERLMOD_LATEX          = NO
    8191193
    820 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    821 # nicely formatted so it can be parsed by a human reader.  This is useful
    822 # if you want to understand what is going on.  On the other hand, if this
    823 # tag is set to NO the size of the Perl module output will be much smaller
     1194# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
     1195# nicely formatted so it can be parsed by a human reader.
     1196# This is useful
     1197# if you want to understand what is going on.
     1198# On the other hand, if this
     1199# tag is set to NO the size of the Perl module output will be much smaller
    8241200# and Perl will parse it just the same.
    8251201
    8261202PERLMOD_PRETTY         = YES
    8271203
    828 # The names of the make variables in the generated doxyrules.make file 
    829 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
    830 # This is useful so different doxyrules.make files included by the same 
     1204# The names of the make variables in the generated doxyrules.make file
     1205# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
     1206# This is useful so different doxyrules.make files included by the same
    8311207# Makefile don't overwrite each other's variables.
    8321208
    833 PERLMOD_MAKEVAR_PREFIX = 
    834 
    835 #---------------------------------------------------------------------------
    836 # Configuration options related to the preprocessor   
    837 #---------------------------------------------------------------------------
    838 
    839 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
    840 # evaluate all C-preprocessor directives found in the sources and include 
     1209PERLMOD_MAKEVAR_PREFIX =
     1210
     1211#---------------------------------------------------------------------------
     1212# Configuration options related to the preprocessor
     1213#---------------------------------------------------------------------------
     1214
     1215# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     1216# evaluate all C-preprocessor directives found in the sources and include
    8411217# files.
    8421218
    8431219ENABLE_PREPROCESSING   = YES
    8441220
    845 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
    846 # names in the source code. If set to NO (the default) only conditional 
    847 # compilation will be performed. Macro expansion can be done in a controlled 
     1221# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     1222# names in the source code. If set to NO (the default) only conditional
     1223# compilation will be performed. Macro expansion can be done in a controlled
    8481224# way by setting EXPAND_ONLY_PREDEF to YES.
    8491225
    8501226MACRO_EXPANSION        = NO
    8511227
    852 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
    853 # then the macro expansion is limited to the macros specified with the 
    854 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
     1228# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     1229# then the macro expansion is limited to the macros specified with the
     1230# PREDEFINED and EXPAND_AS_DEFINED tags.
    8551231
    8561232EXPAND_ONLY_PREDEF     = NO
    8571233
    858 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
     1234# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    8591235# in the INCLUDE_PATH (see below) will be search if a #include is found.
    8601236
    8611237SEARCH_INCLUDES        = YES
    8621238
    863 # The INCLUDE_PATH tag can be used to specify one or more directories that 
    864 # contain include files that are not input files but should be processed by 
     1239# The INCLUDE_PATH tag can be used to specify one or more directories that
     1240# contain include files that are not input files but should be processed by
    8651241# the preprocessor.
    8661242
    867 INCLUDE_PATH           = 
    868 
    869 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
    870 # patterns (like *.h and *.hpp) to filter out the header-files in the 
    871 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
     1243INCLUDE_PATH           =
     1244
     1245# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1246# patterns (like *.h and *.hpp) to filter out the header-files in the
     1247# directories. If left blank, the patterns specified with FILE_PATTERNS will
    8721248# be used.
    8731249
    874 INCLUDE_FILE_PATTERNS  =
    875 
    876 # The PREDEFINED tag can be used to specify one or more macro names that
    877 # are defined before the preprocessor is started (similar to the -D option of
    878 # gcc). The argument of the tag is a list of macros of the form: name
    879 # or name=definition (no spaces). If the definition and the = are
    880 # omitted =1 is assumed.
    881 
    882 PREDEFINED             =
    883 
    884 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    885 # this tag can be used to specify a list of macro names that should be expanded.
    886 # The macro definition that is found in the sources will be used.
     1250INCLUDE_FILE_PATTERNS  =
     1251
     1252# The PREDEFINED tag can be used to specify one or more macro names that
     1253# are defined before the preprocessor is started (similar to the -D option of
     1254# gcc). The argument of the tag is a list of macros of the form: name
     1255# or name=definition (no spaces). If the definition and the = are
     1256# omitted =1 is assumed. To prevent a macro definition from being
     1257# undefined via #undef or recursively expanded use the := operator
     1258# instead of the = operator.
     1259
     1260PREDEFINED             =
     1261
     1262# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     1263# this tag can be used to specify a list of macro names that should be expanded.
     1264# The macro definition that is found in the sources will be used.
    8871265# Use the PREDEFINED tag if you want to use a different macro definition.
    8881266
    889 EXPAND_AS_DEFINED      = 
    890 
    891 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    892 # doxygen's preprocessor will remove all function-like macros that are alone 
    893 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
    894 # function macros are typically used for boiler-plate code, and will confuse the
    895 # parser if not removed.
     1267EXPAND_AS_DEFINED      =
     1268
     1269# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     1270# doxygen's preprocessor will remove all function-like macros that are alone
     1271# on a line, have an all uppercase name, and do not end with a semicolon. Such
     1272# function macros are typically used for boiler-plate code, and will confuse
     1273# the parser if not removed.
    8961274
    8971275SKIP_FUNCTION_MACROS   = YES
    8981276
    8991277#---------------------------------------------------------------------------
    900 # Configuration::addtions related to external references   
    901 #---------------------------------------------------------------------------
    902 
    903 # The TAGFILES option can be used to specify one or more tagfiles.
    904 # Optionally an initial location of the external documentation
    905 # can be added for each tagfile. The format of a tag file without
    906 # this location is as follows:
    907 #   TAGFILES = file1 file2 ...
    908 # Adding location for the tag files is done as follows:
    909 #   TAGFILES = file1=loc1 "file2 = loc2" ...
    910 # where "loc1" and "loc2" can be relative or absolute paths or
    911 # URLs. If a location is present for each tag, the installdox tool
     1278# Configuration::additions related to external references
     1279#---------------------------------------------------------------------------
     1280
     1281# The TAGFILES option can be used to specify one or more tagfiles.
     1282# Optionally an initial location of the external documentation
     1283# can be added for each tagfile. The format of a tag file without
     1284# this location is as follows:
     1285#
     1286# TAGFILES = file1 file2 ...
     1287# Adding location for the tag files is done as follows:
     1288#
     1289# TAGFILES = file1=loc1 "file2 = loc2" ...
     1290# where "loc1" and "loc2" can be relative or absolute paths or
     1291# URLs. If a location is present for each tag, the installdox tool
    9121292# does not have to be run to correct the links.
    9131293# Note that each tag file must have a unique name
    9141294# (where the name does NOT include the path)
    915 # If a tag file is not located in the directory in which doxygen 
     1295# If a tag file is not located in the directory in which doxygen
    9161296# is run, you must also specify the path to the tagfile here.
    9171297
    918 TAGFILES               = 
    919 
    920 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
     1298TAGFILES               =
     1299
     1300# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    9211301# a tag file that is based on the input files it reads.
    9221302
    923 GENERATE_TAGFILE       = 
    924 
    925 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    926 # in the class index. If set to NO only the inherited external classes 
     1303GENERATE_TAGFILE       =
     1304
     1305# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     1306# in the class index. If set to NO only the inherited external classes
    9271307# will be listed.
    9281308
    9291309ALLEXTERNALS           = NO
    9301310
    931 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
    932 # in the modules index. If set to NO, only the current project's groups will 
     1311# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
     1312# in the modules index. If set to NO, only the current project's groups will
    9331313# be listed.
    9341314
    9351315EXTERNAL_GROUPS        = YES
    9361316
    937 # The PERL_PATH should be the absolute path and name of the perl script 
     1317# The PERL_PATH should be the absolute path and name of the perl script
    9381318# interpreter (i.e. the result of `which perl').
    9391319
     
    9411321
    9421322#---------------------------------------------------------------------------
    943 # Configuration options related to the dot tool   
    944 #---------------------------------------------------------------------------
    945 
    946 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    947 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
    948 # super classes. Setting the tag to NO turns the diagrams off. Note that this
    949 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
    950 # recommended to install and use dot, since it yields more powerful graphs.
     1323# Configuration options related to the dot tool
     1324#---------------------------------------------------------------------------
     1325
     1326# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     1327# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1328# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1329# this option is superseded by the HAVE_DOT option below. This is only a
     1330# fallback. It is recommended to install and use dot, since it yields more
     1331# powerful graphs.
    9511332
    9521333CLASS_DIAGRAMS         = YES
    9531334
    954 # If set to YES, the inheritance and collaboration graphs will hide
    955 # inheritance and usage relations if the target is undocumented
     1335# You can define message sequence charts within doxygen comments using the \msc
     1336# command. Doxygen will then run the mscgen tool (see
     1337# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1338# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1339# the mscgen tool resides. If left empty the tool is assumed to be found in the
     1340# default search path.
     1341
     1342MSCGEN_PATH            =
     1343
     1344# If set to YES, the inheritance and collaboration graphs will hide
     1345# inheritance and usage relations if the target is undocumented
    9561346# or is not a class.
    9571347
    9581348HIDE_UNDOC_RELATIONS   = YES
    9591349
    960 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
    961 # available from the path. This tool is part of Graphviz, a graph visualization 
    962 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
     1350# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     1351# available from the path. This tool is part of Graphviz, a graph visualization
     1352# toolkit from AT&T and Lucent Bell Labs. The other options in this section
    9631353# have no effect if this option is set to NO (the default)
    9641354
    965 #HAVE_DOT               = NO
    9661355HAVE_DOT               = YES
    9671356
    968 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    969 # will generate a graph for each documented class showing the direct and
    970 # indirect inheritance relations. Setting this tag to YES will force the
     1357# By default doxygen will write a font called FreeSans.ttf to the output
     1358# directory and reference it in all dot files that doxygen generates. This
     1359# font does not include all possible unicode characters however, so when you need
     1360# these (or just want a differently looking font) you can specify the font name
     1361# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
     1362# which can be done by putting it in a standard location or by setting the
     1363# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
     1364# containing the font.
     1365
     1366DOT_FONTNAME           = FreeSans
     1367
     1368# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
     1369# The default size is 10pt.
     1370
     1371DOT_FONTSIZE           = 10
     1372
     1373# By default doxygen will tell dot to use the output directory to look for the
     1374# FreeSans.ttf font (which doxygen will put there itself). If you specify a
     1375# different font using DOT_FONTNAME you can set the path where dot
     1376# can find it using this tag.
     1377
     1378DOT_FONTPATH           =
     1379
     1380# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1381# will generate a graph for each documented class showing the direct and
     1382# indirect inheritance relations. Setting this tag to YES will force the
    9711383# the CLASS_DIAGRAMS tag to NO.
    9721384
    9731385CLASS_GRAPH            = YES
    9741386
    975 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    976 # will generate a graph for each documented class showing the direct and 
    977 # indirect implementation dependencies (inheritance, containment, and 
     1387# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1388# will generate a graph for each documented class showing the direct and
     1389# indirect implementation dependencies (inheritance, containment, and
    9781390# class references variables) of the class with other documented classes.
    9791391
    9801392COLLABORATION_GRAPH    = YES
    9811393
    982 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    983 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
     1394# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1395# will generate a graph for groups, showing the direct groups dependencies
     1396
     1397GROUP_GRAPHS           = YES
     1398
     1399# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     1400# collaboration diagrams in a style similar to the OMG's Unified Modeling
    9841401# Language.
    9851402
    9861403UML_LOOK               = NO
    9871404
    988 # If set to YES, the inheritance and collaboration graphs will show the 
     1405# If set to YES, the inheritance and collaboration graphs will show the
    9891406# relations between templates and their instances.
    9901407
    9911408TEMPLATE_RELATIONS     = NO
    9921409
    993 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    994 # tags are set to YES then doxygen will generate a graph for each documented 
    995 # file showing the direct and indirect include dependencies of the file with 
     1410# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     1411# tags are set to YES then doxygen will generate a graph for each documented
     1412# file showing the direct and indirect include dependencies of the file with
    9961413# other documented files.
    9971414
    9981415INCLUDE_GRAPH          = YES
    9991416
    1000 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    1001 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    1002 # documented header file showing the documented files that directly or 
     1417# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     1418# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     1419# documented header file showing the documented files that directly or
    10031420# indirectly include this file.
    10041421
    10051422INCLUDED_BY_GRAPH      = YES
    10061423
    1007 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
    1008 # generate a call dependency graph for every global function or class method.
    1009 # Note that enabling this option will significantly increase the time of a run.
    1010 # So in most cases it will be better to enable call graphs for selected
    1011 # functions only using the \callgraph command.
     1424# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1425# doxygen will generate a call dependency graph for every global function
     1426# or class method. Note that enabling this option will significantly increase
     1427# the time of a run. So in most cases it will be better to enable call graphs
     1428# for selected functions only using the \callgraph command.
    10121429
    10131430CALL_GRAPH             = NO
    10141431
    1015 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
     1432# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1433# doxygen will generate a caller dependency graph for every global function
     1434# or class method. Note that enabling this option will significantly increase
     1435# the time of a run. So in most cases it will be better to enable caller
     1436# graphs for selected functions only using the \callergraph command.
     1437
     1438CALLER_GRAPH           = NO
     1439
     1440# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    10161441# will graphical hierarchy of all classes instead of a textual one.
    10171442
    10181443GRAPHICAL_HIERARCHY    = YES
    10191444
    1020 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     1445# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1446# then doxygen will show the dependencies a directory has on other directories
     1447# in a graphical way. The dependency relations are determined by the #include
     1448# relations between the files in the directories.
     1449
     1450DIRECTORY_GRAPH        = YES
     1451
     1452# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    10211453# generated by dot. Possible values are png, jpg, or gif
    10221454# If left blank png will be used.
     
    10241456DOT_IMAGE_FORMAT       = png
    10251457
    1026 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
    1027 # found. If left blank, it is assumed the dot tool can be found on the path.
    1028 
    1029 DOT_PATH               = 
    1030 
    1031 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
    1032 # contain dot files that are included in the documentation (see the 
     1458# The tag DOT_PATH can be used to specify the path where the dot tool can be
     1459# found. If left blank, it is assumed the dot tool can be found in the path.
     1460
     1461DOT_PATH               =
     1462
     1463# The DOTFILE_DIRS tag can be used to specify one or more directories that
     1464# contain dot files that are included in the documentation (see the
    10331465# \dotfile command).
    10341466
    1035 DOTFILE_DIRS           =
    1036 
    1037 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
    1038 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1039 # this value, doxygen will try to truncate the graph, so that it fits within
    1040 # the specified constraint. Beware that most browsers cannot cope with very
    1041 # large images.
    1042 
    1043 MAX_DOT_GRAPH_WIDTH    = 1024
    1044 
    1045 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
    1046 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1047 # this value, doxygen will try to truncate the graph, so that it fits within
    1048 # the specified constraint. Beware that most browsers cannot cope with very
    1049 # large images.
    1050 
    1051 MAX_DOT_GRAPH_HEIGHT   = 1024
    1052 
    1053 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1054 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1055 # from the root by following a path via at most 3 edges will be shown. Nodes that
    1056 # lay further from the root node will be omitted. Note that setting this option to
    1057 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
    1058 # note that a graph may be further truncated if the graph's image dimensions are
    1059 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
    1060 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
     1467DOTFILE_DIRS           =
     1468
     1469# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1470# nodes that will be shown in the graph. If the number of nodes in a graph
     1471# becomes larger than this value, doxygen will truncate the graph, which is
     1472# visualized by representing a node as a red box. Note that doxygen if the
     1473# number of direct children of the root node in a graph is already larger than
     1474# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
     1475# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     1476
     1477DOT_GRAPH_MAX_NODES    = 50
     1478
     1479# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     1480# graphs generated by dot. A depth value of 3 means that only nodes reachable
     1481# from the root by following a path via at most 3 edges will be shown. Nodes
     1482# that lay further from the root node will be omitted. Note that setting this
     1483# option to 1 or 2 may greatly reduce the computation time needed for large
     1484# code bases. Also note that the size of a graph can be further restricted by
     1485# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    10611486
    10621487MAX_DOT_GRAPH_DEPTH    = 0
    10631488
    1064 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1065 # generate a legend page explaining the meaning of the various boxes and
     1489# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1490# background. This is disabled by default, because dot on Windows does not
     1491# seem to support this out of the box. Warning: Depending on the platform used,
     1492# enabling this option may lead to badly anti-aliased labels on the edges of
     1493# a graph (i.e. they become hard to read).
     1494
     1495DOT_TRANSPARENT        = NO
     1496
     1497# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1498# files in one run (i.e. multiple -o and -T options on the command line). This
     1499# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1500# support this, this feature is disabled by default.
     1501
     1502DOT_MULTI_TARGETS      = YES
     1503
     1504# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     1505# generate a legend page explaining the meaning of the various boxes and
    10661506# arrows in the dot generated graphs.
    10671507
    10681508GENERATE_LEGEND        = YES
    10691509
    1070 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    1071 # remove the intermediate dot files that are used to generate 
     1510# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     1511# remove the intermediate dot files that are used to generate
    10721512# the various graphs.
    10731513
    10741514DOT_CLEANUP            = YES
    1075 
    1076 #---------------------------------------------------------------------------
    1077 # Configuration::addtions related to the search engine   
    1078 #---------------------------------------------------------------------------
    1079 
    1080 # The SEARCHENGINE tag specifies whether or not a search engine should be
    1081 # used. If set to NO the values of all tags below this one will be ignored.
    1082 
    1083 SEARCHENGINE           = YES
  • doc/user.cfg

    r46044ed rf00088f  
    1 # Doxyfile 1.5.3-20071008
     1# Doxyfile 1.6.1
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
    17 # This tag specifies the encoding used for all characters in the config file that
    18 # follow. The default is UTF-8 which is also the encoding used for all text before
    19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
    20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
    21 # possible encodings.
     17# This tag specifies the encoding used for all characters in the config file
     18# that follow. The default is UTF-8 which is also the encoding used for all
     19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     20# iconv built into libc) for the transcoding. See
     21# http://www.gnu.org/software/libiconv for the list of possible encodings.
    2222
    2323DOXYFILE_ENCODING      = UTF-8
    2424
    25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
     25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    2626# by quotes) that should identify the project.
    2727
    2828PROJECT_NAME           = aubio
    2929
    30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    31 # This could be handy for archiving the generated documentation or 
     30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     31# This could be handy for archiving the generated documentation or
    3232# if some version control system is used.
    3333
    34 PROJECT_NUMBER         = 
    35 
    36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    37 # base path where the generated documentation will be put. 
    38 # If a relative path is entered, it will be relative to the location 
     34PROJECT_NUMBER         =
     35
     36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     37# base path where the generated documentation will be put.
     38# If a relative path is entered, it will be relative to the location
    3939# where doxygen was started. If left blank the current directory will be used.
    4040
    4141OUTPUT_DIRECTORY       = user
    4242
    43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
    44 # 4096 sub-directories (in 2 levels) under the output directory of each output 
    45 # format and will distribute the generated files over these directories. 
    46 # Enabling this option can be useful when feeding doxygen a huge amount of 
    47 # source files, where putting all generated files in the same directory would 
     43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     44# 4096 sub-directories (in 2 levels) under the output directory of each output
     45# format and will distribute the generated files over these directories.
     46# Enabling this option can be useful when feeding doxygen a huge amount of
     47# source files, where putting all generated files in the same directory would
    4848# otherwise cause performance problems for the file system.
    4949
    5050CREATE_SUBDIRS         = NO
    5151
    52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    53 # documentation generated by doxygen is written. Doxygen will use this
    54 # information to generate all constant output in the proper language.
    55 # The default language is English, other supported languages are:
    56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
    57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
    58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
    59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
    60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
     52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     53# documentation generated by doxygen is written. Doxygen will use this
     54# information to generate all constant output in the proper language.
     55# The default language is English, other supported languages are:
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
     58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
     59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
     60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
     61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    6162
    6263OUTPUT_LANGUAGE        = English
    6364
    64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
    65 # include brief member descriptions after the members that are listed in 
    66 # the file and class documentation (similar to JavaDoc). 
     65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     66# include brief member descriptions after the members that are listed in
     67# the file and class documentation (similar to JavaDoc).
    6768# Set to NO to disable this.
    6869
    6970BRIEF_MEMBER_DESC      = YES
    7071
    71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    72 # the brief description of a member or function before the detailed description. 
    73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     73# the brief description of a member or function before the detailed description.
     74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    7475# brief descriptions will be completely suppressed.
    7576
    7677REPEAT_BRIEF           = YES
    7778
    78 # This tag implements a quasi-intelligent brief description abbreviator 
    79 # that is used to form the text in various listings. Each string 
    80 # in this list, if found as the leading text of the brief description, will be 
    81 # stripped from the text and the result after processing the whole list, is 
    82 # used as the annotated text. Otherwise, the brief description is used as-is. 
    83 # If left blank, the following values are used ("$name" is automatically 
    84 # replaced with the name of the entity): "The $name class" "The $name widget" 
    85 # "The $name file" "is" "provides" "specifies" "contains" 
     79# This tag implements a quasi-intelligent brief description abbreviator
     80# that is used to form the text in various listings. Each string
     81# in this list, if found as the leading text of the brief description, will be
     82# stripped from the text and the result after processing the whole list, is
     83# used as the annotated text. Otherwise, the brief description is used as-is.
     84# If left blank, the following values are used ("$name" is automatically
     85# replaced with the name of the entity): "The $name class" "The $name widget"
     86# "The $name file" "is" "provides" "specifies" "contains"
    8687# "represents" "a" "an" "the"
    8788
    88 ABBREVIATE_BRIEF       = 
    89 
    90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
    91 # Doxygen will generate a detailed section even if there is only a brief 
     89ABBREVIATE_BRIEF       =
     90
     91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     92# Doxygen will generate a detailed section even if there is only a brief
    9293# description.
    9394
    9495ALWAYS_DETAILED_SEC    = NO
    9596
    96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
    97 # inherited members of a class in the documentation of that class as if those 
    98 # members were ordinary class members. Constructors, destructors and assignment 
     97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     98# inherited members of a class in the documentation of that class as if those
     99# members were ordinary class members. Constructors, destructors and assignment
    99100# operators of the base classes will not be shown.
    100101
    101102INLINE_INHERITED_MEMB  = NO
    102103
    103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    104 # path before files name in the file list and in the header files. If set 
     104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     105# path before files name in the file list and in the header files. If set
    105106# to NO the shortest path that makes the file name unique will be used.
    106107
    107108FULL_PATH_NAMES        = YES
    108109
    109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    110 # can be used to strip a user-defined part of the path. Stripping is 
    111 # only done if one of the specified strings matches the left-hand part of 
    112 # the path. The tag can be used to show relative paths in the file list. 
    113 # If left blank the directory from which doxygen is run is used as the 
     110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     111# can be used to strip a user-defined part of the path. Stripping is
     112# only done if one of the specified strings matches the left-hand part of
     113# the path. The tag can be used to show relative paths in the file list.
     114# If left blank the directory from which doxygen is run is used as the
    114115# path to strip.
    115116
    116117STRIP_FROM_PATH        = ../src
    117118
    118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
    119 # the path mentioned in the documentation of a class, which tells 
    120 # the reader which header file to include in order to use a class. 
    121 # If left blank only the name of the header file containing the class 
    122 # definition is used. Otherwise one should specify the include paths that 
     119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     120# the path mentioned in the documentation of a class, which tells
     121# the reader which header file to include in order to use a class.
     122# If left blank only the name of the header file containing the class
     123# definition is used. Otherwise one should specify the include paths that
    123124# are normally passed to the compiler using the -I flag.
    124125
    125 STRIP_FROM_INC_PATH    = 
    126 
    127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    128 # (but less readable) file names. This can be useful is your file systems 
     126STRIP_FROM_INC_PATH    =
     127
     128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     129# (but less readable) file names. This can be useful is your file systems
    129130# doesn't support long names like on DOS, Mac, or CD-ROM.
    130131
    131132SHORT_NAMES            = NO
    132133
    133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    134 # will interpret the first line (until the first dot) of a JavaDoc-style 
    135 # comment as the brief description. If set to NO, the JavaDoc 
    136 # comments will behave just like regular Qt-style comments 
     134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     135# will interpret the first line (until the first dot) of a JavaDoc-style
     136# comment as the brief description. If set to NO, the JavaDoc
     137# comments will behave just like regular Qt-style comments
    137138# (thus requiring an explicit @brief command for a brief description.)
    138139
    139140JAVADOC_AUTOBRIEF      = YES
    140141
    141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
    142 # interpret the first line (until the first dot) of a Qt-style 
    143 # comment as the brief description. If set to NO, the comments 
    144 # will behave just like regular Qt-style comments (thus requiring 
     142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     143# interpret the first line (until the first dot) of a Qt-style
     144# comment as the brief description. If set to NO, the comments
     145# will behave just like regular Qt-style comments (thus requiring
    145146# an explicit \brief command for a brief description.)
    146147
    147148QT_AUTOBRIEF           = NO
    148149
    149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
    150 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
    151 # comments) as a brief description. This used to be the default behaviour. 
    152 # The new default is to treat a multi-line C++ comment block as a detailed 
     150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     152# comments) as a brief description. This used to be the default behaviour.
     153# The new default is to treat a multi-line C++ comment block as a detailed
    153154# description. Set this tag to YES if you prefer the old behaviour instead.
    154155
    155156MULTILINE_CPP_IS_BRIEF = NO
    156157
    157 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
    158 # will output the detailed description near the top, like JavaDoc.
    159 # If set to NO, the detailed description appears after the member
    160 # documentation.
    161 
    162 DETAILS_AT_TOP         = NO
    163 
    164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    165 # member inherits the documentation from any documented member that it
     158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     159# member inherits the documentation from any documented member that it
    166160# re-implements.
    167161
    168162INHERIT_DOCS           = YES
    169163
    170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
    171 # a new page for each member. If set to NO, the documentation of a member will 
     164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     165# a new page for each member. If set to NO, the documentation of a member will
    172166# be part of the file/class/namespace that contains it.
    173167
    174168SEPARATE_MEMBER_PAGES  = NO
    175169
    176 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
     170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
    177171# Doxygen uses this value to replace tabs by spaces in code fragments.
    178172
    179173TAB_SIZE               = 4
    180174
    181 # This tag can be used to specify a number of aliases that acts 
    182 # as commands in the documentation. An alias has the form "name=value". 
    183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
    184 # put the command \sideeffect (or @sideeffect) in the documentation, which 
    185 # will result in a user-defined paragraph with heading "Side Effects:". 
     175# This tag can be used to specify a number of aliases that acts
     176# as commands in the documentation. An alias has the form "name=value".
     177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     178# put the command \sideeffect (or @sideeffect) in the documentation, which
     179# will result in a user-defined paragraph with heading "Side Effects:".
    186180# You can put \n's in the value part of an alias to insert newlines.
    187181
    188 ALIASES                = 
    189 
    190 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
    191 # sources only. Doxygen will then generate output that is more tailored for C. 
    192 # For instance, some of the names that are used will be different. The list 
     182ALIASES                =
     183
     184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     185# sources only. Doxygen will then generate output that is more tailored for C.
     186# For instance, some of the names that are used will be different. The list
    193187# of all members will be omitted, etc.
    194188
    195189OPTIMIZE_OUTPUT_FOR_C  = YES
    196190
    197 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
    198 # sources only. Doxygen will then generate output that is more tailored for Java.
    199 # For instance, namespaces will be presented as packages, qualified scopes
    200 # will look different, etc.
     191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     192# sources only. Doxygen will then generate output that is more tailored for
     193# Java. For instance, namespaces will be presented as packages, qualified
     194# scopes will look different, etc.
    201195
    202196OPTIMIZE_OUTPUT_JAVA   = NO
    203197
    204 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
    205 # include (a tag file for) the STL sources as input, then you should
    206 # set this tag to YES in order to let doxygen match functions declarations and
    207 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    208 # func(std::string) {}). This also make the inheritance and collaboration
     198# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     199# sources only. Doxygen will then generate output that is more tailored for
     200# Fortran.
     201
     202OPTIMIZE_FOR_FORTRAN   = NO
     203
     204# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     205# sources. Doxygen will then generate output that is tailored for
     206# VHDL.
     207
     208OPTIMIZE_OUTPUT_VHDL   = NO
     209
     210# Doxygen selects the parser to use depending on the extension of the files it parses.
     211# With this tag you can assign which parser to use for a given extension.
     212# Doxygen has a built-in mapping, but you can override or extend it using this tag.
     213# The format is ext=language, where ext is a file extension, and language is one of
     214# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
     215# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
     216# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
     217# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     218
     219EXTENSION_MAPPING      =
     220
     221# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     222# to include (a tag file for) the STL sources as input, then you should
     223# set this tag to YES in order to let doxygen match functions declarations and
     224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     225# func(std::string) {}). This also make the inheritance and collaboration
    209226# diagrams that involve STL classes more complete and accurate.
    210227
     
    216233CPP_CLI_SUPPORT        = NO
    217234
    218 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
    219 # Doxygen will parse them like normal C++ but will assume all classes use public 
     235# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     236# Doxygen will parse them like normal C++ but will assume all classes use public
    220237# instead of private inheritance when no explicit protection keyword is present.
    221238
    222239SIP_SUPPORT            = NO
    223240
    224 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    225 # tag is set to YES, then doxygen will reuse the documentation of the first
    226 # member in the group (if any) for the other members of the group. By default
     241# For Microsoft's IDL there are propget and propput attributes to indicate getter
     242# and setter methods for a property. Setting this option to YES (the default)
     243# will make doxygen to replace the get and set methods by a property in the
     244# documentation. This will only work if the methods are indeed getting or
     245# setting a simple type. If this is not the case, or you want to show the
     246# methods anyway, you should set this option to NO.
     247
     248IDL_PROPERTY_SUPPORT   = YES
     249
     250# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     251# tag is set to YES, then doxygen will reuse the documentation of the first
     252# member in the group (if any) for the other members of the group. By default
    227253# all members of a group must be documented explicitly.
    228254
    229255DISTRIBUTE_GROUP_DOC   = NO
    230256
    231 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
    232 # the same type (for instance a group of public functions) to be put as a 
    233 # subgroup of that type (e.g. under the Public Functions section). Set it to 
    234 # NO to prevent subgrouping. Alternatively, this can be done per class using 
     257# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     258# the same type (for instance a group of public functions) to be put as a
     259# subgroup of that type (e.g. under the Public Functions section). Set it to
     260# NO to prevent subgrouping. Alternatively, this can be done per class using
    235261# the \nosubgrouping command.
    236262
    237263SUBGROUPING            = YES
    238264
     265# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     266# is documented as struct, union, or enum with the name of the typedef. So
     267# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     268# with name TypeT. When disabled the typedef will appear as a member of a file,
     269# namespace, or class. And the struct will be named TypeS. This can typically
     270# be useful for C code in case the coding convention dictates that all compound
     271# types are typedef'ed and only the typedef is referenced, never the tag name.
     272
     273TYPEDEF_HIDES_STRUCT   = NO
     274
     275# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
     276# determine which symbols to keep in memory and which to flush to disk.
     277# When the cache is full, less often used symbols will be written to disk.
     278# For small to medium size projects (<1000 input files) the default value is
     279# probably good enough. For larger projects a too small cache size can cause
     280# doxygen to be busy swapping symbols to and from disk most of the time
     281# causing a significant performance penality.
     282# If the system has enough physical memory increasing the cache will improve the
     283# performance by keeping more symbols in memory. Note that the value works on
     284# a logarithmic scale so increasing the size by one will rougly double the
     285# memory usage. The cache size is given by this formula:
     286# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
     287# corresponding to a cache size of 2^16 = 65536 symbols
     288
     289SYMBOL_CACHE_SIZE      = 0
     290
    239291#---------------------------------------------------------------------------
    240292# Build related configuration options
    241293#---------------------------------------------------------------------------
    242294
    243 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    244 # documentation are documented, even if no documentation was available. 
    245 # Private class members and static file members will be hidden unless 
     295# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     296# documentation are documented, even if no documentation was available.
     297# Private class members and static file members will be hidden unless
    246298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    247299
    248300EXTRACT_ALL            = NO
    249301
    250 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
     302# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    251303# will be included in the documentation.
    252304
    253305EXTRACT_PRIVATE        = NO
    254306
    255 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
     307# If the EXTRACT_STATIC tag is set to YES all static members of a file
    256308# will be included in the documentation.
    257309
    258310EXTRACT_STATIC         = NO
    259311
    260 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
    261 # defined locally in source files will be included in the documentation. 
     312# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     313# defined locally in source files will be included in the documentation.
    262314# If set to NO only classes defined in header files are included.
    263315
    264316EXTRACT_LOCAL_CLASSES  = YES
    265317
    266 # This flag is only useful for Objective-C code. When set to YES local 
    267 # methods, which are defined in the implementation section but not in 
    268 # the interface are included in the documentation. 
     318# This flag is only useful for Objective-C code. When set to YES local
     319# methods, which are defined in the implementation section but not in
     320# the interface are included in the documentation.
    269321# If set to NO (the default) only methods in the interface are included.
    270322
    271323EXTRACT_LOCAL_METHODS  = NO
    272324
    273 # If this flag is set to YES, the members of anonymous namespaces will be extracted
    274 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
    275 # where file will be replaced with the base name of the file that contains the anonymous
    276 # namespace. By default anonymous namespace are hidden.
     325# If this flag is set to YES, the members of anonymous namespaces will be
     326# extracted and appear in the documentation as a namespace called
     327# 'anonymous_namespace{file}', where file will be replaced with the base
     328# name of the file that contains the anonymous namespace. By default
     329# anonymous namespace are hidden.
    277330
    278331EXTRACT_ANON_NSPACES   = NO
    279332
    280 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
    281 # undocumented members of documented classes, files or namespaces. 
    282 # If set to NO (the default) these members will be included in the 
    283 # various overviews, but no documentation section is generated. 
     333# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     334# undocumented members of documented classes, files or namespaces.
     335# If set to NO (the default) these members will be included in the
     336# various overviews, but no documentation section is generated.
    284337# This option has no effect if EXTRACT_ALL is enabled.
    285338
    286339HIDE_UNDOC_MEMBERS     = NO
    287340
    288 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    289 # undocumented classes that are normally visible in the class hierarchy. 
    290 # If set to NO (the default) these classes will be included in the various 
     341# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     342# undocumented classes that are normally visible in the class hierarchy.
     343# If set to NO (the default) these classes will be included in the various
    291344# overviews. This option has no effect if EXTRACT_ALL is enabled.
    292345
    293346HIDE_UNDOC_CLASSES     = NO
    294347
    295 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
    296 # friend (class|struct|union) declarations. 
    297 # If set to NO (the default) these declarations will be included in the 
     348# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     349# friend (class|struct|union) declarations.
     350# If set to NO (the default) these declarations will be included in the
    298351# documentation.
    299352
    300353HIDE_FRIEND_COMPOUNDS  = NO
    301354
    302 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
    303 # documentation blocks found inside the body of a function. 
    304 # If set to NO (the default) these blocks will be appended to the 
     355# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
     356# documentation blocks found inside the body of a function.
     357# If set to NO (the default) these blocks will be appended to the
    305358# function's detailed documentation block.
    306359
    307360HIDE_IN_BODY_DOCS      = NO
    308361
    309 # The INTERNAL_DOCS tag determines if documentation 
    310 # that is typed after a \internal command is included. If the tag is set 
    311 # to NO (the default) then the documentation will be excluded. 
     362# The INTERNAL_DOCS tag determines if documentation
     363# that is typed after a \internal command is included. If the tag is set
     364# to NO (the default) then the documentation will be excluded.
    312365# Set it to YES to include the internal documentation.
    313366
    314367INTERNAL_DOCS          = NO
    315368
    316 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
    317 # file names in lower-case letters. If set to YES upper-case letters are also 
    318 # allowed. This is useful if you have classes or files whose names only differ 
    319 # in case and if your file system supports case sensitive file names. Windows 
     369# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     370# file names in lower-case letters. If set to YES upper-case letters are also
     371# allowed. This is useful if you have classes or files whose names only differ
     372# in case and if your file system supports case sensitive file names. Windows
    320373# and Mac users are advised to set this option to NO.
    321374
    322375CASE_SENSE_NAMES       = YES
    323376
    324 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
    325 # will show members with their full class and namespace scopes in the 
     377# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     378# will show members with their full class and namespace scopes in the
    326379# documentation. If set to YES the scope will be hidden.
    327380
    328381HIDE_SCOPE_NAMES       = NO
    329382
    330 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
    331 # will put a list of the files that are included by a file in the documentation 
     383# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     384# will put a list of the files that are included by a file in the documentation
    332385# of that file.
    333386
    334387SHOW_INCLUDE_FILES     = YES
    335388
    336 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
     389# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    337390# is inserted in the documentation for inline members.
    338391
    339392INLINE_INFO            = YES
    340393
    341 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
    342 # will sort the (detailed) documentation of file and class members 
    343 # alphabetically by member name. If set to NO the members will appear in 
     394# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     395# will sort the (detailed) documentation of file and class members
     396# alphabetically by member name. If set to NO the members will appear in
    344397# declaration order.
    345398
    346399SORT_MEMBER_DOCS       = YES
    347400
    348 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
    349 # brief documentation of file, namespace and class members alphabetically 
    350 # by member name. If set to NO (the default) the members will appear in 
     401# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     402# brief documentation of file, namespace and class members alphabetically
     403# by member name. If set to NO (the default) the members will appear in
    351404# declaration order.
    352405
    353406SORT_BRIEF_DOCS        = NO
    354407
    355 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    356 # sorted by fully-qualified names, including namespaces. If set to
    357 # NO (the default), the class list will be sorted only by class name,
    358 # not including the namespace part.
     408# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     409
     410SORT_MEMBERS_CTORS_1ST = NO
     411
     412# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
     413# hierarchy of group names into alphabetical order. If set to NO (the default)
     414# the group names will appear in their defined order.
     415
     416SORT_GROUP_NAMES       = NO
     417
     418# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     419# sorted by fully-qualified names, including namespaces. If set to
     420# NO (the default), the class list will be sorted only by class name,
     421# not including the namespace part.
    359422# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    360 # Note: This option applies only to the class list, not to the 
     423# Note: This option applies only to the class list, not to the
    361424# alphabetical list.
    362425
    363426SORT_BY_SCOPE_NAME     = NO
    364427
    365 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
    366 # disable (NO) the todo list. This list is created by putting \todo 
     428# The GENERATE_TODOLIST tag can be used to enable (YES) or
     429# disable (NO) the todo list. This list is created by putting \todo
    367430# commands in the documentation.
    368431
    369432GENERATE_TODOLIST      = YES
    370433
    371 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
    372 # disable (NO) the test list. This list is created by putting \test 
     434# The GENERATE_TESTLIST tag can be used to enable (YES) or
     435# disable (NO) the test list. This list is created by putting \test
    373436# commands in the documentation.
    374437
    375438GENERATE_TESTLIST      = YES
    376439
    377 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
    378 # disable (NO) the bug list. This list is created by putting \bug 
     440# The GENERATE_BUGLIST tag can be used to enable (YES) or
     441# disable (NO) the bug list. This list is created by putting \bug
    379442# commands in the documentation.
    380443
    381444GENERATE_BUGLIST       = YES
    382445
    383 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
    384 # disable (NO) the deprecated list. This list is created by putting 
     446# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
     447# disable (NO) the deprecated list. This list is created by putting
    385448# \deprecated commands in the documentation.
    386449
    387450GENERATE_DEPRECATEDLIST= YES
    388451
    389 # The ENABLED_SECTIONS tag can be used to enable conditional 
     452# The ENABLED_SECTIONS tag can be used to enable conditional
    390453# documentation sections, marked by \if sectionname ... \endif.
    391454
    392 ENABLED_SECTIONS       = 
    393 
    394 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
    395 # the initial value of a variable or define consists of for it to appear in 
    396 # the documentation. If the initializer consists of more lines than specified 
    397 # here it will be hidden. Use a value of 0 to hide initializers completely. 
    398 # The appearance of the initializer of individual variables and defines in the 
    399 # documentation can be controlled using \showinitializer or \hideinitializer 
     455ENABLED_SECTIONS       =
     456
     457# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     458# the initial value of a variable or define consists of for it to appear in
     459# the documentation. If the initializer consists of more lines than specified
     460# here it will be hidden. Use a value of 0 to hide initializers completely.
     461# The appearance of the initializer of individual variables and defines in the
     462# documentation can be controlled using \showinitializer or \hideinitializer
    400463# command in the documentation regardless of this setting.
    401464
    402465MAX_INITIALIZER_LINES  = 30
    403466
    404 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
    405 # at the bottom of the documentation of classes and structs. If set to YES the 
     467# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
     468# at the bottom of the documentation of classes and structs. If set to YES the
    406469# list will mention the files that were used to generate the documentation.
    407470
    408471SHOW_USED_FILES        = YES
    409472
    410 # If the sources in your project are distributed over multiple directories 
    411 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
     473# If the sources in your project are distributed over multiple directories
     474# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    412475# in the documentation. The default is NO.
    413476
    414477SHOW_DIRECTORIES       = YES
    415478
    416 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
    417 # doxygen should invoke to get the current version for each file (typically from the
    418 # version control system). Doxygen will invoke the program by executing (via
    419 # popen()) the command <command> <input-file>, where <command> is the value of
    420 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    421 # provided by doxygen. Whatever the program writes to standard output
     479# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
     480# This will remove the Files entry from the Quick Index and from the
     481# Folder Tree View (if specified). The default is YES.
     482
     483SHOW_FILES             = YES
     484
     485# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
     486# Namespaces page.
     487# This will remove the Namespaces entry from the Quick Index
     488# and from the Folder Tree View (if specified). The default is YES.
     489
     490SHOW_NAMESPACES        = YES
     491
     492# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     493# doxygen should invoke to get the current version for each file (typically from
     494# the version control system). Doxygen will invoke the program by executing (via
     495# popen()) the command <command> <input-file>, where <command> is the value of
     496# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     497# provided by doxygen. Whatever the program writes to standard output
    422498# is used as the file version. See the manual for examples.
    423499
    424 FILE_VERSION_FILTER    =
     500FILE_VERSION_FILTER    =
     501
     502# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
     503# doxygen. The layout file controls the global structure of the generated output files
     504# in an output format independent way. The create the layout file that represents
     505# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
     506# file name after the option, if omitted DoxygenLayout.xml will be used as the name
     507# of the layout file.
     508
     509LAYOUT_FILE            =
    425510
    426511#---------------------------------------------------------------------------
     
    428513#---------------------------------------------------------------------------
    429514
    430 # The QUIET tag can be used to turn on/off the messages that are generated 
     515# The QUIET tag can be used to turn on/off the messages that are generated
    431516# by doxygen. Possible values are YES and NO. If left blank NO is used.
    432517
    433518QUIET                  = NO
    434519
    435 # The WARNINGS tag can be used to turn on/off the warning messages that are 
    436 # generated by doxygen. Possible values are YES and NO. If left blank 
     520# The WARNINGS tag can be used to turn on/off the warning messages that are
     521# generated by doxygen. Possible values are YES and NO. If left blank
    437522# NO is used.
    438523
    439524WARNINGS               = YES
    440525
    441 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
    442 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
     526# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     527# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    443528# automatically be disabled.
    444529
    445530WARN_IF_UNDOCUMENTED   = YES
    446531
    447 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
    448 # potential errors in the documentation, such as not documenting some 
    449 # parameters in a documented function, or documenting parameters that 
     532# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
     533# potential errors in the documentation, such as not documenting some
     534# parameters in a documented function, or documenting parameters that
    450535# don't exist or using markup commands wrongly.
    451536
    452537WARN_IF_DOC_ERROR      = YES
    453538
    454 # This WARN_NO_PARAMDOC option can be abled to get warnings for 
    455 # functions that are documented, but have no documentation for their parameters 
    456 # or return value. If set to NO (the default) doxygen will only warn about 
    457 # wrong or incomplete parameter documentation, but not about the absence of 
     539# This WARN_NO_PARAMDOC option can be abled to get warnings for
     540# functions that are documented, but have no documentation for their parameters
     541# or return value. If set to NO (the default) doxygen will only warn about
     542# wrong or incomplete parameter documentation, but not about the absence of
    458543# documentation.
    459544
    460545WARN_NO_PARAMDOC       = NO
    461546
    462 # The WARN_FORMAT tag determines the format of the warning messages that 
    463 # doxygen can produce. The string should contain the $file, $line, and $text 
    464 # tags, which will be replaced by the file and line number from which the 
    465 # warning originated and the warning text. Optionally the format may contain 
    466 # $version, which will be replaced by the version of the file (if it could 
     547# The WARN_FORMAT tag determines the format of the warning messages that
     548# doxygen can produce. The string should contain the $file, $line, and $text
     549# tags, which will be replaced by the file and line number from which the
     550# warning originated and the warning text. Optionally the format may contain
     551# $version, which will be replaced by the version of the file (if it could
    467552# be obtained via FILE_VERSION_FILTER)
    468553
    469554WARN_FORMAT            = "$file:$line: $text "
    470555
    471 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    472 # and error messages should be written. If left blank the output is written 
     556# The WARN_LOGFILE tag can be used to specify a file to which warning
     557# and error messages should be written. If left blank the output is written
    473558# to stderr.
    474559
    475 WARN_LOGFILE           = 
     560WARN_LOGFILE           =
    476561
    477562#---------------------------------------------------------------------------
     
    479564#---------------------------------------------------------------------------
    480565
    481 # The INPUT tag can be used to specify the files and/or directories that contain 
    482 # documented source files. You may enter file names like "myfile.cpp" or 
    483 # directories like "/usr/src/myproject". Separate the files or directories 
     566# The INPUT tag can be used to specify the files and/or directories that contain
     567# documented source files. You may enter file names like "myfile.cpp" or
     568# directories like "/usr/src/myproject". Separate the files or directories
    484569# with spaces.
    485570
    486571INPUT                  = ../src
    487572
    488 # This tag can be used to specify the character encoding of the source files that
    489 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
    490 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
    491 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
     573# This tag can be used to specify the character encoding of the source files
     574# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     575# also the default input encoding. Doxygen uses libiconv (or the iconv built
     576# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     577# the list of possible encodings.
    492578
    493579INPUT_ENCODING         = UTF-8
    494580
    495 # If the value of the INPUT tag contains directories, you can use the 
    496 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    497 # and *.h) to filter out the source-files in the directories. If left 
    498 # blank the following patterns are tested: 
    499 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
    500 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
     581# If the value of the INPUT tag contains directories, you can use the
     582# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     583# and *.h) to filter out the source-files in the directories. If left
     584# blank the following patterns are tested:
     585# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     586# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
    501587
    502588FILE_PATTERNS          = *.h
    503589
    504 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
    505 # should be searched for input files as well. Possible values are YES and NO. 
     590# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     591# should be searched for input files as well. Possible values are YES and NO.
    506592# If left blank NO is used.
    507593
    508594RECURSIVE              = YES
    509595
    510 # The EXCLUDE tag can be used to specify files and/or directories that should 
    511 # excluded from the INPUT source files. This way you can easily exclude a 
     596# The EXCLUDE tag can be used to specify files and/or directories that should
     597# excluded from the INPUT source files. This way you can easily exclude a
    512598# subdirectory from a directory tree whose root is specified with the INPUT tag.
    513599
    514 EXCLUDE                = ../src/aubio_priv.h
    515 
    516 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    517 # directories that are symbolic links (a Unix filesystem feature) are excluded
     600EXCLUDE                = ../src/aubio_priv.h \
     601                         ../src/temporal/filter_priv.h
     602
     603# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     604# directories that are symbolic links (a Unix filesystem feature) are excluded
    518605# from the input.
    519606
    520607EXCLUDE_SYMLINKS       = NO
    521608
    522 # If the value of the INPUT tag contains directories, you can use the 
    523 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
    524 # certain files from those directories. Note that the wildcards are matched 
    525 # against the file with absolute path, so to exclude all test directories 
     609# If the value of the INPUT tag contains directories, you can use the
     610# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     611# certain files from those directories. Note that the wildcards are matched
     612# against the file with absolute path, so to exclude all test directories
    526613# for example use the pattern */test/*
    527614
    528 EXCLUDE_PATTERNS       =
    529 
    530 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    531 # (namespaces, classes, functions, etc.) that should be excluded from the output.
    532 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
    533 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
    534 
    535 EXCLUDE_SYMBOLS        =
    536 
    537 # The EXAMPLE_PATH tag can be used to specify one or more files or
    538 # directories that contain example code fragments that are included (see
     615EXCLUDE_PATTERNS       =
     616
     617# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     618# (namespaces, classes, functions, etc.) that should be excluded from the
     619# output. The symbol name can be a fully qualified name, a word, or if the
     620# wildcard * is used, a substring. Examples: ANamespace, AClass,
     621# AClass::ANamespace, ANamespace::*Test
     622
     623EXCLUDE_SYMBOLS        =
     624
     625# The EXAMPLE_PATH tag can be used to specify one or more files or
     626# directories that contain example code fragments that are included (see
    539627# the \include command).
    540628
     
    542630                         ../
    543631
    544 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    545 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    546 # and *.h) to filter out the source-files in the directories. If left 
     632# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     633# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     634# and *.h) to filter out the source-files in the directories. If left
    547635# blank all files are included.
    548636
    549 EXAMPLE_PATTERNS       = 
    550 
    551 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    552 # searched for input files to be used with the \include or \dontinclude 
    553 # commands irrespective of the value of the RECURSIVE tag. 
     637EXAMPLE_PATTERNS       =
     638
     639# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     640# searched for input files to be used with the \include or \dontinclude
     641# commands irrespective of the value of the RECURSIVE tag.
    554642# Possible values are YES and NO. If left blank NO is used.
    555643
    556644EXAMPLE_RECURSIVE      = NO
    557645
    558 # The IMAGE_PATH tag can be used to specify one or more files or 
    559 # directories that contain image that are included in the documentation (see 
     646# The IMAGE_PATH tag can be used to specify one or more files or
     647# directories that contain image that are included in the documentation (see
    560648# the \image command).
    561649
    562 IMAGE_PATH             =
    563 
    564 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    565 # invoke to filter for each input file. Doxygen will invoke the filter program
    566 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    567 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    568 # input file. Doxygen will then use the output that the filter program writes
    569 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
     650IMAGE_PATH             =
     651
     652# The INPUT_FILTER tag can be used to specify a program that doxygen should
     653# invoke to filter for each input file. Doxygen will invoke the filter program
     654# by executing (via popen()) the command <filter> <input-file>, where <filter>
     655# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     656# input file. Doxygen will then use the output that the filter program writes
     657# to standard output.
     658# If FILTER_PATTERNS is specified, this tag will be
    570659# ignored.
    571660
    572 INPUT_FILTER           =
    573 
    574 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    575 # basis.  Doxygen will compare the file name with each pattern and apply the
    576 # filter if there is a match.  The filters are a list of the form:
    577 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    578 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     661INPUT_FILTER           =
     662
     663# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     664# basis.
     665# Doxygen will compare the file name with each pattern and apply the
     666# filter if there is a match.
     667# The filters are a list of the form:
     668# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     669# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    579670# is applied to all files.
    580671
    581 FILTER_PATTERNS        = 
    582 
    583 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
    584 # INPUT_FILTER) will be used to filter the input files when producing source 
     672FILTER_PATTERNS        =
     673
     674# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     675# INPUT_FILTER) will be used to filter the input files when producing source
    585676# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    586677
     
    591682#---------------------------------------------------------------------------
    592683
    593 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
    594 # be generated. Documented entities will be cross-referenced with these sources.
    595 # Note: To get rid of all source code in the generated output, make sure also
    596 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
    597 # then you must also enable this option. If you don't then doxygen will produce
    598 # a warning and turn it on anyway
     684# If the SOURCE_BROWSER tag is set to YES then a list of source files will
     685# be generated. Documented entities will be cross-referenced with these sources.
     686# Note: To get rid of all source code in the generated output, make sure also
     687# VERBATIM_HEADERS is set to NO.
    599688
    600689SOURCE_BROWSER         = YES
    601690
    602 # Setting the INLINE_SOURCES tag to YES will include the body 
     691# Setting the INLINE_SOURCES tag to YES will include the body
    603692# of functions and classes directly in the documentation.
    604693
    605694INLINE_SOURCES         = NO
    606695
    607 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    608 # doxygen to hide any special comment blocks from generated source code 
     696# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     697# doxygen to hide any special comment blocks from generated source code
    609698# fragments. Normal C and C++ comments will always remain visible.
    610699
    611700STRIP_CODE_COMMENTS    = YES
    612701
    613 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
    614 # then for each documented function all documented 
     702# If the REFERENCED_BY_RELATION tag is set to YES
     703# then for each documented function all documented
    615704# functions referencing it will be listed.
    616705
    617706REFERENCED_BY_RELATION = YES
    618707
    619 # If the REFERENCES_RELATION tag is set to YES (the default)
    620 # then for each documented function all documented entities 
     708# If the REFERENCES_RELATION tag is set to YES
     709# then for each documented function all documented entities
    621710# called/used by that function will be listed.
    622711
     
    626715# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    627716# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    628 # link to the source code.  Otherwise they will link to the documentstion.
     717# link to the source code.
     718# Otherwise they will link to the documentation.
    629719
    630720REFERENCES_LINK_SOURCE = YES
    631721
    632 # If the USE_HTAGS tag is set to YES then the references to source code 
    633 # will point to the HTML generated by the htags(1) tool instead of doxygen 
    634 # built-in source browser. The htags tool is part of GNU's global source 
    635 # tagging system (see http://www.gnu.org/software/global/global.html). You 
     722# If the USE_HTAGS tag is set to YES then the references to source code
     723# will point to the HTML generated by the htags(1) tool instead of doxygen
     724# built-in source browser. The htags tool is part of GNU's global source
     725# tagging system (see http://www.gnu.org/software/global/global.html). You
    636726# will need version 4.8.6 or higher.
    637727
    638728USE_HTAGS              = NO
    639729
    640 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
    641 # will generate a verbatim copy of the header file for each class for 
     730# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     731# will generate a verbatim copy of the header file for each class for
    642732# which an include is specified. Set to NO to disable this.
    643733
     
    648738#---------------------------------------------------------------------------
    649739
    650 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    651 # of all compounds will be generated. Enable this if the project 
     740# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     741# of all compounds will be generated. Enable this if the project
    652742# contains a lot of classes, structs, unions or interfaces.
    653743
    654744ALPHABETICAL_INDEX     = NO
    655745
    656 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    657 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     746# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     747# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    658748# in which this list will be split (can be a number in the range [1..20])
    659749
    660750COLS_IN_ALPHA_INDEX    = 5
    661751
    662 # In case all classes in a project start with a common prefix, all 
    663 # classes will be put under the same header in the alphabetical index. 
    664 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     752# In case all classes in a project start with a common prefix, all
     753# classes will be put under the same header in the alphabetical index.
     754# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    665755# should be ignored while generating the index headers.
    666756
    667 IGNORE_PREFIX          = 
     757IGNORE_PREFIX          =
    668758
    669759#---------------------------------------------------------------------------
     
    671761#---------------------------------------------------------------------------
    672762
    673 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     763# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    674764# generate HTML output.
    675765
    676766GENERATE_HTML          = YES
    677767
    678 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    679 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     768# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     769# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    680770# put in front of it. If left blank `html' will be used as the default path.
    681771
    682772HTML_OUTPUT            = html
    683773
    684 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    685 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
     774# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     775# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    686776# doxygen will generate files with .html extension.
    687777
    688778HTML_FILE_EXTENSION    = .html
    689779
    690 # The HTML_HEADER tag can be used to specify a personal HTML header for 
    691 # each generated HTML page. If it is left blank doxygen will generate a 
     780# The HTML_HEADER tag can be used to specify a personal HTML header for
     781# each generated HTML page. If it is left blank doxygen will generate a
    692782# standard header.
    693783
    694 HTML_HEADER            = 
    695 
    696 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    697 # each generated HTML page. If it is left blank doxygen will generate a 
     784HTML_HEADER            =
     785
     786# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     787# each generated HTML page. If it is left blank doxygen will generate a
    698788# standard footer.
    699789
    700 HTML_FOOTER            = 
    701 
    702 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
    703 # style sheet that is used by each HTML page. It can be used to 
    704 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
    705 # will generate a default style sheet. Note that doxygen will try to copy 
    706 # the style sheet file to the HTML output directory, so don't put your own 
     790HTML_FOOTER            =
     791
     792# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     793# style sheet that is used by each HTML page. It can be used to
     794# fine-tune the look of the HTML output. If the tag is left blank doxygen
     795# will generate a default style sheet. Note that doxygen will try to copy
     796# the style sheet file to the HTML output directory, so don't put your own
    707797# stylesheet in the HTML output directory as well, or it will be erased!
    708798
    709799HTML_STYLESHEET        = aubio.css
    710800
    711 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
    712 # files or namespaces will be aligned in HTML using tables. If set to 
     801# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     802# files or namespaces will be aligned in HTML using tables. If set to
    713803# NO a bullet list will be used.
    714804
    715805HTML_ALIGN_MEMBERS     = YES
    716806
    717 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    718 # will be generated that can be used as input for tools like the
    719 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     807# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     808# documentation will contain sections that can be hidden and shown after the
     809# page has loaded. For this to work a browser that supports
     810# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     811# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     812
     813HTML_DYNAMIC_SECTIONS  = NO
     814
     815# If the GENERATE_DOCSET tag is set to YES, additional index files
     816# will be generated that can be used as input for Apple's Xcode 3
     817# integrated development environment, introduced with OSX 10.5 (Leopard).
     818# To create a documentation set, doxygen will generate a Makefile in the
     819# HTML output directory. Running make will produce the docset in that
     820# directory and running "make install" will install the docset in
     821# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     822# it at startup.
     823# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     824
     825GENERATE_DOCSET        = NO
     826
     827# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     828# feed. A documentation feed provides an umbrella under which multiple
     829# documentation sets from a single provider (such as a company or product suite)
     830# can be grouped.
     831
     832DOCSET_FEEDNAME        = "Doxygen generated docs"
     833
     834# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     835# should uniquely identify the documentation set bundle. This should be a
     836# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     837# will append .docset to the name.
     838
     839DOCSET_BUNDLE_ID       = org.doxygen.Project
     840
     841# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     842# will be generated that can be used as input for tools like the
     843# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    720844# of the generated HTML documentation.
    721845
    722846GENERATE_HTMLHELP      = NO
    723847
    724 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    725 # documentation will contain sections that can be hidden and shown after the
    726 # page has loaded. For this to work a browser that supports
    727 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    728 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
    729 
    730 HTML_DYNAMIC_SECTIONS  = NO
    731 
    732 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    733 # be used to specify the file name of the resulting .chm file. You
    734 # can add a path in front of the file if the result should not be
     848# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     849# be used to specify the file name of the resulting .chm file. You
     850# can add a path in front of the file if the result should not be
    735851# written to the html output directory.
    736852
    737 CHM_FILE               = 
    738 
    739 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    740 # be used to specify the location (absolute path including file name) of 
    741 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
     853CHM_FILE               =
     854
     855# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     856# be used to specify the location (absolute path including file name) of
     857# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    742858# the HTML help compiler on the generated index.hhp.
    743859
    744 HHC_LOCATION           = 
    745 
    746 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    747 # controls if a separate .chi index file is generated (YES) or that 
     860HHC_LOCATION           =
     861
     862# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     863# controls if a separate .chi index file is generated (YES) or that
    748864# it should be included in the master .chm file (NO).
    749865
    750866GENERATE_CHI           = NO
    751867
    752 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    753 # controls whether a binary table of contents is generated (YES) or a
     868# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     869# is used to encode HtmlHelp index (hhk), content (hhc) and project file
     870# content.
     871
     872CHM_INDEX_ENCODING     =
     873
     874# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     875# controls whether a binary table of contents is generated (YES) or a
    754876# normal table of contents (NO) in the .chm file.
    755877
    756878BINARY_TOC             = NO
    757879
    758 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     880# The TOC_EXPAND flag can be set to YES to add extra items for group members
    759881# to the contents of the HTML help documentation and to the tree view.
    760882
    761883TOC_EXPAND             = NO
    762884
    763 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    764 # top of each HTML page. The value NO (the default) enables the index and
     885# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
     886# are set, an additional index file will be generated that can be used as input for
     887# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
     888# HTML documentation.
     889
     890GENERATE_QHP           = NO
     891
     892# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     893# be used to specify the file name of the resulting .qch file.
     894# The path specified is relative to the HTML output folder.
     895
     896QCH_FILE               =
     897
     898# The QHP_NAMESPACE tag specifies the namespace to use when generating
     899# Qt Help Project output. For more information please see
     900# http://doc.trolltech.com/qthelpproject.html#namespace
     901
     902QHP_NAMESPACE          =
     903
     904# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     905# Qt Help Project output. For more information please see
     906# http://doc.trolltech.com/qthelpproject.html#virtual-folders
     907
     908QHP_VIRTUAL_FOLDER     = doc
     909
     910# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
     911# For more information please see
     912# http://doc.trolltech.com/qthelpproject.html#custom-filters
     913
     914QHP_CUST_FILTER_NAME   =
     915
     916# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
     917# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     918
     919QHP_CUST_FILTER_ATTRS  =
     920
     921# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     922# filter section matches.
     923# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     924
     925QHP_SECT_FILTER_ATTRS  =
     926
     927# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     928# be used to specify the location of Qt's qhelpgenerator.
     929# If non-empty doxygen will try to run qhelpgenerator on the generated
     930# .qhp file.
     931
     932QHG_LOCATION           =
     933
     934# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     935# top of each HTML page. The value NO (the default) enables the index and
    765936# the value YES disables it.
    766937
    767938DISABLE_INDEX          = NO
    768939
    769 # This tag can be used to set the number of enum values (range [1..20]) 
     940# This tag can be used to set the number of enum values (range [1..20])
    770941# that doxygen will group on one line in the generated HTML documentation.
    771942
    772943ENUM_VALUES_PER_LINE   = 4
    773944
    774 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    775 # generated containing a tree-like index structure (just like the one that
    776 # is generated for HTML Help). For this to work a browser that supports
    777 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    778 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    779 # probably better off using the HTML help feature.
     945# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     946# structure should be generated to display hierarchical information.
     947# If the tag value is set to YES, a side panel will be generated
     948# containing a tree-like index structure (just like the one that
     949# is generated for HTML Help). For this to work a browser that supports
     950# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
     951# Windows users are probably better off using the HTML help feature.
    780952
    781953GENERATE_TREEVIEW      = NO
    782954
    783 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    784 # used to set the initial width (in pixels) of the frame in which the tree
     955# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
     956# and Class Hierarchy pages using a tree view instead of an ordered list.
     957
     958USE_INLINE_TREES       = NO
     959
     960# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     961# used to set the initial width (in pixels) of the frame in which the tree
    785962# is shown.
    786963
    787964TREEVIEW_WIDTH         = 250
    788965
     966# Use this tag to change the font size of Latex formulas included
     967# as images in the HTML documentation. The default is 10. Note that
     968# when you change the font size after a successful doxygen run you need
     969# to manually remove any form_*.png images from the HTML output directory
     970# to force them to be regenerated.
     971
     972FORMULA_FONTSIZE       = 10
     973
     974# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
     975# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
     976# there is already a search function so this one should typically
     977# be disabled.
     978
     979SEARCHENGINE           = YES
     980
    789981#---------------------------------------------------------------------------
    790982# configuration options related to the LaTeX output
    791983#---------------------------------------------------------------------------
    792984
    793 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     985# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    794986# generate Latex output.
    795987
    796988GENERATE_LATEX         = NO
    797989
    798 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    799 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     990# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     991# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    800992# put in front of it. If left blank `latex' will be used as the default path.
    801993
    802994LATEX_OUTPUT           = latex
    803995
    804 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
     996# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    805997# invoked. If left blank `latex' will be used as the default command name.
    806998
    807999LATEX_CMD_NAME         = latex
    8081000
    809 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
    810 # generate index for LaTeX. If left blank `makeindex' will be used as the 
     1001# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     1002# generate index for LaTeX. If left blank `makeindex' will be used as the
    8111003# default command name.
    8121004
    8131005MAKEINDEX_CMD_NAME     = makeindex
    8141006
    815 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    816 # LaTeX documents. This may be useful for small projects and may help to 
     1007# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     1008# LaTeX documents. This may be useful for small projects and may help to
    8171009# save some trees in general.
    8181010
    8191011COMPACT_LATEX          = NO
    8201012
    821 # The PAPER_TYPE tag can be used to set the paper type that is used 
    822 # by the printer. Possible values are: a4, a4wide, letter, legal and 
     1013# The PAPER_TYPE tag can be used to set the paper type that is used
     1014# by the printer. Possible values are: a4, a4wide, letter, legal and
    8231015# executive. If left blank a4wide will be used.
    8241016
    8251017PAPER_TYPE             = a4wide
    8261018
    827 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     1019# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    8281020# packages that should be included in the LaTeX output.
    8291021
    830 EXTRA_PACKAGES         = 
    831 
    832 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    833 # the generated latex document. The header should contain everything until 
    834 # the first chapter. If it is left blank doxygen will generate a 
     1022EXTRA_PACKAGES         =
     1023
     1024# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     1025# the generated latex document. The header should contain everything until
     1026# the first chapter. If it is left blank doxygen will generate a
    8351027# standard header. Notice: only use this tag if you know what you are doing!
    8361028
    837 LATEX_HEADER           = 
    838 
    839 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
    840 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
    841 # contain links (just like the HTML output) instead of page references 
     1029LATEX_HEADER           =
     1030
     1031# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     1032# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     1033# contain links (just like the HTML output) instead of page references
    8421034# This makes the output suitable for online browsing using a pdf viewer.
    8431035
    8441036PDF_HYPERLINKS         = NO
    8451037
    846 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    847 # plain latex in the generated Makefile. Set this option to YES to get a 
     1038# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     1039# plain latex in the generated Makefile. Set this option to YES to get a
    8481040# higher quality PDF documentation.
    8491041
    8501042USE_PDFLATEX           = NO
    8511043
    852 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    853 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    854 # running if errors occur, instead of asking the user for help. 
     1044# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     1045# command to the generated LaTeX files. This will instruct LaTeX to keep
     1046# running if errors occur, instead of asking the user for help.
    8551047# This option is also used when generating formulas in HTML.
    8561048
    8571049LATEX_BATCHMODE        = NO
    8581050
    859 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
    860 # include the index chapters (such as File Index, Compound Index, etc.) 
     1051# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     1052# include the index chapters (such as File Index, Compound Index, etc.)
    8611053# in the output.
    8621054
    8631055LATEX_HIDE_INDICES     = NO
    8641056
     1057# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
     1058
     1059LATEX_SOURCE_CODE      = NO
     1060
    8651061#---------------------------------------------------------------------------
    8661062# configuration options related to the RTF output
    8671063#---------------------------------------------------------------------------
    8681064
    869 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    870 # The RTF output is optimized for Word 97 and may not look very pretty with 
     1065# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     1066# The RTF output is optimized for Word 97 and may not look very pretty with
    8711067# other RTF readers or editors.
    8721068
    8731069GENERATE_RTF           = NO
    8741070
    875 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    876 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1071# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     1072# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    8771073# put in front of it. If left blank `rtf' will be used as the default path.
    8781074
    8791075RTF_OUTPUT             = rtf
    8801076
    881 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    882 # RTF documents. This may be useful for small projects and may help to 
     1077# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     1078# RTF documents. This may be useful for small projects and may help to
    8831079# save some trees in general.
    8841080
    8851081COMPACT_RTF            = NO
    8861082
    887 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    888 # will contain hyperlink fields. The RTF file will 
    889 # contain links (just like the HTML output) instead of page references. 
    890 # This makes the output suitable for online browsing using WORD or other 
    891 # programs which support those fields. 
     1083# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     1084# will contain hyperlink fields. The RTF file will
     1085# contain links (just like the HTML output) instead of page references.
     1086# This makes the output suitable for online browsing using WORD or other
     1087# programs which support those fields.
    8921088# Note: wordpad (write) and others do not support links.
    8931089
    8941090RTF_HYPERLINKS         = NO
    8951091
    896 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
    897 # config file, i.e. a series of assignments. You only have to provide 
     1092# Load stylesheet definitions from file. Syntax is similar to doxygen's
     1093# config file, i.e. a series of assignments. You only have to provide
    8981094# replacements, missing definitions are set to their default value.
    8991095
    900 RTF_STYLESHEET_FILE    = 
    901 
    902 # Set optional variables used in the generation of an rtf document. 
     1096RTF_STYLESHEET_FILE    =
     1097
     1098# Set optional variables used in the generation of an rtf document.
    9031099# Syntax is similar to doxygen's config file.
    9041100
    905 RTF_EXTENSIONS_FILE    = 
     1101RTF_EXTENSIONS_FILE    =
    9061102
    9071103#---------------------------------------------------------------------------
     
    9091105#---------------------------------------------------------------------------
    9101106
    911 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     1107# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    9121108# generate man pages
    9131109