Doxyfile 62.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
# Doxyfile 1.5.9

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
12
13

#---------------------------------------------------------------------------
Naumann, Andreas's avatar
Naumann, Andreas committed
14
# Project related configuration options
15
#---------------------------------------------------------------------------
16
17
18
19
20
21
22

# This tag specifies the encoding used for all characters in the config file 
# that follow. The default is UTF-8 which is also the encoding used for all 
# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
# iconv built into libc) for the transcoding. See 
# http://www.gnu.org/software/libiconv for the list of possible encodings.

Naumann, Andreas's avatar
Naumann, Andreas committed
23
DOXYFILE_ENCODING      = UTF-8
24
25
26
27

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
# by quotes) that should identify the project.

28
PROJECT_NAME           = AMDiS
29
30
31
32
33

# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
# This could be handy for archiving the generated documentation or 
# if some version control system is used.

34
PROJECT_NUMBER         = 
35
36
37
38
39
40

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
# base path where the generated documentation will be put. 
# If a relative path is entered, it will be relative to the location 
# where doxygen was started. If left blank the current directory will be used.

41
OUTPUT_DIRECTORY       = .
42
43
44
45
46
47
48
49

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
# 4096 sub-directories (in 2 levels) under the output directory of each output 
# format and will distribute the generated files over these directories. 
# Enabling this option can be useful when feeding doxygen a huge amount of 
# source files, where putting all generated files in the same directory would 
# otherwise cause performance problems for the file system.

Naumann, Andreas's avatar
Naumann, Andreas committed
50
CREATE_SUBDIRS         = NO
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
# documentation generated by doxygen is written. Doxygen will use this 
# information to generate all constant output in the proper language. 
# The default language is English, other supported languages are: 
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.

OUTPUT_LANGUAGE        = German

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
# include brief member descriptions after the members that are listed in 
# the file and class documentation (similar to JavaDoc). 
# Set to NO to disable this.

70
BRIEF_MEMBER_DESC      = YES
71
72
73
74
75
76

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
# the brief description of a member or function before the detailed description. 
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
# brief descriptions will be completely suppressed.

77
REPEAT_BRIEF           = YES
78
79
80
81
82
83
84
85
86
87
88

# This tag implements a quasi-intelligent brief description abbreviator 
# that is used to form the text in various listings. Each string 
# in this list, if found as the leading text of the brief description, will be 
# stripped from the text and the result after processing the whole list, is 
# used as the annotated text. Otherwise, the brief description is used as-is. 
# If left blank, the following values are used ("$name" is automatically 
# replaced with the name of the entity): "The $name class" "The $name widget" 
# "The $name file" "is" "provides" "specifies" "contains" 
# "represents" "a" "an" "the"

Naumann, Andreas's avatar
Naumann, Andreas committed
89
90
91
92
93
94
95
96
97
98
99
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the
100
101
102
103
104

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
# Doxygen will generate a detailed section even if there is only a brief 
# description.

105
ALWAYS_DETAILED_SEC    = NO
106
107
108
109
110
111

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
# inherited members of a class in the documentation of that class as if those 
# members were ordinary class members. Constructors, destructors and assignment 
# operators of the base classes will not be shown.

112
INLINE_INHERITED_MEMB  = NO
113
114
115
116
117

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
# path before files name in the file list and in the header files. If set 
# to NO the shortest path that makes the file name unique will be used.

118
FULL_PATH_NAMES        = NO
119
120
121
122
123
124
125
126

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
# can be used to strip a user-defined part of the path. Stripping is 
# only done if one of the specified strings matches the left-hand part of 
# the path. The tag can be used to show relative paths in the file list. 
# If left blank the directory from which doxygen is run is used as the 
# path to strip.

127
STRIP_FROM_PATH        = 
128
129
130
131
132
133
134
135

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
# the path mentioned in the documentation of a class, which tells 
# the reader which header file to include in order to use a class. 
# If left blank only the name of the header file containing the class 
# definition is used. Otherwise one should specify the include paths that 
# are normally passed to the compiler using the -I flag.

Naumann, Andreas's avatar
Naumann, Andreas committed
136
STRIP_FROM_INC_PATH    = 
137
138
139
140
141

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
# (but less readable) file names. This can be useful is your file systems 
# doesn't support long names like on DOS, Mac, or CD-ROM.

