Doxyfile.in 46.6 KB
Newer Older
1
# Doxyfile 1.3.9
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
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
19
20
21
# by quotes) that should identify the project.

PROJECT_NAME           = @PACKAGE_NAME@

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

26
PROJECT_NUMBER         = @PACKAGE_VERSION@
27

28
29
30
# 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
31
32
# where doxygen was started. If left blank the current directory will be used.

33
OUTPUT_DIRECTORY       = .
34

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

CREATE_SUBDIRS         = NO

# 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:
48
49
50
51
52
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
# Swedish, and Ukrainian.
53

54
OUTPUT_LANGUAGE        = English
55

56
57
58
59
60
61
# This tag can be used to specify the encoding used in the generated output.
# The encoding is not always determined by the language that is chosen,
# but also whether or not the output is meant for Windows or non-Windows users.
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
# forces the Windows encoding (this is the default for the Windows binary),
# whereas setting the tag to NO uses a Unix-style encoding (the default for
62
63
64
65
# all platforms other than Windows).

USE_WINDOWS_ENCODING   = NO

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

BRIEF_MEMBER_DESC      = YES

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

REPEAT_BRIEF           = YES

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"
87
88
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"

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

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

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

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

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
# 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 the Qt-style comments (thus requiring an
141
142
143
144
# explicit @brief command for a brief description.

JAVADOC_AUTOBRIEF      = NO

145
146
147
148
# 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
149
150
151
152
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

153
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
154
# will output the detailed description near the top, like JavaDoc.
155
# If set to NO, the detailed description appears after the member
156
157
158
159
# documentation.

DETAILS_AT_TOP         = NO

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

INHERIT_DOCS           = YES

166
167
168
# 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
169
170
171
172
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

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
# 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
197
198
199
200
# will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

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

SUBGROUPING            = YES

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

213
214
215
# 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
216
217
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

218
EXTRACT_ALL            = YES
219

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

223
EXTRACT_PRIVATE        = YES
224

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

228
EXTRACT_STATIC         = YES
229

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

234
EXTRACT_LOCAL_CLASSES  = YES
235

236
237
238
239
240
241
242
243
244
245
246
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = 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.
247
248
# This option has no effect if EXTRACT_ALL is enabled.

249
HIDE_UNDOC_MEMBERS     = NO
250

251
252
253
# 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
254
255
# overviews. This option has no effect if EXTRACT_ALL is enabled.

256
HIDE_UNDOC_CLASSES     = NO
257

258
259
260
# 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
261
262
# documentation.

263
HIDE_FRIEND_COMPOUNDS  = NO
264

265
266
267
# 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
268
269
# function's detailed documentation block.

270
HIDE_IN_BODY_DOCS      = NO
271

272
273
274
# 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.
275
276
# Set it to YES to include the internal documentation.

277
INTERNAL_DOCS          = NO
278

279
280
281
282
# 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
283
# and Mac users are advised to set this option to NO.
284

285
CASE_SENSE_NAMES       = YES
286

287
288
# 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
289
290
# documentation. If set to YES the scope will be hidden.

291
HIDE_SCOPE_NAMES       = NO
292

293
294
# 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
295
296
# of that file.

297
SHOW_INCLUDE_FILES     = YES
298

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

302
INLINE_INFO            = YES
303

304
305
306
# 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
307
308
# declaration order.

309
SORT_MEMBER_DOCS       = YES
310

311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
# declaration order.

SORT_BRIEF_DOCS        = 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.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

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

332
GENERATE_TODOLIST      = YES
333

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

338
GENERATE_TESTLIST      = YES
339

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

344
GENERATE_BUGLIST       = YES
345

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

350
GENERATE_DEPRECATEDLIST= YES
351

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

355
ENABLED_SECTIONS       =
356

357
358
359
360
361
362
# 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
363
364
# command in the documentation regardless of this setting.

365
MAX_INITIALIZER_LINES  = 30
366

367
368
# 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
369
370
# list will mention the files that were used to generate the documentation.

371
SHOW_USED_FILES        = YES
372

373
374
375
376
377
378
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation.

SHOW_DIRECTORIES       = YES

379
380
381
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
382

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

386
QUIET                  = NO
387

388
389
# 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
390
391
# NO is used.

392
WARNINGS               = YES
393

394
395
# 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
396
397
# automatically be disabled.

398
WARN_IF_UNDOCUMENTED   = YES
399

400
401
402
# 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
403
404
# don't exist or using markup commands wrongly.

405
WARN_IF_DOC_ERROR      = YES
406

407
408
409
# 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
410
411
# warning originated and the warning text.

412
WARN_FORMAT            = "$file:$line: $text"
413

