doxygen.config
author insilmaril
Mon, 08 Dec 2008 16:57:33 +0000
changeset 729 7ddbe3fa34a1
parent 728 a8a98a94899a
child 758 04039e47ac74
permissions -rw-r--r--
More fixes for selections
insilmaril@728
     1
# Doxyfile 1.5.5
insilmaril@501
     2
insilmaril@501
     3
# This file describes the settings to be used by the documentation system
insilmaril@501
     4
# doxygen (www.doxygen.org) for a project
insilmaril@501
     5
#
insilmaril@501
     6
# All text after a hash (#) is considered a comment and will be ignored
insilmaril@501
     7
# The format is:
insilmaril@501
     8
#       TAG = value [value, ...]
insilmaril@501
     9
# For lists items can also be appended using:
insilmaril@501
    10
#       TAG += value [value, ...]
insilmaril@501
    11
# Values that contain spaces should be placed between quotes (" ")
insilmaril@501
    12
insilmaril@501
    13
#---------------------------------------------------------------------------
insilmaril@501
    14
# Project related configuration options
insilmaril@501
    15
#---------------------------------------------------------------------------
insilmaril@501
    16
insilmaril@728
    17
# This tag specifies the encoding used for all characters in the config file 
insilmaril@728
    18
# that follow. The default is UTF-8 which is also the encoding used for all 
insilmaril@728
    19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
insilmaril@728
    20
# iconv built into libc) for the transcoding. See 
insilmaril@728
    21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
insilmaril@728
    22
insilmaril@728
    23
DOXYFILE_ENCODING      = UTF-8
insilmaril@728
    24
insilmaril@501
    25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
insilmaril@501
    26
# by quotes) that should identify the project.
insilmaril@501
    27
insilmaril@728
    28
PROJECT_NAME           = 
insilmaril@501
    29
insilmaril@501
    30
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
insilmaril@501
    31
# This could be handy for archiving the generated documentation or 
insilmaril@501
    32
# if some version control system is used.
insilmaril@501
    33
insilmaril@501
    34
PROJECT_NUMBER         = 
insilmaril@501
    35
insilmaril@501
    36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
insilmaril@501
    37
# base path where the generated documentation will be put. 
insilmaril@501
    38
# If a relative path is entered, it will be relative to the location 
insilmaril@501
    39
# where doxygen was started. If left blank the current directory will be used.
insilmaril@501
    40
insilmaril@728
    41
OUTPUT_DIRECTORY       = 
insilmaril@501
    42
insilmaril@501
    43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
insilmaril@501
    44
# 4096 sub-directories (in 2 levels) under the output directory of each output 
insilmaril@501
    45
# format and will distribute the generated files over these directories. 
insilmaril@501
    46
# Enabling this option can be useful when feeding doxygen a huge amount of 
insilmaril@501
    47
# source files, where putting all generated files in the same directory would 
insilmaril@501
    48
# otherwise cause performance problems for the file system.
insilmaril@501
    49
insilmaril@501
    50
CREATE_SUBDIRS         = NO
insilmaril@501
    51
insilmaril@501
    52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
insilmaril@501
    53
# documentation generated by doxygen is written. Doxygen will use this 
insilmaril@501
    54
# information to generate all constant output in the proper language. 
insilmaril@501
    55
# The default language is English, other supported languages are: 
insilmaril@501
    56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
insilmaril@728
    57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
insilmaril@728
    58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
insilmaril@728
    59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
insilmaril@728
    60
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 
insilmaril@728
    61
# and Ukrainian.
insilmaril@501
    62
insilmaril@501
    63
OUTPUT_LANGUAGE        = English
insilmaril@501
    64
insilmaril@501
    65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
insilmaril@501
    66
# include brief member descriptions after the members that are listed in 
insilmaril@501
    67
# the file and class documentation (similar to JavaDoc). 
insilmaril@501
    68
# Set to NO to disable this.
insilmaril@501
    69
insilmaril@501
    70
BRIEF_MEMBER_DESC      = YES
insilmaril@501
    71
insilmaril@501
    72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
insilmaril@501
    73
# the brief description of a member or function before the detailed description. 
insilmaril@501
    74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
insilmaril@501
    75
# brief descriptions will be completely suppressed.
insilmaril@501
    76
insilmaril@501
    77
REPEAT_BRIEF           = YES
insilmaril@501
    78
insilmaril@501
    79
# This tag implements a quasi-intelligent brief description abbreviator 
insilmaril@501
    80
# that is used to form the text in various listings. Each string 
insilmaril@501
    81
# in this list, if found as the leading text of the brief description, will be 
insilmaril@501
    82
# stripped from the text and the result after processing the whole list, is 
insilmaril@501
    83
# used as the annotated text. Otherwise, the brief description is used as-is. 
insilmaril@501
    84
# If left blank, the following values are used ("$name" is automatically 
insilmaril@501
    85
# replaced with the name of the entity): "The $name class" "The $name widget" 
insilmaril@501
    86
# "The $name file" "is" "provides" "specifies" "contains" 
insilmaril@501
    87
# "represents" "a" "an" "the"
insilmaril@501
    88
insilmaril@501
    89
ABBREVIATE_BRIEF       = 
insilmaril@501
    90
insilmaril@501
    91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
insilmaril@501
    92
# Doxygen will generate a detailed section even if there is only a brief 
insilmaril@501
    93
# description.
insilmaril@501
    94
insilmaril@501
    95
ALWAYS_DETAILED_SEC    = NO
insilmaril@501
    96
insilmaril@501
    97
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
insilmaril@501
    98
# inherited members of a class in the documentation of that class as if those 
insilmaril@501
    99
# members were ordinary class members. Constructors, destructors and assignment 
insilmaril@501
   100
# operators of the base classes will not be shown.
insilmaril@501
   101
insilmaril@501
   102
INLINE_INHERITED_MEMB  = NO
insilmaril@501
   103
insilmaril@501
   104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
insilmaril@501
   105
# path before files name in the file list and in the header files. If set 
insilmaril@501
   106
# to NO the shortest path that makes the file name unique will be used.
insilmaril@501
   107
insilmaril@501
   108
FULL_PATH_NAMES        = YES
insilmaril@501
   109
insilmaril@501
   110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
insilmaril@501
   111
# can be used to strip a user-defined part of the path. Stripping is 
insilmaril@501
   112
# only done if one of the specified strings matches the left-hand part of 
insilmaril@501
   113
# the path. The tag can be used to show relative paths in the file list. 
insilmaril@501
   114
# If left blank the directory from which doxygen is run is used as the 
insilmaril@501
   115
# path to strip.
insilmaril@501
   116
insilmaril@501
   117
STRIP_FROM_PATH        = 
insilmaril@501
   118
insilmaril@501
   119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
insilmaril@501
   120
# the path mentioned in the documentation of a class, which tells 
insilmaril@501
   121
# the reader which header file to include in order to use a class. 
insilmaril@501
   122
# If left blank only the name of the header file containing the class 
insilmaril@501
   123
# definition is used. Otherwise one should specify the include paths that 
insilmaril@501
   124
# are normally passed to the compiler using the -I flag.
insilmaril@501
   125
insilmaril@501
   126
STRIP_FROM_INC_PATH    = 
insilmaril@501
   127
insilmaril@501
   128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
insilmaril@501
   129
# (but less readable) file names. This can be useful is your file systems 
insilmaril@501
   130
# doesn't support long names like on DOS, Mac, or CD-ROM.
insilmaril@501
   131
insilmaril@501
   132
SHORT_NAMES            = NO
insilmaril@501
   133
insilmaril@501
   134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
insilmaril@501
   135
# will interpret the first line (until the first dot) of a JavaDoc-style 
insilmaril@501
   136
# comment as the brief description. If set to NO, the JavaDoc 
insilmaril@728
   137
# comments will behave just like regular Qt-style comments 
insilmaril@728
   138
# (thus requiring an explicit @brief command for a brief description.)
insilmaril@501
   139
insilmaril@501
   140
JAVADOC_AUTOBRIEF      = NO
insilmaril@501
   141
insilmaril@728
   142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
insilmaril@728
   143
# interpret the first line (until the first dot) of a Qt-style 
insilmaril@728
   144
# comment as the brief description. If set to NO, the comments 
insilmaril@728
   145
# will behave just like regular Qt-style comments (thus requiring 
insilmaril@728
   146
# an explicit \brief command for a brief description.)
insilmaril@728
   147
insilmaril@728
   148
QT_AUTOBRIEF           = NO
insilmaril@728
   149
insilmaril@501
   150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
insilmaril@501
   151
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
insilmaril@501
   152
# comments) as a brief description. This used to be the default behaviour. 
insilmaril@501
   153
# The new default is to treat a multi-line C++ comment block as a detailed 
insilmaril@501
   154
# description. Set this tag to YES if you prefer the old behaviour instead.
insilmaril@501
   155
insilmaril@501
   156
MULTILINE_CPP_IS_BRIEF = NO
insilmaril@501
   157
insilmaril@501
   158
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
insilmaril@501
   159
# will output the detailed description near the top, like JavaDoc.
insilmaril@501
   160
# If set to NO, the detailed description appears after the member 
insilmaril@501
   161
# documentation.
insilmaril@501
   162
insilmaril@501
   163
