Doxyfile.in 64.5 KB
Newer Older
1
# Doxyfile 1.6.2
2
3
4
5
6
7
8
9
10
11

# 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

#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
16

17
18
19
20
21
# 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.
22
23
24

DOXYFILE_ENCODING      = UTF-8

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

PROJECT_NAME           = @PACKAGE_NAME@

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

34
PROJECT_NUMBER         = @PACKAGE_VERSION@
35

36
37
38
# 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
39
40
# where doxygen was started. If left blank the current directory will be used.

41
OUTPUT_DIRECTORY       = .
42

43
44
45
46
47
# 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
48
# otherwise cause performance problems for the file system.
49
50
51

CREATE_SUBDIRS         = NO

52
53
54
55
56
# 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,
57
58
59
60
61
# 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.
62

63
OUTPUT_LANGUAGE        = English
64

65
66
67
# 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).
68
69
70
71
# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

72
73
74
# 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
75
76
77
78
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

79
80
81
82
83
84
85
86
# 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"
87
# "represents" "a" "an" "the"
88

89
ABBREVIATE_BRIEF       =
90

91
92
# 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
93
94
95
96
# description.

ALWAYS_DETAILED_SEC    = YES

97
98
99
# 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
100
# operators of the base classes will not be shown.
101
102
103

INLINE_INHERITED_MEMB  = YES

104
105
# 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
106
107
108
109
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

110
111
112
113
114
# 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
115
# path to strip.
116
117

STRIP_FROM_PATH        = @top_srcdir@/src/ \
118
                         @top_srcdir@/iface/ \
119
                         @srcdir@
120

121
122
123
124
125
# 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
126
127
# are normally passed to the compiler using the -I flag.

128
129
STRIP_FROM_INC_PATH    = @top_srcdir@/src/ \
                         @top_srcdir@/iface/
130

131
132
# 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
133
134
135
136
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

137
138
139
140
141
# 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.)
142
143
144

JAVADOC_AUTOBRIEF      = NO

145
146
147
148
149
150
151
152
153
154
155
156
# 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.)

QT_AUTOBRIEF           = NO

# 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
157
158
159
160
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

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

INHERIT_DOCS           = YES

167
168
# 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
169
# be part of the file/class/namespace that contains it.
170

171
SEPARATE_MEMBER_PAGES  = NO
172

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

TAB_SIZE               = 8

178
179
180
181
182
# 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:".
183
184
# You can put \n's in the value part of an alias to insert newlines.

185
ALIASES                =
186

187
188
189
# 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
190
191
192
193
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

194
195
196
197
# 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.
198
199
200

OPTIMIZE_OUTPUT_JAVA   = NO

201
202
203
204
205
206
207
208
209
210
211
212
# 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.

OPTIMIZE_FOR_FORTRAN   = NO

# 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.

OPTIMIZE_OUTPUT_VHDL   = NO

213
214
215
216
217
218
219
220
221
222
223
# 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      =

224
225
226
227
228
# 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
229
230
231
232
233
234
235
236
237
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

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

CPP_CLI_SUPPORT        = NO

238
239
240
241
242
243
# 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.

SIP_SUPPORT            = NO

244
245
246
247
248
249
250
251
252
# 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   = NO

253
254
255
# 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
256
257
258
259
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

260
261
262
263
# 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
264
265
266
267
# the \nosubgrouping command.

SUBGROUPING            = YES

268
269
270
271
272
273
274
275
276
277
# 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.

TYPEDEF_HIDES_STRUCT   = NO

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# 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

294
295
296
297
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

298
299
300
# 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
301
302
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

303
EXTRACT_ALL            = YES
304

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

308
EXTRACT_PRIVATE        = YES
309

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

313
EXTRACT_STATIC         = YES
314

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

319
EXTRACT_LOCAL_CLASSES  = YES
320

321
322
323
# 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.
324
325
326
327
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

328
329
330
331
332
333
334
335
336
337
338
339
# 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.

EXTRACT_ANON_NSPACES   = NO

# 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.
340
341
# This option has no effect if EXTRACT_ALL is enabled.

342
HIDE_UNDOC_MEMBERS     = NO
343

344
345
346
# 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
347
348
# overviews. This option has no effect if EXTRACT_ALL is enabled.

349
HIDE_UNDOC_CLASSES     = NO
350

351
352
353
# 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
354
355
# documentation.

356
HIDE_FRIEND_COMPOUNDS  = NO
357

358
359
360
# 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
361
362
# function's detailed documentation block.

363
HIDE_IN_BODY_DOCS      = NO
364

365
366
367
# 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.
368
369
# Set it to YES to include the internal documentation.

370
INTERNAL_DOCS          = NO
371

372
373
374
375
# 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
376
# and Mac users are advised to set this option to NO.
377

378
CASE_SENSE_NAMES       = YES
379

380
381
# 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
382
383
# documentation. If set to YES the scope will be hidden.

384
HIDE_SCOPE_NAMES       = NO
385

386
387
# 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
388
389
# of that file.

390
SHOW_INCLUDE_FILES     = YES
391

