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