DETAILS_AT_TOP         = NO
insilmaril@501
   164
insilmaril@501
   165
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
insilmaril@501
   166
# member inherits the documentation from any documented member that it 
insilmaril@501
   167
# re-implements.
insilmaril@501
   168
insilmaril@501
   169
INHERIT_DOCS           = YES
insilmaril@501
   170
insilmaril@501
   171
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
insilmaril@501
   172
# a new page for each member. If set to NO, the documentation of a member will 
insilmaril@501
   173
# be part of the file/class/namespace that contains it.
insilmaril@501
   174
insilmaril@501
   175
SEPARATE_MEMBER_PAGES  = NO
insilmaril@501
   176
insilmaril@501
   177
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
insilmaril@501
   178
# Doxygen uses this value to replace tabs by spaces in code fragments.
insilmaril@501
   179
insilmaril@501
   180
TAB_SIZE               = 8
insilmaril@501
   181
insilmaril@501
   182
# This tag can be used to specify a number of aliases that acts 
insilmaril@501
   183
# as commands in the documentation. An alias has the form "name=value". 
insilmaril@501
   184
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
insilmaril@501
   185
# put the command \sideeffect (or @sideeffect) in the documentation, which 
insilmaril@501
   186
# will result in a user-defined paragraph with heading "Side Effects:". 
insilmaril@501
   187
# You can put \n's in the value part of an alias to insert newlines.
insilmaril@501
   188
insilmaril@501
   189
ALIASES                = 
insilmaril@501
   190
insilmaril@501
   191
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
insilmaril@501
   192
# sources only. Doxygen will then generate output that is more tailored for C. 
insilmaril@501
   193
# For instance, some of the names that are used will be different. The list 
insilmaril@501
   194
# of all members will be omitted, etc.
insilmaril@501
   195
insilmaril@501
   196
OPTIMIZE_OUTPUT_FOR_C  = NO
insilmaril@501
   197
insilmaril@501
   198
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
insilmaril@728
   199
# sources only. Doxygen will then generate output that is more tailored for 
insilmaril@728
   200
# Java. For instance, namespaces will be presented as packages, qualified 
insilmaril@728
   201
# scopes will look different, etc.
insilmaril@501
   202
insilmaril@501
   203
OPTIMIZE_OUTPUT_JAVA   = NO
insilmaril@501
   204
insilmaril@728
   205
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
insilmaril@728
   206
# sources only. Doxygen will then generate output that is more tailored for 
insilmaril@728
   207
# Fortran.
insilmaril@728
   208
insilmaril@728
   209
OPTIMIZE_FOR_FORTRAN   = NO
insilmaril@728
   210
insilmaril@728
   211
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
insilmaril@728
   212
# sources. Doxygen will then generate output that is tailored for 
insilmaril@728
   213
# VHDL.
insilmaril@728
   214
insilmaril@728
   215
OPTIMIZE_OUTPUT_VHDL   = NO
insilmaril@728
   216
insilmaril@728
   217
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
insilmaril@728
   218
# to include (a tag file for) the STL sources as input, then you should 
insilmaril@501
   219
# set this tag to YES in order to let doxygen match functions declarations and 
insilmaril@501
   220
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
insilmaril@501
   221
# func(std::string) {}). This also make the inheritance and collaboration 
insilmaril@501
   222
# diagrams that involve STL classes more complete and accurate.
insilmaril@501
   223
insilmaril@501
   224
BUILTIN_STL_SUPPORT    = NO
insilmaril@501
   225
insilmaril@728
   226
# If you use Microsoft's C++/CLI language, you should set this option to YES to
insilmaril@728
   227
# enable parsing support.
insilmaril@728
   228
insilmaril@728
   229
CPP_CLI_SUPPORT        = NO
insilmaril@728
   230
insilmaril@728
   231
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
insilmaril@728
   232
# Doxygen will parse them like normal C++ but will assume all classes use public 
insilmaril@728
   233
# instead of private inheritance when no explicit protection keyword is present.
insilmaril@728
   234
insilmaril@728
   235
SIP_SUPPORT            = NO
insilmaril@728
   236
insilmaril@501
   237
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
insilmaril@501
   238
# tag is set to YES, then doxygen will reuse the documentation of the first 
insilmaril@501
   239
# member in the group (if any) for the other members of the group. By default 
insilmaril@501
   240
# all members of a group must be documented explicitly.
insilmaril@501
   241
insilmaril@501
   242
DISTRIBUTE_GROUP_DOC   = NO
insilmaril@501
   243
insilmaril@501
   244
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
insilmaril@501
   245
# the same type (for instance a group of public functions) to be put as a 
insilmaril@501
   246
# subgroup of that type (e.g. under the Public Functions section). Set it to 
insilmaril@501
   247
# NO to prevent subgrouping. Alternatively, this can be done per class using 
insilmaril@501
   248
# the \nosubgrouping command.
insilmaril@501
   249
insilmaril@501
   250
SUBGROUPING            = YES
insilmaril@501
   251
insilmaril@728
   252
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
insilmaril@728
   253
# is documented as struct, union, or enum with the name of the typedef. So 
insilmaril@728
   254
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
insilmaril@728
   255
# with name TypeT. When disabled the typedef will appear as a member of a file, 
insilmaril@728
   256
# namespace, or class. And the struct will be named TypeS. This can typically 
insilmaril@728
   257
# be useful for C code in case the coding convention dictates that all compound 
insilmaril@728
   258
# types are typedef'ed and only the typedef is referenced, never the tag name.
insilmaril@728
   259
insilmaril@728
   260
TYPEDEF_HIDES_STRUCT   = NO
insilmaril@728
   261
insilmaril@501
   262
#---------------------------------------------------------------------------
insilmaril@501
   263
# Build related configuration options
insilmaril@501
   264
#---------------------------------------------------------------------------
insilmaril@501
   265
insilmaril@501
   266
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
insilmaril@501
   267
# documentation are documented, even if no documentation was available. 
insilmaril@501
   268
# Private class members and static file members will be hidden unless 
insilmaril@501
   269
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
insilmaril@501
   270
insilmaril@501
   271
EXTRACT_ALL            = NO
insilmaril@501
   272
insilmaril@501
   273
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
insilmaril@501
   274
# will be included in the documentation.
insilmaril@501
   275
insilmaril@501
   276
EXTRACT_PRIVATE        = NO
insilmaril@501
   277
insilmaril@501
   278
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
insilmaril@501
   279
# will be included in the documentation.
insilmaril@501
   280
insilmaril@501
   281
EXTRACT_STATIC         = NO
insilmaril@501
   282
insilmaril@501
   283
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
insilmaril@501
   284
# defined locally in source files will be included in the documentation. 
insilmaril@501
   285
# If set to NO only classes defined in header files are included.
insilmaril@501
   286
insilmaril@501
   287
EXTRACT_LOCAL_CLASSES  = YES
insilmaril@501
   288
insilmaril@501
   289
# This flag is only useful for Objective-C code. When set to YES local 
insilmaril@501
   290
# methods, which are defined in the implementation section but not in 
insilmaril@501
   291
# the interface are included in the documentation. 
insilmaril@501
   292
# If set to NO (the default) only methods in the interface are included.
insilmaril@501
   293
insilmaril@501
   294
EXTRACT_LOCAL_METHODS  = NO
insilmaril@501
   295
insilmaril@728
   296
# If this flag is set to YES, the members of anonymous namespaces will be 
insilmaril@728
   297
# extracted and appear in the documentation as a namespace called 
insilmaril@728
   298
# 'anonymous_namespace{file}', where file will be replaced with the base 
insilmaril@728
   299
# name of the file that contains the anonymous namespace. By default 
insilmaril@728
   300
# anonymous namespace are hidden.
insilmaril@728
   301
insilmaril@728
   302
EXTRACT_ANON_NSPACES   = NO
insilmaril@728
   303
insilmaril@501
   304
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
insilmaril@501
   305
# undocumented members of documented classes, files or namespaces. 
insilmaril@501
   306
# If set to NO (the default) these members will be included in the 
insilmaril@501
   307
# various overviews, but no documentation section is generated. 
insilmaril@501
   308
# This option has no effect if EXTRACT_ALL is enabled.
insilmaril@501
   309
insilmaril@501
   310
HIDE_UNDOC_MEMBERS     = NO
insilmaril@501
   311
insilmaril@501
   312
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
insilmaril@501
   313
# undocumented classes that are normally visible in the class hierarchy. 
insilmaril@501
   314
# If set to NO (the default) these classes will be included in the various 
insilmaril@501
   315
# overviews. This option has no effect if EXTRACT_ALL is enabled.
insilmaril@501
   316
insilmaril@501
   317
HIDE_UNDOC_CLASSES     = NO
insilmaril@501
   318
insilmaril@501
   319
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
insilmaril@501
   320
# friend (class|struct|union) declarations. 
insilmaril@501
   321
# If set to NO (the default) these declarations will be included in the 
insilmaril@501
   322
# documentation.
insilmaril@501
   323
insilmaril@501
   324
HIDE_FRIEND_COMPOUNDS  = NO
insilmaril@501
   325
insilmaril@501
   326
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
insilmaril@501
   327
# documentation blocks found inside the body of a function. 
insilmaril@501
   328