Naumann, Andreas's avatar
Naumann, Andreas committed
142
SHORT_NAMES            = NO
143
144
145
146
147
148
149

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
# will interpret the first line (until the first dot) of a JavaDoc-style 
# comment as the brief description. If set to NO, the JavaDoc 
# comments will behave just like regular Qt-style comments 
# (thus requiring an explicit @brief command for a brief description.)

Naumann, Andreas's avatar
Naumann, Andreas committed
150
JAVADOC_AUTOBRIEF      = NO
151
152
153
154
155
156
157

# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
# interpret the first line (until the first dot) of a Qt-style 
# comment as the brief description. If set to NO, the comments 
# will behave just like regular Qt-style comments (thus requiring 
# an explicit \brief command for a brief description.)

Naumann, Andreas's avatar
Naumann, Andreas committed
158
QT_AUTOBRIEF           = NO
159
160
161
162
163
164
165

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
# comments) as a brief description. This used to be the default behaviour. 
# The new default is to treat a multi-line C++ comment block as a detailed 
# description. Set this tag to YES if you prefer the old behaviour instead.

Naumann, Andreas's avatar
Naumann, Andreas committed
166
MULTILINE_CPP_IS_BRIEF = NO
167
168
169
170
171

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
# member inherits the documentation from any documented member that it 
# re-implements.

Naumann, Andreas's avatar
Naumann, Andreas committed
172
INHERIT_DOCS           = YES
173
174
175
176
177

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
# a new page for each member. If set to NO, the documentation of a member will 
# be part of the file/class/namespace that contains it.

Naumann, Andreas's avatar
Naumann, Andreas committed
178
SEPARATE_MEMBER_PAGES  = NO
179
180
181
182

# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
# Doxygen uses this value to replace tabs by spaces in code fragments.

Naumann, Andreas's avatar
Naumann, Andreas committed
183
TAB_SIZE               = 8
184
185
186
187
188
189
190
191

# This tag can be used to specify a number of aliases that acts 
# as commands in the documentation. An alias has the form "name=value". 
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
# put the command \sideeffect (or @sideeffect) in the documentation, which 
# will result in a user-defined paragraph with heading "Side Effects:". 
# You can put \n's in the value part of an alias to insert newlines.

Naumann, Andreas's avatar
Naumann, Andreas committed
192
ALIASES                = 
193
194
195
196
197
198

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
# sources only. Doxygen will then generate output that is more tailored for C. 
# For instance, some of the names that are used will be different. The list 
# of all members will be omitted, etc.

Naumann, Andreas's avatar
Naumann, Andreas committed
199
OPTIMIZE_OUTPUT_FOR_C  = NO
200
201
202
203
204
205

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
# sources only. Doxygen will then generate output that is more tailored for 
# Java. For instance, namespaces will be presented as packages, qualified 
# scopes will look different, etc.

Naumann, Andreas's avatar
Naumann, Andreas committed
206
OPTIMIZE_OUTPUT_JAVA   = NO
207
208
209
210
211

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
# sources only. Doxygen will then generate output that is more tailored for 
# Fortran.

Naumann, Andreas's avatar
Naumann, Andreas committed
212
OPTIMIZE_FOR_FORTRAN   = NO
213
214
215
216
217

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
# sources. Doxygen will then generate output that is tailored for 
# VHDL.

Naumann, Andreas's avatar
Naumann, Andreas committed
218
OPTIMIZE_OUTPUT_VHDL   = NO
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

# Doxygen selects the parser to use depending on the extension of the files it parses. 
# With this tag you can assign which parser to use for a given extension. 
# Doxygen has a built-in mapping, but you can override or extend it using this tag. 
# The format is ext=language, where ext is a file extension, and language is one of 
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 
# use: inc=Fortran f=C. Note that for custom extensions you also need to set
# FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING      = 

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
# to include (a tag file for) the STL sources as input, then you should 
# set this tag to YES in order to let doxygen match functions declarations and 
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
# func(std::string) {}). This also make the inheritance and collaboration 
# diagrams that involve STL classes more complete and accurate.

Naumann, Andreas's avatar
Naumann, Andreas committed
239
BUILTIN_STL_SUPPORT    = NO
240
241
242
243