392
393
394
395
396
397
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

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

401
INLINE_INFO            = YES
402

403
404
405
# 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
406
407
# declaration order.

408
SORT_MEMBER_DOCS       = YES
409

410
411
412
# 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
413
414
415
416
# declaration order.

SORT_BRIEF_DOCS        = NO

417
418
419
420
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = YES

421
422
423
424
425
426
427
428
429
430
# 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.

SORT_GROUP_NAMES       = NO

# 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.
431
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
432
# Note: This option applies only to the class list, not to the
433
434
435
436
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

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
439
440
# commands in the documentation.

441
GENERATE_TODOLIST      = YES
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
445
446
# commands in the documentation.

447
GENERATE_TESTLIST      = YES
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
451
452
# commands in the documentation.

453
GENERATE_BUGLIST       = YES
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
457
458
# \deprecated commands in the documentation.

459
GENERATE_DEPRECATEDLIST= YES
460

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

464
ENABLED_SECTIONS       =
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
472
473
# command in the documentation regardless of this setting.

474
MAX_INITIALIZER_LINES  = 30
475

476
477
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
478
479
# list will mention the files that were used to generate the documentation.

480
SHOW_USED_FILES        = YES
481

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

SHOW_DIRECTORIES       = YES

488
489
490
491
492
493
494
495
496
497
498
499
500
# 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

501
502
503
504
505
506
# 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
507
508
# is used as the file version. See the manual for examples.

509
FILE_VERSION_FILTER    =
510

511
512
513
514
515
516
517
518
519
# 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            =

520
521
522
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
523

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

527
QUIET                  = NO
528

529
530
# 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
531
532
# NO is used.

533
WARNINGS               = YES
534

535
536
# 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
537
538
# automatically be disabled.

539
WARN_IF_UNDOCUMENTED   = YES
540

541
542
543
# 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
544
545
# don't exist or using markup commands wrongly.

546
WARN_IF_DOC_ERROR      = YES
547

548
549
550
551
# 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
552
553
554
555
# documentation.

WARN_NO_PARAMDOC       = NO

556
557
558
559
560
# 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
561
# be obtained via FILE_VERSION_FILTER)
562

563
WARN_FORMAT            = "$file:$line: $text"
564

565
566
# 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
567
568
# to stderr.

569
WARN_LOGFILE           =
570

571
572
573
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
574

575
576
577
# 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
578
579
580
581
582
583
# with spaces.

INPUT                  = @srcdir@/mainpage.dox \
                         @top_srcdir@/src \
                         @top_srcdir@/iface

584
585
586
587
588
# 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.
589
590
591

INPUT_ENCODING         = latin1

592
593
594
595
596
597
# 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
598

599
FILE_PATTERNS          = *.hh
600

601
602
# 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.
603
604
# If left blank NO is used.

605
RECURSIVE              = YES
606

607
608
# 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
609
610
# subdirectory from a directory tree whose root is specified with the INPUT tag.

611
EXCLUDE                =
612

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

617
EXCLUDE_SYMLINKS       = YES
618

619
620
621
622
# 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
623
# for example use the pattern */test/*
624

