Changeset 7a7ddd6 in rtems-testing


Ignore:
Timestamp:
May 12, 2010, 6:12:36 PM (9 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, 8895273c193787f84c4585a10f6d6aceb3b25dc4
Children:
a49d72c
Parents:
65a6eb4
Message:

2010-05-12 Joel Sherrill <joel.sherrilL@…>

Location:
rtems-coverage
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • rtems-coverage/ChangeLog

    r65a6eb4 r7a7ddd6  
     12010-05-12      Joel Sherrill <joel.sherrilL@OARcorp.com>
     2
     3        * ConfigFile.h, Doxyfile, Makefile, ReportsBase.h, ReportsHtml.h,
     4        ReportsText.h, TraceWriterBase.h: Doxygen update.
     5
    162010-05-12      Jennifer Averett <Jennifer.Averett@OARcorp.com>
    27
  • rtems-coverage/ConfigFile.h

    r65a6eb4 r7a7ddd6  
    55
    66
    7 /*! @file FileReader.h
    8  *  @brief FileReader Specification
     7/*! @file ConfigFile.h
     8 *  @brief Configuration File Reader Specification
    99 *
    1010 *  This file contains the specification of the FileReader class.
  • rtems-coverage/Doxyfile

    r65a6eb4 r7a7ddd6  
    1 # Doxyfile 1.5.2
     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           = "RTEMS Coverage Map Processor"
    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
    41 OUTPUT_DIRECTORY       = 
    42 
    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 
     41OUTPUT_DIRECTORY       =
     42
     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
    116 STRIP_FROM_PATH        = 
    117 
    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 
     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
    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 the Qt-style comments (thus requiring an
    137 # explicit @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.)
    138139
    139140JAVADOC_AUTOBRIEF      = NO
    140141
    141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
    142 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
    143 # comments) as a brief description. This used to be the default behaviour.
    144 # 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
    145154# description. Set this tag to YES if you prefer the old behaviour instead.
    146155
    147156MULTILINE_CPP_IS_BRIEF = NO
    148157
    149 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
    150 # will output the detailed description near the top, like JavaDoc.
    151 # If set to NO, the detailed description appears after the member
    152 # documentation.
    153 
    154 DETAILS_AT_TOP         = NO
    155 
    156 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    157 # 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
    158160# re-implements.
    159161
    160162INHERIT_DOCS           = YES
    161163
    162 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
    163 # 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
    164166# be part of the file/class/namespace that contains it.
    165167
    166168SEPARATE_MEMBER_PAGES  = NO
    167169
    168 # 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.
    169171# Doxygen uses this value to replace tabs by spaces in code fragments.
    170172
    171173TAB_SIZE               = 8
    172174
    173 # This tag can be used to specify a number of aliases that acts 
    174 # as commands in the documentation. An alias has the form "name=value". 
    175 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
    176 # put the command \sideeffect (or @sideeffect) in the documentation, which 
    177 # 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:".
    178180# You can put \n's in the value part of an alias to insert newlines.
    179181
    180 ALIASES                = 
    181 
    182 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
    183 # sources only. Doxygen will then generate output that is more tailored for C. 
    184 # 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
    185187# of all members will be omitted, etc.
    186188
    187189OPTIMIZE_OUTPUT_FOR_C  = NO
    188190
    189 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
    190 # sources only. Doxygen will then generate output that is more tailored for Java.
    191 # For instance, namespaces will be presented as packages, qualified scopes
    192 # 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.
    193195
    194196OPTIMIZE_OUTPUT_JAVA   = NO
    195197
    196 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
    197 # include (a tag file for) the STL sources as input, then you should
    198 # set this tag to YES in order to let doxygen match functions declarations and
    199 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    200 # 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
    201226# diagrams that involve STL classes more complete and accurate.
    202227
     
    208233CPP_CLI_SUPPORT        = NO
    209234
    210 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    211 # tag is set to YES, then doxygen will reuse the documentation of the first
    212 # member in the group (if any) for the other members of the group. By default
     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
    213253# all members of a group must be documented explicitly.
    214254
    215255DISTRIBUTE_GROUP_DOC   = NO
    216256
    217 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
    218 # the same type (for instance a group of public functions) to be put as a 
    219 # subgroup of that type (e.g. under the Public Functions section). Set it to 
    220 # 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
    221261# the \nosubgrouping command.
    222262
    223263SUBGROUPING            = YES
    224264
     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
    225291#---------------------------------------------------------------------------
    226292# Build related configuration options
    227293#---------------------------------------------------------------------------
    228294
    229 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    230 # documentation are documented, even if no documentation was available. 
    231 # 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
    232298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    233299
    234300EXTRACT_ALL            = NO
    235301
    236 # 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
    237303# will be included in the documentation.
    238304
    239305EXTRACT_PRIVATE        = NO
    240306
    241 # 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
    242308# will be included in the documentation.
    243309
    244310EXTRACT_STATIC         = NO
    245311
    246 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
    247 # 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.
    248314# If set to NO only classes defined in header files are included.
    249315
    250316EXTRACT_LOCAL_CLASSES  = YES
    251317
    252 # This flag is only useful for Objective-C code. When set to YES local 
    253 # methods, which are defined in the implementation section but not in 
    254 # 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.
    255321# If set to NO (the default) only methods in the interface are included.
    256322
    257323EXTRACT_LOCAL_METHODS  = NO
    258324
    259 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    260 # undocumented members of documented classes, files or namespaces.
    261 # If set to NO (the default) these members will be included in the
    262 # various overviews, but no documentation section is generated.
     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.
    263337# This option has no effect if EXTRACT_ALL is enabled.
    264338
    265339HIDE_UNDOC_MEMBERS     = NO
    266340
    267 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    268 # undocumented classes that are normally visible in the class hierarchy. 
    269 # 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
    270344# overviews. This option has no effect if EXTRACT_ALL is enabled.
    271345
    272346HIDE_UNDOC_CLASSES     = NO
    273347
    274 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
    275 # friend (class|struct|union) declarations. 
    276 # 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
    277351# documentation.
    278352
    279353HIDE_FRIEND_COMPOUNDS  = NO
    280354
    281 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
    282 # documentation blocks found inside the body of a function. 
    283 # 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
    284358# function's detailed documentation block.
    285359
    286360HIDE_IN_BODY_DOCS      = NO
    287361
    288 # The INTERNAL_DOCS tag determines if documentation 
    289 # that is typed after a \internal command is included. If the tag is set 
    290 # 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.
    291365# Set it to YES to include the internal documentation.
    292366
    293367INTERNAL_DOCS          = NO
    294368
    295 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
    296 # file names in lower-case letters. If set to YES upper-case letters are also 
    297 # allowed. This is useful if you have classes or files whose names only differ 
    298 # 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
    299373# and Mac users are advised to set this option to NO.
    300374
    301375CASE_SENSE_NAMES       = YES
    302376
    303 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
    304 # 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
    305379# documentation. If set to YES the scope will be hidden.
    306380
    307381HIDE_SCOPE_NAMES       = NO
    308382
    309 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
    310 # 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
    311385# of that file.
    312386
    313387SHOW_INCLUDE_FILES     = YES
    314388
    315 # 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]
    316390# is inserted in the documentation for inline members.
    317391
    318392INLINE_INFO            = YES
    319393
    320 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
    321 # will sort the (detailed) documentation of file and class members 
    322 # 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
    323397# declaration order.
    324398
    325399SORT_MEMBER_DOCS       = YES
    326400
    327 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
    328 # brief documentation of file, namespace and class members alphabetically 
    329 # 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
    330404# declaration order.
    331405
    332406SORT_BRIEF_DOCS        = NO
    333407
    334 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
    335 # sorted by fully-qualified names, including namespaces. If set to
    336 # NO (the default), the class list will be sorted only by class name,
    337 # 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.
    338422# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
    339 # 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
    340424# alphabetical list.
    341425
    342426SORT_BY_SCOPE_NAME     = NO
    343427
    344 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
    345 # 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
    346430# commands in the documentation.
    347431
    348432GENERATE_TODOLIST      = YES
    349433
    350 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
    351 # 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
    352436# commands in the documentation.
    353437
    354438GENERATE_TESTLIST      = YES
    355439
    356 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
    357 # 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
    358442# commands in the documentation.
    359443
    360444GENERATE_BUGLIST       = YES
    361445
    362 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
    363 # 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
    364448# \deprecated commands in the documentation.
    365449
    366450GENERATE_DEPRECATEDLIST= YES
    367451
    368 # The ENABLED_SECTIONS tag can be used to enable conditional 
     452# The ENABLED_SECTIONS tag can be used to enable conditional
    369453# documentation sections, marked by \if sectionname ... \endif.
    370454
    371 ENABLED_SECTIONS       = 
    372 
    373 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
    374 # the initial value of a variable or define consists of for it to appear in 
    375 # the documentation. If the initializer consists of more lines than specified 
    376 # here it will be hidden. Use a value of 0 to hide initializers completely. 
    377 # The appearance of the initializer of individual variables and defines in the 
    378 # 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
    379463# command in the documentation regardless of this setting.
    380464
    381465MAX_INITIALIZER_LINES  = 30
    382466
    383 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
    384 # 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
    385469# list will mention the files that were used to generate the documentation.
    386470
    387471SHOW_USED_FILES        = YES
    388472
    389 # If the sources in your project are distributed over multiple directories 
    390 # 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
    391475# in the documentation. The default is NO.
    392476
    393477SHOW_DIRECTORIES       = NO
    394478
    395 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
    396 # doxygen should invoke to get the current version for each file (typically from the
    397 # version control system). Doxygen will invoke the program by executing (via
    398 # popen()) the command <command> <input-file>, where <command> is the value of
    399 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
    400 # 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
    401498# is used as the file version. See the manual for examples.
    402499
    403 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            =
    404510
    405511#---------------------------------------------------------------------------
     
    407513#---------------------------------------------------------------------------
    408514
    409 # 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
    410516# by doxygen. Possible values are YES and NO. If left blank NO is used.
    411517
    412518QUIET                  = NO
    413519
    414 # The WARNINGS tag can be used to turn on/off the warning messages that are 
    415 # 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
    416522# NO is used.
    417523
    418524WARNINGS               = YES
    419525
    420 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
    421 # 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
    422528# automatically be disabled.
    423529
    424530WARN_IF_UNDOCUMENTED   = YES
    425531
    426 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
    427 # potential errors in the documentation, such as not documenting some 
    428 # 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
    429535# don't exist or using markup commands wrongly.
    430536
    431537WARN_IF_DOC_ERROR      = YES
    432538
    433 # This WARN_NO_PARAMDOC option can be abled to get warnings for 
    434 # functions that are documented, but have no documentation for their parameters 
    435 # or return value. If set to NO (the default) doxygen will only warn about 
    436 # 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
    437543# documentation.
    438544
    439545WARN_NO_PARAMDOC       = NO
    440546
    441 # The WARN_FORMAT tag determines the format of the warning messages that 
    442 # doxygen can produce. The string should contain the $file, $line, and $text 
    443 # tags, which will be replaced by the file and line number from which the 
    444 # warning originated and the warning text. Optionally the format may contain 
    445 # $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
    446552# be obtained via FILE_VERSION_FILTER)
    447553
    448554WARN_FORMAT            = "$file:$line: $text"
    449555
    450 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    451 # 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
    452558# to stderr.
    453559
    454 WARN_LOGFILE           =
     560WARN_LOGFILE           = warnings.log
    455561
    456562#---------------------------------------------------------------------------
     
    458564#---------------------------------------------------------------------------
    459565
    460 # The INPUT tag can be used to specify the files and/or directories that contain 
    461 # documented source files. You may enter file names like "myfile.cpp" or 
    462 # 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
    463569# with spaces.
    464570
    465 INPUT                  =
    466 
    467 # This tag can be used to specify the character encoding of the source files that
    468 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
    469 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
    470 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
     571INPUT                  =
     572
     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.
    471578
    472579INPUT_ENCODING         = UTF-8
    473580
    474 # If the value of the INPUT tag contains directories, you can use the 
    475 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    476 # and *.h) to filter out the source-files in the directories. If left 
    477 # blank the following patterns are tested: 
    478 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
    479 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
    480 
    481 FILE_PATTERNS          = 
    482 
    483 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
    484 # should be searched for input files as well. Possible values are YES and NO. 
     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.
    485592# If left blank NO is used.
    486593
    487594RECURSIVE              = NO
    488595
    489 # The EXCLUDE tag can be used to specify files and/or directories that should 
    490 # 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
    491598# subdirectory from a directory tree whose root is specified with the INPUT tag.
    492599
    493 EXCLUDE                =
    494 
    495 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    496 # directories that are symbolic links (a Unix filesystem feature) are excluded
     600EXCLUDE                = qemu-traces.h \
     601                         skyeye_header.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
    497605# from the input.
    498606
    499607EXCLUDE_SYMLINKS       = NO
    500608
    501 # If the value of the INPUT tag contains directories, you can use the 
    502 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
    503 # certain files from those directories. Note that the wildcards are matched 
    504 # 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
    505613# for example use the pattern */test/*
    506614
    507 EXCLUDE_PATTERNS       =
    508 
    509 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
    510 # (namespaces, classes, functions, etc.) that should be excluded from the output.
    511 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
    512 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
    513 
    514 EXCLUDE_SYMBOLS        =
    515 
    516 # The EXAMPLE_PATH tag can be used to specify one or more files or
    517 # 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
    518627# the \include command).
    519628
    520 EXAMPLE_PATH           = 
    521 
    522 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    523 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    524 # and *.h) to filter out the source-files in the directories. If left 
     629EXAMPLE_PATH           =
     630
     631# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     632# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     633# and *.h) to filter out the source-files in the directories. If left
    525634# blank all files are included.
    526635
    527 EXAMPLE_PATTERNS       = 
    528 
    529 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    530 # searched for input files to be used with the \include or \dontinclude 
    531 # commands irrespective of the value of the RECURSIVE tag. 
     636EXAMPLE_PATTERNS       =
     637
     638# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     639# searched for input files to be used with the \include or \dontinclude
     640# commands irrespective of the value of the RECURSIVE tag.
    532641# Possible values are YES and NO. If left blank NO is used.
    533642
    534643EXAMPLE_RECURSIVE      = NO
    535644
    536 # The IMAGE_PATH tag can be used to specify one or more files or 
    537 # directories that contain image that are included in the documentation (see 
     645# The IMAGE_PATH tag can be used to specify one or more files or
     646# directories that contain image that are included in the documentation (see
    538647# the \image command).
    539648
    540 IMAGE_PATH             =
    541 
    542 # The INPUT_FILTER tag can be used to specify a program that doxygen should
    543 # invoke to filter for each input file. Doxygen will invoke the filter program
    544 # by executing (via popen()) the command <filter> <input-file>, where <filter>
    545 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
    546 # input file. Doxygen will then use the output that the filter program writes
    547 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
     649IMAGE_PATH             =
     650
     651# The INPUT_FILTER tag can be used to specify a program that doxygen should
     652# invoke to filter for each input file. Doxygen will invoke the filter program
     653# by executing (via popen()) the command <filter> <input-file>, where <filter>
     654# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     655# input file. Doxygen will then use the output that the filter program writes
     656# to standard output.
     657# If FILTER_PATTERNS is specified, this tag will be
    548658# ignored.
    549659
    550 INPUT_FILTER           =
    551 
    552 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
    553 # basis.  Doxygen will compare the file name with each pattern and apply the
    554 # filter if there is a match.  The filters are a list of the form:
    555 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    556 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     660INPUT_FILTER           =
     661
     662# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     663# basis.
     664# Doxygen will compare the file name with each pattern and apply the
     665# filter if there is a match.
     666# The filters are a list of the form:
     667# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     668# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    557669# is applied to all files.
    558670
    559 FILTER_PATTERNS        = 
    560 
    561 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
    562 # INPUT_FILTER) will be used to filter the input files when producing source 
     671FILTER_PATTERNS        =
     672
     673# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     674# INPUT_FILTER) will be used to filter the input files when producing source
    563675# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    564676
     
    569681#---------------------------------------------------------------------------
    570682
    571 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
    572 # be generated. Documented entities will be cross-referenced with these sources. 
    573 # Note: To get rid of all source code in the generated output, make sure also 
     683# If the SOURCE_BROWSER tag is set to YES then a list of source files will
     684# be generated. Documented entities will be cross-referenced with these sources.
     685# Note: To get rid of all source code in the generated output, make sure also
    574686# VERBATIM_HEADERS is set to NO.
    575687
    576688SOURCE_BROWSER         = NO
    577689
    578 # Setting the INLINE_SOURCES tag to YES will include the body 
     690# Setting the INLINE_SOURCES tag to YES will include the body
    579691# of functions and classes directly in the documentation.
    580692
    581693INLINE_SOURCES         = NO
    582694
    583 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    584 # doxygen to hide any special comment blocks from generated source code 
     695# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     696# doxygen to hide any special comment blocks from generated source code
    585697# fragments. Normal C and C++ comments will always remain visible.
    586698
    587699STRIP_CODE_COMMENTS    = YES
    588700
    589 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
    590 # then for each documented function all documented 
     701# If the REFERENCED_BY_RELATION tag is set to YES
     702# then for each documented function all documented
    591703# functions referencing it will be listed.
    592704
    593705REFERENCED_BY_RELATION = YES
    594706
    595 # If the REFERENCES_RELATION tag is set to YES (the default)
    596 # then for each documented function all documented entities 
     707# If the REFERENCES_RELATION tag is set to YES
     708# then for each documented function all documented entities
    597709# called/used by that function will be listed.
    598710
     
    602714# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
    603715# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
    604 # link to the source code.  Otherwise they will link to the documentstion.
     716# link to the source code.
     717# Otherwise they will link to the documentation.
    605718
    606719REFERENCES_LINK_SOURCE = YES
    607720
    608 # If the USE_HTAGS tag is set to YES then the references to source code 
    609 # will point to the HTML generated by the htags(1) tool instead of doxygen 
    610 # built-in source browser. The htags tool is part of GNU's global source 
    611 # tagging system (see http://www.gnu.org/software/global/global.html). You 
     721# If the USE_HTAGS tag is set to YES then the references to source code
     722# will point to the HTML generated by the htags(1) tool instead of doxygen
     723# built-in source browser. The htags tool is part of GNU's global source
     724# tagging system (see http://www.gnu.org/software/global/global.html). You
    612725# will need version 4.8.6 or higher.
    613726
    614727USE_HTAGS              = NO
    615728
    616 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
    617 # will generate a verbatim copy of the header file for each class for 
     729# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     730# will generate a verbatim copy of the header file for each class for
    618731# which an include is specified. Set to NO to disable this.
    619732
     
    624737#---------------------------------------------------------------------------
    625738
    626 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    627 # of all compounds will be generated. Enable this if the project 
     739# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     740# of all compounds will be generated. Enable this if the project
    628741# contains a lot of classes, structs, unions or interfaces.
    629742
    630743ALPHABETICAL_INDEX     = NO
    631744
    632 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    633 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     745# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     746# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    634747# in which this list will be split (can be a number in the range [1..20])
    635748
    636749COLS_IN_ALPHA_INDEX    = 5
    637750
    638 # In case all classes in a project start with a common prefix, all 
    639 # classes will be put under the same header in the alphabetical index. 
    640 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     751# In case all classes in a project start with a common prefix, all
     752# classes will be put under the same header in the alphabetical index.
     753# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    641754# should be ignored while generating the index headers.
    642755
    643 IGNORE_PREFIX          = 
     756IGNORE_PREFIX          =
    644757
    645758#---------------------------------------------------------------------------
     
    647760#---------------------------------------------------------------------------
    648761
    649 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     762# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    650763# generate HTML output.
    651764
    652765GENERATE_HTML          = YES
    653766
    654 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    655 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     767# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     768# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    656769# put in front of it. If left blank `html' will be used as the default path.
    657770
    658771HTML_OUTPUT            = html
    659772
    660 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    661 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
     773# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     774# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    662775# doxygen will generate files with .html extension.
    663776
    664777HTML_FILE_EXTENSION    = .html
    665778
    666 # The HTML_HEADER tag can be used to specify a personal HTML header for 
    667 # each generated HTML page. If it is left blank doxygen will generate a 
     779# The HTML_HEADER tag can be used to specify a personal HTML header for
     780# each generated HTML page. If it is left blank doxygen will generate a
    668781# standard header.
    669782
    670 HTML_HEADER            = 
    671 
    672 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    673 # each generated HTML page. If it is left blank doxygen will generate a 
     783HTML_HEADER            =
     784
     785# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     786# each generated HTML page. If it is left blank doxygen will generate a
    674787# standard footer.
    675788
    676 HTML_FOOTER            =
    677 
    678 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    679 # style sheet that is used by each HTML page. It can be used to
    680 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    681 # will generate a default style sheet. Note that doxygen will try to copy
    682 # the style sheet file to the HTML output directory, so don't put your own
     789HTML_FOOTER            =
     790
     791# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
     792# documentation will contain the timesstamp.
     793
     794HTML_TIMESTAMP         = NO
     795
     796# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     797# style sheet that is used by each HTML page. It can be used to
     798# fine-tune the look of the HTML output. If the tag is left blank doxygen
     799# will generate a default style sheet. Note that doxygen will try to copy
     800# the style sheet file to the HTML output directory, so don't put your own
    683801# stylesheet in the HTML output directory as well, or it will be erased!
    684802
    685 HTML_STYLESHEET        = 
    686 
    687 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
    688 # files or namespaces will be aligned in HTML using tables. If set to 
     803HTML_STYLESHEET        =
     804
     805# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     806# files or namespaces will be aligned in HTML using tables. If set to
    689807# NO a bullet list will be used.
    690808
    691809HTML_ALIGN_MEMBERS     = YES
    692810
    693 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    694 # will be generated that can be used as input for tools like the
    695 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     811# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     812# documentation will contain sections that can be hidden and shown after the
     813# page has loaded. For this to work a browser that supports
     814# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     815# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     816
     817HTML_DYNAMIC_SECTIONS  = NO
     818
     819# If the GENERATE_DOCSET tag is set to YES, additional index files
     820# will be generated that can be used as input for Apple's Xcode 3
     821# integrated development environment, introduced with OSX 10.5 (Leopard).
     822# To create a documentation set, doxygen will generate a Makefile in the
     823# HTML output directory. Running make will produce the docset in that
     824# directory and running "make install" will install the docset in
     825# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     826# it at startup.
     827# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     828
     829GENERATE_DOCSET        = NO
     830
     831# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     832# feed. A documentation feed provides an umbrella under which multiple
     833# documentation sets from a single provider (such as a company or product suite)
     834# can be grouped.
     835
     836DOCSET_FEEDNAME        = "Doxygen generated docs"
     837
     838# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     839# should uniquely identify the documentation set bundle. This should be a
     840# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     841# will append .docset to the name.
     842
     843DOCSET_BUNDLE_ID       = org.doxygen.Project
     844
     845# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     846# will be generated that can be used as input for tools like the
     847# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    696848# of the generated HTML documentation.
    697849
    698850GENERATE_HTMLHELP      = NO
    699851
    700 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
    701 # be used to specify the file name of the resulting .chm file. You 
    702 # can add a path in front of the file if the result should not be 
     852# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     853# be used to specify the file name of the resulting .chm file. You
     854# can add a path in front of the file if the result should not be
    703855# written to the html output directory.
    704856
    705 CHM_FILE               = 
    706 
    707 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    708 # be used to specify the location (absolute path including file name) of 
    709 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
     857CHM_FILE               =
     858
     859# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     860# be used to specify the location (absolute path including file name) of
     861# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    710862# the HTML help compiler on the generated index.hhp.
    711863
    712 HHC_LOCATION           = 
    713 
    714 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    715 # controls if a separate .chi index file is generated (YES) or that 
     864HHC_LOCATION           =
     865
     866# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     867# controls if a separate .chi index file is generated (YES) or that
    716868# it should be included in the master .chm file (NO).
    717869
    718870GENERATE_CHI           = NO
    719871
    720 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    721 # controls whether a binary table of contents is generated (YES) or a
     872# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     873# is used to encode HtmlHelp index (hhk), content (hhc) and project file
     874# content.
     875
     876CHM_INDEX_ENCODING     =
     877
     878# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     879# controls whether a binary table of contents is generated (YES) or a
    722880# normal table of contents (NO) in the .chm file.
    723881
    724882BINARY_TOC             = NO
    725883
    726 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     884# The TOC_EXPAND flag can be set to YES to add extra items for group members
    727885# to the contents of the HTML help documentation and to the tree view.
    728886
    729887TOC_EXPAND             = NO
    730888
    731 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    732 # top of each HTML page. The value NO (the default) enables the index and
     889# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
     890# are set, an additional index file will be generated that can be used as input for
     891# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
     892# HTML documentation.
     893
     894GENERATE_QHP           = NO
     895
     896# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     897# be used to specify the file name of the resulting .qch file.
     898# The path specified is relative to the HTML output folder.
     899
     900QCH_FILE               =
     901
     902# The QHP_NAMESPACE 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#namespace
     905
     906QHP_NAMESPACE          =
     907
     908# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     909# Qt Help Project output. For more information please see
     910# http://doc.trolltech.com/qthelpproject.html#virtual-folders
     911
     912QHP_VIRTUAL_FOLDER     = doc
     913
     914# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
     915# For more information please see
     916# http://doc.trolltech.com/qthelpproject.html#custom-filters
     917
     918QHP_CUST_FILTER_NAME   =
     919
     920# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
     921# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     922
     923QHP_CUST_FILTER_ATTRS  =
     924
     925# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     926# filter section matches.
     927# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     928
     929QHP_SECT_FILTER_ATTRS  =
     930
     931# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     932# be used to specify the location of Qt's qhelpgenerator.
     933# If non-empty doxygen will try to run qhelpgenerator on the generated
     934# .qhp file.
     935
     936QHG_LOCATION           =
     937
     938# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     939# top of each HTML page. The value NO (the default) enables the index and
    733940# the value YES disables it.
    734941
    735942DISABLE_INDEX          = NO
    736943
    737 # This tag can be used to set the number of enum values (range [1..20]) 
     944# This tag can be used to set the number of enum values (range [1..20])
    738945# that doxygen will group on one line in the generated HTML documentation.
    739946
    740947ENUM_VALUES_PER_LINE   = 4
    741948
    742 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    743 # generated containing a tree-like index structure (just like the one that
    744 # is generated for HTML Help). For this to work a browser that supports
    745 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    746 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    747 # probably better off using the HTML help feature.
     949# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     950# structure should be generated to display hierarchical information.
     951# If the tag value is set to YES, a side panel will be generated
     952# containing a tree-like index structure (just like the one that
     953# is generated for HTML Help). For this to work a browser that supports
     954# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
     955# Windows users are probably better off using the HTML help feature.
    748956
    749957GENERATE_TREEVIEW      = NO
    750958
    751 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    752 # used to set the initial width (in pixels) of the frame in which the tree
     959# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
     960# and Class Hierarchy pages using a tree view instead of an ordered list.
     961
     962USE_INLINE_TREES       = NO
     963
     964# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     965# used to set the initial width (in pixels) of the frame in which the tree
    753966# is shown.
    754967
    755968TREEVIEW_WIDTH         = 250
    756969
     970# Use this tag to change the font size of Latex formulas included
     971# as images in the HTML documentation. The default is 10. Note that
     972# when you change the font size after a successful doxygen run you need
     973# to manually remove any form_*.png images from the HTML output directory
     974# to force them to be regenerated.
     975
     976FORMULA_FONTSIZE       = 10
     977
     978# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
     979# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
     980# there is already a search function so this one should typically
     981# be disabled.
     982
     983SEARCHENGINE           = NO
     984
    757985#---------------------------------------------------------------------------
    758986# configuration options related to the LaTeX output
    759987#---------------------------------------------------------------------------
    760988
    761 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     989# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    762990# generate Latex output.
    763991
    764992GENERATE_LATEX         = YES
    765993
    766 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    767 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     994# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     995# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    768996# put in front of it. If left blank `latex' will be used as the default path.
    769997
    770998LATEX_OUTPUT           = latex
    771999
    772 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
     1000# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    7731001# invoked. If left blank `latex' will be used as the default command name.
    7741002
    7751003LATEX_CMD_NAME         = latex
    7761004
    777 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
    778 # generate index for LaTeX. If left blank `makeindex' will be used as the 
     1005# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     1006# generate index for LaTeX. If left blank `makeindex' will be used as the
    7791007# default command name.
    7801008
    7811009MAKEINDEX_CMD_NAME     = makeindex
    7821010
    783 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    784 # LaTeX documents. This may be useful for small projects and may help to 
     1011# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     1012# LaTeX documents. This may be useful for small projects and may help to
    7851013# save some trees in general.
    7861014
    7871015COMPACT_LATEX          = NO
    7881016
    789 # The PAPER_TYPE tag can be used to set the paper type that is used 
    790 # by the printer. Possible values are: a4, a4wide, letter, legal and 
     1017# The PAPER_TYPE tag can be used to set the paper type that is used
     1018# by the printer. Possible values are: a4, a4wide, letter, legal and
    7911019# executive. If left blank a4wide will be used.
    7921020
    7931021PAPER_TYPE             = a4wide
    7941022
    795 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     1023# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    7961024# packages that should be included in the LaTeX output.
    7971025
    798 EXTRA_PACKAGES         = 
    799 
    800 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    801 # the generated latex document. The header should contain everything until 
    802 # the first chapter. If it is left blank doxygen will generate a 
     1026EXTRA_PACKAGES         =
     1027
     1028# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     1029# the generated latex document. The header should contain everything until
     1030# the first chapter. If it is left blank doxygen will generate a
    8031031# standard header. Notice: only use this tag if you know what you are doing!
    8041032
    805 LATEX_HEADER           = 
    806 
    807 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
    808 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
    809 # contain links (just like the HTML output) instead of page references 
     1033LATEX_HEADER           =
     1034
     1035# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     1036# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     1037# contain links (just like the HTML output) instead of page references
    8101038# This makes the output suitable for online browsing using a pdf viewer.
    8111039
    8121040PDF_HYPERLINKS         = NO
    8131041
    814 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    815 # plain latex in the generated Makefile. Set this option to YES to get a 
     1042# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     1043# plain latex in the generated Makefile. Set this option to YES to get a
    8161044# higher quality PDF documentation.
    8171045
    8181046USE_PDFLATEX           = NO
    8191047
    820 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    821 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    822 # running if errors occur, instead of asking the user for help. 
     1048# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     1049# command to the generated LaTeX files. This will instruct LaTeX to keep
     1050# running if errors occur, instead of asking the user for help.
    8231051# This option is also used when generating formulas in HTML.
    8241052
    8251053LATEX_BATCHMODE        = NO
    8261054
    827 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
    828 # include the index chapters (such as File Index, Compound Index, etc.) 
     1055# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     1056# include the index chapters (such as File Index, Compound Index, etc.)
    8291057# in the output.
    8301058
    8311059LATEX_HIDE_INDICES     = NO
    8321060
     1061# 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.
     1062
     1063LATEX_SOURCE_CODE      = NO
     1064
    8331065#---------------------------------------------------------------------------
    8341066# configuration options related to the RTF output
    8351067#---------------------------------------------------------------------------
    8361068
    837 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    838 # The RTF output is optimized for Word 97 and may not look very pretty with 
     1069# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     1070# The RTF output is optimized for Word 97 and may not look very pretty with
    8391071# other RTF readers or editors.
    8401072
    8411073GENERATE_RTF           = NO
    8421074
    843 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    844 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1075# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     1076# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    8451077# put in front of it. If left blank `rtf' will be used as the default path.
    8461078
    8471079RTF_OUTPUT             = rtf
    8481080
    849 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    850 # RTF documents. This may be useful for small projects and may help to 
     1081# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     1082# RTF documents. This may be useful for small projects and may help to
    8511083# save some trees in general.
    8521084
    8531085COMPACT_RTF            = NO
    8541086
    855 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    856 # will contain hyperlink fields. The RTF file will 
    857 # contain links (just like the HTML output) instead of page references. 
    858 # This makes the output suitable for online browsing using WORD or other 
    859 # programs which support those fields. 
     1087# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     1088# will contain hyperlink fields. The RTF file will
     1089# contain links (just like the HTML output) instead of page references.
     1090# This makes the output suitable for online browsing using WORD or other
     1091# programs which support those fields.
    8601092# Note: wordpad (write) and others do not support links.
    8611093
    8621094RTF_HYPERLINKS         = NO
    8631095
    864 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
    865 # config file, i.e. a series of assignments. You only have to provide 
     1096# Load stylesheet definitions from file. Syntax is similar to doxygen's
     1097# config file, i.e. a series of assignments. You only have to provide
    8661098# replacements, missing definitions are set to their default value.
    8671099
    868 RTF_STYLESHEET_FILE    = 
    869 
    870 # Set optional variables used in the generation of an rtf document. 
     1100RTF_STYLESHEET_FILE    =
     1101
     1102# Set optional variables used in the generation of an rtf document.
    8711103# Syntax is similar to doxygen's config file.
    8721104
    873 RTF_EXTENSIONS_FILE    = 
     1105RTF_EXTENSIONS_FILE    =
    8741106
    8751107#---------------------------------------------------------------------------
     
    8771109#---------------------------------------------------------------------------
    8781110
    879 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     1111# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    8801112# generate man pages
    8811113
    8821114GENERATE_MAN           = NO
    8831115
    884 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
    885 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1116# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     1117# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    8861118# put in front of it. If left blank `man' will be used as the default path.
    8871119
    8881120MAN_OUTPUT             = man
    8891121
    890 # The MAN_EXTENSION tag determines the extension that is added to 
     1122# The MAN_EXTENSION tag determines the extension that is added to
    8911123# the generated man pages (default is the subroutine's section .3)
    8921124
    8931125MAN_EXTENSION          = .3
    8941126
    895 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
    896 # then it will generate one additional man file for each entity 
    897 # documented in the real man page(s). These additional files 
    898 # only source the real man page, but without them the man command 
     1127# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     1128# then it will generate one additional man file for each entity
     1129# documented in the real man page(s). These additional files
     1130# only source the real man page, but without them the man command
    8991131# would be unable to find the correct page. The default is NO.
    9001132
     
    9051137#---------------------------------------------------------------------------
    9061138
    907 # If the GENERATE_XML tag is set to YES Doxygen will 
    908 # generate an XML file that captures the structure of 
     1139# If the GENERATE_XML tag is set to YES Doxygen will
     1140# generate an XML file that captures the structure of
    9091141# the code including all documentation.
    9101142
    9111143GENERATE_XML           = NO
    9121144
    913 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
    914 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1145# The XML_OUTPUT tag is used to specify where the XML pages will be put.
     1146# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    9151147# put in front of it. If left blank `xml' will be used as the default path.
    9161148
    9171149XML_OUTPUT             = xml
    9181150
    919 # The XML_SCHEMA tag can be used to specify an XML schema, 
    920 # which can be used by a validating XML parser to check the 
     1151# The XML_SCHEMA tag can be used to specify an XML schema,
     1152# which can be used by a validating XML parser to check the
    9211153# syntax of the XML files.
    9221154
    923 XML_SCHEMA             = 
    924 
    925 # The XML_DTD tag can be used to specify an XML DTD, 
    926 # which can be used by a validating XML parser to check the 
     1155XML_SCHEMA             =
     1156
     1157# The XML_DTD tag can be used to specify an XML DTD,
     1158# which can be used by a validating XML parser to check the
    9271159# syntax of the XML files.
    9281160
    929 XML_DTD                = 
    930 
    931 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
    932 # dump the program listings (including syntax highlighting 
    933 # and cross-referencing information) to the XML output. Note that 
     1161XML_DTD                =
     1162
     1163# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     1164# dump the program listings (including syntax highlighting
     1165# and cross-referencing information) to the XML output. Note that
    9341166# enabling this will significantly increase the size of the XML output.
    9351167
     
    9401172#---------------------------------------------------------------------------
    9411173
    942 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
    943 # generate an AutoGen Definitions (see autogen.sf.net) file 
    944 # that captures the structure of the code including all 
    945 # documentation. Note that this feature is still experimental 
     1174# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     1175# generate an AutoGen Definitions (see autogen.sf.net) file
     1176# that captures the structure of the code including all
     1177# documentation. Note that this feature is still experimental
    9461178# and incomplete at the moment.
    9471179
     
    9521184#---------------------------------------------------------------------------
    9531185
    954 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
    955 # generate a Perl module file that captures the structure of 
    956 # the code including all documentation. Note that this 
    957 # feature is still experimental and incomplete at the 
     1186# If the GENERATE_PERLMOD tag is set to YES Doxygen will
     1187# generate a Perl module file that captures the structure of
     1188# the code including all documentation. Note that this
     1189# feature is still experimental and incomplete at the
    9581190# moment.
    9591191
    9601192GENERATE_PERLMOD       = NO
    9611193
    962 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
    963 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
     1194# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
     1195# the necessary Makefile rules, Perl scripts and LaTeX code to be able
    9641196# to generate PDF and DVI output from the Perl module output.
    9651197
    9661198PERLMOD_LATEX          = NO
    9671199
    968 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    969 # nicely formatted so it can be parsed by a human reader.  This is useful
    970 # if you want to understand what is going on.  On the other hand, if this
    971 # tag is set to NO the size of the Perl module output will be much smaller
     1200# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
     1201# nicely formatted so it can be parsed by a human reader.
     1202# This is useful
     1203# if you want to understand what is going on.
     1204# On the other hand, if this
     1205# tag is set to NO the size of the Perl module output will be much smaller
    9721206# and Perl will parse it just the same.
    9731207
    9741208PERLMOD_PRETTY         = YES
    9751209
    976 # The names of the make variables in the generated doxyrules.make file 
    977 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
    978 # This is useful so different doxyrules.make files included by the same 
     1210# The names of the make variables in the generated doxyrules.make file
     1211# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
     1212# This is useful so different doxyrules.make files included by the same
    9791213# Makefile don't overwrite each other's variables.
    9801214
    981 PERLMOD_MAKEVAR_PREFIX = 
    982 
    983 #---------------------------------------------------------------------------
    984 # Configuration options related to the preprocessor   
    985 #---------------------------------------------------------------------------
    986 
    987 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
    988 # evaluate all C-preprocessor directives found in the sources and include 
     1215PERLMOD_MAKEVAR_PREFIX =
     1216
     1217#---------------------------------------------------------------------------
     1218# Configuration options related to the preprocessor
     1219#---------------------------------------------------------------------------
     1220
     1221# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     1222# evaluate all C-preprocessor directives found in the sources and include
    9891223# files.
    9901224
    9911225ENABLE_PREPROCESSING   = YES
    9921226
    993 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
    994 # names in the source code. If set to NO (the default) only conditional 
    995 # compilation will be performed. Macro expansion can be done in a controlled 
     1227# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     1228# names in the source code. If set to NO (the default) only conditional
     1229# compilation will be performed. Macro expansion can be done in a controlled
    9961230# way by setting EXPAND_ONLY_PREDEF to YES.
    9971231
    9981232MACRO_EXPANSION        = NO
    9991233
    1000 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
    1001 # then the macro expansion is limited to the macros specified with the 
     1234# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     1235# then the macro expansion is limited to the macros specified with the
    10021236# PREDEFINED and EXPAND_AS_DEFINED tags.
    10031237
    10041238EXPAND_ONLY_PREDEF     = NO
    10051239
    1006 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
     1240# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    10071241# in the INCLUDE_PATH (see below) will be search if a #include is found.
    10081242
    10091243SEARCH_INCLUDES        = YES
    10101244
    1011 # The INCLUDE_PATH tag can be used to specify one or more directories that 
    1012 # contain include files that are not input files but should be processed by 
     1245# The INCLUDE_PATH tag can be used to specify one or more directories that
     1246# contain include files that are not input files but should be processed by
    10131247# the preprocessor.
    10141248
    1015 INCLUDE_PATH           = 
    1016 
    1017 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
    1018 # patterns (like *.h and *.hpp) to filter out the header-files in the 
    1019 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
     1249INCLUDE_PATH           =
     1250
     1251# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1252# patterns (like *.h and *.hpp) to filter out the header-files in the
     1253# directories. If left blank, the patterns specified with FILE_PATTERNS will
    10201254# be used.
    10211255
    1022 INCLUDE_FILE_PATTERNS  = 
    1023 
    1024 # The PREDEFINED tag can be used to specify one or more macro names that 
    1025 # are defined before the preprocessor is started (similar to the -D option of 
    1026 # gcc). The argument of the tag is a list of macros of the form: name 
    1027 # or name=definition (no spaces). If the definition and the = are 
    1028 # omitted =1 is assumed. To prevent a macro definition from being 
    1029 # undefined via #undef or recursively expanded use the := operator 
     1256INCLUDE_FILE_PATTERNS  =
     1257
     1258# The PREDEFINED tag can be used to specify one or more macro names that
     1259# are defined before the preprocessor is started (similar to the -D option of
     1260# gcc). The argument of the tag is a list of macros of the form: name
     1261# or name=definition (no spaces). If the definition and the = are
     1262# omitted =1 is assumed. To prevent a macro definition from being
     1263# undefined via #undef or recursively expanded use the := operator
    10301264# instead of the = operator.
    10311265
    1032 PREDEFINED             = 
    1033 
    1034 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
    1035 # this tag can be used to specify a list of macro names that should be expanded. 
    1036 # The macro definition that is found in the sources will be used. 
     1266PREDEFINED             =
     1267
     1268# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     1269# this tag can be used to specify a list of macro names that should be expanded.
     1270# The macro definition that is found in the sources will be used.
    10371271# Use the PREDEFINED tag if you want to use a different macro definition.
    10381272
    1039 EXPAND_AS_DEFINED      = 
    1040 
    1041 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    1042 # doxygen's preprocessor will remove all function-like macros that are alone 
    1043 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
    1044 # function macros are typically used for boiler-plate code, and will confuse 
     1273EXPAND_AS_DEFINED      =
     1274
     1275# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     1276# doxygen's preprocessor will remove all function-like macros that are alone
     1277# on a line, have an all uppercase name, and do not end with a semicolon. Such
     1278# function macros are typically used for boiler-plate code, and will confuse
    10451279# the parser if not removed.
    10461280
     
    10481282
    10491283#---------------------------------------------------------------------------
    1050 # Configuration::additions related to external references   
    1051 #---------------------------------------------------------------------------
    1052 
    1053 # The TAGFILES option can be used to specify one or more tagfiles.
    1054 # Optionally an initial location of the external documentation
    1055 # can be added for each tagfile. The format of a tag file without
    1056 # this location is as follows:
    1057 #   TAGFILES = file1 file2 ...
    1058 # Adding location for the tag files is done as follows:
    1059 #   TAGFILES = file1=loc1 "file2 = loc2" ...
    1060 # where "loc1" and "loc2" can be relative or absolute paths or
    1061 # URLs. If a location is present for each tag, the installdox tool
     1284# Configuration::additions related to external references
     1285#---------------------------------------------------------------------------
     1286
     1287# The TAGFILES option can be used to specify one or more tagfiles.
     1288# Optionally an initial location of the external documentation
     1289# can be added for each tagfile. The format of a tag file without
     1290# this location is as follows:
     1291#
     1292# TAGFILES = file1 file2 ...
     1293# Adding location for the tag files is done as follows:
     1294#
     1295# TAGFILES = file1=loc1 "file2 = loc2" ...
     1296# where "loc1" and "loc2" can be relative or absolute paths or
     1297# URLs. If a location is present for each tag, the installdox tool
    10621298# does not have to be run to correct the links.
    10631299# Note that each tag file must have a unique name
    10641300# (where the name does NOT include the path)
    1065 # If a tag file is not located in the directory in which doxygen 
     1301# If a tag file is not located in the directory in which doxygen
    10661302# is run, you must also specify the path to the tagfile here.
    10671303
    1068 TAGFILES               = 
    1069 
    1070 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
     1304TAGFILES               =
     1305
     1306# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    10711307# a tag file that is based on the input files it reads.
    10721308
    1073 GENERATE_TAGFILE       = 
    1074 
    1075 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    1076 # in the class index. If set to NO only the inherited external classes 
     1309GENERATE_TAGFILE       =
     1310
     1311# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     1312# in the class index. If set to NO only the inherited external classes
    10771313# will be listed.
    10781314
    10791315ALLEXTERNALS           = NO
    10801316
    1081 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
    1082 # in the modules index. If set to NO, only the current project's groups will 
     1317# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
     1318# in the modules index. If set to NO, only the current project's groups will
    10831319# be listed.
    10841320
    10851321EXTERNAL_GROUPS        = YES
    10861322
    1087 # The PERL_PATH should be the absolute path and name of the perl script 
     1323# The PERL_PATH should be the absolute path and name of the perl script
    10881324# interpreter (i.e. the result of `which perl').
    10891325
     
    10911327
    10921328#---------------------------------------------------------------------------
    1093 # Configuration options related to the dot tool   
    1094 #---------------------------------------------------------------------------
    1095 
    1096 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
    1097 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
    1098 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
    1099 # this option is superseded by the HAVE_DOT option below. This is only a 
    1100 # fallback. It is recommended to install and use dot, since it yields more 
     1329# Configuration options related to the dot tool
     1330#---------------------------------------------------------------------------
     1331
     1332# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     1333# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1334# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1335# this option is superseded by the HAVE_DOT option below. This is only a
     1336# fallback. It is recommended to install and use dot, since it yields more
    11011337# powerful graphs.
    11021338
    11031339CLASS_DIAGRAMS         = YES
    11041340
    1105 # You can define message sequence charts within doxygen comments using the \msc
    1106 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
    1107 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
    1108 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
    1109 # be found in the default search path.
    1110 
    1111 MSCGEN_PATH            =
    1112 
    1113 # If set to YES, the inheritance and collaboration graphs will hide
    1114 # inheritance and usage relations if the target is undocumented
     1341# You can define message sequence charts within doxygen comments using the \msc
     1342# command. Doxygen will then run the mscgen tool (see
     1343# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1344# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1345# the mscgen tool resides. If left empty the tool is assumed to be found in the
     1346# default search path.
     1347
     1348MSCGEN_PATH            =
     1349
     1350# If set to YES, the inheritance and collaboration graphs will hide
     1351# inheritance and usage relations if the target is undocumented
    11151352# or is not a class.
    11161353
    11171354HIDE_UNDOC_RELATIONS   = YES
    11181355
    1119 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
    1120 # available from the path. This tool is part of Graphviz, a graph visualization 
    1121 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
     1356# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     1357# available from the path. This tool is part of Graphviz, a graph visualization
     1358# toolkit from AT&T and Lucent Bell Labs. The other options in this section
    11221359# have no effect if this option is set to NO (the default)
    11231360
    11241361HAVE_DOT               = NO
    11251362
    1126 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    1127 # will generate a graph for each documented class showing the direct and
    1128 # indirect inheritance relations. Setting this tag to YES will force the
     1363# By default doxygen will write a font called FreeSans.ttf to the output
     1364# directory and reference it in all dot files that doxygen generates. This
     1365# font does not include all possible unicode characters however, so when you need
     1366# these (or just want a differently looking font) you can specify the font name
     1367# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
     1368# which can be done by putting it in a standard location or by setting the
     1369# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
     1370# containing the font.
     1371
     1372DOT_FONTNAME           = FreeSans
     1373
     1374# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
     1375# The default size is 10pt.
     1376
     1377DOT_FONTSIZE           = 10
     1378
     1379# By default doxygen will tell dot to use the output directory to look for the
     1380# FreeSans.ttf font (which doxygen will put there itself). If you specify a
     1381# different font using DOT_FONTNAME you can set the path where dot
     1382# can find it using this tag.
     1383
     1384DOT_FONTPATH           =
     1385
     1386# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1387# will generate a graph for each documented class showing the direct and
     1388# indirect inheritance relations. Setting this tag to YES will force the
    11291389# the CLASS_DIAGRAMS tag to NO.
    11301390
    11311391CLASS_GRAPH            = YES
    11321392
    1133 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    1134 # will generate a graph for each documented class showing the direct and 
    1135 # indirect implementation dependencies (inheritance, containment, and 
     1393# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1394# will generate a graph for each documented class showing the direct and
     1395# indirect implementation dependencies (inheritance, containment, and
    11361396# class references variables) of the class with other documented classes.
    11371397
    11381398COLLABORATION_GRAPH    = YES
    11391399
    1140 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
     1400# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    11411401# will generate a graph for groups, showing the direct groups dependencies
    11421402
    11431403GROUP_GRAPHS           = YES
    11441404
    1145 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
    1146 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
     1405# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     1406# collaboration diagrams in a style similar to the OMG's Unified Modeling
    11471407# Language.
    11481408
    11491409UML_LOOK               = NO
    11501410
    1151 # If set to YES, the inheritance and collaboration graphs will show the 
     1411# If set to YES, the inheritance and collaboration graphs will show the
    11521412# relations between templates and their instances.
    11531413
    11541414TEMPLATE_RELATIONS     = NO
    11551415
    1156 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    1157 # tags are set to YES then doxygen will generate a graph for each documented 
    1158 # file showing the direct and indirect include dependencies of the file with 
     1416# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     1417# tags are set to YES then doxygen will generate a graph for each documented
     1418# file showing the direct and indirect include dependencies of the file with
    11591419# other documented files.
    11601420
    11611421INCLUDE_GRAPH          = YES
    11621422
    1163 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    1164 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    1165 # documented header file showing the documented files that directly or 
     1423# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     1424# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     1425# documented header file showing the documented files that directly or
    11661426# indirectly include this file.
    11671427
    11681428INCLUDED_BY_GRAPH      = YES
    11691429
    1170 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
    1171 # generate a call dependency graph for every global function or class method.
    1172 # Note that enabling this option will significantly increase the time of a run.
    1173 # So in most cases it will be better to enable call graphs for selected
    1174 # functions only using the \callgraph command.
     1430# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1431# doxygen will generate a call dependency graph for every global function
     1432# or class method. Note that enabling this option will significantly increase
     1433# the time of a run. So in most cases it will be better to enable call graphs
     1434# for selected functions only using the \callgraph command.
    11751435
    11761436CALL_GRAPH             = NO
    11771437
    1178 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
    1179 # generate a caller dependency graph for every global function or class method.
    1180 # Note that enabling this option will significantly increase the time of a run.
    1181 # So in most cases it will be better to enable caller graphs for selected
    1182 # functions only using the \callergraph command.
     1438# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1439# doxygen will generate a caller dependency graph for every global function
     1440# or class method. Note that enabling this option will significantly increase
     1441# the time of a run. So in most cases it will be better to enable caller
     1442# graphs for selected functions only using the \callergraph command.
    11831443
    11841444CALLER_GRAPH           = NO
    11851445
    1186 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
     1446# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    11871447# will graphical hierarchy of all classes instead of a textual one.
    11881448
    11891449GRAPHICAL_HIERARCHY    = YES
    11901450
    1191 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
    1192 # then doxygen will show the dependencies a directory has on other directories 
     1451# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1452# then doxygen will show the dependencies a directory has on other directories
    11931453# in a graphical way. The dependency relations are determined by the #include
    11941454# relations between the files in the directories.
     
    11961456DIRECTORY_GRAPH        = YES
    11971457
    1198 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
     1458# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    11991459# generated by dot. Possible values are png, jpg, or gif
    12001460# If left blank png will be used.
     
    12021462DOT_IMAGE_FORMAT       = png
    12031463
    1204 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
     1464# The tag DOT_PATH can be used to specify the path where the dot tool can be
    12051465# found. If left blank, it is assumed the dot tool can be found in the path.
    12061466
    1207 DOT_PATH               = 
    1208 
    1209 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
    1210 # contain dot files that are included in the documentation (see the 
     1467DOT_PATH               =
     1468
     1469# The DOTFILE_DIRS tag can be used to specify one or more directories that
     1470# contain dot files that are included in the documentation (see the
    12111471# \dotfile command).
    12121472
    1213 DOTFILE_DIRS           =
    1214 
    1215 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    1216 # nodes that will be shown in the graph. If the number of nodes in a graph
    1217 # becomes larger than this value, doxygen will truncate the graph, which is
    1218 # visualized by representing a node as a red box. Note that doxygen will always
    1219 # show the root nodes and its direct children regardless of this setting.
     1473DOTFILE_DIRS           =
     1474
     1475# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1476# nodes that will be shown in the graph. If the number of nodes in a graph
     1477# becomes larger than this value, doxygen will truncate the graph, which is
     1478# visualized by representing a node as a red box. Note that doxygen if the
     1479# number of direct children of the root node in a graph is already larger than
     1480# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
     1481# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    12201482
    12211483DOT_GRAPH_MAX_NODES    = 50
    12221484
    1223 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    1224 # background. This is disabled by default, which results in a white background.
    1225 # Warning: Depending on the platform used, enabling this option may lead to
    1226 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
    1227 # read).
     1485# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     1486# graphs generated by dot. A depth value of 3 means that only nodes reachable
     1487# from the root by following a path via at most 3 edges will be shown. Nodes
     1488# that lay further from the root node will be omitted. Note that setting this
     1489# option to 1 or 2 may greatly reduce the computation time needed for large
     1490# code bases. Also note that the size of a graph can be further restricted by
     1491# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
     1492
     1493MAX_DOT_GRAPH_DEPTH    = 0
     1494
     1495# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1496# background. This is disabled by default, because dot on Windows does not
     1497# seem to support this out of the box. Warning: Depending on the platform used,
     1498# enabling this option may lead to badly anti-aliased labels on the edges of
     1499# a graph (i.e. they become hard to read).
    12281500
    12291501DOT_TRANSPARENT        = NO
    12301502
    1231 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
    1232 # files in one run (i.e. multiple -o and -T options on the command line). This 
    1233 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
     1503# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1504# files in one run (i.e. multiple -o and -T options on the command line). This
     1505# makes dot run faster, but since only newer versions of dot (>1.8.10)
    12341506# support this, this feature is disabled by default.
    12351507
    12361508DOT_MULTI_TARGETS      = NO
    12371509
    1238 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
    1239 # generate a legend page explaining the meaning of the various boxes and 
     1510# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     1511# generate a legend page explaining the meaning of the various boxes and
    12401512# arrows in the dot generated graphs.
    12411513
    12421514GENERATE_LEGEND        = YES
    12431515
    1244 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    1245 # remove the intermediate dot files that are used to generate 
     1516# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     1517# remove the intermediate dot files that are used to generate
    12461518# the various graphs.
    12471519
    12481520DOT_CLEANUP            = YES
    1249 
    1250 #---------------------------------------------------------------------------
    1251 # Configuration::additions related to the search engine   
    1252 #---------------------------------------------------------------------------
    1253 
    1254 # The SEARCHENGINE tag specifies whether or not a search engine should be
    1255 # used. If set to NO the values of all tags below this one will be ignored.
    1256 
    1257 SEARCHENGINE           = NO
  • rtems-coverage/Makefile

    r65a6eb4 r7a7ddd6  
    143143
    144144clean:
    145         rm -rf $(PROGRAMS) *.o doxy html latex *.exe *~
     145        rm -rf $(PROGRAMS) *.o doxy html latex *.exe *~ warnings.log
    146146
    147147doxygen:
  • rtems-coverage/ReportsBase.h

    r65a6eb4 r7a7ddd6  
    33 */
    44
    5 /*! @file Reports.h
    6  *  @brief Reports Specification
     5/*! @file ReportsBase.h
     6 *  @brief Reports Base Class Specification
    77 *
    88 *  This file contains the specification of the Reports methods.  This
  • rtems-coverage/ReportsHtml.h

    r65a6eb4 r7a7ddd6  
    33 */
    44
    5 /*! @file Reports.h
    6  *  @brief Reports Specification
     5/*! @file ReportsHtml.h
     6 *  @brief Reports in HTML Specification
    77 *
    88 *  This file contains the specification of the Reports methods.  This
  • rtems-coverage/ReportsText.h

    r65a6eb4 r7a7ddd6  
    33 */
    44
    5 /*! @file Reports.h
    6  *  @brief Reports Specification
     5/*! @file ReportsText.h
     6 *  @brief Reports Text Format Write Specification
    77 *
    88 *  This file contains the specification of the Reports methods.  This
  • rtems-coverage/TraceWriterBase.h

    r65a6eb4 r7a7ddd6  
    33 */
    44
    5 /*! @file TraceWiterBase.h
     5/*! @file TraceWriterBase.h
    66 *  @brief TraceWriterBase Specification
    77 *
Note: See TracChangeset for help on using the changeset viewer.