# If set to NO (the default) these blocks will be appended to the 
insilmaril@501
   329
# function's detailed documentation block.
insilmaril@501
   330
insilmaril@501
   331
HIDE_IN_BODY_DOCS      = NO
insilmaril@501
   332
insilmaril@501
   333
# The INTERNAL_DOCS tag determines if documentation 
insilmaril@501
   334
# that is typed after a \internal command is included. If the tag is set 
insilmaril@501
   335
# to NO (the default) then the documentation will be excluded. 
insilmaril@501
   336
# Set it to YES to include the internal documentation.
insilmaril@501
   337
insilmaril@501
   338
INTERNAL_DOCS          = NO
insilmaril@501
   339
insilmaril@501
   340
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
insilmaril@501
   341
# file names in lower-case letters. If set to YES upper-case letters are also 
insilmaril@501
   342
# allowed. This is useful if you have classes or files whose names only differ 
insilmaril@501
   343
# in case and if your file system supports case sensitive file names. Windows 
insilmaril@501
   344
# and Mac users are advised to set this option to NO.
insilmaril@501
   345
insilmaril@501
   346
CASE_SENSE_NAMES       = YES
insilmaril@501
   347
insilmaril@501
   348
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
insilmaril@501
   349
# will show members with their full class and namespace scopes in the 
insilmaril@501
   350
# documentation. If set to YES the scope will be hidden.
insilmaril@501
   351
insilmaril@501
   352
HIDE_SCOPE_NAMES       = NO
insilmaril@501
   353
insilmaril@501
   354
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
insilmaril@501
   355
# will put a list of the files that are included by a file in the documentation 
insilmaril@501
   356
# of that file.
insilmaril@501
   357
insilmaril@501
   358
SHOW_INCLUDE_FILES     = YES
insilmaril@501
   359
insilmaril@501
   360
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
insilmaril@501
   361
# is inserted in the documentation for inline members.
insilmaril@501
   362
insilmaril@501
   363
INLINE_INFO            = YES
insilmaril@501
   364
insilmaril@501
   365
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
insilmaril@501
   366
# will sort the (detailed) documentation of file and class members 
insilmaril@501
   367
# alphabetically by member name. If set to NO the members will appear in 
insilmaril@501
   368
# declaration order.
insilmaril@501
   369
insilmaril@501
   370
SORT_MEMBER_DOCS       = YES
insilmaril@501
   371
insilmaril@501
   372
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
insilmaril@501
   373
# brief documentation of file, namespace and class members alphabetically 
insilmaril@501
   374
# by member name. If set to NO (the default) the members will appear in 
insilmaril@501
   375
# declaration order.
insilmaril@501
   376
insilmaril@501
   377
SORT_BRIEF_DOCS        = NO
insilmaril@501
   378
insilmaril@728
   379
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
insilmaril@728
   380
# hierarchy of group names into alphabetical order. If set to NO (the default) 
insilmaril@728
   381
# the group names will appear in their defined order.
insilmaril@728
   382
insilmaril@728
   383
SORT_GROUP_NAMES       = NO
insilmaril@728
   384
insilmaril@501
   385
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
insilmaril@501
   386
# sorted by fully-qualified names, including namespaces. If set to 
insilmaril@501
   387
# NO (the default), the class list will be sorted only by class name, 
insilmaril@501
   388
# not including the namespace part. 
insilmaril@501
   389
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
insilmaril@501
   390
# Note: This option applies only to the class list, not to the 
insilmaril@501
   391
# alphabetical list.
insilmaril@501
   392
insilmaril@501
   393
SORT_BY_SCOPE_NAME     = NO
insilmaril@501
   394
insilmaril@501
   395
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
insilmaril@501
   396
# disable (NO) the todo list. This list is created by putting \todo 
insilmaril@501
   397
# commands in the documentation.
insilmaril@501
   398
insilmaril@501
   399
GENERATE_TODOLIST      = YES
insilmaril@501
   400
insilmaril@501
   401
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
insilmaril@501
   402
# disable (NO) the test list. This list is created by putting \test 
insilmaril@501
   403
# commands in the documentation.
insilmaril@501
   404
insilmaril@501
   405
GENERATE_TESTLIST      = YES
insilmaril@501
   406
insilmaril@501
   407
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
insilmaril@501
   408
# disable (NO) the bug list. This list is created by putting \bug 
insilmaril@501
   409
# commands in the documentation.
insilmaril@501
   410
insilmaril@501
   411
GENERATE_BUGLIST       = YES
insilmaril@501
   412
insilmaril@501
   413
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
insilmaril@501
   414
# disable (NO) the deprecated list. This list is created by putting 
insilmaril@501
   415
# \deprecated commands in the documentation.
insilmaril@501
   416
insilmaril@501
   417
GENERATE_DEPRECATEDLIST= YES
insilmaril@501
   418
insilmaril@501
   419
# The ENABLED_SECTIONS tag can be used to enable conditional 
insilmaril@501
   420
# documentation sections, marked by \if sectionname ... \endif.
insilmaril@501
   421
insilmaril@501
   422
ENABLED_SECTIONS       = 
insilmaril@501
   423
insilmaril@501
   424
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
insilmaril@501
   425
# the initial value of a variable or define consists of for it to appear in 
insilmaril@501
   426
# the documentation. If the initializer consists of more lines than specified 
insilmaril@501
   427
# here it will be hidden. Use a value of 0 to hide initializers completely. 
insilmaril@501
   428
# The appearance of the initializer of individual variables and defines in the 
insilmaril@501
   429
# documentation can be controlled using \showinitializer or \hideinitializer 
insilmaril@501
   430
# command in the documentation regardless of this setting.
insilmaril@501
   431
insilmaril@501
   432
MAX_INITIALIZER_LINES  = 30
insilmaril@501
   433
insilmaril@501
   434
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
insilmaril@501
   435
# at the bottom of the documentation of classes and structs. If set to YES the 
insilmaril@501
   436
# list will mention the files that were used to generate the documentation.
insilmaril@501
   437
insilmaril@501
   438
SHOW_USED_FILES        = YES
insilmaril@501
   439
insilmaril@501
   440
# If the sources in your project are distributed over multiple directories 
insilmaril@501
   441
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
insilmaril@501
   442
# in the documentation. The default is NO.
insilmaril@501
   443
insilmaril@501
   444
SHOW_DIRECTORIES       = NO
insilmaril@501
   445
insilmaril@501
   446
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
insilmaril@728
   447
# doxygen should invoke to get the current version for each file (typically from 
insilmaril@728
   448
# the version control system). Doxygen will invoke the program by executing (via 
insilmaril@501
   449
# popen()) the command <command> <input-file>, where <command> is the value of 
insilmaril@501
   450
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
insilmaril@501
   451
# provided by doxygen. Whatever the program writes to standard output 
insilmaril@501
   452
# is used as the file version. See the manual for examples.
insilmaril@501
   453
insilmaril@501
   454
FILE_VERSION_FILTER    = 
insilmaril@501
   455
insilmaril@501
   456
#---------------------------------------------------------------------------
insilmaril@501
   457
# configuration options related to warning and progress messages
insilmaril@501
   458
#---------------------------------------------------------------------------
insilmaril@501
   459
insilmaril@501
   460
# The QUIET tag can be used to turn on/off the messages that are generated 
insilmaril@501
   461
# by doxygen. Possible values are YES and NO. If left blank NO is used.
insilmaril@501
   462
insilmaril@501
   463
QUIET                  = NO
insilmaril@501
   464
insilmaril@501
   465
# The WARNINGS tag can be used to turn on/off the warning messages that are 
insilmaril@501
   466
# generated by doxygen. Possible values are YES and NO. If left blank 
insilmaril@501
   467
# NO is used.
insilmaril@501
   468
insilmaril@501
   469
WARNINGS               = YES
insilmaril@501
   470
insilmaril@501
   471
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
insilmaril@501
   472
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
insilmaril@501
   473
# automatically be disabled.
insilmaril@501
   474
insilmaril@501
   475
WARN_IF_UNDOCUMENTED   = YES
insilmaril@501
   476
insilmaril@501
   477
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
insilmaril@501
   478
# potential errors in the documentation, such as not documenting some 
insilmaril@501
   479
# parameters in a documented function, or documenting parameters that 
insilmaril@501
   480
# don't exist or using markup commands wrongly.
insilmaril@501
   481
insilmaril@501
   482
WARN_IF_DOC_ERROR      = YES
insilmaril@501
   483
insilmaril@501
   484
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
insilmaril@501
   485
# functions that are documented, but have no documentation for their parameters 
insilmaril@501
   486
# or return value. If set to NO (the default) doxygen will only warn about 
insilmaril@501
   487
# wrong or incomplete parameter documentation, but not about the absence of 
insilmaril@501
   488
# documentation.
insilmaril@501
   489
insilmaril@501
   490
WARN_NO_PARAMDOC       = NO
insilmaril@501
   491
insilmaril@501
   492
# The WARN_FORMAT tag determines the format of the warning messages that 
insilmaril@501
   493
# doxygen can produce. The string should contain the $file, $line, and $text 
insilmaril@501
   494
# tags, which will be replaced by the file and line number from which the 
insilmaril@501
   495
# warning originated and the warning text. Optionally the format may contain 
insilmaril@501
   496
