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