# If you use Microsoft's C++/CLI language, you should set this option to YES to 
# enable parsing support.

Naumann, Andreas's avatar
Naumann, Andreas committed
244
CPP_CLI_SUPPORT        = NO
245
246
247
248
249

# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
# Doxygen will parse them like normal C++ but will assume all classes use public 
# instead of private inheritance when no explicit protection keyword is present.

Naumann, Andreas's avatar
Naumann, Andreas committed
250
SIP_SUPPORT            = NO
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

# For Microsoft's IDL there are propget and propput attributes to indicate getter 
# and setter methods for a property. Setting this option to YES (the default) 
# will make doxygen to replace the get and set methods by a property in the 
# documentation. This will only work if the methods are indeed getting or 
# setting a simple type. If this is not the case, or you want to show the 
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
# tag is set to YES, then doxygen will reuse the documentation of the first 
# member in the group (if any) for the other members of the group. By default 
# all members of a group must be documented explicitly.

Naumann, Andreas's avatar
Naumann, Andreas committed
266
DISTRIBUTE_GROUP_DOC   = NO
267
268
269
270
271
272
273

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
# the same type (for instance a group of public functions) to be put as a 
# subgroup of that type (e.g. under the Public Functions section). Set it to 
# NO to prevent subgrouping. Alternatively, this can be done per class using 
# the \nosubgrouping command.

Naumann, Andreas's avatar
Naumann, Andreas committed
274
SUBGROUPING            = YES
275
276
277
278
279
280
281
282
283

# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
# is documented as struct, union, or enum with the name of the typedef. So 
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
# with name TypeT. When disabled the typedef will appear as a member of a file, 
# namespace, or class. And the struct will be named TypeS. This can typically 
# be useful for C code in case the coding convention dictates that all compound 
# types are typedef'ed and only the typedef is referenced, never the tag name.

Naumann, Andreas's avatar
Naumann, Andreas committed
284
TYPEDEF_HIDES_STRUCT   = NO
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301

# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
# determine which symbols to keep in memory and which to flush to disk. 
# When the cache is full, less often used symbols will be written to disk. 
# For small to medium size projects (<1000 input files) the default value is 
# probably good enough. For larger projects a too small cache size can cause 
# doxygen to be busy swapping symbols to and from disk most of the time 
# causing a significant performance penality. 
# If the system has enough physical memory increasing the cache will improve the 
# performance by keeping more symbols in memory. Note that the value works on 
# a logarithmic scale so increasing the size by one will rougly double the 
# memory usage. The cache size is given by this formula: 
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
# corresponding to a cache size of 2^16 = 65536 symbols

SYMBOL_CACHE_SIZE      = 0

Naumann, Andreas's avatar
Naumann, Andreas committed
302
303
304
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
305
306
307
308
309
310

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
# documentation are documented, even if no documentation was available. 
# Private class members and static file members will be hidden unless 
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

Naumann, Andreas's avatar
Naumann, Andreas committed
311
EXTRACT_ALL            = YES
312
313
314
315

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
# will be included in the documentation.

Naumann, Andreas's avatar
Naumann, Andreas committed
316
EXTRACT_PRIVATE        = YES
317
318
319
320

# If the EXTRACT_STATIC tag is set to YES all static members of a file 
# will be included in the documentation.

Naumann, Andreas's avatar
Naumann, Andreas committed
321
EXTRACT_STATIC         = YES
322
323
324
325
326

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
# defined locally in source files will be included in the documentation. 
# If set to NO only classes defined in header files are included.

Naumann, Andreas's avatar
Naumann, Andreas committed
327
EXTRACT_LOCAL_CLASSES  = YES
328
329
330
331
332
333

# This flag is only useful for Objective-C code. When set to YES local 
# methods, which are defined in the implementation section but not in 
# the interface are included in the documentation. 
# If set to NO (the default) only methods in the interface are included.

Naumann, Andreas's avatar
Naumann, Andreas committed
334
EXTRACT_LOCAL_METHODS  = NO
335
336
337
338
339
340
341

# If this flag is set to YES, the members of anonymous namespaces will be 
# extracted and appear in the documentation as a namespace called 
# 'anonymous_namespace{file}', where file will be replaced with the base 
# name of the file that contains the anonymous namespace. By default 
# anonymous namespace are hidden.

