Subversion Repositories Scribus

Rev

Rev 9672 | Rev 13956 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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