# $version, which will be replaced by the version of the file (if it could 
insilmaril@501
   497
# be obtained via FILE_VERSION_FILTER)
insilmaril@501
   498
insilmaril@501
   499
WARN_FORMAT            = "$file:$line: $text"
insilmaril@501
   500
insilmaril@501
   501
# The WARN_LOGFILE tag can be used to specify a file to which warning 
insilmaril@501
   502
# and error messages should be written. If left blank the output is written 
insilmaril@501
   503
# to stderr.
insilmaril@501
   504
insilmaril@501
   505
WARN_LOGFILE           = 
insilmaril@501
   506
insilmaril@501
   507
#---------------------------------------------------------------------------
insilmaril@501
   508
# configuration options related to the input files
insilmaril@501
   509
#---------------------------------------------------------------------------
insilmaril@501
   510
insilmaril@501
   511
# The INPUT tag can be used to specify the files and/or directories that contain 
insilmaril@501
   512
# documented source files. You may enter file names like "myfile.cpp" or 
insilmaril@501
   513
# directories like "/usr/src/myproject". Separate the files or directories 
insilmaril@501
   514
# with spaces.
insilmaril@501
   515
insilmaril@501
   516
INPUT                  = 
insilmaril@501
   517
insilmaril@728
   518
# This tag can be used to specify the character encoding of the source files 
insilmaril@728
   519
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
insilmaril@728
   520
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
insilmaril@728
   521
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
insilmaril@728
   522
# the list of possible encodings.
insilmaril@728
   523
insilmaril@728
   524
INPUT_ENCODING         = UTF-8
insilmaril@728
   525
insilmaril@501
   526
# If the value of the INPUT tag contains directories, you can use the 
insilmaril@501
   527
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
insilmaril@501
   528
# and *.h) to filter out the source-files in the directories. If left 
insilmaril@501
   529
# blank the following patterns are tested: 
insilmaril@501
   530
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
insilmaril@728
   531
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
insilmaril@501
   532
insilmaril@501
   533
FILE_PATTERNS          = 
insilmaril@501
   534
insilmaril@501
   535
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
insilmaril@501
   536
# should be searched for input files as well. Possible values are YES and NO. 
insilmaril@501
   537
# If left blank NO is used.
insilmaril@501
   538
insilmaril@501
   539
RECURSIVE              = NO
insilmaril@501
   540
insilmaril@501
   541
# The EXCLUDE tag can be used to specify files and/or directories that should 
insilmaril@501
   542
# excluded from the INPUT source files. This way you can easily exclude a 
insilmaril@501
   543
# subdirectory from a directory tree whose root is specified with the INPUT tag.
insilmaril@501
   544
insilmaril@501
   545
EXCLUDE                = 
insilmaril@501
   546
insilmaril@501
   547
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
insilmaril@501
   548
# directories that are symbolic links (a Unix filesystem feature) are excluded 
insilmaril@501
   549
# from the input.
insilmaril@501
   550
insilmaril@501
   551
EXCLUDE_SYMLINKS       = NO
insilmaril@501
   552
insilmaril@501
   553
# If the value of the INPUT tag contains directories, you can use the 
insilmaril@501
   554
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
insilmaril@501
   555
# certain files from those directories. Note that the wildcards are matched 
insilmaril@501
   556
# against the file with absolute path, so to exclude all test directories 
insilmaril@501
   557
# for example use the pattern */test/*
insilmaril@501
   558
insilmaril@728
   559
EXCLUDE_PATTERNS       = 
insilmaril@728
   560
insilmaril@728
   561
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
insilmaril@728
   562
# (namespaces, classes, functions, etc.) that should be excluded from the 
insilmaril@728
   563
# output. The symbol name can be a fully qualified name, a word, or if the 
insilmaril@728
   564
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
insilmaril@728
   565
# AClass::ANamespace, ANamespace::*Test
insilmaril@728
   566
insilmaril@728
   567
EXCLUDE_SYMBOLS        = 
insilmaril@501
   568
insilmaril@501
   569
# The EXAMPLE_PATH tag can be used to specify one or more files or 
insilmaril@501
   570
# directories that contain example code fragments that are included (see 
insilmaril@501
   571
# the \include command).
insilmaril@501
   572
insilmaril@501
   573
EXAMPLE_PATH           = 
insilmaril@501
   574
insilmaril@501
   575
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
insilmaril@501
   576
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
insilmaril@501
   577
# and *.h) to filter out the source-files in the directories. If left 
insilmaril@501
   578
# blank all files are included.
insilmaril@501
   579
insilmaril@501
   580
EXAMPLE_PATTERNS       = 
insilmaril@501
   581
insilmaril@501
   582
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
insilmaril@501
   583
# searched for input files to be used with the \include or \dontinclude 
insilmaril@501
   584
# commands irrespective of the value of the RECURSIVE tag. 
insilmaril@501
   585
# Possible values are YES and NO. If left blank NO is used.
insilmaril@501
   586
insilmaril@501
   587
EXAMPLE_RECURSIVE      = NO
insilmaril@501
   588
insilmaril@501
   589
# The IMAGE_PATH tag can be used to specify one or more files or 
insilmaril@501
   590
# directories that contain image that are included in the documentation (see 
insilmaril@501
   591
# the \image command).
insilmaril@501
   592
insilmaril@501
   593
IMAGE_PATH             = 
insilmaril@501
   594
insilmaril@501
   595
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
insilmaril@501
   596
# invoke to filter for each input file. Doxygen will invoke the filter program 
insilmaril@501
   597
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
insilmaril@501
   598
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
insilmaril@501
   599
# input file. Doxygen will then use the output that the filter program writes 
insilmaril@501
   600
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
insilmaril@501
   601
# ignored.
insilmaril@501
   602
insilmaril@501
   603
INPUT_FILTER           = 
insilmaril@501
   604
insilmaril@501
   605
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
insilmaril@501
   606
# basis.  Doxygen will compare the file name with each pattern and apply the 
insilmaril@501
   607
# filter if there is a match.  The filters are a list of the form: 
insilmaril@501
   608
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
insilmaril@501
   609
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
insilmaril@501
   610
# is applied to all files.
insilmaril@501
   611
insilmaril@501
   612
FILTER_PATTERNS        = 
insilmaril@501
   613
insilmaril@501
   614
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
insilmaril@501
   615
# INPUT_FILTER) will be used to filter the input files when producing source 
insilmaril@501
   616
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
insilmaril@501
   617
insilmaril@501
   618
FILTER_SOURCE_FILES    = NO
insilmaril@501
   619
insilmaril@501
   620
#---------------------------------------------------------------------------
insilmaril@501
   621
# configuration options related to source browsing
insilmaril@501
   622
#---------------------------------------------------------------------------
insilmaril@501
   623
insilmaril@501
   624
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
insilmaril@501
   625
# be generated. Documented entities will be cross-referenced with these sources. 
insilmaril@501
   626
# Note: To get rid of all source code in the generated output, make sure also 
insilmaril@501
   627
# VERBATIM_HEADERS is set to NO.
insilmaril@501
   628
insilmaril@501
   629
SOURCE_BROWSER         = NO
insilmaril@501
   630
insilmaril@501
   631
# Setting the INLINE_SOURCES tag to YES will include the body 
insilmaril@501
   632
# of functions and classes directly in the documentation.
insilmaril@501
   633
insilmaril@501
   634
INLINE_SOURCES         = NO
insilmaril@501
   635
insilmaril@501
   636
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
insilmaril@501
   637
# doxygen to hide any special comment blocks from generated source code 
insilmaril@501
   638
# fragments. Normal C and C++ comments will always remain visible.
insilmaril@501
   639
insilmaril@501
   640
STRIP_CODE_COMMENTS    = YES
insilmaril@501
   641
insilmaril@501
   642
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
insilmaril@501
   643
# then for each documented function all documented 
insilmaril@501
   644
# functions referencing it will be listed.
insilmaril@501
   645
insilmaril@728
   646
REFERENCED_BY_RELATION = NO
insilmaril@501
   647
insilmaril@501
   648
# If the REFERENCES_RELATION tag is set to YES (the default) 
insilmaril@501
   649
# then for each documented function all documented entities 
insilmaril@501
   650
# called/used by that function will be listed.
insilmaril@501
   651
insilmaril@728
   652
REFERENCES_RELATION    = NO
insilmaril@501
   653
insilmaril@501
   654
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
insilmaril@501
   655
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
insilmaril@501
   656
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
insilmaril@501
   657
# link to the source code.  Otherwise they will link to the documentstion.
insilmaril@501
   658
insilmaril@501
   659
REFERENCES_LINK_SOURCE = YES
insilmaril@501
   660
insilmaril@501
   661
# If the USE_HTAGS tag is set to YES then the references to source code 
insilmaril@501
   662
# will point to the HTML generated by the htags(1) tool instead of doxygen 
insilmaril@501
   663
# built-in source browser. The htags tool is part of GNU's global source 
insilmaril@501
   664
# tagging system (see http://www.gnu.org/software/global/global.html). You 
insilmaril@501
   665
# will need version 4.8.6 or higher.
insilmaril@501
   666
insilmaril@501
   667
USE_HTAGS              = NO
insilmaril@501
   668
insilmaril@501
   669
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
insilmaril@501
   670