414
415
# 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
416
417
# to stderr.

418
WARN_LOGFILE           =
419

420
421
422
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
423

424
425
426
# 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
427
428
429
430
431
432
# with spaces.

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

433
434
435
436
437
438
# 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
439

440
FILE_PATTERNS          = *.hh \
441
                         *.hxx
442

443
444
# 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.
445
446
# If left blank NO is used.

447
RECURSIVE              = YES
448

449
450
# 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
451
452
# subdirectory from a directory tree whose root is specified with the INPUT tag.

453
EXCLUDE                =
454

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

458
EXCLUDE_SYMLINKS       = YES
459

460
461
# 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
462
463
# certain files from those directories.

464
465
466
EXCLUDE_PATTERNS       = */*tgbaparse/location.hh \
                         */*tgbaparse/stack.hh \
                         */*tgbaparse/position.hh \
467
468
469
                         */*parse/*parse*.hh \
                         *test/*

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

474
EXAMPLE_PATH           =
475

476
477
478
# 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
479
480
# blank all files are included.

481
EXAMPLE_PATTERNS       =
482

483
484
485
# 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.
486
487
# Possible values are YES and NO. If left blank NO is used.

488
EXAMPLE_RECURSIVE      = NO
489

490
491
# 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
492
493
# the \image command).

494
IMAGE_PATH             =
495

496
497
498
499
500
# 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
501
502
# to standard output.  If FILTER_PATTERNS is specified, this tag will be
# ignored.
503

504
INPUT_FILTER           =
505

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

FILTER_PATTERNS        =

515
516
# 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
517
518
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

519
FILTER_SOURCE_FILES    = NO
520

521
522
523
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
524

525
526
527
# 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
528
529
# VERBATIM_HEADERS is set to NO.

530
SOURCE_BROWSER         = NO
531

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

535
INLINE_SOURCES         = NO
536

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

541
STRIP_CODE_COMMENTS    = YES
542

543
544
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
545
546
# functions referencing it will be listed.

547
REFERENCED_BY_RELATION = YES
548

549
550
# If the REFERENCES_RELATION tag is set to YES (the default)
# then for each documented function all documented entities
551
552
# called/used by that function will be listed.

553
REFERENCES_RELATION    = YES
554

555
556
# 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
557
558
559
560
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

561
562
563
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
564

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

569
ALPHABETICAL_INDEX     = NO
570

571
572
# 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
573
574
# in which this list will be split (can be a number in the range [1..20])

575
COLS_IN_ALPHA_INDEX    = 5
576

577
578
579
# 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
580
581
# should be ignored while generating the index headers.

582
IGNORE_PREFIX          =
583

584
585
586
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
587

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

591
GENERATE_HTML          = YES
592

593
594
# 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
595
596
# put in front of it. If left blank `html' will be used as the default path.

597
HTML_OUTPUT            = @srcdir@/spot.html
598

599
600
# 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
601
602
# doxygen will generate files with .html extension.

603
HTML_FILE_EXTENSION    = .html
604

605
606
# 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
607
608
# standard header.

609
HTML_HEADER            =
610

611
612
# 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
613
614
# standard footer.

615
HTML_FOOTER            = @srcdir@/footer.html
616

617
618
619
620
621
# 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
622
623
# stylesheet in the HTML output directory as well, or it will be erased!

624
HTML_STYLESHEET        =
625

626
627
# 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
628
629
# NO a bullet list will be used.

630
HTML_ALIGN_MEMBERS     = YES
631

632
633
634
# 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 compressed HTML help file (.chm)
635
636
# of the generated HTML documentation.

637
GENERATE_HTMLHELP      = NO
638

639
640
641
# 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
642
643
# written to the html output directory.

644
CHM_FILE               =
645

646
647
648
# 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
649
650
# the HTML help compiler on the generated index.hhp.

651
HHC_LOCATION           =
652

653
654
# 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
655
656
# it should be included in the master .chm file (NO).

657
GENERATE_CHI           = NO
658

659
660
# 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
661
662
# normal table of contents (NO) in the .chm file.

663
BINARY_TOC             = NO
664

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

668
TOC_EXPAND             = NO
669

670
671
# 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
672
673
# the value YES disables it.

674
DISABLE_INDEX          = NO
675

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

679
ENUM_VALUES_PER_LINE   = 4
680
681

# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
682
683
684
685
# generated containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
686
687
# probably better off using the HTML help feature.

688
GENERATE_TREEVIEW      = NO
689

690
691
# 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
692
693
# is shown.

694
TREEVIEW_WIDTH         = 250
695

696
697
698
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
699

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

703
GENERATE_LATEX         = YES
704

705
706
# 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
707
708
# put in front of it. If left blank `latex' will be used as the default path.

709
LATEX_OUTPUT           = spot.latex
710

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

714
LATEX_CMD_NAME         =
715

716
717
# 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
718
719
# default command name.

720
MAKEINDEX_CMD_NAME     = makeindex
721

722
723
# 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
724
725
# save some trees in general.

726
COMPACT_LATEX          = YES
727

728
729
# 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
730
731
# executive. If left blank a4wide will be used.

732
PAPER_TYPE             = a4wide
733

734
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
735
736
# packages that should be included in the LaTeX output.

737
EXTRA_PACKAGES         =
738

739
740
741
# 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
742
743
# standard header. Notice: only use this tag if you know what you are doing!

744
LATEX_HEADER           =
745

746
747
748
# 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
749
750
# This makes the output suitable for online browsing using a pdf viewer.

751
PDF_HYPERLINKS         = YES
752

753
754
# 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
755
756
# higher quality PDF documentation.

757
USE_PDFLATEX           = YES
758

759
760
761
# 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.
762
763
# This option is also used when generating formulas in HTML.

764
LATEX_BATCHMODE        = NO
765

766
767
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
768
769
770
771
# in the output.

LATEX_HIDE_INDICES     = NO

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

776
777
# 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
778
779
# other RTF readers or editors.

780
GENERATE_RTF           = NO
781

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

786
RTF_OUTPUT             = rtf
787

788
789
# 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
790
791
# save some trees in general.

792
COMPACT_RTF            = NO
793

794
795
796
797
798
# 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.
799
800
# Note: wordpad (write) and others do not support links.

801
RTF_HYPERLINKS         = NO
802

803
804
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
805
806
# replacements, missing definitions are set to their default value.

807
RTF_STYLESHEET_FILE    =
808

809
# Set optional variables used in the generation of an rtf document.
810
811
# Syntax is similar to doxygen's config file.

812
RTF_EXTENSIONS_FILE    =
813

814
815
816
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
817

818
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
819
820
# generate man pages

821
GENERATE_MAN           = NO
822

823
824
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
825
826
# put in front of it. If left blank `man' will be used as the default path.

827
MAN_OUTPUT             = man
828

829
# The MAN_EXTENSION tag determines the extension that is added to
830
831
# the generated man pages (default is the subroutine's section .3)

832
MAN_EXTENSION          = .3
833

834
835
836
837
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
838
839
# would be unable to find the correct page. The default is NO.

840
MAN_LINKS              = NO
841

842
843
844
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
845

846
847
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
848
849
# the code including all documentation.

850
GENERATE_XML           = NO
851

852
853
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
854
855
856
857
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

858
859
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
860
861
# syntax of the XML files.

862
XML_SCHEMA             =
863

864
865
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
866
867
# syntax of the XML files.

868
XML_DTD                =
869

870
871
872
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
873
874
875
876
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

877
878
879
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
880

881
882
883
884
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
885
886
# and incomplete at the moment.

887
GENERATE_AUTOGEN_DEF   = NO
888

889
890
891
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
892

893
894
895
896
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
897
898
# moment.

899
GENERATE_PERLMOD       = NO
900

901
902
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
903
904
# to generate PDF and DVI output from the Perl module output.

905
PERLMOD_LATEX          = NO
906

907
908
909
910
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.  This is useful
# if you want to understand what is going on.  On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
911
912
# and Perl will parse it just the same.

913
PERLMOD_PRETTY         = YES
914

915
916
917
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
918
919
# Makefile don't overwrite each other's variables.

920
PERLMOD_MAKEVAR_PREFIX =
921

922
#---------------------------------------------------------------------------
923
# Configuration options related to the preprocessor
924
#---------------------------------------------------------------------------
925

926
927
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
928
929
# files.

930
ENABLE_PREPROCESSING   = YES
931

932
933
934
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
935
936
# way by setting EXPAND_ONLY_PREDEF to YES.

937
MACRO_EXPANSION        = NO
938

939
940
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
941
942
# PREDEFINED and EXPAND_AS_PREDEFINED tags.

943
EXPAND_ONLY_PREDEF     = NO
944

945
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
946
947
# in the INCLUDE_PATH (see below) will be search if a #include is found.

948
SEARCH_INCLUDES        = YES
949

950
951
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
952
953
# the preprocessor.

954
INCLUDE_PATH           = @top_srcdir@/src
955

956
957
958
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
959
960
# be used.

961
INCLUDE_FILE_PATTERNS  =
962

963
964
965
966
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
967
968
969
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
970

971
PREDEFINED             =
972

973
974
975
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
976
977
# Use the PREDEFINED tag if you want to use a different macro definition.

978
EXPAND_AS_DEFINED      =