Changeset 452506d in rtems


Ignore:
Timestamp:
Jun 12, 2010, 6:08:39 AM (10 years ago)
Author:
Ralf Corsepius <ralf.corsepius@…>
Branches:
4.11, master
Children:
1965fa42
Parents:
48e77eb9
Message:

Update.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/Doxyfile.in

    r48e77eb9 r452506d  
    1 # Doxyfile 1.3.4
     1# Doxyfile 1.6.2-20100208
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
    17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
     17# This tag specifies the encoding used for all characters in the config file
     18# that follow. The default is UTF-8 which is also the encoding used for all
     19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
     20# iconv built into libc) for the transcoding. See
     21# http://www.gnu.org/software/libiconv for the list of possible encodings.
     22
     23DOXYFILE_ENCODING      = UTF-8
     24
     25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    1826# by quotes) that should identify the project.
    1927
    2028PROJECT_NAME           = "RTEMS CPU Kit with SuperCore"
    2129
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    23 # This could be handy for archiving the generated documentation or 
     30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     31# This could be handy for archiving the generated documentation or
    2432# if some version control system is used.
    2533
    2634PROJECT_NUMBER         = @PACKAGE_VERSION@
    2735
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    29 # base path where the generated documentation will be put. 
    30 # If a relative path is entered, it will be relative to the location 
     36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     37# base path where the generated documentation will be put.
     38# If a relative path is entered, it will be relative to the location
    3139# where doxygen was started. If left blank the current directory will be used.
    3240
    3341OUTPUT_DIRECTORY       = cpukit_doxy
    3442
    35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
    36 # documentation generated by doxygen is written. Doxygen will use this
    37 # information to generate all constant output in the proper language.
    38 # The default language is English, other supported languages are:
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
    41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
    42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
     43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
     44# 4096 sub-directories (in 2 levels) under the output directory of each output
     45# format and will distribute the generated files over these directories.
     46# Enabling this option can be useful when feeding doxygen a huge amount of
     47# source files, where putting all generated files in the same directory would
     48# otherwise cause performance problems for the file system.
     49
     50CREATE_SUBDIRS         = NO
     51
     52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     53# documentation generated by doxygen is written. Doxygen will use this
     54# information to generate all constant output in the proper language.
     55# The default language is English, other supported languages are:
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
     58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
     59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
     60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
     61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
    4362
    4463OUTPUT_LANGUAGE        = English
    4564
    46 # This tag can be used to specify the encoding used in the generated output.
    47 # The encoding is not always determined by the language that is chosen,
    48 # but also whether or not the output is meant for Windows or non-Windows users.
    49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
    50 # forces the Windows encoding (this is the default for the Windows binary),
    51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
    52 # all platforms other than Windows).
    53 
    54 USE_WINDOWS_ENCODING   = NO
    55 
    56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
    57 # include brief member descriptions after the members that are listed in
    58 # the file and class documentation (similar to JavaDoc).
     65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     66# include brief member descriptions after the members that are listed in
     67# the file and class documentation (similar to JavaDoc).
    5968# Set to NO to disable this.
    6069
    6170BRIEF_MEMBER_DESC      = YES
    6271
    63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    64 # the brief description of a member or function before the detailed description. 
    65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     73# the brief description of a member or function before the detailed description.
     74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    6675# brief descriptions will be completely suppressed.
    6776
    6877REPEAT_BRIEF           = YES
    6978
    70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
    71 # Doxygen will generate a detailed section even if there is only a brief
     79# This tag implements a quasi-intelligent brief description abbreviator
     80# that is used to form the text in various listings. Each string
     81# in this list, if found as the leading text of the brief description, will be
     82# stripped from the text and the result after processing the whole list, is
     83# used as the annotated text. Otherwise, the brief description is used as-is.
     84# If left blank, the following values are used ("$name" is automatically
     85# replaced with the name of the entity): "The $name class" "The $name widget"
     86# "The $name file" "is" "provides" "specifies" "contains"
     87# "represents" "a" "an" "the"
     88
     89ABBREVIATE_BRIEF       =
     90
     91# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     92# Doxygen will generate a detailed section even if there is only a brief
    7293# description.
    7394
    7495ALWAYS_DETAILED_SEC    = NO
    7596
    76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
    77 # members of a class in the documentation of that class as if those members were
    78 # ordinary class members. Constructors, destructors and assignment operators of
    79 # the base classes will not be shown.
     97# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
     98# inherited members of a class in the documentation of that class as if those
     99# members were ordinary class members. Constructors, destructors and assignment
     100# operators of the base classes will not be shown.
    80101
    81102INLINE_INHERITED_MEMB  = NO
    82103
    83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    84 # path before files name in the file list and in the header files. If set 
     104# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     105# path before files name in the file list and in the header files. If set
    85106# to NO the shortest path that makes the file name unique will be used.
    86107
    87 FULL_PATH_NAMES        = NO
    88 
    89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
    90 # can be used to strip a user-defined part of the path. Stripping is
    91 # only done if one of the specified strings matches the left-hand part of
    92 # the path. It is allowed to use relative paths in the argument list.
    93 
    94 STRIP_FROM_PATH        =
    95 
    96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    97 # (but less readable) file names. This can be useful is your file systems
     108FULL_PATH_NAMES        = YES
     109
     110# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     111# can be used to strip a user-defined part of the path. Stripping is
     112# only done if one of the specified strings matches the left-hand part of
     113# the path. The tag can be used to show relative paths in the file list.
     114# If left blank the directory from which doxygen is run is used as the
     115# path to strip.
     116
     117STRIP_FROM_PATH        = ../lib/include
     118
     119# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     120# the path mentioned in the documentation of a class, which tells
     121# the reader which header file to include in order to use a class.
     122# If left blank only the name of the header file containing the class
     123# definition is used. Otherwise one should specify the include paths that
     124# are normally passed to the compiler using the -I flag.
     125
     126STRIP_FROM_INC_PATH    =
     127
     128# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     129# (but less readable) file names. This can be useful is your file systems
    98130# doesn't support long names like on DOS, Mac, or CD-ROM.
    99131
    100132SHORT_NAMES            = NO
    101133
    102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    103 # will interpret the first line (until the first dot) of a JavaDoc-style 
    104 # comment as the brief description. If set to NO, the JavaDoc 
    105 # comments will behave just like the Qt-style comments (thus requiring an
    106 # explict @brief command for a brief description.
     134# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     135# will interpret the first line (until the first dot) of a JavaDoc-style
     136# comment as the brief description. If set to NO, the JavaDoc
     137# comments will behave just like regular Qt-style comments
     138# (thus requiring an explicit @brief command for a brief description.)
    107139
    108140JAVADOC_AUTOBRIEF      = YES
    109141
    110 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
    111 # interpret the first line (until the first dot) of a Qt-style 
    112 # comment as the brief description. If set to NO, the comments 
    113 # will behave just like regular Qt-style comments (thus requiring 
     142# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     143# interpret the first line (until the first dot) of a Qt-style
     144# comment as the brief description. If set to NO, the comments
     145# will behave just like regular Qt-style comments (thus requiring
    114146# an explicit \brief command for a brief description.)
    115147
    116148QT_AUTOBRIEF           = YES
    117149
    118 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
    119 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
    120 # comments) as a brief description. This used to be the default behaviour. 
    121 # The new default is to treat a multi-line C++ comment block as a detailed 
     150# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     151# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     152# comments) as a brief description. This used to be the default behaviour.
     153# The new default is to treat a multi-line C++ comment block as a detailed
    122154# description. Set this tag to YES if you prefer the old behaviour instead.
    123155
    124156MULTILINE_CPP_IS_BRIEF = NO
    125157
    126 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
    127 # will output the detailed description near the top, like JavaDoc.
    128 # If set to NO, the detailed description appears after the member
     158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     159# member inherits the documentation from any documented member that it
     160# re-implements.
     161
     162INHERIT_DOCS           = YES
     163
     164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
     165# a new page for each member. If set to NO, the documentation of a member will
     166# be part of the file/class/namespace that contains it.
     167
     168SEPARATE_MEMBER_PAGES  = NO
     169
     170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
     171# Doxygen uses this value to replace tabs by spaces in code fragments.
     172
     173TAB_SIZE               = 8
     174
     175# This tag can be used to specify a number of aliases that acts
     176# as commands in the documentation. An alias has the form "name=value".
     177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
     178# put the command \sideeffect (or @sideeffect) in the documentation, which
     179# will result in a user-defined paragraph with heading "Side Effects:".
     180# You can put \n's in the value part of an alias to insert newlines.
     181
     182ALIASES                =
     183
     184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     185# sources only. Doxygen will then generate output that is more tailored for C.
     186# For instance, some of the names that are used will be different. The list
     187# of all members will be omitted, etc.
     188
     189OPTIMIZE_OUTPUT_FOR_C  = YES
     190
     191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
     192# sources only. Doxygen will then generate output that is more tailored for
     193# Java. For instance, namespaces will be presented as packages, qualified
     194# scopes will look different, etc.
     195
     196OPTIMIZE_OUTPUT_JAVA   = NO
     197
     198# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
     199# sources only. Doxygen will then generate output that is more tailored for
     200# Fortran.
     201
     202OPTIMIZE_FOR_FORTRAN   = NO
     203
     204# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
     205# sources. Doxygen will then generate output that is tailored for
     206# VHDL.
     207
     208OPTIMIZE_OUTPUT_VHDL   = NO
     209
     210# Doxygen selects the parser to use depending on the extension of the files it parses.
     211# With this tag you can assign which parser to use for a given extension.
     212# Doxygen has a built-in mapping, but you can override or extend it using this tag.
     213# The format is ext=language, where ext is a file extension, and language is one of
     214# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
     215# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
     216# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
     217# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     218
     219EXTENSION_MAPPING      =
     220
     221# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     222# to include (a tag file for) the STL sources as input, then you should
     223# set this tag to YES in order to let doxygen match functions declarations and
     224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
     225# func(std::string) {}). This also make the inheritance and collaboration
     226# diagrams that involve STL classes more complete and accurate.
     227
     228BUILTIN_STL_SUPPORT    = NO
     229
     230# If you use Microsoft's C++/CLI language, you should set this option to YES to
     231# enable parsing support.
     232
     233CPP_CLI_SUPPORT        = NO
     234
     235# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     236# Doxygen will parse them like normal C++ but will assume all classes use public
     237# instead of private inheritance when no explicit protection keyword is present.
     238
     239SIP_SUPPORT            = NO
     240
     241# For Microsoft's IDL there are propget and propput attributes to indicate getter
     242# and setter methods for a property. Setting this option to YES (the default)
     243# will make doxygen to replace the get and set methods by a property in the
     244# documentation. This will only work if the methods are indeed getting or
     245# setting a simple type. If this is not the case, or you want to show the
     246# methods anyway, you should set this option to NO.
     247
     248IDL_PROPERTY_SUPPORT   = YES
     249
     250# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     251# tag is set to YES, then doxygen will reuse the documentation of the first
     252# member in the group (if any) for the other members of the group. By default
     253# all members of a group must be documented explicitly.
     254
     255DISTRIBUTE_GROUP_DOC   = NO
     256
     257# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
     258# the same type (for instance a group of public functions) to be put as a
     259# subgroup of that type (e.g. under the Public Functions section). Set it to
     260# NO to prevent subgrouping. Alternatively, this can be done per class using
     261# the \nosubgrouping command.
     262
     263SUBGROUPING            = YES
     264
     265# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     266# is documented as struct, union, or enum with the name of the typedef. So
     267# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
     268# with name TypeT. When disabled the typedef will appear as a member of a file,
     269# namespace, or class. And the struct will be named TypeS. This can typically
     270# be useful for C code in case the coding convention dictates that all compound
     271# types are typedef'ed and only the typedef is referenced, never the tag name.
     272
     273TYPEDEF_HIDES_STRUCT   = NO
     274
     275# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
     276# determine which symbols to keep in memory and which to flush to disk.
     277# When the cache is full, less often used symbols will be written to disk.
     278# For small to medium size projects (<1000 input files) the default value is
     279# probably good enough. For larger projects a too small cache size can cause
     280# doxygen to be busy swapping symbols to and from disk most of the time
     281# causing a significant performance penality.
     282# If the system has enough physical memory increasing the cache will improve the
     283# performance by keeping more symbols in memory. Note that the value works on
     284# a logarithmic scale so increasing the size by one will rougly double the
     285# memory usage. The cache size is given by this formula:
     286# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
     287# corresponding to a cache size of 2^16 = 65536 symbols
     288
     289SYMBOL_CACHE_SIZE      = 0
     290
     291#---------------------------------------------------------------------------
     292# Build related configuration options
     293#---------------------------------------------------------------------------
     294
     295# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     296# documentation are documented, even if no documentation was available.
     297# Private class members and static file members will be hidden unless
     298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
     299
     300EXTRACT_ALL            = NO
     301
     302# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
     303# will be included in the documentation.
     304
     305EXTRACT_PRIVATE        = NO
     306
     307# If the EXTRACT_STATIC tag is set to YES all static members of a file
     308# will be included in the documentation.
     309
     310EXTRACT_STATIC         = NO
     311
     312# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     313# defined locally in source files will be included in the documentation.
     314# If set to NO only classes defined in header files are included.
     315
     316EXTRACT_LOCAL_CLASSES  = YES
     317
     318# This flag is only useful for Objective-C code. When set to YES local
     319# methods, which are defined in the implementation section but not in
     320# the interface are included in the documentation.
     321# If set to NO (the default) only methods in the interface are included.
     322
     323EXTRACT_LOCAL_METHODS  = NO
     324
     325# If this flag is set to YES, the members of anonymous namespaces will be
     326# extracted and appear in the documentation as a namespace called
     327# 'anonymous_namespace{file}', where file will be replaced with the base
     328# name of the file that contains the anonymous namespace. By default
     329# anonymous namespace are hidden.
     330
     331EXTRACT_ANON_NSPACES   = NO
     332
     333# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     334# undocumented members of documented classes, files or namespaces.
     335# If set to NO (the default) these members will be included in the
     336# various overviews, but no documentation section is generated.
     337# This option has no effect if EXTRACT_ALL is enabled.
     338
     339HIDE_UNDOC_MEMBERS     = NO
     340
     341# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     342# undocumented classes that are normally visible in the class hierarchy.
     343# If set to NO (the default) these classes will be included in the various
     344# overviews. This option has no effect if EXTRACT_ALL is enabled.
     345
     346HIDE_UNDOC_CLASSES     = NO
     347
     348# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     349# friend (class|struct|union) declarations.
     350# If set to NO (the default) these declarations will be included in the
    129351# documentation.
    130352
    131 DETAILS_AT_TOP         = NO
    132 
    133 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
    134 # member inherits the documentation from any documented member that it
    135 # reimplements.
    136 
    137 INHERIT_DOCS           = YES
    138 
    139 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    140 # tag is set to YES, then doxygen will reuse the documentation of the first
    141 # member in the group (if any) for the other members of the group. By default
    142 # all members of a group must be documented explicitly.
    143 
    144 DISTRIBUTE_GROUP_DOC   = NO
    145 
    146 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
    147 # Doxygen uses this value to replace tabs by spaces in code fragments.
    148 
    149 TAB_SIZE               = 8
    150 
    151 # This tag can be used to specify a number of aliases that acts
    152 # as commands in the documentation. An alias has the form "name=value".
    153 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
    154 # put the command \sideeffect (or @sideeffect) in the documentation, which
    155 # will result in a user-defined paragraph with heading "Side Effects:".
    156 # You can put \n's in the value part of an alias to insert newlines.
    157 
    158 ALIASES                =
    159 
    160 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
    161 # only. Doxygen will then generate output that is more tailored for C.
    162 # For instance, some of the names that are used will be different. The list
    163 # of all members will be omitted, etc.
    164 
    165 OPTIMIZE_OUTPUT_FOR_C  = YES
    166 
    167 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
    168 # only. Doxygen will then generate output that is more tailored for Java.
    169 # For instance, namespaces will be presented as packages, qualified scopes
    170 # will look different, etc.
    171 
    172 OPTIMIZE_OUTPUT_JAVA   = NO
    173 
    174 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    175 # the same type (for instance a group of public functions) to be put as a
    176 # subgroup of that type (e.g. under the Public Functions section). Set it to
    177 # NO to prevent subgrouping. Alternatively, this can be done per class using
    178 # the \nosubgrouping command.
    179 
    180 SUBGROUPING            = YES
    181 
    182 #---------------------------------------------------------------------------
    183 # Build related configuration options
    184 #---------------------------------------------------------------------------
    185 
    186 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
    187 # documentation are documented, even if no documentation was available.
    188 # Private class members and static file members will be hidden unless
    189 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    190 
    191 EXTRACT_ALL            = NO
    192 
    193 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    194 # will be included in the documentation.
    195 
    196 EXTRACT_PRIVATE        = NO
    197 
    198 # If the EXTRACT_STATIC tag is set to YES all static members of a file
    199 # will be included in the documentation.
    200 
    201 EXTRACT_STATIC         = NO
    202 
    203 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
    204 # defined locally in source files will be included in the documentation.
    205 # If set to NO only classes defined in header files are included.
    206 
    207 EXTRACT_LOCAL_CLASSES  = YES
    208 
    209 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
    210 # undocumented members of documented classes, files or namespaces.
    211 # If set to NO (the default) these members will be included in the
    212 # various overviews, but no documentation section is generated.
    213 # This option has no effect if EXTRACT_ALL is enabled.
    214 
    215 HIDE_UNDOC_MEMBERS     = NO
    216 
    217 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
    218 # undocumented classes that are normally visible in the class hierarchy.
    219 # If set to NO (the default) these classes will be included in the various
    220 # overviews. This option has no effect if EXTRACT_ALL is enabled.
    221 
    222 HIDE_UNDOC_CLASSES     = NO
    223 
    224 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
    225 # friend (class|struct|union) declarations.
    226 # If set to NO (the default) these declarations will be included in the
     353HIDE_FRIEND_COMPOUNDS  = NO
     354
     355# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
     356# documentation blocks found inside the body of a function.
     357# If set to NO (the default) these blocks will be appended to the
     358# function's detailed documentation block.
     359
     360HIDE_IN_BODY_DOCS      = NO
     361
     362# The INTERNAL_DOCS tag determines if documentation
     363# that is typed after a \internal command is included. If the tag is set
     364# to NO (the default) then the documentation will be excluded.
     365# Set it to YES to include the internal documentation.
     366
     367INTERNAL_DOCS          = NO
     368
     369# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
     370# file names in lower-case letters. If set to YES upper-case letters are also
     371# allowed. This is useful if you have classes or files whose names only differ
     372# in case and if your file system supports case sensitive file names. Windows
     373# and Mac users are advised to set this option to NO.
     374
     375CASE_SENSE_NAMES       = YES
     376
     377# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     378# will show members with their full class and namespace scopes in the
     379# documentation. If set to YES the scope will be hidden.
     380
     381HIDE_SCOPE_NAMES       = NO
     382
     383# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
     384# will put a list of the files that are included by a file in the documentation
     385# of that file.
     386
     387SHOW_INCLUDE_FILES     = YES
     388
     389# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
     390# will list include files with double quotes in the documentation
     391# rather than with sharp brackets.
     392
     393FORCE_LOCAL_INCLUDES   = NO
     394
     395# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     396# is inserted in the documentation for inline members.
     397
     398INLINE_INFO            = YES
     399
     400# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
     401# will sort the (detailed) documentation of file and class members
     402# alphabetically by member name. If set to NO the members will appear in
     403# declaration order.
     404
     405SORT_MEMBER_DOCS       = YES
     406
     407# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     408# brief documentation of file, namespace and class members alphabetically
     409# by member name. If set to NO (the default) the members will appear in
     410# declaration order.
     411
     412SORT_BRIEF_DOCS        = NO
     413
     414# 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.
     415
     416SORT_MEMBERS_CTORS_1ST = NO
     417
     418# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
     419# hierarchy of group names into alphabetical order. If set to NO (the default)
     420# the group names will appear in their defined order.
     421
     422SORT_GROUP_NAMES       = NO
     423
     424# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
     425# sorted by fully-qualified names, including namespaces. If set to
     426# NO (the default), the class list will be sorted only by class name,
     427# not including the namespace part.
     428# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
     429# Note: This option applies only to the class list, not to the
     430# alphabetical list.
     431
     432SORT_BY_SCOPE_NAME     = NO
     433
     434# The GENERATE_TODOLIST tag can be used to enable (YES) or
     435# disable (NO) the todo list. This list is created by putting \todo
     436# commands in the documentation.
     437
     438GENERATE_TODOLIST      = YES
     439
     440# The GENERATE_TESTLIST tag can be used to enable (YES) or
     441# disable (NO) the test list. This list is created by putting \test
     442# commands in the documentation.
     443
     444GENERATE_TESTLIST      = YES
     445
     446# The GENERATE_BUGLIST tag can be used to enable (YES) or
     447# disable (NO) the bug list. This list is created by putting \bug
     448# commands in the documentation.
     449
     450GENERATE_BUGLIST       = YES
     451
     452# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
     453# disable (NO) the deprecated list. This list is created by putting
     454# \deprecated commands in the documentation.
     455
     456GENERATE_DEPRECATEDLIST= YES
     457
     458# The ENABLED_SECTIONS tag can be used to enable conditional
     459# documentation sections, marked by \if sectionname ... \endif.
     460
     461ENABLED_SECTIONS       =
     462
     463# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
     464# the initial value of a variable or define consists of for it to appear in
     465# the documentation. If the initializer consists of more lines than specified
     466# here it will be hidden. Use a value of 0 to hide initializers completely.
     467# The appearance of the initializer of individual variables and defines in the
     468# documentation can be controlled using \showinitializer or \hideinitializer
     469# command in the documentation regardless of this setting.
     470
     471MAX_INITIALIZER_LINES  = 30
     472
     473# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
     474# at the bottom of the documentation of classes and structs. If set to YES the
     475# list will mention the files that were used to generate the documentation.
     476
     477SHOW_USED_FILES        = YES
     478
     479# If the sources in your project are distributed over multiple directories
     480# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
     481# in the documentation. The default is NO.
     482
     483SHOW_DIRECTORIES       = NO
     484
     485# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
     486# This will remove the Files entry from the Quick Index and from the
     487# Folder Tree View (if specified). The default is YES.
     488
     489SHOW_FILES             = YES
     490
     491# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
     492# Namespaces page.
     493# This will remove the Namespaces entry from the Quick Index
     494# and from the Folder Tree View (if specified). The default is YES.
     495
     496SHOW_NAMESPACES        = YES
     497
     498# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     499# doxygen should invoke to get the current version for each file (typically from
     500# the version control system). Doxygen will invoke the program by executing (via
     501# popen()) the command <command> <input-file>, where <command> is the value of
     502# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
     503# provided by doxygen. Whatever the program writes to standard output
     504# is used as the file version. See the manual for examples.
     505
     506FILE_VERSION_FILTER    =
     507
     508# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
     509# doxygen. The layout file controls the global structure of the generated output files
     510# in an output format independent way. The create the layout file that represents
     511# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
     512# file name after the option, if omitted DoxygenLayout.xml will be used as the name
     513# of the layout file.
     514
     515LAYOUT_FILE            =
     516
     517#---------------------------------------------------------------------------
     518# configuration options related to warning and progress messages
     519#---------------------------------------------------------------------------
     520
     521# The QUIET tag can be used to turn on/off the messages that are generated
     522# by doxygen. Possible values are YES and NO. If left blank NO is used.
     523
     524QUIET                  = NO
     525
     526# The WARNINGS tag can be used to turn on/off the warning messages that are
     527# generated by doxygen. Possible values are YES and NO. If left blank
     528# NO is used.
     529
     530WARNINGS               = YES
     531
     532# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
     533# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
     534# automatically be disabled.
     535
     536WARN_IF_UNDOCUMENTED   = YES
     537
     538# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
     539# potential errors in the documentation, such as not documenting some
     540# parameters in a documented function, or documenting parameters that
     541# don't exist or using markup commands wrongly.
     542
     543WARN_IF_DOC_ERROR      = YES
     544
     545# This WARN_NO_PARAMDOC option can be abled to get warnings for
     546# functions that are documented, but have no documentation for their parameters
     547# or return value. If set to NO (the default) doxygen will only warn about
     548# wrong or incomplete parameter documentation, but not about the absence of
    227549# documentation.
    228550
    229 HIDE_FRIEND_COMPOUNDS  = NO
    230 
    231 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
    232 # documentation blocks found inside the body of a function.
    233 # If set to NO (the default) these blocks will be appended to the
    234 # function's detailed documentation block.
    235 
    236 HIDE_IN_BODY_DOCS      = NO
    237 
    238 # The INTERNAL_DOCS tag determines if documentation
    239 # that is typed after a \internal command is included. If the tag is set
    240 # to NO (the default) then the documentation will be excluded.
    241 # Set it to YES to include the internal documentation.
    242 
    243 INTERNAL_DOCS          = NO
    244 
    245 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
    246 # file names in lower-case letters. If set to YES upper-case letters are also
    247 # allowed. This is useful if you have classes or files whose names only differ
    248 # in case and if your file system supports case sensitive file names. Windows
    249 # users are advised to set this option to NO.
    250 
    251 CASE_SENSE_NAMES       = YES
    252 
    253 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
    254 # will show members with their full class and namespace scopes in the
    255 # documentation. If set to YES the scope will be hidden.
    256 
    257 HIDE_SCOPE_NAMES       = NO
    258 
    259 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
    260 # will put a list of the files that are included by a file in the documentation
    261 # of that file.
    262 
    263 SHOW_INCLUDE_FILES     = YES
    264 
    265 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
    266 # is inserted in the documentation for inline members.
    267 
    268 INLINE_INFO            = YES
    269 
    270 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
    271 # will sort the (detailed) documentation of file and class members
    272 # alphabetically by member name. If set to NO the members will appear in
    273 # declaration order.
    274 
    275 SORT_MEMBER_DOCS       = YES
    276 
    277 # The GENERATE_TODOLIST tag can be used to enable (YES) or
    278 # disable (NO) the todo list. This list is created by putting \todo
    279 # commands in the documentation.
    280 
    281 GENERATE_TODOLIST      = YES
    282 
    283 # The GENERATE_TESTLIST tag can be used to enable (YES) or
    284 # disable (NO) the test list. This list is created by putting \test
    285 # commands in the documentation.
    286 
    287 GENERATE_TESTLIST      = YES
    288 
    289 # The GENERATE_BUGLIST tag can be used to enable (YES) or
    290 # disable (NO) the bug list. This list is created by putting \bug
    291 # commands in the documentation.
    292 
    293 GENERATE_BUGLIST       = YES
    294 
    295 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
    296 # disable (NO) the deprecated list. This list is created by putting
    297 # \deprecated commands in the documentation.
    298 
    299 GENERATE_DEPRECATEDLIST= YES
    300 
    301 # The ENABLED_SECTIONS tag can be used to enable conditional
    302 # documentation sections, marked by \if sectionname ... \endif.
    303 
    304 ENABLED_SECTIONS       =
    305 
    306 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    307 # the initial value of a variable or define consists of for it to appear in
    308 # the documentation. If the initializer consists of more lines than specified
    309 # here it will be hidden. Use a value of 0 to hide initializers completely.
    310 # The appearance of the initializer of individual variables and defines in the
    311 # documentation can be controlled using \showinitializer or \hideinitializer
    312 # command in the documentation regardless of this setting.
    313 
    314 MAX_INITIALIZER_LINES  = 30
    315 
    316 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
    317 # at the bottom of the documentation of classes and structs. If set to YES the
    318 # list will mention the files that were used to generate the documentation.
    319 
    320 SHOW_USED_FILES        = YES
    321 
    322 #---------------------------------------------------------------------------
    323 # configuration options related to warning and progress messages
    324 #---------------------------------------------------------------------------
    325 
    326 # The QUIET tag can be used to turn on/off the messages that are generated
    327 # by doxygen. Possible values are YES and NO. If left blank NO is used.
    328 
    329 QUIET                  = NO
    330 
    331 # The WARNINGS tag can be used to turn on/off the warning messages that are
    332 # generated by doxygen. Possible values are YES and NO. If left blank
    333 # NO is used.
    334 
    335 WARNINGS               = YES
    336 
    337 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
    338 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
    339 # automatically be disabled.
    340 
    341 WARN_IF_UNDOCUMENTED   = YES
    342 
    343 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
    344 # potential errors in the documentation, such as not documenting some
    345 # parameters in a documented function, or documenting parameters that
    346 # don't exist or using markup commands wrongly.
    347 
    348 WARN_IF_DOC_ERROR      = YES
    349 
    350 # The WARN_FORMAT tag determines the format of the warning messages that
    351 # doxygen can produce. The string should contain the $file, $line, and $text
    352 # tags, which will be replaced by the file and line number from which the
    353 # warning originated and the warning text.
     551WARN_NO_PARAMDOC       = NO
     552
     553# The WARN_FORMAT tag determines the format of the warning messages that
     554# doxygen can produce. The string should contain the $file, $line, and $text
     555# tags, which will be replaced by the file and line number from which the
     556# warning originated and the warning text. Optionally the format may contain
     557# $version, which will be replaced by the version of the file (if it could
     558# be obtained via FILE_VERSION_FILTER)
    354559
    355560WARN_FORMAT            = "$file:$line: $text"
    356561
    357 # The WARN_LOGFILE tag can be used to specify a file to which warning 
    358 # and error messages should be written. If left blank the output is written 
     562# The WARN_LOGFILE tag can be used to specify a file to which warning
     563# and error messages should be written. If left blank the output is written
    359564# to stderr.
    360565
    361 WARN_LOGFILE           = 
     566WARN_LOGFILE           =
    362567
    363568#---------------------------------------------------------------------------
     
    365570#---------------------------------------------------------------------------
    366571
    367 # The INPUT tag can be used to specify the files and/or directories that contain 
    368 # documented source files. You may enter file names like "myfile.cpp" or 
    369 # directories like "/usr/src/myproject". Separate the files or directories 
     572# The INPUT tag can be used to specify the files and/or directories that contain
     573# documented source files. You may enter file names like "myfile.cpp" or
     574# directories like "/usr/src/myproject". Separate the files or directories
    370575# with spaces.
    371576
    372577INPUT                  = ../lib/include
    373578
    374 # If the value of the INPUT tag contains directories, you can use the
    375 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
    376 # and *.h) to filter out the source-files in the directories. If left
    377 # blank the following patterns are tested:
    378 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
    379 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
    380 
    381 FILE_PATTERNS          = *.h *.inl
    382 
    383 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
    384 # should be searched for input files as well. Possible values are YES and NO.
     579# This tag can be used to specify the character encoding of the source files
     580# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
     581# also the default input encoding. Doxygen uses libiconv (or the iconv built
     582# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
     583# the list of possible encodings.
     584
     585INPUT_ENCODING         = UTF-8
     586
     587# If the value of the INPUT tag contains directories, you can use the
     588# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     589# and *.h) to filter out the source-files in the directories. If left
     590# blank the following patterns are tested:
     591# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
     592# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     593
     594FILE_PATTERNS          = *.h \
     595                         *.inl
     596
     597# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     598# should be searched for input files as well. Possible values are YES and NO.
    385599# If left blank NO is used.
    386600
    387601RECURSIVE              = YES
    388602
    389 # The EXCLUDE tag can be used to specify files and/or directories that should 
    390 # excluded from the INPUT source files. This way you can easily exclude a 
     603# The EXCLUDE tag can be used to specify files and/or directories that should
     604# excluded from the INPUT source files. This way you can easily exclude a
    391605# subdirectory from a directory tree whose root is specified with the INPUT tag.
    392606
    393607EXCLUDE                = score/mainpage.h
    394608
    395 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
    396 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
     609# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     610# directories that are symbolic links (a Unix filesystem feature) are excluded
     611# from the input.
    397612
    398613EXCLUDE_SYMLINKS       = NO
    399614
    400 # If the value of the INPUT tag contains directories, you can use the
    401 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
    402 # certain files from those directories.
    403 
    404 EXCLUDE_PATTERNS       =
    405 
    406 # The EXAMPLE_PATH tag can be used to specify one or more files or
    407 # directories that contain example code fragments that are included (see
     615# If the value of the INPUT tag contains directories, you can use the
     616# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
     617# certain files from those directories. Note that the wildcards are matched
     618# against the file with absolute path, so to exclude all test directories
     619# for example use the pattern */test/*
     620
     621EXCLUDE_PATTERNS       =
     622
     623# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     624# (namespaces, classes, functions, etc.) that should be excluded from the
     625# output. The symbol name can be a fully qualified name, a word, or if the
     626# wildcard * is used, a substring. Examples: ANamespace, AClass,
     627# AClass::ANamespace, ANamespace::*Test
     628
     629EXCLUDE_SYMBOLS        =
     630
     631# The EXAMPLE_PATH tag can be used to specify one or more files or
     632# directories that contain example code fragments that are included (see
    408633# the \include command).
    409634
    410 EXAMPLE_PATH           = 
    411 
    412 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
    413 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    414 # and *.h) to filter out the source-files in the directories. If left 
     635EXAMPLE_PATH           =
     636
     637# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     638# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     639# and *.h) to filter out the source-files in the directories. If left
    415640# blank all files are included.
    416641
    417 EXAMPLE_PATTERNS       = 
    418 
    419 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
    420 # searched for input files to be used with the \include or \dontinclude 
    421 # commands irrespective of the value of the RECURSIVE tag. 
     642EXAMPLE_PATTERNS       =
     643
     644# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
     645# searched for input files to be used with the \include or \dontinclude
     646# commands irrespective of the value of the RECURSIVE tag.
    422647# Possible values are YES and NO. If left blank NO is used.
    423648
    424649EXAMPLE_RECURSIVE      = NO
    425650
    426 # The IMAGE_PATH tag can be used to specify one or more files or 
    427 # directories that contain image that are included in the documentation (see 
     651# The IMAGE_PATH tag can be used to specify one or more files or
     652# directories that contain image that are included in the documentation (see
    428653# the \image command).
    429654
    430 IMAGE_PATH             = 
    431 
    432 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
    433 # invoke to filter for each input file. Doxygen will invoke the filter program 
    434 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
    435 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
    436 # input file. Doxygen will then use the output that the filter program writes 
     655IMAGE_PATH             =
     656
     657# The INPUT_FILTER tag can be used to specify a program that doxygen should
     658# invoke to filter for each input file. Doxygen will invoke the filter program
     659# by executing (via popen()) the command <filter> <input-file>, where <filter>
     660# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
     661# input file. Doxygen will then use the output that the filter program writes
    437662# to standard output.
    438 
    439 INPUT_FILTER           =
    440 
    441 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
    442 # INPUT_FILTER) will be used to filter the input files when producing source
     663# If FILTER_PATTERNS is specified, this tag will be
     664# ignored.
     665
     666INPUT_FILTER           = @top_srcdir@/doxy-filter
     667
     668# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
     669# basis.
     670# Doxygen will compare the file name with each pattern and apply the
     671# filter if there is a match.
     672# The filters are a list of the form:
     673# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
     674# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
     675# is applied to all files.
     676
     677FILTER_PATTERNS        =
     678
     679# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
     680# INPUT_FILTER) will be used to filter the input files when producing source
    443681# files to browse (i.e. when SOURCE_BROWSER is set to YES).
    444682
     
    449687#---------------------------------------------------------------------------
    450688
    451 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
     689# If the SOURCE_BROWSER tag is set to YES then a list of source files will
    452690# be generated. Documented entities will be cross-referenced with these sources.
     691# Note: To get rid of all source code in the generated output, make sure also
     692# VERBATIM_HEADERS is set to NO.
    453693
    454694SOURCE_BROWSER         = NO
    455695
    456 # Setting the INLINE_SOURCES tag to YES will include the body 
     696# Setting the INLINE_SOURCES tag to YES will include the body
    457697# of functions and classes directly in the documentation.
    458698
    459699INLINE_SOURCES         = NO
    460700
    461 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
    462 # doxygen to hide any special comment blocks from generated source code 
     701# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
     702# doxygen to hide any special comment blocks from generated source code
    463703# fragments. Normal C and C++ comments will always remain visible.
    464704
    465705STRIP_CODE_COMMENTS    = YES
    466706
    467 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
    468 # then for each documented function all documented 
     707# If the REFERENCED_BY_RELATION tag is set to YES
     708# then for each documented function all documented
    469709# functions referencing it will be listed.
    470710
    471711REFERENCED_BY_RELATION = YES
    472712
    473 # If the REFERENCES_RELATION tag is set to YES (the default)
    474 # then for each documented function all documented entities 
     713# If the REFERENCES_RELATION tag is set to YES
     714# then for each documented function all documented entities
    475715# called/used by that function will be listed.
    476716
    477717REFERENCES_RELATION    = YES
    478718
    479 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
    480 # will generate a verbatim copy of the header file for each class for
     719# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     720# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     721# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     722# link to the source code.
     723# Otherwise they will link to the documentation.
     724
     725REFERENCES_LINK_SOURCE = YES
     726
     727# If the USE_HTAGS tag is set to YES then the references to source code
     728# will point to the HTML generated by the htags(1) tool instead of doxygen
     729# built-in source browser. The htags tool is part of GNU's global source
     730# tagging system (see http://www.gnu.org/software/global/global.html). You
     731# will need version 4.8.6 or higher.
     732
     733USE_HTAGS              = NO
     734
     735# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
     736# will generate a verbatim copy of the header file for each class for
    481737# which an include is specified. Set to NO to disable this.
    482738
     
    487743#---------------------------------------------------------------------------
    488744
    489 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
    490 # of all compounds will be generated. Enable this if the project 
     745# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
     746# of all compounds will be generated. Enable this if the project
    491747# contains a lot of classes, structs, unions or interfaces.
    492748
    493749ALPHABETICAL_INDEX     = NO
    494750
    495 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
    496 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
     751# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
     752# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
    497753# in which this list will be split (can be a number in the range [1..20])
    498754
    499755COLS_IN_ALPHA_INDEX    = 5
    500756
    501 # In case all classes in a project start with a common prefix, all 
    502 # classes will be put under the same header in the alphabetical index. 
    503 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
     757# In case all classes in a project start with a common prefix, all
     758# classes will be put under the same header in the alphabetical index.
     759# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
    504760# should be ignored while generating the index headers.
    505761
    506 IGNORE_PREFIX          = 
     762IGNORE_PREFIX          =
    507763
    508764#---------------------------------------------------------------------------
     
    510766#---------------------------------------------------------------------------
    511767
    512 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
     768# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
    513769# generate HTML output.
    514770
    515771GENERATE_HTML          = YES
    516772
    517 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
    518 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     773# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
     774# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    519775# put in front of it. If left blank `html' will be used as the default path.
    520776
    521777HTML_OUTPUT            = html
    522778
    523 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
    524 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
     779# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
     780# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
    525781# doxygen will generate files with .html extension.
    526782
    527783HTML_FILE_EXTENSION    = .html
    528784
    529 # The HTML_HEADER tag can be used to specify a personal HTML header for 
    530 # each generated HTML page. If it is left blank doxygen will generate a 
     785# The HTML_HEADER tag can be used to specify a personal HTML header for
     786# each generated HTML page. If it is left blank doxygen will generate a
    531787# standard header.
    532788
    533 HTML_HEADER            = 
    534 
    535 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
    536 # each generated HTML page. If it is left blank doxygen will generate a 
     789HTML_HEADER            =
     790
     791# The HTML_FOOTER tag can be used to specify a personal HTML footer for
     792# each generated HTML page. If it is left blank doxygen will generate a
    537793# standard footer.
    538794
    539 HTML_FOOTER            =
    540 
    541 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    542 # style sheet that is used by each HTML page. It can be used to
    543 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    544 # will generate a default style sheet
    545 
    546 HTML_STYLESHEET        =
    547 
    548 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    549 # files or namespaces will be aligned in HTML using tables. If set to
     795HTML_FOOTER            =
     796
     797# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
     798# documentation will contain the timesstamp.
     799
     800HTML_TIMESTAMP         = NO
     801
     802# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
     803# style sheet that is used by each HTML page. It can be used to
     804# fine-tune the look of the HTML output. If the tag is left blank doxygen
     805# will generate a default style sheet. Note that doxygen will try to copy
     806# the style sheet file to the HTML output directory, so don't put your own
     807# stylesheet in the HTML output directory as well, or it will be erased!
     808
     809HTML_STYLESHEET        =
     810
     811# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
     812# page will contain the date and time when the page was generated. Setting
     813# this to NO can help when comparing the output of multiple runs.
     814
     815HTML_TIMESTAMP         = NO
     816
     817# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
     818# files or namespaces will be aligned in HTML using tables. If set to
    550819# NO a bullet list will be used.
    551820
    552821HTML_ALIGN_MEMBERS     = YES
    553822
    554 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    555 # will be generated that can be used as input for tools like the
    556 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
     823# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     824# documentation will contain sections that can be hidden and shown after the
     825# page has loaded. For this to work a browser that supports
     826# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     827# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     828
     829HTML_DYNAMIC_SECTIONS  = NO
     830
     831# If the GENERATE_DOCSET tag is set to YES, additional index files
     832# will be generated that can be used as input for Apple's Xcode 3
     833# integrated development environment, introduced with OSX 10.5 (Leopard).
     834# To create a documentation set, doxygen will generate a Makefile in the
     835# HTML output directory. Running make will produce the docset in that
     836# directory and running "make install" will install the docset in
     837# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
     838# it at startup.
     839# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     840
     841GENERATE_DOCSET        = NO
     842
     843# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
     844# feed. A documentation feed provides an umbrella under which multiple
     845# documentation sets from a single provider (such as a company or product suite)
     846# can be grouped.
     847
     848DOCSET_FEEDNAME        = "Doxygen generated docs"
     849
     850# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
     851# should uniquely identify the documentation set bundle. This should be a
     852# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
     853# will append .docset to the name.
     854
     855DOCSET_BUNDLE_ID       = org.doxygen.Project
     856
     857# If the GENERATE_HTMLHELP tag is set to YES, additional index files
     858# will be generated that can be used as input for tools like the
     859# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    557860# of the generated HTML documentation.
    558861
    559862GENERATE_HTMLHELP      = NO
    560863
    561 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
    562 # be used to specify the file name of the resulting .chm file. You 
    563 # can add a path in front of the file if the result should not be 
    564 # written to the html output dir.
    565 
    566 CHM_FILE               = 
    567 
    568 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
    569 # be used to specify the location (absolute path including file name) of 
    570 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
     864# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
     865# be used to specify the file name of the resulting .chm file. You
     866# can add a path in front of the file if the result should not be
     867# written to the html output directory.
     868
     869CHM_FILE               =
     870
     871# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
     872# be used to specify the location (absolute path including file name) of
     873# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    571874# the HTML help compiler on the generated index.hhp.
    572875
    573 HHC_LOCATION           = 
    574 
    575 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
    576 # controls if a separate .chi index file is generated (YES) or that 
     876HHC_LOCATION           =
     877
     878# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
     879# controls if a separate .chi index file is generated (YES) or that
    577880# it should be included in the master .chm file (NO).
    578881
    579882GENERATE_CHI           = NO
    580883
    581 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    582 # controls whether a binary table of contents is generated (YES) or a
     884# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
     885# is used to encode HtmlHelp index (hhk), content (hhc) and project file
     886# content.
     887
     888CHM_INDEX_ENCODING     =
     889
     890# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
     891# controls whether a binary table of contents is generated (YES) or a
    583892# normal table of contents (NO) in the .chm file.
    584893
    585894BINARY_TOC             = NO
    586895
    587 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
     896# The TOC_EXPAND flag can be set to YES to add extra items for group members
    588897# to the contents of the HTML help documentation and to the tree view.
    589898
    590899TOC_EXPAND             = NO
    591900
    592 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    593 # top of each HTML page. The value NO (the default) enables the index and
     901# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
     902# are set, an additional index file will be generated that can be used as input for
     903# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
     904# HTML documentation.
     905
     906GENERATE_QHP           = NO
     907
     908# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
     909# be used to specify the file name of the resulting .qch file.
     910# The path specified is relative to the HTML output folder.
     911
     912QCH_FILE               =
     913
     914# The QHP_NAMESPACE tag specifies the namespace to use when generating
     915# Qt Help Project output. For more information please see
     916# http://doc.trolltech.com/qthelpproject.html#namespace
     917
     918QHP_NAMESPACE          = org.doxygen.Project
     919
     920# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
     921# Qt Help Project output. For more information please see
     922# http://doc.trolltech.com/qthelpproject.html#virtual-folders
     923
     924QHP_VIRTUAL_FOLDER     = doc
     925
     926# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
     927# For more information please see
     928# http://doc.trolltech.com/qthelpproject.html#custom-filters
     929
     930QHP_CUST_FILTER_NAME   =
     931
     932# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
     933# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     934
     935QHP_CUST_FILTER_ATTRS  =
     936
     937# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     938# filter section matches.
     939# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     940
     941QHP_SECT_FILTER_ATTRS  =
     942
     943# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
     944# be used to specify the location of Qt's qhelpgenerator.
     945# If non-empty doxygen will try to run qhelpgenerator on the generated
     946# .qhp file.
     947
     948QHG_LOCATION           =
     949
     950# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
     951#  will be generated, which together with the HTML files, form an Eclipse help
     952#  plugin. To install this plugin and make it available under the help contents
     953# menu in Eclipse, the contents of the directory containing the HTML and XML
     954# files needs to be copied into the plugins directory of eclipse. The name of
     955# the directory within the plugins directory should be the same as
     956# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
     957
     958GENERATE_ECLIPSEHELP   = NO
     959
     960# A unique identifier for the eclipse help plugin. When installing the plugin
     961# the directory name containing the HTML and XML files should also have
     962# this name.
     963
     964ECLIPSE_DOC_ID         = org.doxygen.Project
     965
     966# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
     967# top of each HTML page. The value NO (the default) enables the index and
    594968# the value YES disables it.
    595969
    596970DISABLE_INDEX          = NO
    597971
    598 # This tag can be used to set the number of enum values (range [1..20]) 
     972# This tag can be used to set the number of enum values (range [1..20])
    599973# that doxygen will group on one line in the generated HTML documentation.
    600974
    601975ENUM_VALUES_PER_LINE   = 4
    602976
    603 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
    604 # generated containing a tree-like index structure (just like the one that
    605 # is generated for HTML Help). For this to work a browser that supports
    606 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
    607 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
    608 # probably better off using the HTML help feature.
     977# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     978# structure should be generated to display hierarchical information.
     979# If the tag value is set to YES, a side panel will be generated
     980# containing a tree-like index structure (just like the one that
     981# is generated for HTML Help). For this to work a browser that supports
     982# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
     983# Windows users are probably better off using the HTML help feature.
    609984
    610985GENERATE_TREEVIEW      = NO
    611986
    612 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    613 # used to set the initial width (in pixels) of the frame in which the tree
     987# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
     988# and Class Hierarchy pages using a tree view instead of an ordered list.
     989
     990USE_INLINE_TREES       = NO
     991
     992# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     993# used to set the initial width (in pixels) of the frame in which the tree
    614994# is shown.
    615995
    616996TREEVIEW_WIDTH         = 250
    617997
     998# Use this tag to change the font size of Latex formulas included
     999# as images in the HTML documentation. The default is 10. Note that
     1000# when you change the font size after a successful doxygen run you need
     1001# to manually remove any form_*.png images from the HTML output directory
     1002# to force them to be regenerated.
     1003
     1004FORMULA_FONTSIZE       = 10
     1005
     1006# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
     1007# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
     1008# typically be disabled. For large projects the javascript based search engine
     1009# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
     1010
     1011SEARCHENGINE           = NO
     1012
     1013# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
     1014# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
     1015# and does not have live searching capabilities.
     1016
     1017SERVER_BASED_SEARCH    = NO
     1018
    6181019#---------------------------------------------------------------------------
    6191020# configuration options related to the LaTeX output
    6201021#---------------------------------------------------------------------------
    6211022
    622 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
     1023# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    6231024# generate Latex output.
    6241025
    6251026GENERATE_LATEX         = YES
    6261027
    627 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
    628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1028# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     1029# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    6291030# put in front of it. If left blank `latex' will be used as the default path.
    6301031
    6311032LATEX_OUTPUT           = latex
    6321033
    633 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
     1034# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    6341035# invoked. If left blank `latex' will be used as the default command name.
     1036# Note that when enabling USE_PDFLATEX this option is only used for
     1037# generating bitmaps for formulas in the HTML output, but not in the
     1038# Makefile that is written to the output directory.
    6351039
    6361040LATEX_CMD_NAME         = latex
    6371041
    638 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
    639 # generate index for LaTeX. If left blank `makeindex' will be used as the 
     1042# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
     1043# generate index for LaTeX. If left blank `makeindex' will be used as the
    6401044# default command name.
    6411045
    6421046MAKEINDEX_CMD_NAME     = makeindex
    6431047
    644 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
    645 # LaTeX documents. This may be useful for small projects and may help to 
     1048# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
     1049# LaTeX documents. This may be useful for small projects and may help to
    6461050# save some trees in general.
    6471051
    6481052COMPACT_LATEX          = NO
    6491053
    650 # The PAPER_TYPE tag can be used to set the paper type that is used 
    651 # by the printer. Possible values are: a4, a4wide, letter, legal and 
     1054# The PAPER_TYPE tag can be used to set the paper type that is used
     1055# by the printer. Possible values are: a4, a4wide, letter, legal and
    6521056# executive. If left blank a4wide will be used.
    6531057
    6541058PAPER_TYPE             = a4wide
    6551059
    656 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
     1060# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    6571061# packages that should be included in the LaTeX output.
    6581062
    659 EXTRA_PACKAGES         = 
    660 
    661 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
    662 # the generated latex document. The header should contain everything until 
    663 # the first chapter. If it is left blank doxygen will generate a 
     1063EXTRA_PACKAGES         =
     1064
     1065# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
     1066# the generated latex document. The header should contain everything until
     1067# the first chapter. If it is left blank doxygen will generate a
    6641068# standard header. Notice: only use this tag if you know what you are doing!
    6651069
    666 LATEX_HEADER           = 
    667 
    668 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
    669 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
    670 # contain links (just like the HTML output) instead of page references 
     1070LATEX_HEADER           =
     1071
     1072# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     1073# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     1074# contain links (just like the HTML output) instead of page references
    6711075# This makes the output suitable for online browsing using a pdf viewer.
    6721076
    6731077PDF_HYPERLINKS         = NO
    6741078
    675 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
    676 # plain latex in the generated Makefile. Set this option to YES to get a 
     1079# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     1080# plain latex in the generated Makefile. Set this option to YES to get a
    6771081# higher quality PDF documentation.
    6781082
    6791083USE_PDFLATEX           = NO
    6801084
    681 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
    682 # command to the generated LaTeX files. This will instruct LaTeX to keep 
    683 # running if errors occur, instead of asking the user for help. 
     1085# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     1086# command to the generated LaTeX files. This will instruct LaTeX to keep
     1087# running if errors occur, instead of asking the user for help.
    6841088# This option is also used when generating formulas in HTML.
    6851089
    6861090LATEX_BATCHMODE        = NO
    6871091
    688 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
    689 # include the index chapters (such as File Index, Compound Index, etc.) 
     1092# If LATEX_HIDE_INDICES is set to YES then doxygen will not
     1093# include the index chapters (such as File Index, Compound Index, etc.)
    6901094# in the output.
    6911095
    6921096LATEX_HIDE_INDICES     = NO
    6931097
     1098# 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.
     1099
     1100LATEX_SOURCE_CODE      = NO
     1101
    6941102#---------------------------------------------------------------------------
    6951103# configuration options related to the RTF output
    6961104#---------------------------------------------------------------------------
    6971105
    698 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
    699 # The RTF output is optimised for Word 97 and may not look very pretty with
     1106# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
     1107# The RTF output is optimized for Word 97 and may not look very pretty with
    7001108# other RTF readers or editors.
    7011109
    7021110GENERATE_RTF           = NO
    7031111
    704 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
    705 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1112# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
     1113# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    7061114# put in front of it. If left blank `rtf' will be used as the default path.
    7071115
    7081116RTF_OUTPUT             = rtf
    7091117
    710 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
    711 # RTF documents. This may be useful for small projects and may help to 
     1118# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
     1119# RTF documents. This may be useful for small projects and may help to
    7121120# save some trees in general.
    7131121
    7141122COMPACT_RTF            = NO
    7151123
    716 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
    717 # will contain hyperlink fields. The RTF file will 
    718 # contain links (just like the HTML output) instead of page references. 
    719 # This makes the output suitable for online browsing using WORD or other 
    720 # programs which support those fields. 
     1124# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
     1125# will contain hyperlink fields. The RTF file will
     1126# contain links (just like the HTML output) instead of page references.
     1127# This makes the output suitable for online browsing using WORD or other
     1128# programs which support those fields.
    7211129# Note: wordpad (write) and others do not support links.
    7221130
    7231131RTF_HYPERLINKS         = NO
    7241132
    725 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
    726 # config file, i.e. a series of assigments. You only have to provide
     1133# Load stylesheet definitions from file. Syntax is similar to doxygen's
     1134# config file, i.e. a series of assignments. You only have to provide
    7271135# replacements, missing definitions are set to their default value.
    7281136
    729 RTF_STYLESHEET_FILE    = 
    730 
    731 # Set optional variables used in the generation of an rtf document. 
     1137RTF_STYLESHEET_FILE    =
     1138
     1139# Set optional variables used in the generation of an rtf document.
    7321140# Syntax is similar to doxygen's config file.
    7331141
    734 RTF_EXTENSIONS_FILE    = 
     1142RTF_EXTENSIONS_FILE    =
    7351143
    7361144#---------------------------------------------------------------------------
     
    7381146#---------------------------------------------------------------------------
    7391147
    740 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
     1148# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    7411149# generate man pages
    7421150
    7431151GENERATE_MAN           = NO
    7441152
    745 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
    746 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
     1153# The MAN_OUTPUT tag is used to specify where the man pages will be put.
     1154# If a relative path is entered the value of OUTPUT_DIRECTORY will be
    7471155# put in front of it. If left blank `man' will be used as the default path.
    7481156
    7491157MAN_OUTPUT             = man
    7501158
    751 # The MAN_EXTENSION tag determines the extension that is added to 
     1159# The MAN_EXTENSION tag determines the extension that is added to
    7521160# the generated man pages (default is the subroutine's section .3)
    7531161
    7541162MAN_EXTENSION          = .3
    7551163
    756 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
    757 # then it will generate one additional man file for each entity 
    758 # documented in the real man page(s). These additional files 
    759 # only source the real man page, but without them the man command 
     1164# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
     1165# then it will generate one additional man file for each entity
     1166# documented in the real man page(s). These additional files
     1167# only source the real man page, but without them the man command
    7601168# would be unable to find the correct page. The default is NO.
    7611169
     
    7661174#---------------------------------------------------------------------------
    7671175
    768 # If the GENERATE_XML tag is set to YES Doxygen will
    769 # generate an XML file that captures the structure of
    770 # the code including all documentation. Note that this
    771 # feature is still experimental and incomplete at the
     1176# If the GENERATE_XML tag is set to YES Doxygen will
     1177# generate an XML file that captures the structure of
     1178# the code including all documentation.
     1179
     1180GENERATE_XML           = NO
     1181
     1182# The XML_OUTPUT tag is used to specify where the XML pages will be put.
     1183# If a relative path is entered the value of OUTPUT_DIRECTORY will be
     1184# put in front of it. If left blank `xml' will be used as the default path.
     1185
     1186XML_OUTPUT             = xml
     1187
     1188# The XML_SCHEMA tag can be used to specify an XML schema,
     1189# which can be used by a validating XML parser to check the
     1190# syntax of the XML files.
     1191
     1192XML_SCHEMA             =
     1193
     1194# The XML_DTD tag can be used to specify an XML DTD,
     1195# which can be used by a validating XML parser to check the
     1196# syntax of the XML files.
     1197
     1198XML_DTD                =
     1199
     1200# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
     1201# dump the program listings (including syntax highlighting
     1202# and cross-referencing information) to the XML output. Note that
     1203# enabling this will significantly increase the size of the XML output.
     1204
     1205XML_PROGRAMLISTING     = YES
     1206
     1207#---------------------------------------------------------------------------
     1208# configuration options for the AutoGen Definitions output
     1209#---------------------------------------------------------------------------
     1210
     1211# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
     1212# generate an AutoGen Definitions (see autogen.sf.net) file
     1213# that captures the structure of the code including all
     1214# documentation. Note that this feature is still experimental
     1215# and incomplete at the moment.
     1216
     1217GENERATE_AUTOGEN_DEF   = NO
     1218
     1219#---------------------------------------------------------------------------
     1220# configuration options related to the Perl module output
     1221#---------------------------------------------------------------------------
     1222
     1223# If the GENERATE_PERLMOD tag is set to YES Doxygen will
     1224# generate a Perl module file that captures the structure of
     1225# the code including all documentation. Note that this
     1226# feature is still experimental and incomplete at the
    7721227# moment.
    7731228
    774 GENERATE_XML           = NO
    775 
    776 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    777 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    778 # put in front of it. If left blank `xml' will be used as the default path.
    779 
    780 XML_OUTPUT             = xml
    781 
    782 # The XML_SCHEMA tag can be used to specify an XML schema,
    783 # which can be used by a validating XML parser to check the
    784 # syntax of the XML files.
    785 
    786 XML_SCHEMA             =
    787 
    788 # The XML_DTD tag can be used to specify an XML DTD,
    789 # which can be used by a validating XML parser to check the
    790 # syntax of the XML files.
    791 
    792 XML_DTD                =
    793 
    794 #---------------------------------------------------------------------------
    795 # configuration options for the AutoGen Definitions output
    796 #---------------------------------------------------------------------------
    797 
    798 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    799 # generate an AutoGen Definitions (see autogen.sf.net) file
    800 # that captures the structure of the code including all
    801 # documentation. Note that this feature is still experimental
    802 # and incomplete at the moment.
    803 
    804 GENERATE_AUTOGEN_DEF   = NO
    805 
    806 #---------------------------------------------------------------------------
    807 # configuration options related to the Perl module output
    808 #---------------------------------------------------------------------------
    809 
    810 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    811 # generate a Perl module file that captures the structure of
    812 # the code including all documentation. Note that this
    813 # feature is still experimental and incomplete at the
    814 # moment.
    815 
    8161229GENERATE_PERLMOD       = NO
    8171230
    818 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
    819 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
     1231# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
     1232# the necessary Makefile rules, Perl scripts and LaTeX code to be able
    8201233# to generate PDF and DVI output from the Perl module output.
    8211234
    8221235PERLMOD_LATEX          = NO
    8231236
    824 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    825 # nicely formatted so it can be parsed by a human reader.  This is useful
    826 # if you want to understand what is going on.  On the other hand, if this
    827 # tag is set to NO the size of the Perl module output will be much smaller
     1237# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
     1238# nicely formatted so it can be parsed by a human reader.
     1239# This is useful
     1240# if you want to understand what is going on.
     1241# On the other hand, if this
     1242# tag is set to NO the size of the Perl module output will be much smaller
    8281243# and Perl will parse it just the same.
    8291244
    8301245PERLMOD_PRETTY         = YES
    8311246
    832 # The names of the make variables in the generated doxyrules.make file 
    833 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
    834 # This is useful so different doxyrules.make files included by the same 
     1247# The names of the make variables in the generated doxyrules.make file
     1248# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
     1249# This is useful so different doxyrules.make files included by the same
    8351250# Makefile don't overwrite each other's variables.
    8361251
    837 PERLMOD_MAKEVAR_PREFIX = 
    838 
    839 #---------------------------------------------------------------------------
    840 # Configuration options related to the preprocessor   
    841 #---------------------------------------------------------------------------
    842 
    843 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
    844 # evaluate all C-preprocessor directives found in the sources and include 
     1252PERLMOD_MAKEVAR_PREFIX =
     1253
     1254#---------------------------------------------------------------------------
     1255# Configuration options related to the preprocessor
     1256#---------------------------------------------------------------------------
     1257
     1258# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
     1259# evaluate all C-preprocessor directives found in the sources and include
    8451260# files.
    8461261
    8471262ENABLE_PREPROCESSING   = YES
    8481263
    849 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
    850 # names in the source code. If set to NO (the default) only conditional 
    851 # compilation will be performed. Macro expansion can be done in a controlled 
     1264# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
     1265# names in the source code. If set to NO (the default) only conditional
     1266# compilation will be performed. Macro expansion can be done in a controlled
    8521267# way by setting EXPAND_ONLY_PREDEF to YES.
    8531268
    8541269MACRO_EXPANSION        = NO
    8551270
    856 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
    857 # then the macro expansion is limited to the macros specified with the 
    858 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
     1271# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
     1272# then the macro expansion is limited to the macros specified with the
     1273# PREDEFINED and EXPAND_AS_DEFINED tags.
    8591274
    8601275EXPAND_ONLY_PREDEF     = NO
    8611276
    862 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
     1277# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    8631278# in the INCLUDE_PATH (see below) will be search if a #include is found.
    8641279
    8651280SEARCH_INCLUDES        = YES
    8661281
    867 # The INCLUDE_PATH tag can be used to specify one or more directories that 
    868 # contain include files that are not input files but should be processed by 
     1282# The INCLUDE_PATH tag can be used to specify one or more directories that
     1283# contain include files that are not input files but should be processed by
    8691284# the preprocessor.
    8701285
    871 INCLUDE_PATH           = 
    872 
    873 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
    874 # patterns (like *.h and *.hpp) to filter out the header-files in the 
    875 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
     1286INCLUDE_PATH           =
     1287
     1288# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
     1289# patterns (like *.h and *.hpp) to filter out the header-files in the
     1290# directories. If left blank, the patterns specified with FILE_PATTERNS will
    8761291# be used.
    8771292
    878 INCLUDE_FILE_PATTERNS  =
    879 
    880 # The PREDEFINED tag can be used to specify one or more macro names that
    881 # are defined before the preprocessor is started (similar to the -D option of
    882 # gcc). The argument of the tag is a list of macros of the form: name
    883 # or name=definition (no spaces). If the definition and the = are
    884 # omitted =1 is assumed.
     1293INCLUDE_FILE_PATTERNS  =
     1294
     1295# The PREDEFINED tag can be used to specify one or more macro names that
     1296# are defined before the preprocessor is started (similar to the -D option of
     1297# gcc). The argument of the tag is a list of macros of the form: name
     1298# or name=definition (no spaces). If the definition and the = are
     1299# omitted =1 is assumed. To prevent a macro definition from being
     1300# undefined via #undef or recursively expanded use the := operator
     1301# instead of the = operator.
    8851302
    8861303PREDEFINED             = FALSE=0 \
    887    CPU_USE_GENERIC_BITFIELD_DATA=0 \
    888    __attribute__(x)= \
    889    RTEMS_COMPILER_NO_RETURN_ATTRIBUTE= \
    890    RTEMS_COMPILER_DEPRECATED_ATTRIBUTE=
    891 
    892 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
    893 # this tag can be used to specify a list of macro names that should be expanded. 
    894 # The macro definition that is found in the sources will be used. 
     1304                         CPU_USE_GENERIC_BITFIELD_DATA=0 \
     1305                         __attribute__(x)= \
     1306                         RTEMS_COMPILER_NO_RETURN_ATTRIBUTE= \
     1307                         RTEMS_COMPILER_DEPRECATED_ATTRIBUTE=
     1308
     1309# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
     1310# this tag can be used to specify a list of macro names that should be expanded.
     1311# The macro definition that is found in the sources will be used.
    8951312# Use the PREDEFINED tag if you want to use a different macro definition.
    8961313
    897 EXPAND_AS_DEFINED      = 
    898 
    899 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
    900 # doxygen's preprocessor will remove all function-like macros that are alone 
    901 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
    902 # function macros are typically used for boiler-plate code, and will confuse the
    903 # parser if not removed.
     1314EXPAND_AS_DEFINED      =
     1315
     1316# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
     1317# doxygen's preprocessor will remove all function-like macros that are alone
     1318# on a line, have an all uppercase name, and do not end with a semicolon. Such
     1319# function macros are typically used for boiler-plate code, and will confuse
     1320# the parser if not removed.
    9041321
    9051322SKIP_FUNCTION_MACROS   = YES
    9061323
    9071324#---------------------------------------------------------------------------
    908 # Configuration::addtions related to external references   
    909 #---------------------------------------------------------------------------
    910 
    911 # The TAGFILES option can be used to specify one or more tagfiles.
    912 # Optionally an initial location of the external documentation
    913 # can be added for each tagfile. The format of a tag file without
    914 # this location is as follows:
    915 #   TAGFILES = file1 file2 ...
    916 # Adding location for the tag files is done as follows:
    917 #   TAGFILES = file1=loc1 "file2 = loc2" ...
    918 # where "loc1" and "loc2" can be relative or absolute paths or
    919 # URLs. If a location is present for each tag, the installdox tool
     1325# Configuration::additions related to external references
     1326#---------------------------------------------------------------------------
     1327
     1328# The TAGFILES option can be used to specify one or more tagfiles.
     1329# Optionally an initial location of the external documentation
     1330# can be added for each tagfile. The format of a tag file without
     1331# this location is as follows:
     1332#
     1333# TAGFILES = file1 file2 ...
     1334# Adding location for the tag files is done as follows:
     1335#
     1336# TAGFILES = file1=loc1 "file2 = loc2" ...
     1337# where "loc1" and "loc2" can be relative or absolute paths or
     1338# URLs. If a location is present for each tag, the installdox tool
    9201339# does not have to be run to correct the links.
    9211340# Note that each tag file must have a unique name
    9221341# (where the name does NOT include the path)
    923 # If a tag file is not located in the directory in which doxygen 
     1342# If a tag file is not located in the directory in which doxygen
    9241343# is run, you must also specify the path to the tagfile here.
    9251344
    926 TAGFILES               = 
    927 
    928 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
     1345TAGFILES               =
     1346
     1347# When a file name is specified after GENERATE_TAGFILE, doxygen will create
    9291348# a tag file that is based on the input files it reads.
    9301349
    931 GENERATE_TAGFILE       = 
    932 
    933 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
    934 # in the class index. If set to NO only the inherited external classes 
     1350GENERATE_TAGFILE       =
     1351
     1352# If the ALLEXTERNALS tag is set to YES all external classes will be listed
     1353# in the class index. If set to NO only the inherited external classes
    9351354# will be listed.
    9361355
    9371356ALLEXTERNALS           = NO
    9381357
    939 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
    940 # in the modules index. If set to NO, only the current project's groups will 
     1358# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
     1359# in the modules index. If set to NO, only the current project's groups will
    9411360# be listed.
    9421361
    9431362EXTERNAL_GROUPS        = YES
    9441363
    945 # The PERL_PATH should be the absolute path and name of the perl script 
     1364# The PERL_PATH should be the absolute path and name of the perl script
    9461365# interpreter (i.e. the result of `which perl').
    9471366
     
    9491368
    9501369#---------------------------------------------------------------------------
    951 # Configuration options related to the dot tool   
    952 #---------------------------------------------------------------------------
    953 
    954 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    955 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
    956 # super classes. Setting the tag to NO turns the diagrams off. Note that this
    957 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
    958 # recommended to install and use dot, since it yields more powerful graphs.
     1370# Configuration options related to the dot tool
     1371#---------------------------------------------------------------------------
     1372
     1373# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
     1374# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
     1375# or super classes. Setting the tag to NO turns the diagrams off. Note that
     1376# this option is superseded by the HAVE_DOT option below. This is only a
     1377# fallback. It is recommended to install and use dot, since it yields more
     1378# powerful graphs.
    9591379
    9601380CLASS_DIAGRAMS         = YES
    9611381
    962 # If set to YES, the inheritance and collaboration graphs will hide
    963 # inheritance and usage relations if the target is undocumented
     1382# You can define message sequence charts within doxygen comments using the \msc
     1383# command. Doxygen will then run the mscgen tool (see
     1384# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
     1385# documentation. The MSCGEN_PATH tag allows you to specify the directory where
     1386# the mscgen tool resides. If left empty the tool is assumed to be found in the
     1387# default search path.
     1388
     1389MSCGEN_PATH            =
     1390
     1391# If set to YES, the inheritance and collaboration graphs will hide
     1392# inheritance and usage relations if the target is undocumented
    9641393# or is not a class.
    9651394
    9661395HIDE_UNDOC_RELATIONS   = YES
    9671396
    968 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
    969 # available from the path. This tool is part of Graphviz, a graph visualization 
    970 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
     1397# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
     1398# available from the path. This tool is part of Graphviz, a graph visualization
     1399# toolkit from AT&T and Lucent Bell Labs. The other options in this section
    9711400# have no effect if this option is set to NO (the default)
    9721401
    9731402HAVE_DOT               = YES
    9741403
    975 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    976 # will generate a graph for each documented class showing the direct and
    977 # indirect inheritance relations. Setting this tag to YES will force the
     1404# By default doxygen will write a font called FreeSans.ttf to the output
     1405# directory and reference it in all dot files that doxygen generates. This
     1406# font does not include all possible unicode characters however, so when you need
     1407# these (or just want a differently looking font) you can specify the font name
     1408# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
     1409# which can be done by putting it in a standard location or by setting the
     1410# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
     1411# containing the font.
     1412
     1413DOT_FONTNAME           = FreeSans
     1414
     1415# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
     1416# The default size is 10pt.
     1417
     1418DOT_FONTSIZE           = 10
     1419
     1420# By default doxygen will tell dot to use the output directory to look for the
     1421# FreeSans.ttf font (which doxygen will put there itself). If you specify a
     1422# different font using DOT_FONTNAME you can set the path where dot
     1423# can find it using this tag.
     1424
     1425DOT_FONTPATH           =
     1426
     1427# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1428# will generate a graph for each documented class showing the direct and
     1429# indirect inheritance relations. Setting this tag to YES will force the
    9781430# the CLASS_DIAGRAMS tag to NO.
    9791431
    9801432CLASS_GRAPH            = YES
    9811433
    982 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
    983 # will generate a graph for each documented class showing the direct and 
    984 # indirect implementation dependencies (inheritance, containment, and 
     1434# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
     1435# will generate a graph for each documented class showing the direct and
     1436# indirect implementation dependencies (inheritance, containment, and
    9851437# class references variables) of the class with other documented classes.
    9861438
    9871439COLLABORATION_GRAPH    = YES
    9881440
    989 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    990 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
     1441# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
     1442# will generate a graph for groups, showing the direct groups dependencies
     1443
     1444GROUP_GRAPHS           = YES
     1445
     1446# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
     1447# collaboration diagrams in a style similar to the OMG's Unified Modeling
    9911448# Language.
    9921449
    9931450UML_LOOK               = NO
    9941451
    995 # If set to YES, the inheritance and collaboration graphs will show the 
     1452# If set to YES, the inheritance and collaboration graphs will show the
    9961453# relations between templates and their instances.
    9971454
    9981455TEMPLATE_RELATIONS     = NO
    9991456
    1000 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
    1001 # tags are set to YES then doxygen will generate a graph for each documented 
    1002 # file showing the direct and indirect include dependencies of the file with 
     1457# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
     1458# tags are set to YES then doxygen will generate a graph for each documented
     1459# file showing the direct and indirect include dependencies of the file with
    10031460# other documented files.
    10041461
    10051462INCLUDE_GRAPH          = NO
    10061463
    1007 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
    1008 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
    1009 # documented header file showing the documented files that directly or 
     1464# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
     1465# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
     1466# documented header file showing the documented files that directly or
    10101467# indirectly include this file.
    10111468
    10121469INCLUDED_BY_GRAPH      = NO
    10131470
    1014 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
    1015 # generate a call dependency graph for every global function or class method.
    1016 # Note that enabling this option will significantly increase the time of a run.
    1017 # So in most cases it will be better to enable call graphs for selected
    1018 # functions only using the \callgraph command.
     1471# If the CALL_GRAPH and HAVE_DOT options are set to YES then
     1472# doxygen will generate a call dependency graph for every global function
     1473# or class method. Note that enabling this option will significantly increase
     1474# the time of a run. So in most cases it will be better to enable call graphs
     1475# for selected functions only using the \callgraph command.
    10191476
    10201477CALL_GRAPH             = NO
    10211478
    1022 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
     1479# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
     1480# doxygen will generate a caller dependency graph for every global function
     1481# or class method. Note that enabling this option will significantly increase
     1482# the time of a run. So in most cases it will be better to enable caller
     1483# graphs for selected functions only using the \callergraph command.
     1484
     1485CALLER_GRAPH           = NO
     1486
     1487# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    10231488# will graphical hierarchy of all classes instead of a textual one.
    10241489
    10251490GRAPHICAL_HIERARCHY    = YES
    10261491
    1027 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
     1492# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1493# then doxygen will show the dependencies a directory has on other directories
     1494# in a graphical way. The dependency relations are determined by the #include
     1495# relations between the files in the directories.
     1496
     1497DIRECTORY_GRAPH        = YES
     1498
     1499# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    10281500# generated by dot. Possible values are png, jpg, or gif
    10291501# If left blank png will be used.
     
    10311503DOT_IMAGE_FORMAT       = png
    10321504
    1033 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
    1034 # found. If left blank, it is assumed the dot tool can be found on the path.
    1035 
    1036 DOT_PATH               = 
    1037 
    1038 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
    1039 # contain dot files that are included in the documentation (see the 
     1505# The tag DOT_PATH can be used to specify the path where the dot tool can be
     1506# found. If left blank, it is assumed the dot tool can be found in the path.
     1507
     1508DOT_PATH               =
     1509
     1510# The DOTFILE_DIRS tag can be used to specify one or more directories that
     1511# contain dot files that are included in the documentation (see the
    10401512# \dotfile command).
    10411513
    1042 DOTFILE_DIRS           =
    1043 
    1044 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
    1045 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1046 # this value, doxygen will try to truncate the graph, so that it fits within
    1047 # the specified constraint. Beware that most browsers cannot cope with very
    1048 # large images.
    1049 
    1050 MAX_DOT_GRAPH_WIDTH    = 1024
    1051 
    1052 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
    1053 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1054 # this value, doxygen will try to truncate the graph, so that it fits within
    1055 # the specified constraint. Beware that most browsers cannot cope with very
    1056 # large images.
    1057 
    1058 MAX_DOT_GRAPH_HEIGHT   = 1024
    1059 
    1060 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    1061 # graphs generated by dot. A depth value of 3 means that only nodes reachable
    1062 # from the root by following a path via at most 3 edges will be shown. Nodes that
    1063 # lay further from the root node will be omitted. Note that setting this option to
    1064 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
    1065 # note that a graph may be further truncated if the graph's image dimensions are
    1066 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
    1067 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
     1514DOTFILE_DIRS           =
     1515
     1516# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1517# nodes that will be shown in the graph. If the number of nodes in a graph
     1518# becomes larger than this value, doxygen will truncate the graph, which is
     1519# visualized by representing a node as a red box. Note that doxygen if the
     1520# number of direct children of the root node in a graph is already larger than
     1521# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
     1522# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     1523
     1524DOT_GRAPH_MAX_NODES    = 50
     1525
     1526# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     1527# graphs generated by dot. A depth value of 3 means that only nodes reachable
     1528# from the root by following a path via at most 3 edges will be shown. Nodes
     1529# that lay further from the root node will be omitted. Note that setting this
     1530# option to 1 or 2 may greatly reduce the computation time needed for large
     1531# code bases. Also note that the size of a graph can be further restricted by
     1532# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    10681533
    10691534MAX_DOT_GRAPH_DEPTH    = 0
    10701535
    1071 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    1072 # generate a legend page explaining the meaning of the various boxes and
     1536# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
     1537# background. This is disabled by default, because dot on Windows does not
     1538# seem to support this out of the box. Warning: Depending on the platform used,
     1539# enabling this option may lead to badly anti-aliased labels on the edges of
     1540# a graph (i.e. they become hard to read).
     1541
     1542DOT_TRANSPARENT        = NO
     1543
     1544# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
     1545# files in one run (i.e. multiple -o and -T options on the command line). This
     1546# makes dot run faster, but since only newer versions of dot (>1.8.10)
     1547# support this, this feature is disabled by default.
     1548
     1549DOT_MULTI_TARGETS      = NO
     1550
     1551# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
     1552# generate a legend page explaining the meaning of the various boxes and
    10731553# arrows in the dot generated graphs.
    10741554
    10751555GENERATE_LEGEND        = YES
    10761556
    1077 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
    1078 # remove the intermediate dot files that are used to generate 
     1557# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
     1558# remove the intermediate dot files that are used to generate
    10791559# the various graphs.
    10801560
    10811561DOT_CLEANUP            = YES
    1082 
    1083 #---------------------------------------------------------------------------
    1084 # Configuration::addtions related to the search engine   
    1085 #---------------------------------------------------------------------------
    1086 
    1087 # The SEARCHENGINE tag specifies whether or not a search engine should be
    1088 # used. If set to NO the values of all tags below this one will be ignored.
    1089 
    1090 SEARCHENGINE           = NO
Note: See TracChangeset for help on using the changeset viewer.