# will generate a verbatim copy of the header file for each class for 
insilmaril@501
   671
# which an include is specified. Set to NO to disable this.
insilmaril@501
   672
insilmaril@501
   673
VERBATIM_HEADERS       = YES
insilmaril@501
   674
insilmaril@501
   675
#---------------------------------------------------------------------------
insilmaril@501
   676
# configuration options related to the alphabetical class index
insilmaril@501
   677
#---------------------------------------------------------------------------
insilmaril@501
   678
insilmaril@501
   679
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
insilmaril@501
   680
# of all compounds will be generated. Enable this if the project 
insilmaril@501
   681
# contains a lot of classes, structs, unions or interfaces.
insilmaril@501
   682
insilmaril@501
   683
ALPHABETICAL_INDEX     = NO
insilmaril@501
   684
insilmaril@501
   685
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
insilmaril@501
   686
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
insilmaril@501
   687
# in which this list will be split (can be a number in the range [1..20])
insilmaril@501
   688
insilmaril@501
   689
COLS_IN_ALPHA_INDEX    = 5
insilmaril@501
   690
insilmaril@501
   691
# In case all classes in a project start with a common prefix, all 
insilmaril@501
   692
# classes will be put under the same header in the alphabetical index. 
insilmaril@501
   693
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
insilmaril@501
   694
# should be ignored while generating the index headers.
insilmaril@501
   695
insilmaril@501
   696
IGNORE_PREFIX          = 
insilmaril@501
   697
insilmaril@501
   698
#---------------------------------------------------------------------------
insilmaril@501
   699
# configuration options related to the HTML output
insilmaril@501
   700
#---------------------------------------------------------------------------
insilmaril@501
   701
insilmaril@501
   702
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
insilmaril@501
   703
# generate HTML output.
insilmaril@501
   704
insilmaril@501
   705
GENERATE_HTML          = YES
insilmaril@501
   706
insilmaril@501
   707
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
insilmaril@501
   708
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
insilmaril@501
   709
# put in front of it. If left blank `html' will be used as the default path.
insilmaril@501
   710
insilmaril@501
   711
HTML_OUTPUT            = html
insilmaril@501
   712
insilmaril@501
   713
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
insilmaril@501
   714
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
insilmaril@501
   715
# doxygen will generate files with .html extension.
insilmaril@501
   716
insilmaril@501
   717
HTML_FILE_EXTENSION    = .html
insilmaril@501
   718
insilmaril@501
   719
# The HTML_HEADER tag can be used to specify a personal HTML header for 
insilmaril@501
   720
# each generated HTML page. If it is left blank doxygen will generate a 
insilmaril@501
   721
# standard header.
insilmaril@501
   722
insilmaril@501
   723
HTML_HEADER            = 
insilmaril@501
   724
insilmaril@501
   725
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
insilmaril@501
   726
# each generated HTML page. If it is left blank doxygen will generate a 
insilmaril@501
   727
# standard footer.
insilmaril@501
   728
insilmaril@501
   729
HTML_FOOTER            = 
insilmaril@501
   730
insilmaril@501
   731
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
insilmaril@501
   732
# style sheet that is used by each HTML page. It can be used to 
insilmaril@501
   733
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
insilmaril@501
   734
# will generate a default style sheet. Note that doxygen will try to copy 
insilmaril@501
   735
# the style sheet file to the HTML output directory, so don't put your own 
insilmaril@501
   736
# stylesheet in the HTML output directory as well, or it will be erased!
insilmaril@501
   737
insilmaril@501
   738
HTML_STYLESHEET        = 
insilmaril@501
   739
insilmaril@501
   740
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
insilmaril@501
   741
# files or namespaces will be aligned in HTML using tables. If set to 
insilmaril@501
   742
# NO a bullet list will be used.
insilmaril@501
   743
insilmaril@501
   744
HTML_ALIGN_MEMBERS     = YES
insilmaril@501
   745
insilmaril@501
   746
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
insilmaril@501
   747
# will be generated that can be used as input for tools like the 
insilmaril@728
   748
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
insilmaril@501
   749
# of the generated HTML documentation.
insilmaril@501
   750
insilmaril@501
   751
GENERATE_HTMLHELP      = NO
insilmaril@501
   752
insilmaril@728
   753
# If the GENERATE_DOCSET tag is set to YES, additional index files 
insilmaril@728
   754
# will be generated that can be used as input for Apple's Xcode 3 
insilmaril@728
   755
# integrated development environment, introduced with OSX 10.5 (Leopard). 
insilmaril@728
   756
# To create a documentation set, doxygen will generate a Makefile in the 
insilmaril@728
   757
# HTML output directory. Running make will produce the docset in that 
insilmaril@728
   758
# directory and running "make install" will install the docset in 
insilmaril@728
   759
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
insilmaril@728
   760
# it at startup.
insilmaril@728
   761
insilmaril@728
   762
GENERATE_DOCSET        = NO
insilmaril@728
   763
insilmaril@728
   764
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
insilmaril@728
   765
# feed. A documentation feed provides an umbrella under which multiple 
insilmaril@728
   766
# documentation sets from a single provider (such as a company or product suite) 
insilmaril@728
   767
# can be grouped.
insilmaril@728
   768
insilmaril@728
   769
DOCSET_FEEDNAME        = "Doxygen generated docs"
insilmaril@728
   770
insilmaril@728
   771
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
insilmaril@728
   772
# should uniquely identify the documentation set bundle. This should be a 
insilmaril@728
   773
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
insilmaril@728
   774
# will append .docset to the name.
insilmaril@728
   775
insilmaril@728
   776
DOCSET_BUNDLE_ID       = org.doxygen.Project
insilmaril@728
   777
insilmaril@728
   778
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
insilmaril@728
   779
# documentation will contain sections that can be hidden and shown after the 
insilmaril@728
   780
# page has loaded. For this to work a browser that supports 
insilmaril@728
   781
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
insilmaril@728
   782
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
insilmaril@728
   783
insilmaril@728
   784
HTML_DYNAMIC_SECTIONS  = NO
insilmaril@728
   785
insilmaril@501
   786
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
insilmaril@501
   787
# be used to specify the file name of the resulting .chm file. You 
insilmaril@501
   788
# can add a path in front of the file if the result should not be 
insilmaril@501
   789
# written to the html output directory.
insilmaril@501
   790
insilmaril@501
   791
CHM_FILE               = 
insilmaril@501
   792
insilmaril@501
   793
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
insilmaril@501
   794
# be used to specify the location (absolute path including file name) of 
insilmaril@501
   795
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
insilmaril@501
   796
# the HTML help compiler on the generated index.hhp.
insilmaril@501
   797
insilmaril@501
   798
HHC_LOCATION           = 
insilmaril@501
   799
insilmaril@501
   800
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
insilmaril@501
   801
# controls if a separate .chi index file is generated (YES) or that 
insilmaril@501
   802
# it should be included in the master .chm file (NO).
insilmaril@501
   803
insilmaril@501
   804
GENERATE_CHI           = NO
insilmaril@501
   805
insilmaril@501
   806
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
insilmaril@501
   807
# controls whether a binary table of contents is generated (YES) or a 
insilmaril@501
   808
# normal table of contents (NO) in the .chm file.
insilmaril@501
   809
insilmaril@501
   810
BINARY_TOC             = NO
insilmaril@501
   811
insilmaril@501
   812
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
insilmaril@501
   813
# to the contents of the HTML help documentation and to the tree view.
insilmaril@501
   814
insilmaril@501
   815
TOC_EXPAND             = NO
insilmaril@501
   816
insilmaril@501
   817
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
insilmaril@501
   818
# top of each HTML page. The value NO (the default) enables the index and 
insilmaril@501
   819
# the value YES disables it.
insilmaril@501
   820
insilmaril@501
   821
DISABLE_INDEX          = NO
insilmaril@501
   822
insilmaril@501
   823
# This tag can be used to set the number of enum values (range [1..20]) 
insilmaril@501
   824
# that doxygen will group on one line in the generated HTML documentation.
insilmaril@501
   825
insilmaril@501
   826
ENUM_VALUES_PER_LINE   = 4
insilmaril@501
   827
insilmaril@501
   828
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
insilmaril@501
   829
# generated containing a tree-like index structure (just like the one that 
insilmaril@501
   830
# is generated for HTML Help). For this to work a browser that supports 
insilmaril@501
   831
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
insilmaril@501
   832
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
insilmaril@501
   833
# probably better off using the HTML help feature.
insilmaril@501
   834
insilmaril@501
   835
GENERATE_TREEVIEW      = NO
insilmaril@501
   836
insilmaril@501
   837
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
insilmaril@501
   838
# used to set the initial width (in pixels) of the frame in which the tree 
insilmaril@501
   839
# is shown.
insilmaril@501
   840
insilmaril@501
   841
TREEVIEW_WIDTH         = 250
insilmaril@501
   842
insilmaril@501
   843
#---------------------------------------------------------------------------
insilmaril@501
   844
# configuration options related to the LaTeX output
insilmaril@501
   845
#---------------------------------------------------------------------------
insilmaril@501
   846
insilmaril@501
   847
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
insilmaril@501
   848
# generate Latex output.
insilmaril@501
   849
insilmaril@728
   850