625
626
627
EXCLUDE_PATTERNS       = */*tgbaparse/location.hh \
                         */*tgbaparse/stack.hh \
                         */*tgbaparse/position.hh \
628
629
630
                         */*parse/*parse*.hh \
                         *test/*

631
632
633
634
635
# 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
636

637
EXCLUDE_SYMBOLS        =
638

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

643
EXAMPLE_PATH           =
644

645
646
647
# 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
648
649
# blank all files are included.

650
EXAMPLE_PATTERNS       =
651

652
653
654
# 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.
655
656
# Possible values are YES and NO. If left blank NO is used.

657
EXAMPLE_RECURSIVE      = NO
658

659
660
# 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
661
662
# the \image command).

663
IMAGE_PATH             =
664

665
666
667
668
669
# 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
670
671
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
672
# ignored.
673

674
INPUT_FILTER           =
675

676
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
677
678
679
680
# 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:
681
682
# 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
683
684
# is applied to all files.

685
FILTER_PATTERNS        =
686

687
688
# 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
689
690
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

691
FILTER_SOURCE_FILES    = NO
692

693
694
695
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
696

697
698
699
# 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
700
701
# VERBATIM_HEADERS is set to NO.

702
SOURCE_BROWSER         = NO
703

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

707
INLINE_SOURCES         = NO
708

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

713
STRIP_CODE_COMMENTS    = YES
714

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

719
REFERENCED_BY_RELATION = YES
720

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

725
REFERENCES_RELATION    = YES
726

727
728
729
# 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
730
731
# link to the source code.
# Otherwise they will link to the documentation.
732
733
734

REFERENCES_LINK_SOURCE = YES

735
736
737
738
# 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
739
740
741
742
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

743
744
# 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
745
746
747
748
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

749
750
751
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
752

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

757
ALPHABETICAL_INDEX     = NO
758

759
760
# 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
761
762
# in which this list will be split (can be a number in the range [1..20])

763
COLS_IN_ALPHA_INDEX    = 5
764

765
766
767
# 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
768
769
# should be ignored while generating the index headers.

770
IGNORE_PREFIX          =
771

772
773
774
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
775

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

779
GENERATE_HTML          = YES
780

781
782
# 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
783
784
# put in front of it. If left blank `html' will be used as the default path.

785
HTML_OUTPUT            = @srcdir@/spot.html
786

787
788
# 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
789
790
# doxygen will generate files with .html extension.

791
HTML_FILE_EXTENSION    = .html
792

793
794
# 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
795
796
# standard header.

797
HTML_HEADER            =
798

799
800
# 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
801
802
# standard footer.

803
HTML_FOOTER            = @srcdir@/footer.html
804

805
806
807
808
809
# 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
810
811
# stylesheet in the HTML output directory as well, or it will be erased!

812
HTML_STYLESHEET        =
813

814
815
816
817
818
819
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = NO

820
821
# 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
822
823
# NO a bullet list will be used.

824
HTML_ALIGN_MEMBERS     = YES
825

826
827
828
829
830
# 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).
831

832
HTML_DYNAMIC_SECTIONS  = NO
833

834
835
836
837
838
839
840
841
# 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.
842
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859

GENERATE_DOCSET        = NO

# 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.

DOCSET_FEEDNAME        = "Doxygen generated docs"

# 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.

DOCSET_BUNDLE_ID       = org.doxygen.Project

860
861
862
863
# 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.
864

865
GENERATE_HTMLHELP      = NO
866
867
868
869

# 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
870
871
# written to the html output directory.

872
CHM_FILE               =
873

874
875
876
# 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
877
878
# the HTML help compiler on the generated index.hhp.

879
HHC_LOCATION           =
880

881
882
# 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
883
884
# it should be included in the master .chm file (NO).

885
GENERATE_CHI           = NO
886

887
888
889
890
891
892
# 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     =

893
894
# 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
895
896
# normal table of contents (NO) in the .chm file.

897
BINARY_TOC             = NO
898

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

902
TOC_EXPAND             = NO
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
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
# 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          = org.doxygen.Project

# 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           =

# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
#  will be generated, which together with the HTML files, form an Eclipse help
#  plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.

GENERATE_ECLIPSEHELP   = NO

# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.

ECLIPSE_DOC_ID         = org.doxygen.Project

969
970
# 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
971
972
# the value YES disables it.

973
DISABLE_INDEX          = NO
974

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

978
ENUM_VALUES_PER_LINE   = 4
979

980
981
982
983
# 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 YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
984
# is generated for HTML Help). For this to work a browser that supports
985
986
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
987

988
GENERATE_TREEVIEW      = NO
989

990
991
992
993
994
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.

USE_INLINE_TREES       = NO

995
996
# 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
997
998
# is shown.

999
TREEVIEW_WIDTH         = 250
1000

1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# 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

# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = NO

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
# and does not have live searching capabilities.

SERVER_BASED_SEARCH    = NO

1022
1023
1024
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
1025

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

1029
GENERATE_LATEX         = YES
1030

1031
1032
# 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
1033
1034
# put in front of it. If left blank `latex' will be used as the default path.

1035
LATEX_OUTPUT           = spot.latex
1036

1037
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1038
# invoked. If left blank `latex' will be used as the default command name.
1039
1040
1041
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
1042

1043
LATEX_CMD_NAME         =
1044

1045
1046
# 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
1047
1048
# default command name.

1049
MAKEINDEX_CMD_NAME     = makeindex
1050

1051
1052
# 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
1053
1054
# save some trees in general.

1055
COMPACT_LATEX          = YES
1056

1057
1058
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
1059
1060
# executive. If left blank a4wide will be used.

1061
PAPER_TYPE             = a4wide
1062

1063
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1064
1065
# packages that should be included in the LaTeX output.

1066
EXTRA_PACKAGES         =
1067

1068
1069
1070
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
1071
1072
# standard header. Notice: only use this tag if you know what you are doing!

1073
LATEX_HEADER           =
1074

1075
1076
1077
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
1078
1079
# This makes the output suitable for online browsing using a pdf viewer.

1080
PDF_HYPERLINKS         = YES
1081

1082
1083
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
1084
1085
# higher quality PDF documentation.

1086
USE_PDFLATEX           = YES
1087

1088
1089
1090
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
1091
1092
# This option is also used when generating formulas in HTML.

1093
LATEX_BATCHMODE        = NO
1094

1095
1096
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
1097
1098
# in the output.

1099
LATEX_HIDE_INDICES     = YES
1100

1101
1102
1103
1104
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.

LATEX_SOURCE_CODE      = NO

1105
1106
1107
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
1108

1109
1110
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
1111
1112
# other RTF readers or editors.

1113
GENERATE_RTF           = NO
1114

1115
1116
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1117
1118
# put in front of it. If left blank `rtf' will be used as the default path.

1119
RTF_OUTPUT             = rtf
1120

1121
1122
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
1123
1124
# save some trees in general.

1125
COMPACT_RTF            = NO
1126

1127
1128
1129
1130
1131
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
1132