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