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