GENERATE_LATEX         = YES
insilmaril@501
   851
insilmaril@501
   852
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
insilmaril@501
   853
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
insilmaril@501
   854
# put in front of it. If left blank `latex' will be used as the default path.
insilmaril@501
   855
insilmaril@501
   856
LATEX_OUTPUT           = latex
insilmaril@501
   857
insilmaril@501
   858
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
insilmaril@501
   859
# invoked. If left blank `latex' will be used as the default command name.
insilmaril@501
   860
insilmaril@501
   861
LATEX_CMD_NAME         = latex
insilmaril@501
   862
insilmaril@501
   863
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
insilmaril@501
   864
# generate index for LaTeX. If left blank `makeindex' will be used as the 
insilmaril@501
   865
# default command name.
insilmaril@501
   866
insilmaril@501
   867
MAKEINDEX_CMD_NAME     = makeindex
insilmaril@501
   868
insilmaril@501
   869
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
insilmaril@501
   870
# LaTeX documents. This may be useful for small projects and may help to 
insilmaril@501
   871
# save some trees in general.
insilmaril@501
   872
insilmaril@501
   873
COMPACT_LATEX          = NO
insilmaril@501
   874
insilmaril@501
   875
# The PAPER_TYPE tag can be used to set the paper type that is used 
insilmaril@501
   876
# by the printer. Possible values are: a4, a4wide, letter, legal and 
insilmaril@501
   877
# executive. If left blank a4wide will be used.
insilmaril@501
   878
insilmaril@501
   879
PAPER_TYPE             = a4wide
insilmaril@501
   880
insilmaril@501
   881
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
insilmaril@501
   882
# packages that should be included in the LaTeX output.
insilmaril@501
   883
insilmaril@501
   884
EXTRA_PACKAGES         = 
insilmaril@501
   885
insilmaril@501
   886
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
insilmaril@501
   887
# the generated latex document. The header should contain everything until 
insilmaril@501
   888
# the first chapter. If it is left blank doxygen will generate a 
insilmaril@501
   889
# standard header. Notice: only use this tag if you know what you are doing!
insilmaril@501
   890
insilmaril@501
   891
LATEX_HEADER           = 
insilmaril@501
   892
insilmaril@501
   893
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
insilmaril@501
   894
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
insilmaril@501
   895
# contain links (just like the HTML output) instead of page references 
insilmaril@501
   896
# This makes the output suitable for online browsing using a pdf viewer.
insilmaril@501
   897
insilmaril@728
   898
PDF_HYPERLINKS         = YES
insilmaril@501
   899
insilmaril@501
   900
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
insilmaril@501
   901
# plain latex in the generated Makefile. Set this option to YES to get a 
insilmaril@501
   902
# higher quality PDF documentation.
insilmaril@501
   903
insilmaril@728
   904
USE_PDFLATEX           = YES
insilmaril@501
   905
insilmaril@501
   906
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
insilmaril@501
   907
# command to the generated LaTeX files. This will instruct LaTeX to keep 
insilmaril@501
   908
# running if errors occur, instead of asking the user for help. 
insilmaril@501
   909
# This option is also used when generating formulas in HTML.
insilmaril@501
   910
insilmaril@501
   911
LATEX_BATCHMODE        = NO
insilmaril@501
   912
insilmaril@501
   913
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
insilmaril@501
   914
# include the index chapters (such as File Index, Compound Index, etc.) 
insilmaril@501
   915
# in the output.
insilmaril@501
   916
insilmaril@501
   917
LATEX_HIDE_INDICES     = NO
insilmaril@501
   918
insilmaril@501
   919
#---------------------------------------------------------------------------
insilmaril@501
   920
# configuration options related to the RTF output
insilmaril@501
   921
#---------------------------------------------------------------------------
insilmaril@501
   922
insilmaril@501
   923
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
insilmaril@501
   924
# The RTF output is optimized for Word 97 and may not look very pretty with 
insilmaril@501
   925
# other RTF readers or editors.
insilmaril@501
   926
insilmaril@501
   927
GENERATE_RTF           = NO
insilmaril@501
   928
insilmaril@501
   929
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
insilmaril@501
   930
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
insilmaril@501
   931
# put in front of it. If left blank `rtf' will be used as the default path.
insilmaril@501
   932
insilmaril@501
   933
RTF_OUTPUT             = rtf
insilmaril@501
   934
insilmaril@501
   935
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
insilmaril@501
   936
# RTF documents. This may be useful for small projects and may help to 
insilmaril@501
   937
# save some trees in general.
insilmaril@501
   938
insilmaril@501
   939
COMPACT_RTF            = NO
insilmaril@501
   940
insilmaril@501
   941
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
insilmaril@501
   942
# will contain hyperlink fields. The RTF file will 
insilmaril@501
   943
# contain links (just like the HTML output) instead of page references. 
insilmaril@501
   944
# This makes the output suitable for online browsing using WORD or other 
insilmaril@501
   945
# programs which support those fields. 
insilmaril@501
   946
# Note: wordpad (write) and others do not support links.
insilmaril@501
   947
insilmaril@501
   948
RTF_HYPERLINKS         = NO
insilmaril@501
   949
insilmaril@501
   950
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
insilmaril@501
   951
# config file, i.e. a series of assignments. You only have to provide 
insilmaril@501
   952
# replacements, missing definitions are set to their default value.
insilmaril@501
   953
insilmaril@501
   954
RTF_STYLESHEET_FILE    = 
insilmaril@501
   955
insilmaril@501
   956
# Set optional variables used in the generation of an rtf document. 
insilmaril@501
   957
# Syntax is similar to doxygen's config file.
insilmaril@501
   958
insilmaril@501
   959
RTF_EXTENSIONS_FILE    = 
insilmaril@501
   960
insilmaril@501
   961
#---------------------------------------------------------------------------
insilmaril@501
   962
# configuration options related to the man page output
insilmaril@501
   963
#---------------------------------------------------------------------------
insilmaril@501
   964
insilmaril@501
   965
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
insilmaril@501
   966
# generate man pages
insilmaril@501
   967
insilmaril@501
   968
GENERATE_MAN           = NO
insilmaril@501
   969
insilmaril@501
   970
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
insilmaril@501
   971
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
insilmaril@501
   972
# put in front of it. If left blank `man' will be used as the default path.
insilmaril@501
   973
insilmaril@501
   974
MAN_OUTPUT             = man
insilmaril@501
   975
insilmaril@501
   976
# The MAN_EXTENSION tag determines the extension that is added to 
insilmaril@501
   977
# the generated man pages (default is the subroutine's section .3)
insilmaril@501
   978
insilmaril@501
   979
MAN_EXTENSION          = .3
insilmaril@501
   980
insilmaril@501
   981
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
insilmaril@501
   982
# then it will generate one additional man file for each entity 
insilmaril@501
   983
# documented in the real man page(s). These additional files 
insilmaril@501
   984
# only source the real man page, but without them the man command 
insilmaril@501
   985
# would be unable to find the correct page. The default is NO.
insilmaril@501
   986
insilmaril@501
   987
MAN_LINKS              = NO
insilmaril@501
   988
insilmaril@501
   989
#---------------------------------------------------------------------------
insilmaril@501
   990
# configuration options related to the XML output
insilmaril@501
   991
#---------------------------------------------------------------------------
insilmaril@501
   992
insilmaril@501
   993
# If the GENERATE_XML tag is set to YES Doxygen will 
insilmaril@501
   994
# generate an XML file that captures the structure of 
insilmaril@501
   995
# the code including all documentation.
insilmaril@501
   996
insilmaril@501
   997
GENERATE_XML           = NO
insilmaril@501
   998
insilmaril@501
   999
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
insilmaril@501
  1000
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
insilmaril@501
  1001
# put in front of it. If left blank `xml' will be used as the default path.
insilmaril@501
  1002
insilmaril@501
  1003
XML_OUTPUT             = xml
insilmaril@501
  1004
insilmaril@501
  1005
# The XML_SCHEMA tag can be used to specify an XML schema, 
insilmaril@501
  1006
# which can be used by a validating XML parser to check the 
insilmaril@501
  1007
# syntax of the XML files.
insilmaril@501
  1008
insilmaril@501
  1009
XML_SCHEMA             = 
insilmaril@501
  1010
insilmaril@501
  1011
# The XML_DTD tag can be used to specify an XML DTD, 
insilmaril@501
  1012
# which can be used by a validating XML parser to check the 
insilmaril@501
  1013
# syntax of the XML files.
insilmaril@501
  1014
insilmaril@501
  1015
XML_DTD                = 
insilmaril@501
  1016
insilmaril@501
  1017
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
insilmaril@501
  1018
# dump the program listings (including syntax highlighting 
insilmaril@501
  1019
# and cross-referencing information) to the XML output. Note that 
insilmaril@501
  1020
# enabling this will significantly increase the size of the XML output.
insilmaril@501
  1021
insilmaril@501
  1022
XML_PROGRAMLISTING     = YES
insilmaril@501
  1023
insilmaril@501
  1024
#---------------------------------------------------------------------------
insilmaril@501
  1025
# configuration options for the AutoGen Definitions output
insilmaril@501
  1026
#---------------------------------------------------------------------------
insilmaril@501
  1027
insilmaril@501
  1028
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
insilmaril@501
  1029