Naumann, Andreas's avatar
Naumann, Andreas committed
342
EXTRACT_ANON_NSPACES   = NO
343
344
345
346
347
348
349

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
# undocumented members of documented classes, files or namespaces. 
# If set to NO (the default) these members will be included in the 
# various overviews, but no documentation section is generated. 
# This option has no effect if EXTRACT_ALL is enabled.

Naumann, Andreas's avatar
Naumann, Andreas committed
350
HIDE_UNDOC_MEMBERS     = NO
351
352
353
354
355
356

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
# undocumented classes that are normally visible in the class hierarchy. 
# If set to NO (the default) these classes will be included in the various 
# overviews. This option has no effect if EXTRACT_ALL is enabled.

Naumann, Andreas's avatar
Naumann, Andreas committed
357
HIDE_UNDOC_CLASSES     = NO
358
359
360
361
362
363

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
# friend (class|struct|union) declarations. 
# If set to NO (the default) these declarations will be included in the 
# documentation.

Naumann, Andreas's avatar
Naumann, Andreas committed
364
HIDE_FRIEND_COMPOUNDS  = NO
365
366
367
368
369
370

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
# documentation blocks found inside the body of a function. 
# If set to NO (the default) these blocks will be appended to the 
# function's detailed documentation block.

Naumann, Andreas's avatar
Naumann, Andreas committed
371
HIDE_IN_BODY_DOCS      = NO
372
373
374
375
376
377

# The INTERNAL_DOCS tag determines if documentation 
# that is typed after a \internal command is included. If the tag is set 
# to NO (the default) then the documentation will be excluded. 
# Set it to YES to include the internal documentation.

378
INTERNAL_DOCS          = NO
379
380
381
382
383
384
385

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
# file names in lower-case letters. If set to YES upper-case letters are also 
# allowed. This is useful if you have classes or files whose names only differ 
# in case and if your file system supports case sensitive file names. Windows 
# and Mac users are advised to set this option to NO.

386
CASE_SENSE_NAMES       = YES
387
388
389
390
391

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
# will show members with their full class and namespace scopes in the 
# documentation. If set to YES the scope will be hidden.

392
HIDE_SCOPE_NAMES       = NO
393
394
395
396
397

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
# will put a list of the files that are included by a file in the documentation 
# of that file.

398
SHOW_INCLUDE_FILES     = YES
399
400
401
402

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
# is inserted in the documentation for inline members.

403
INLINE_INFO            = YES
404
405
406
407
408
409

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
# will sort the (detailed) documentation of file and class members 
# alphabetically by member name. If set to NO the members will appear in 
# declaration order.

410
SORT_MEMBER_DOCS       = YES
411
412
413
414
415
416

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
# brief documentation of file, namespace and class members alphabetically 
# by member name. If set to NO (the default) the members will appear in 
# declaration order.

Naumann, Andreas's avatar
Naumann, Andreas committed
417
SORT_BRIEF_DOCS        = NO
418
419
420
421
422

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
# hierarchy of group names into alphabetical order. If set to NO (the default) 
# the group names will appear in their defined order.

Naumann, Andreas's avatar
Naumann, Andreas committed
423
SORT_GROUP_NAMES       = NO
424
425
426
427
428
429
430
431
432

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
# sorted by fully-qualified names, including namespaces. If set to 
# NO (the default), the class list will be sorted only by class name, 
# not including the namespace part. 
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
# Note: This option applies only to the class list, not to the 
# alphabetical list.

Naumann, Andreas's avatar
Naumann, Andreas committed
433
SORT_BY_SCOPE_NAME     = NO
434
435
436
437
438

# The GENERATE_TODOLIST tag can be used to enable (YES) or 
# disable (NO) the todo list. This list is created by putting \todo 
# commands in the documentation.

439
GENERATE_TODOLIST      = YES
440
441
442
443
444

# The GENERATE_TESTLIST tag can be used to enable (YES) or 
# disable (NO) the test list. This list is created by putting \test 
# commands in the documentation.

445
GENERATE_TESTLIST      = YES
446
447
448
449
450

# The GENERATE_BUGLIST tag can be used to enable (YES) or 
# disable (NO) the bug list. This list is created by putting \bug 
# commands in the documentation.

