~ubuntu-branches/ubuntu/lucid/graphviz/lucid-security

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