# generate an AutoGen Definitions (see autogen.sf.net) file 
insilmaril@501
  1030
# that captures the structure of the code including all 
insilmaril@501
  1031
# documentation. Note that this feature is still experimental 
insilmaril@501
  1032
# and incomplete at the moment.
insilmaril@501
  1033
insilmaril@501
  1034
GENERATE_AUTOGEN_DEF   = NO
insilmaril@501
  1035
insilmaril@501
  1036
#---------------------------------------------------------------------------
insilmaril@501
  1037
# configuration options related to the Perl module output
insilmaril@501
  1038
#---------------------------------------------------------------------------
insilmaril@501
  1039
insilmaril@501
  1040
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
insilmaril@501
  1041
# generate a Perl module file that captures the structure of 
insilmaril@501
  1042
# the code including all documentation. Note that this 
insilmaril@501
  1043
# feature is still experimental and incomplete at the 
insilmaril@501
  1044
# moment.
insilmaril@501
  1045
insilmaril@501
  1046
GENERATE_PERLMOD       = NO
insilmaril@501
  1047
insilmaril@501
  1048
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
insilmaril@501
  1049
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
insilmaril@501
  1050
# to generate PDF and DVI output from the Perl module output.
insilmaril@501
  1051
insilmaril@501
  1052
PERLMOD_LATEX          = NO
insilmaril@501
  1053
insilmaril@501
  1054
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
insilmaril@501
  1055
# nicely formatted so it can be parsed by a human reader.  This is useful 
insilmaril@501
  1056
# if you want to understand what is going on.  On the other hand, if this 
insilmaril@501
  1057
# tag is set to NO the size of the Perl module output will be much smaller 
insilmaril@501
  1058
# and Perl will parse it just the same.
insilmaril@501
  1059
insilmaril@501
  1060
PERLMOD_PRETTY         = YES
insilmaril@501
  1061
insilmaril@501
  1062
# The names of the make variables in the generated doxyrules.make file 
insilmaril@501
  1063
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
insilmaril@501
  1064
# This is useful so different doxyrules.make files included by the same 
insilmaril@501
  1065
# Makefile don't overwrite each other's variables.
insilmaril@501
  1066
insilmaril@501
  1067
PERLMOD_MAKEVAR_PREFIX = 
insilmaril@501
  1068
insilmaril@501
  1069
#---------------------------------------------------------------------------
insilmaril@501
  1070
# Configuration options related to the preprocessor   
insilmaril@501
  1071
#---------------------------------------------------------------------------
insilmaril@501
  1072
insilmaril@501
  1073
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
insilmaril@501
  1074
# evaluate all C-preprocessor directives found in the sources and include 
insilmaril@501
  1075
# files.
insilmaril@501
  1076
insilmaril@501
  1077
ENABLE_PREPROCESSING   = YES
insilmaril@501
  1078
insilmaril@501
  1079
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
insilmaril@501
  1080
# names in the source code. If set to NO (the default) only conditional 
insilmaril@501
  1081
# compilation will be performed. Macro expansion can be done in a controlled 
insilmaril@501
  1082
# way by setting EXPAND_ONLY_PREDEF to YES.
insilmaril@501
  1083
insilmaril@501
  1084
MACRO_EXPANSION        = NO
insilmaril@501
  1085
insilmaril@501
  1086
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
insilmaril@501
  1087
# then the macro expansion is limited to the macros specified with the 
insilmaril@501
  1088
# PREDEFINED and EXPAND_AS_DEFINED tags.
insilmaril@501
  1089
insilmaril@501
  1090
EXPAND_ONLY_PREDEF     = NO
insilmaril@501
  1091
insilmaril@501
  1092
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
insilmaril@501
  1093
# in the INCLUDE_PATH (see below) will be search if a #include is found.
insilmaril@501
  1094
insilmaril@501
  1095
SEARCH_INCLUDES        = YES
insilmaril@501
  1096
insilmaril@501
  1097
# The INCLUDE_PATH tag can be used to specify one or more directories that 
insilmaril@501
  1098
# contain include files that are not input files but should be processed by 
insilmaril@501
  1099
# the preprocessor.
insilmaril@501
  1100
insilmaril@501
  1101
INCLUDE_PATH           = 
insilmaril@501
  1102
insilmaril@501
  1103
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
insilmaril@501
  1104
# patterns (like *.h and *.hpp) to filter out the header-files in the 
insilmaril@501
  1105
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
insilmaril@501
  1106
# be used.
insilmaril@501
  1107
insilmaril@501
  1108
INCLUDE_FILE_PATTERNS  = 
insilmaril@501
  1109
insilmaril@501
  1110
# The PREDEFINED tag can be used to specify one or more macro names that 
insilmaril@501
  1111
# are defined before the preprocessor is started (similar to the -D option of 
insilmaril@501
  1112
# gcc). The argument of the tag is a list of macros of the form: name 
insilmaril@501
  1113
# or name=definition (no spaces). If the definition and the = are 
insilmaril@501
  1114
# omitted =1 is assumed. To prevent a macro definition from being 
insilmaril@501
  1115
# undefined via #undef or recursively expanded use the := operator 
insilmaril@501
  1116
# instead of the = operator.
insilmaril@501
  1117
insilmaril@501
  1118
PREDEFINED             = 
insilmaril@501
  1119
insilmaril@501
  1120
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
insilmaril@501
  1121
# this tag can be used to specify a list of macro names that should be expanded. 
insilmaril@501
  1122
# The macro definition that is found in the sources will be used. 
insilmaril@501
  1123
# Use the PREDEFINED tag if you want to use a different macro definition.
insilmaril@501
  1124
insilmaril@501
  1125
EXPAND_AS_DEFINED      = 
insilmaril@501
  1126
insilmaril@501
  1127
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
insilmaril@501
  1128
# doxygen's preprocessor will remove all function-like macros that are alone 
insilmaril@501
  1129
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
insilmaril@501
  1130
# function macros are typically used for boiler-plate code, and will confuse 
insilmaril@501
  1131
# the parser if not removed.
insilmaril@501
  1132
insilmaril@501
  1133
SKIP_FUNCTION_MACROS   = YES
insilmaril@501
  1134
insilmaril@501
  1135
#---------------------------------------------------------------------------
insilmaril@501
  1136
# Configuration::additions related to external references   
insilmaril@501
  1137
#---------------------------------------------------------------------------
insilmaril@501
  1138
insilmaril@501
  1139
# The TAGFILES option can be used to specify one or more tagfiles. 
insilmaril@501
  1140
# Optionally an initial location of the external documentation 
insilmaril@501
  1141
# can be added for each tagfile. The format of a tag file without 
insilmaril@501
  1142
# this location is as follows: 
insilmaril@501
  1143
#   TAGFILES = file1 file2 ... 
insilmaril@501
  1144
# Adding location for the tag files is done as follows: 
insilmaril@501
  1145
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
insilmaril@501
  1146
# where "loc1" and "loc2" can be relative or absolute paths or 
insilmaril@501
  1147
# URLs. If a location is present for each tag, the installdox tool 
insilmaril@501
  1148
# does not have to be run to correct the links.
insilmaril@501
  1149
# Note that each tag file must have a unique name
insilmaril@501
  1150
# (where the name does NOT include the path)
insilmaril@501
  1151
# If a tag file is not located in the directory in which doxygen 
insilmaril@501
  1152
# is run, you must also specify the path to the tagfile here.
insilmaril@501
  1153
insilmaril@501
  1154
TAGFILES               = 
insilmaril@501
  1155
insilmaril@501
  1156
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
insilmaril@501
  1157
# a tag file that is based on the input files it reads.
insilmaril@501
  1158
insilmaril@501
  1159
GENERATE_TAGFILE       = 
insilmaril@501
  1160
insilmaril@501
  1161
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
insilmaril@501
  1162
# in the class index. If set to NO only the inherited external classes 
insilmaril@501
  1163
# will be listed.
insilmaril@501
  1164
insilmaril@501
  1165
ALLEXTERNALS           = NO
insilmaril@501
  1166
insilmaril@501
  1167
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
insilmaril@501
  1168
# in the modules index. If set to NO, only the current project's groups will 
insilmaril@501
  1169
# be listed.
insilmaril@501
  1170
insilmaril@501
  1171
EXTERNAL_GROUPS        = YES
insilmaril@501
  1172
insilmaril@501
  1173
# The PERL_PATH should be the absolute path and name of the perl script 
insilmaril@501
  1174
# interpreter (i.e. the result of `which perl').
insilmaril@501
  1175
insilmaril@501
  1176
PERL_PATH              = /usr/bin/perl
insilmaril@501
  1177
insilmaril@501
  1178
#---------------------------------------------------------------------------
insilmaril@501
  1179
# Configuration options related to the dot tool   
insilmaril@501
  1180
#---------------------------------------------------------------------------
insilmaril@501
  1181
insilmaril@501
  1182
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
insilmaril@501
  1183
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
insilmaril@501
  1184
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
insilmaril@501
  1185
# this option is superseded by the HAVE_DOT option below. This is only a 
insilmaril@501
  1186
# fallback. It is recommended to install and use dot, since it yields more 
insilmaril@501
  1187
# powerful graphs.
insilmaril@501
  1188
insilmaril@501
  1189