451
GENERATE_BUGLIST       = YES
452
453
454
455
456

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
# disable (NO) the deprecated list. This list is created by putting 
# \deprecated commands in the documentation.

Naumann, Andreas's avatar
Naumann, Andreas committed
457
GENERATE_DEPRECATEDLIST= YES
458
459
460
461

# The ENABLED_SECTIONS tag can be used to enable conditional 
# documentation sections, marked by \if sectionname ... \endif.

462
ENABLED_SECTIONS       = 
463
464
465
466
467
468
469
470
471

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
# the initial value of a variable or define consists of for it to appear in 
# the documentation. If the initializer consists of more lines than specified 
# here it will be hidden. Use a value of 0 to hide initializers completely. 
# The appearance of the initializer of individual variables and defines in the 
# documentation can be controlled using \showinitializer or \hideinitializer 
# command in the documentation regardless of this setting.

472
MAX_INITIALIZER_LINES  = 30
473
474
475
476
477

# If the sources in your project are distributed over multiple directories 
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
# in the documentation. The default is NO.

Naumann, Andreas's avatar
Naumann, Andreas committed
478
SHOW_DIRECTORIES       = NO
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499

# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
# This will remove the Files entry from the Quick Index and from the 
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
# Namespaces page.  This will remove the Namespaces entry from the Quick Index 
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
# doxygen should invoke to get the current version for each file (typically from 
# the version control system). Doxygen will invoke the program by executing (via 
# popen()) the command <command> <input-file>, where <command> is the value of 
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
# provided by doxygen. Whatever the program writes to standard output 
# is used as the file version. See the manual for examples.

Naumann, Andreas's avatar
Naumann, Andreas committed
500
FILE_VERSION_FILTER    = 
501
502
503
504
505
506
507
508
509
510

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
# doxygen. The layout file controls the global structure of the generated output files 
# in an output format independent way. The create the layout file that represents 
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
# file name after the option, if omitted DoxygenLayout.xml will be used as the name 
# of the layout file.

LAYOUT_FILE            = 

511
512
513
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
514
515
516
517

# The QUIET tag can be used to turn on/off the messages that are generated 
# by doxygen. Possible values are YES and NO. If left blank NO is used.

518
QUIET                  = NO
519
520
521
522
523

# The WARNINGS tag can be used to turn on/off the warning messages that are 
# generated by doxygen. Possible values are YES and NO. If left blank 
# NO is used.

524
WARNINGS               = YES
525
526
527
528
529

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
# automatically be disabled.

530
WARN_IF_UNDOCUMENTED   = YES
531
532
533
534
535
536

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
# potential errors in the documentation, such as not documenting some 
# parameters in a documented function, or documenting parameters that 
# don't exist or using markup commands wrongly.

Naumann, Andreas's avatar
Naumann, Andreas committed
537
WARN_IF_DOC_ERROR      = YES
538
539
540
541
542
543
544

# This WARN_NO_PARAMDOC option can be abled to get warnings for 
# functions that are documented, but have no documentation for their parameters 
# or return value. If set to NO (the default) doxygen will only warn about 
# wrong or incomplete parameter documentation, but not about the absence of 
# documentation.

Naumann, Andreas's avatar
Naumann, Andreas committed
545
WARN_NO_PARAMDOC       = NO
546
547
548
549
550
551
552
553

# The WARN_FORMAT tag determines the format of the warning messages that 
# doxygen can produce. The string should contain the $file, $line, and $text 
# tags, which will be replaced by the file and line number from which the 
# warning originated and the warning text. Optionally the format may contain 
# $version, which will be replaced by the version of the file (if it could 
# be obtained via FILE_VERSION_FILTER)

554
WARN_FORMAT            = "$file:$line: $text"
555
556
557
558
559

# The WARN_LOGFILE tag can be used to specify a file to which warning 
# and error messages should be written. If left blank the output is written 
# to stderr.

560
WARN_LOGFILE           = 
561

562
563
564
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
565
566
567
568
569
570

# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
# with spaces.

571
INPUT                  = ../src/
572
573
574
575
576
577
578

# This tag can be used to specify the character encoding of the source files 
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
# the list of possible encodings.

Naumann, Andreas's avatar
Naumann, Andreas committed
579
INPUT_ENCODING         = UTF-8
580
581
582
583
584
585
586
587

