Doxyfile.in 45.7 KB
Newer Older
1
# Doxyfile 1.3.7
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 2 levels of 10 sub-directories under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of source
# files, where putting all generated files in the same directory would otherwise
# cause performance problems for the file system.

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:
# 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,
51
52
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.

53
OUTPUT_LANGUAGE        = English
54

55
56
57
58
59
60
# 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
61
62
63
64
# all platforms other than Windows).

USE_WINDOWS_ENCODING   = NO

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

88
ABBREVIATE_BRIEF       =
89

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

ALWAYS_DETAILED_SEC    = YES

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

INLINE_INHERITED_MEMB  = YES

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

FULL_PATH_NAMES        = YES

109
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
# path to strip.
115
116
117
118

STRIP_FROM_PATH        = @top_srcdir@/src/ \
                         @top_srcdir@/iface/

119
120
121
122
123
124
125
126
127
128
129
# 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.

STRIP_FROM_INC_PATH    =

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

SHORT_NAMES            = NO

134
135
136
137
# 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
138
139
140
141
# explicit @brief command for a brief description.

JAVADOC_AUTOBRIEF      = NO

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

MULTILINE_CPP_IS_BRIEF = NO

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

DETAILS_AT_TOP         = NO

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

INHERIT_DOCS           = YES

163
164
165
# 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
166
167
168
169
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

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

TAB_SIZE               = 8

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

182
ALIASES                =
183

184
185
186
# 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
187
188
189
190
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

191
192
193
# 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
194
195
196
197
# will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

198
199
200
201
# 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
202
203
204
205
206
207
208
209
# the \nosubgrouping command.

SUBGROUPING            = YES

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

210
211
212
# 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
213
214
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

215
EXTRACT_ALL            = YES
216

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

220
EXTRACT_PRIVATE        = YES
221

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

225
EXTRACT_STATIC         = YES
226

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

231
EXTRACT_LOCAL_CLASSES  = YES
232

233
234
235
236
237
238
239
240
241
242
243
# 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.
244
245
# This option has no effect if EXTRACT_ALL is enabled.

246
HIDE_UNDOC_MEMBERS     = NO
247

248
249
250
# 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
251
252
# overviews. This option has no effect if EXTRACT_ALL is enabled.

253
HIDE_UNDOC_CLASSES     = NO
254

255
256
257
# 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
258
259
# documentation.

260
HIDE_FRIEND_COMPOUNDS  = NO
261

262
263
264
# 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
265
266
# function's detailed documentation block.

267
HIDE_IN_BODY_DOCS      = NO
268

269
270
271
# 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.
272
273
# Set it to YES to include the internal documentation.

274
INTERNAL_DOCS          = NO
275

276
277
278
279
# 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
280
281
# users are advised to set this option to NO.

282
CASE_SENSE_NAMES       = YES
283

284
285
# 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
286
287
# documentation. If set to YES the scope will be hidden.

288
HIDE_SCOPE_NAMES       = NO
289

290
291
# 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
292
293
# of that file.

294
SHOW_INCLUDE_FILES     = YES
295

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

299
INLINE_INFO            = YES
300

301
302
303
# 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
304
305
# declaration order.

306
SORT_MEMBER_DOCS       = YES
307

308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# 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
327
328
# commands in the documentation.

329
GENERATE_TODOLIST      = YES
330

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

335
GENERATE_TESTLIST      = YES
336

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

341
GENERATE_BUGLIST       = YES
342

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

347
GENERATE_DEPRECATEDLIST= YES
348

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

352
ENABLED_SECTIONS       =
353

354
355
356
357
358
359
# 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
360
361
# command in the documentation regardless of this setting.

362
MAX_INITIALIZER_LINES  = 30
363

364
365
# 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
366
367
# list will mention the files that were used to generate the documentation.

368
SHOW_USED_FILES        = YES
369

370
371
372
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
373

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

377
QUIET                  = NO
378

379
380
# 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
381
382
# NO is used.

383
WARNINGS               = YES
384

385
386
# 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
387
388
# automatically be disabled.

389
WARN_IF_UNDOCUMENTED   = YES
390

391
392
393
# 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
394
395
# don't exist or using markup commands wrongly.

396
WARN_IF_DOC_ERROR      = YES
397

398
399
400
# 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
401
402
# warning originated and the warning text.

403
WARN_FORMAT            = "$file:$line: $text"
404

405
406
# 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
407
408
# to stderr.

409
WARN_LOGFILE           =
410

411
412
413
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
414

415
416
417
# 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
418
419
420
421
422
423
# with spaces.

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

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

431
FILE_PATTERNS          = *.hh \
432
                         *.hxx
433

434
435
# 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.
436
437
# If left blank NO is used.

