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