CLASS_DIAGRAMS         = YES
insilmaril@501
  1190
insilmaril@728
  1191
# You can define message sequence charts within doxygen comments using the \msc 
insilmaril@728
  1192
# command. Doxygen will then run the mscgen tool (see 
insilmaril@728
  1193
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
insilmaril@728
  1194
# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
insilmaril@728
  1195
# the mscgen tool resides. If left empty the tool is assumed to be found in the 
insilmaril@728
  1196
# default search path.
insilmaril@728
  1197
insilmaril@728
  1198
MSCGEN_PATH            = 
insilmaril@728
  1199
insilmaril@501
  1200
# If set to YES, the inheritance and collaboration graphs will hide 
insilmaril@501
  1201
# inheritance and usage relations if the target is undocumented 
insilmaril@501
  1202
# or is not a class.
insilmaril@501
  1203
insilmaril@501
  1204
HIDE_UNDOC_RELATIONS   = YES
insilmaril@501
  1205
insilmaril@501
  1206
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
insilmaril@501
  1207
# available from the path. This tool is part of Graphviz, a graph visualization 
insilmaril@501
  1208
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
insilmaril@501
  1209
# have no effect if this option is set to NO (the default)
insilmaril@501
  1210
insilmaril@501
  1211
HAVE_DOT               = NO
insilmaril@501
  1212
insilmaril@501
  1213
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
insilmaril@501
  1214
# will generate a graph for each documented class showing the direct and 
insilmaril@501
  1215
# indirect inheritance relations. Setting this tag to YES will force the 
insilmaril@501
  1216
# the CLASS_DIAGRAMS tag to NO.
insilmaril@501
  1217
insilmaril@501
  1218
CLASS_GRAPH            = YES
insilmaril@501
  1219
insilmaril@501
  1220
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
insilmaril@501
  1221
# will generate a graph for each documented class showing the direct and 
insilmaril@501
  1222
# indirect implementation dependencies (inheritance, containment, and 
insilmaril@501
  1223
# class references variables) of the class with other documented classes.
insilmaril@501
  1224
insilmaril@501
  1225
COLLABORATION_GRAPH    = YES
insilmaril@501
  1226
insilmaril@501
  1227
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
insilmaril@501
  1228
# will generate a graph for groups, showing the direct groups dependencies
insilmaril@501
  1229
insilmaril@501
  1230
GROUP_GRAPHS           = YES
insilmaril@501
  1231
insilmaril@501
  1232
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
insilmaril@501
  1233
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
insilmaril@501
  1234
# Language.
insilmaril@501
  1235
insilmaril@501
  1236
UML_LOOK               = NO
insilmaril@501
  1237
insilmaril@501
  1238
# If set to YES, the inheritance and collaboration graphs will show the 
insilmaril@501
  1239
# relations between templates and their instances.
insilmaril@501
  1240
insilmaril@501
  1241
TEMPLATE_RELATIONS     = NO
insilmaril@501
  1242
insilmaril@501
  1243
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
insilmaril@501
  1244
# tags are set to YES then doxygen will generate a graph for each documented 
insilmaril@501
  1245
# file showing the direct and indirect include dependencies of the file with 
insilmaril@501
  1246
# other documented files.
insilmaril@501
  1247
insilmaril@501
  1248
INCLUDE_GRAPH          = YES
insilmaril@501
  1249
insilmaril@501
  1250
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
insilmaril@501
  1251
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
insilmaril@501
  1252
# documented header file showing the documented files that directly or 
insilmaril@501
  1253
# indirectly include this file.
insilmaril@501
  1254
insilmaril@501
  1255
INCLUDED_BY_GRAPH      = YES
insilmaril@501
  1256
insilmaril@728
  1257
# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
insilmaril@728
  1258
# doxygen will generate a call dependency graph for every global function 
insilmaril@728
  1259
# or class method. Note that enabling this option will significantly increase 
insilmaril@728
  1260
# the time of a run. So in most cases it will be better to enable call graphs 
insilmaril@728
  1261
# for selected functions only using the \callgraph command.
insilmaril@501
  1262
insilmaril@501
  1263
CALL_GRAPH             = NO
insilmaril@501
  1264
insilmaril@728
  1265
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
insilmaril@728
  1266
# doxygen will generate a caller dependency graph for every global function 
insilmaril@728
  1267
# or class method. Note that enabling this option will significantly increase 
insilmaril@728
  1268
# the time of a run. So in most cases it will be better to enable caller 
insilmaril@728
  1269
# graphs for selected functions only using the \callergraph command.
insilmaril@501
  1270
insilmaril@501
  1271
CALLER_GRAPH           = NO
insilmaril@501
  1272
insilmaril@501
  1273
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
insilmaril@501
  1274
# will graphical hierarchy of all classes instead of a textual one.
insilmaril@501
  1275
insilmaril@501
  1276
GRAPHICAL_HIERARCHY    = YES
insilmaril@501
  1277
insilmaril@501
  1278
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
insilmaril@501
  1279
# then doxygen will show the dependencies a directory has on other directories 
insilmaril@501
  1280
# in a graphical way. The dependency relations are determined by the #include
insilmaril@501
  1281
# relations between the files in the directories.
insilmaril@501
  1282
insilmaril@501
  1283
DIRECTORY_GRAPH        = YES
insilmaril@501
  1284
insilmaril@501
  1285
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
insilmaril@501
  1286
# generated by dot. Possible values are png, jpg, or gif
insilmaril@501
  1287
# If left blank png will be used.
insilmaril@501
  1288
insilmaril@501
  1289
DOT_IMAGE_FORMAT       = png
insilmaril@501
  1290
insilmaril@501
  1291
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
insilmaril@501
  1292
# found. If left blank, it is assumed the dot tool can be found in the path.
insilmaril@501
  1293
insilmaril@501
  1294
DOT_PATH               = 
insilmaril@501
  1295
insilmaril@501
  1296
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
insilmaril@501
  1297
# contain dot files that are included in the documentation (see the 
insilmaril@501
  1298
# \dotfile command).
insilmaril@501
  1299
insilmaril@501
  1300
DOTFILE_DIRS           = 
insilmaril@501
  1301
insilmaril@728
  1302
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
insilmaril@728
  1303
# nodes that will be shown in the graph. If the number of nodes in a graph 
insilmaril@728
  1304
# becomes larger than this value, doxygen will truncate the graph, which is 
insilmaril@728
  1305
# visualized by representing a node as a red box. Note that doxygen if the 
insilmaril@728
  1306
# number of direct children of the root node in a graph is already larger than 
insilmaril@728
  1307
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
insilmaril@728
  1308
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
insilmaril@501
  1309
insilmaril@728
  1310
DOT_GRAPH_MAX_NODES    = 50
insilmaril@501
  1311
insilmaril@501
  1312
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
insilmaril@501
  1313
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
insilmaril@501
  1314
# from the root by following a path via at most 3 edges will be shown. Nodes 
insilmaril@501
  1315
# that lay further from the root node will be omitted. Note that setting this 
insilmaril@501
  1316
# option to 1 or 2 may greatly reduce the computation time needed for large 
insilmaril@728
  1317
# code bases. Also note that the size of a graph can be further restricted by 
insilmaril@728
  1318
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
insilmaril@501
  1319
insilmaril@501
  1320
MAX_DOT_GRAPH_DEPTH    = 0
insilmaril@501
  1321
insilmaril@501
  1322
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
insilmaril@728
  1323
# background. This is enabled by default, which results in a transparent 
insilmaril@728
  1324
# background. Warning: Depending on the platform used, enabling this option 
insilmaril@728
  1325
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 
insilmaril@728
  1326
# become hard to read).
insilmaril@501
  1327
insilmaril@728
  1328
DOT_TRANSPARENT        = YES
insilmaril@501
  1329
insilmaril@501
  1330
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
insilmaril@501
  1331
# files in one run (i.e. multiple -o and -T options on the command line). This 
insilmaril@501
  1332
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
insilmaril@501
  1333
# support this, this feature is disabled by default.
insilmaril@501
  1334
insilmaril@501
  1335
DOT_MULTI_TARGETS      = NO
insilmaril@501
  1336
insilmaril@501
  1337
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
insilmaril@501
  1338
# generate a legend page explaining the meaning of the various boxes and 
insilmaril@501
  1339
# arrows in the dot generated graphs.
insilmaril@501
  1340
insilmaril@501
  1341
GENERATE_LEGEND        = YES
insilmaril@501
  1342
insilmaril@501
  1343
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
insilmaril@501
  1344
# remove the intermediate dot files that are used to generate 
insilmaril@501
  1345
# the various graphs.
insilmaril@501
  1346
insilmaril@501
  1347
DOT_CLEANUP            = YES
insilmaril@501
  1348
insilmaril@501
  1349
#---------------------------------------------------------------------------
insilmaril@501
  1350
# Configuration::additions related to the search engine   
insilmaril@501
  1351
#---------------------------------------------------------------------------
insilmaril@501
  1352
insilmaril@501
  1353
# The SEARCHENGINE tag specifies whether or not a search engine should be 
insilmaril@501
  1354
# used. If set to NO the values of all tags below this one will be ignored.
insilmaril@501
  1355
insilmaril@501
  1356
SEARCHENGINE           = NO