# If the value of the INPUT tag contains directories, you can use the 
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
# and *.h) to filter out the source-files in the directories. If left 
# blank the following patterns are tested: 
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

588
FILE_PATTERNS          = *.h
589
590
591
592
593

# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
# should be searched for input files as well. Possible values are YES and NO. 
# If left blank NO is used.

Naumann, Andreas's avatar
Naumann, Andreas committed
594
RECURSIVE              = YES
595
596
597
598
599

# The EXCLUDE tag can be used to specify files and/or directories that should 
# excluded from the INPUT source files. This way you can easily exclude a 
# subdirectory from a directory tree whose root is specified with the INPUT tag.

600
EXCLUDE                = 
601
602
603
604
605

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
# directories that are symbolic links (a Unix filesystem feature) are excluded 
# from the input.

Naumann, Andreas's avatar
Naumann, Andreas committed
606
EXCLUDE_SYMLINKS       = NO
607
608
609
610
611
612
613

# If the value of the INPUT tag contains directories, you can use the 
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
# certain files from those directories. Note that the wildcards are matched 
# against the file with absolute path, so to exclude all test directories 
# for example use the pattern */test/*

614
EXCLUDE_PATTERNS       = 
615
616
617
618
619
620
621

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
# (namespaces, classes, functions, etc.) that should be excluded from the 
# output. The symbol name can be a fully qualified name, a word, or if the 
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
# AClass::ANamespace, ANamespace::*Test

Naumann, Andreas's avatar
Naumann, Andreas committed
622
EXCLUDE_SYMBOLS        = 
623
624
625
626
627

# The EXAMPLE_PATH tag can be used to specify one or more files or 
# directories that contain example code fragments that are included (see 
# the \include command).

628
EXAMPLE_PATH           = 
629
630
631
632
633
634

# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
# and *.h) to filter out the source-files in the directories. If left 
# blank all files are included.

635
EXAMPLE_PATTERNS       = 
636
637
638
639
640
641

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
# searched for input files to be used with the \include or \dontinclude 
# commands irrespective of the value of the RECURSIVE tag. 
# Possible values are YES and NO. If left blank NO is used.

642
EXAMPLE_RECURSIVE      = NO
643
644
645
646
647

# The IMAGE_PATH tag can be used to specify one or more files or 
# directories that contain image that are included in the documentation (see 
# the \image command).

648
IMAGE_PATH             = 
649
650
651
652
653
654
655
656
657

# The INPUT_FILTER tag can be used to specify a program that doxygen should 
# invoke to filter for each input file. Doxygen will invoke the filter program 
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
# input file. Doxygen will then use the output that the filter program writes 
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
# ignored.

658
INPUT_FILTER           = 
659
660
661
662
663
664
665
666

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
# basis.  Doxygen will compare the file name with each pattern and apply the 
# filter if there is a match.  The filters are a list of the form: 
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
# is applied to all files.

Naumann, Andreas's avatar
Naumann, Andreas committed
667
FILTER_PATTERNS        = 
668
669
670
671
672

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
# INPUT_FILTER) will be used to filter the input files when producing source 
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

673
FILTER_SOURCE_FILES    = NO
674

675
676
677
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
678
679
680
681
682
683

# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
# be generated. Documented entities will be cross-referenced with these sources. 
# Note: To get rid of all source code in the generated output, make sure also 
# VERBATIM_HEADERS is set to NO.

Naumann, Andreas's avatar
Naumann, Andreas committed
684
SOURCE_BROWSER         = YES
685
686
687
688

# Setting the INLINE_SOURCES tag to YES will include the body 
# of functions and classes directly in the documentation.

689
INLINE_SOURCES         = NO
690
691
692
693
694

# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
# doxygen to hide any special comment blocks from generated source code 
# fragments. Normal C and C++ comments will always remain visible.

Naumann, Andreas's avatar
Naumann, Andreas committed
695
STRIP_CODE_COMMENTS    = YES
696
697
698
699
700

# If the REFERENCED_BY_RELATION tag is set to YES 
# then for each documented function all documented 
# functions referencing it will be listed.

701
REFERENCED_BY_RELATION = YES
702
703
704
705
706

# If the REFERENCES_RELATION tag is set to YES 
# then for each documented function all documented entities 
# called/used by that function will be listed.