438
RECURSIVE              = YES
439

440
441
# 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
442
443
# subdirectory from a directory tree whose root is specified with the INPUT tag.

444
EXCLUDE                =
445

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

449
EXCLUDE_SYMLINKS       = NO
450

451
452
# 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
453
454
# certain files from those directories.

455
EXCLUDE_PATTERNS       = */tgbaparse/location.hh \
456
457
458
459
460
                         */tgbaparse/stack.hh \
                         */tgbaparse/position.hh \
                         */*parse/*parse*.hh \
                         *test/*

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

465
EXAMPLE_PATH           =
466

467
468
469
# 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
470
471
# blank all files are included.

472
EXAMPLE_PATTERNS       =
473

474
475
476
# 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.
477
478
# Possible values are YES and NO. If left blank NO is used.

479
EXAMPLE_RECURSIVE      = NO
480

481
482
# 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
483
484
# the \image command).

485
IMAGE_PATH             =
486

487
488
489
490
491
# 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
492
493
# to standard output.

494
INPUT_FILTER           =
495

496
497
# 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
498
499
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

500
FILTER_SOURCE_FILES    = NO
501

502
503
504
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
505

506
507
508
# 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
509
510
# VERBATIM_HEADERS is set to NO.

511
SOURCE_BROWSER         = NO
512

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

516
INLINE_SOURCES         = NO
517

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

522
STRIP_CODE_COMMENTS    = YES
523

524
525
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
526
527
# functions referencing it will be listed.

528
REFERENCED_BY_RELATION = YES
529

530
531
# If the REFERENCES_RELATION tag is set to YES (the default)
# then for each documented function all documented entities
532
533
# called/used by that function will be listed.

534
REFERENCES_RELATION    = YES
535

536
537
# 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
538
539
540
541
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

542
543
544
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
545

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

550
ALPHABETICAL_INDEX     = NO
551

552
553
# 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
554
555
# in which this list will be split (can be a number in the range [1..20])

556
COLS_IN_ALPHA_INDEX    = 5
557

558
559
560
# 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
561
562
# should be ignored while generating the index headers.

563
IGNORE_PREFIX          =
564

565
566
567
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
568

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

572
GENERATE_HTML          = YES
573

574
575
# 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
576
577
# put in front of it. If left blank `html' will be used as the default path.

578
HTML_OUTPUT            = @srcdir@/spot.html
579

580
581
# 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
582
583
# doxygen will generate files with .html extension.

584
HTML_FILE_EXTENSION    = .html
585

586
587
# 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
588
589
# standard header.

590
HTML_HEADER            =
591

592
593
# 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
594
595
# standard footer.

596
HTML_FOOTER            = @srcdir@/footer.html
597

598
599
600
601
602
# 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
603
604
# stylesheet in the HTML output directory as well, or it will be erased!

605
HTML_STYLESHEET        =
606

607
608
# 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
609
610
# NO a bullet list will be used.

611
HTML_ALIGN_MEMBERS     = YES
612

613
614
615
# 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)
616
617
# of the generated HTML documentation.

618
GENERATE_HTMLHELP      = NO
619

620
621
622
# 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
623
624
# written to the html output directory.

625
CHM_FILE               =
626

627
628
629
# 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
630
631
# the HTML help compiler on the generated index.hhp.

632
HHC_LOCATION           =
633

634
635
# 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
636
637
# it should be included in the master .chm file (NO).

638
GENERATE_CHI           = NO
639

640
641
# 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
642
643
# normal table of contents (NO) in the .chm file.

644
BINARY_TOC             = NO
645

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

649
TOC_EXPAND             = NO
650

651
652
# 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
653
654
# the value YES disables it.

655
DISABLE_INDEX          = NO
656

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

660
ENUM_VALUES_PER_LINE   = 4
661
662

# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
663
664
665
666
# 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
667
668
# probably better off using the HTML help feature.

669
GENERATE_TREEVIEW      = NO
670

671
672
# 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
673
674
# is shown.

675
TREEVIEW_WIDTH         = 250
676

677
678
679
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
680

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

684
GENERATE_LATEX         = YES
685

686
687
# 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
688
689
# put in front of it. If left blank `latex' will be used as the default path.

690
LATEX_OUTPUT           = spot.latex
691

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

695
LATEX_CMD_NAME         =
696

697
698
# 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
699
700
# default command name.

701
MAKEINDEX_CMD_NAME     = makeindex
702

703
704
# 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
705
706
# save some trees in general.

707
COMPACT_LATEX          = YES
708

709
710
# 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
711
712
# executive. If left blank a4wide will be used.

713
PAPER_TYPE             = a4wide
714

715
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
716
717
# packages that should be included in the LaTeX output.

718
EXTRA_PACKAGES         =
719

720
721
722
# 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
723
724
# standard header. Notice: only use this tag if you know what you are doing!

725
LATEX_HEADER           =
726

727
728
729
# 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
730
731
# This makes the output suitable for online browsing using a pdf viewer.

732
PDF_HYPERLINKS         = YES
733

734
735
# 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
736
737
# higher quality PDF documentation.

738
USE_PDFLATEX           = YES
739

740
741
742
# 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.
743
744
# This option is also used when generating formulas in HTML.

745
LATEX_BATCHMODE        = NO
746

747
748
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
749
750
751
752
# in the output.

LATEX_HIDE_INDICES     = NO

753
754
755
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
756

757
758
# 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
759
760
# other RTF readers or editors.

761
GENERATE_RTF           = NO
762

763
764
# 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
765
766
# put in front of it. If left blank `rtf' will be used as the default path.

767
RTF_OUTPUT             = rtf
768

769
770
# 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
771
772
# save some trees in general.

773
COMPACT_RTF            = NO
774

775
776
777
778
779
# 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.
780
781
# Note: wordpad (write) and others do not support links.

782
RTF_HYPERLINKS         = NO
783

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

788
RTF_STYLESHEET_FILE    =
789

790
# Set optional variables used in the generation of an rtf document.
791
792
# Syntax is similar to doxygen's config file.

793
RTF_EXTENSIONS_FILE    =
794

795
796
797
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
798

799
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
800
801
# generate man pages

802
GENERATE_MAN           = NO
803

804
805
# 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
806
807
# put in front of it. If left blank `man' will be used as the default path.

808
MAN_OUTPUT             = man
809

810
# The MAN_EXTENSION tag determines the extension that is added to
811
812
# the generated man pages (default is the subroutine's section .3)

813
MAN_EXTENSION          = .3
814

815
816
817
818
# 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
819
820
# would be unable to find the correct page. The default is NO.

821
MAN_LINKS              = NO
822

823
824
825
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
826

827
828
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
829
830
# the code including all documentation.

831
GENERATE_XML           = NO
832

833
834
# 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
835
836
837
838
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

839
840
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
841
842
# syntax of the XML files.

843
XML_SCHEMA             =
844

845
846
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
847
848
# syntax of the XML files.

849
XML_DTD                =
850

851
852
853
# 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
854
855
856
857
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

858
859
860
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
861

862
863
864
865
# 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
866
867
# and incomplete at the moment.

868
GENERATE_AUTOGEN_DEF   = NO
869

870
871
872
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
873

874
875
876
877
# 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
878
879
# moment.

880
GENERATE_PERLMOD       = NO
881

882
883
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
884
885
# to generate PDF and DVI output from the Perl module output.

886
PERLMOD_LATEX          = NO
887

888
889
890
891
# 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
892
893
# and Perl will parse it just the same.

894
PERLMOD_PRETTY         = YES
895

896
897
898
# 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
899
900
# Makefile don't overwrite each other's variables.

901
PERLMOD_MAKEVAR_PREFIX =
902

903
#---------------------------------------------------------------------------
904
# Configuration options related to the preprocessor
905
#---------------------------------------------------------------------------
906

907
908
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
909
910
# files.

911
ENABLE_PREPROCESSING   = YES
912

913
914
915
# 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
916
917
# way by setting EXPAND_ONLY_PREDEF to YES.

918
MACRO_EXPANSION        = NO
919

920
921
# 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
922
923
# PREDEFINED and EXPAND_AS_PREDEFINED tags.

924
EXPAND_ONLY_PREDEF     = NO
925

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

929
SEARCH_INCLUDES        = YES
930

931
932
# 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
933
934
# the preprocessor.

935
INCLUDE_PATH           = @top_srcdir@/src
936

937
938
939
# 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
940
941
# be used.

942
INCLUDE_FILE_PATTERNS  =
943

944
945
946
947
# 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
948
949
# omitted =1 is assumed.

950
PREDEFINED             =
951

952
953
954
# 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.
955
956
# Use the PREDEFINED tag if you want to use a different macro definition.

957
EXPAND_AS_DEFINED      =
958

959
960
961
962
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse the
963
964
# parser if not removed.

965
SKIP_FUNCTION_MACROS   = YES
966

967
#---------------------------------------------------------------------------
968
# Configuration::additions related to external references
969
#---------------------------------------------------------------------------
970

971
972
973
974
975
976
977
978
979
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
#   TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
#   TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
980
981
982
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
983
# If a tag file is not located in the directory in which doxygen
984
985
# is run, you must also specify the path to the tagfile here.

Alexandre Duret-Lutz's avatar