707
REFERENCES_RELATION    = YES
708
709
710
711
712
713

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
# link to the source code.  Otherwise they will link to the documentation.

Naumann, Andreas's avatar
Naumann, Andreas committed
714
REFERENCES_LINK_SOURCE = YES
715
716
717
718
719
720
721

# If the USE_HTAGS tag is set to YES then the references to source code 
# will point to the HTML generated by the htags(1) tool instead of doxygen 
# built-in source browser. The htags tool is part of GNU's global source 
# tagging system (see http://www.gnu.org/software/global/global.html). You 
# will need version 4.8.6 or higher.

Naumann, Andreas's avatar
Naumann, Andreas committed
722
USE_HTAGS              = NO
723
724
725
726
727

# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
# will generate a verbatim copy of the header file for each class for 
# which an include is specified. Set to NO to disable this.

Naumann, Andreas's avatar
Naumann, Andreas committed
728
VERBATIM_HEADERS       = YES
729

730
731
732
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
733
734
735
736
737

# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
# of all compounds will be generated. Enable this if the project 
# contains a lot of classes, structs, unions or interfaces.

738
ALPHABETICAL_INDEX     = NO
739
740
741
742
743

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
# in which this list will be split (can be a number in the range [1..20])

744
COLS_IN_ALPHA_INDEX    = 5
745
746
747
748
749
750

# In case all classes in a project start with a common prefix, all 
# classes will be put under the same header in the alphabetical index. 
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
# should be ignored while generating the index headers.

751
IGNORE_PREFIX          = 
752

753
754
755
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
756
757
758
759

# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
# generate HTML output.

760
GENERATE_HTML          = YES
761
762
763
764
765

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
# put in front of it. If left blank `html' will be used as the default path.

766
HTML_OUTPUT            = html
767
768
769
770
771

# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
# doxygen will generate files with .html extension.

Naumann, Andreas's avatar
Naumann, Andreas committed
772
HTML_FILE_EXTENSION    = .html
773
774
775
776
777

# The HTML_HEADER tag can be used to specify a personal HTML header for 
# each generated HTML page. If it is left blank doxygen will generate a 
# standard header.

778
HTML_HEADER            = 
779
780
781
782
783

# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
# each generated HTML page. If it is left blank doxygen will generate a 
# standard footer.

784
HTML_FOOTER            = 
785
786
787
788
789
790
791
792

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
# style sheet that is used by each HTML page. It can be used to 
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
# will generate a default style sheet. Note that doxygen will try to copy 
# the style sheet file to the HTML output directory, so don't put your own 
# stylesheet in the HTML output directory as well, or it will be erased!

793
HTML_STYLESHEET        = 
794
795
796
797
798

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
# files or namespaces will be aligned in HTML using tables. If set to 
# NO a bullet list will be used.

799
HTML_ALIGN_MEMBERS     = YES
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
# documentation will contain sections that can be hidden and shown after the 
# page has loaded. For this to work a browser that supports 
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = NO

# If the GENERATE_DOCSET tag is set to YES, additional index files 
# will be generated that can be used as input for Apple's Xcode 3 
# integrated development environment, introduced with OSX 10.5 (Leopard). 
# To create a documentation set, doxygen will generate a Makefile in the 
# HTML output directory. Running make will produce the docset in that 
# directory and running "make install" will install the docset in 
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
# it at startup. 
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.

Naumann, Andreas's avatar
Naumann, Andreas committed
819
GENERATE_DOCSET        = NO
820
821
822
823
824
825

# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
# feed. A documentation feed provides an umbrella under which multiple 
# documentation sets from a single provider (such as a company or product suite) 
# can be grouped.

Naumann, Andreas's avatar
Naumann, Andreas committed
826
DOCSET_FEEDNAME        = "Doxygen generated docs"
827
828
829
830
831
832

# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
# should uniquely identify the documentation set bundle. This should be a 
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
# will append .docset to the name.

Naumann, Andreas's avatar
Naumann, Andreas committed
833
DOCSET_BUNDLE_ID       = org.doxygen.Project
834
835
836
837
838
839
840
841
842
843
844
845
846

# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
# will be generated that can be used as input for tools like the 
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
# be used to specify the file name of the resulting .chm file. You 
# can add a path in front of the file if the result should not be 
# written to the html output directory.

Naumann, Andreas's avatar
Naumann, Andreas committed
847
CHM_FILE               = 
848
849
850
851
852
853

# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
# be used to specify the location (absolute path including file name) of 
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
# the HTML help compiler on the generated index.hhp.

Naumann, Andreas's avatar
Naumann, Andreas committed
854
HHC_LOCATION           = 
855
856
857
858
859

# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
# controls if a separate .chi index file is generated (YES) or that 
# it should be included in the master .chm file (NO).

860
GENERATE_CHI           = NO
861
862
863
864
865
866
867
868
869
870
871

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
# is used to encode HtmlHelp index (hhk), content (hhc) and project file 
# content.

CHM_INDEX_ENCODING     = 

# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
# controls whether a binary table of contents is generated (YES) or a 
# normal table of contents (NO) in the .chm file.

872
BINARY_TOC             = NO
873
874
875
876

# The TOC_EXPAND flag can be set to YES to add extra items for group members 
# to the contents of the HTML help documentation and to the tree view.

877
TOC_EXPAND             = NO
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931

# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
# are set, an additional index file will be generated that can be used as input for 
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
# HTML documentation.

GENERATE_QHP           = NO

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
# be used to specify the file name of the resulting .qch file. 
# The path specified is relative to the HTML output folder.

QCH_FILE               = 

# The QHP_NAMESPACE tag specifies the namespace to use when generating 
# Qt Help Project output. For more information please see 
# http://doc.trolltech.com/qthelpproject.html#namespace

QHP_NAMESPACE          = 

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
# Qt Help Project output. For more information please see 
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
# For more information please see 
# http://doc.trolltech.com/qthelpproject.html#custom-filters

QHP_CUST_FILTER_NAME   = 

# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.

QHP_CUST_FILTER_ATTRS  = 

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
# filter section matches. 
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.

QHP_SECT_FILTER_ATTRS  = 

# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
# be used to specify the location of Qt's qhelpgenerator. 
# If non-empty doxygen will try to run qhelpgenerator on the generated 
# .qhp file.

QHG_LOCATION           = 

# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
# top of each HTML page. The value NO (the default) enables the index and 
# the value YES disables it.

932
DISABLE_INDEX          = NO
933
934
935
936

# This tag can be used to set the number of enum values (range [1..20]) 
# that doxygen will group on one line in the generated HTML documentation.

937
ENUM_VALUES_PER_LINE   = 4
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953

# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
# structure should be generated to display hierarchical information. 
# If the tag value is set to FRAME, a side panel will be generated 
# containing a tree-like index structure (just like the one that 
# is generated for HTML Help). For this to work a browser that supports 
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
# probably better off using the HTML help feature. Other possible values 
# for this tag are: HIERARCHIES, which will generate the Groups, Directories, 
# and Class Hierarchy pages using a tree view instead of an ordered list; 
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 
# disables this behavior completely. For backwards compatibility with previous 
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 
# respectively.

954
GENERATE_TREEVIEW      = NO
955
956
957
958
959

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
# used to set the initial width (in pixels) of the frame in which the tree 
# is shown.

960
TREEVIEW_WIDTH         = 250
961
962
963
964
965
966
967
968
969

# Use this tag to change the font size of Latex formulas included 
# as images in the HTML documentation. The default is 10. Note that 
# when you change the font size after a successful doxygen run you need 
# to manually remove any form_*.png images from the HTML output directory 
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

970
971
972
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
973
974
975
976

# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
# generate Latex output.

977
GENERATE_LATEX         = NO
978
979
980
981
982

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
# put in front of it. If left blank `latex' will be used as the default path.

983
LATEX_OUTPUT           = latex
984
985
986
987

# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
# invoked. If left blank `latex' will be used as the default command name.

Naumann, Andreas's avatar
Naumann, Andreas committed
988
LATEX_CMD_NAME         = latex
989
990
991
992
993

# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
# generate index for LaTeX. If left blank `makeindex' will be used as the 
# default command name.

Naumann, Andreas's avatar
Naumann, Andreas committed
994
MAKEINDEX_CMD_NAME     = makeindex
995
996
997
998
999

# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
# LaTeX documents. This may be useful for small projects and may help to 
# save some trees in general.

1000
COMPACT_LATEX          = NO
For faster browsing, not all history is shown. View entire blame