3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
8
# TAG = value [value, ...]
9
# For lists items can also be appended using:
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23
# This could be handy for archiving the generated documentation or
24
# if some version control system is used.
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
31
# where doxygen was started. If left blank the current directory will be used.
33
OUTPUT_DIRECTORY = ../apidocs/
35
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36
# documentation generated by doxygen is written. Doxygen will use this
37
# information to generate all constant output in the proper language.
38
# The default language is English, other supported languages are:
39
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44
1
OUTPUT_LANGUAGE = English
46
# This tag can be used to specify the encoding used in the generated output.
47
# The encoding is not always determined by the language that is chosen,
48
# but also whether or not the output is meant for Windows or non-Windows users.
49
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50
# forces the Windows encoding (this is the default for the Windows binary),
51
# whereas setting the tag to NO uses a Unix-style encoding (the default for
52
# all platforms other than Windows).
54
2
USE_WINDOWS_ENCODING = NO
56
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57
# include brief member descriptions after the members that are listed in
58
# the file and class documentation (similar to JavaDoc).
59
# Set to NO to disable this.
61
3
BRIEF_MEMBER_DESC = NO
63
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64
# the brief description of a member or function before the detailed description.
65
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66
# brief descriptions will be completely suppressed.
70
# This tag implements a quasi-intelligent brief description abbreviator
71
# that is used to form the text in various listings. Each string
72
# in this list, if found as the leading text of the brief description, will be
73
# stripped from the text and the result after processing the whole list, is used
74
# as the annotated text. Otherwise, the brief description is used as-is. If left
75
# blank, the following values are used ("$name" is automatically replaced with the
76
# name of the entity): "The $name class" "The $name widget" "The $name file"
77
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
81
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82
# Doxygen will generate a detailed section even if there is only a brief
85
6
ALWAYS_DETAILED_SEC = YES
87
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88
# members of a class in the documentation of that class as if those members were
89
# ordinary class members. Constructors, destructors and assignment operators of
90
# the base classes will not be shown.
92
7
INLINE_INHERITED_MEMB = NO
94
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95
# path before files name in the file list and in the header files. If set
96
# to NO the shortest path that makes the file name unique will be used.
98
8
FULL_PATH_NAMES = NO
100
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101
# can be used to strip a user-defined part of the path. Stripping is
102
# only done if one of the specified strings matches the left-hand part of
103
# the path. It is allowed to use relative paths in the argument list.
104
# If left blank the directory from which doxygen is run is used as the
109
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
110
# (but less readable) file names. This can be useful is your file systems
111
# doesn't support long names like on DOS, Mac, or CD-ROM.
115
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
116
# will interpret the first line (until the first dot) of a JavaDoc-style
117
# comment as the brief description. If set to NO, the JavaDoc
118
# comments will behave just like the Qt-style comments (thus requiring an
119
# explicit @brief command for a brief description.
121
11
JAVADOC_AUTOBRIEF = YES
123
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
124
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
125
# comments) as a brief description. This used to be the default behaviour.
126
# The new default is to treat a multi-line C++ comment block as a detailed
127
# description. Set this tag to YES if you prefer the old behaviour instead.
129
12
MULTILINE_CPP_IS_BRIEF = NO
131
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
132
# will output the detailed description near the top, like JavaDoc.
133
# If set to NO, the detailed description appears after the member
138
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
139
# member inherits the documentation from any documented member that it
142
13
INHERIT_DOCS = YES
144
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
145
# tag is set to YES, then doxygen will reuse the documentation of the first
146
# member in the group (if any) for the other members of the group. By default
147
# all members of a group must be documented explicitly.
149
14
DISTRIBUTE_GROUP_DOC = NO
151
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
152
# Doxygen uses this value to replace tabs by spaces in code fragments.
156
# This tag can be used to specify a number of aliases that acts
157
# as commands in the documentation. An alias has the form "name=value".
158
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
159
# put the command \sideeffect (or @sideeffect) in the documentation, which
160
# will result in a user-defined paragraph with heading "Side Effects:".
161
# You can put \n's in the value part of an alias to insert newlines.
163
ALIASES = obsolete=@deprecated
165
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
166
# only. Doxygen will then generate output that is more tailored for C.
167
# For instance, some of the names that are used will be different. The list
168
# of all members will be omitted, etc.
170
16
OPTIMIZE_OUTPUT_FOR_C = NO
172
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
173
# only. Doxygen will then generate output that is more tailored for Java.
174
# For instance, namespaces will be presented as packages, qualified scopes
175
# will look different, etc.
177
17
OPTIMIZE_OUTPUT_JAVA = NO
179
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
180
# the same type (for instance a group of public functions) to be put as a
181
# subgroup of that type (e.g. under the Public Functions section). Set it to
182
# NO to prevent subgrouping. Alternatively, this can be done per class using
183
# the \nosubgrouping command.
187
#---------------------------------------------------------------------------
188
# Build related configuration options
189
#---------------------------------------------------------------------------
191
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
192
# documentation are documented, even if no documentation was available.
193
# Private class members and static file members will be hidden unless
194
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
198
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
199
# will be included in the documentation.
201
20
EXTRACT_PRIVATE = NO
203
# If the EXTRACT_STATIC tag is set to YES all static members of a file
204
# will be included in the documentation.
206
21
EXTRACT_STATIC = YES
208
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
209
# defined locally in source files will be included in the documentation.
210
# If set to NO only classes defined in header files are included.
212
22
EXTRACT_LOCAL_CLASSES = NO
214
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
215
# undocumented members of documented classes, files or namespaces.
216
# If set to NO (the default) these members will be included in the
217
# various overviews, but no documentation section is generated.
218
# This option has no effect if EXTRACT_ALL is enabled.
220
23
HIDE_UNDOC_MEMBERS = NO
222
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
223
# undocumented classes that are normally visible in the class hierarchy.
224
# If set to NO (the default) these classes will be included in the various
225
# overviews. This option has no effect if EXTRACT_ALL is enabled.
227
24
HIDE_UNDOC_CLASSES = YES
229
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
230
# friend (class|struct|union) declarations.
231
# If set to NO (the default) these declarations will be included in the
234
25
HIDE_FRIEND_COMPOUNDS = NO
236
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
237
# documentation blocks found inside the body of a function.
238
# If set to NO (the default) these blocks will be appended to the
239
# function's detailed documentation block.
241
26
HIDE_IN_BODY_DOCS = NO
243
# The INTERNAL_DOCS tag determines if documentation
244
# that is typed after a \internal command is included. If the tag is set
245
# to NO (the default) then the documentation will be excluded.
246
# Set it to YES to include the internal documentation.
248
27
INTERNAL_DOCS = NO
250
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
251
# file names in lower-case letters. If set to YES upper-case letters are also
252
# allowed. This is useful if you have classes or files whose names only differ
253
# in case and if your file system supports case sensitive file names. Windows
254
# users are advised to set this option to NO.
256
28
CASE_SENSE_NAMES = YES
258
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
259
# will show members with their full class and namespace scopes in the
260
# documentation. If set to YES the scope will be hidden.
262
29
HIDE_SCOPE_NAMES = NO
264
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
265
# will put a list of the files that are included by a file in the documentation
268
30
SHOW_INCLUDE_FILES = YES
270
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
271
# is inserted in the documentation for inline members.
275
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
276
# will sort the (detailed) documentation of file and class members
277
# alphabetically by member name. If set to NO the members will appear in
280
SORT_MEMBER_DOCS = NO
282
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
283
# brief documentation of file, namespace and class members alphabetically
284
# by member name. If set to NO (the default) the members will appear in
287
32
SORT_BRIEF_DOCS = NO
289
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
290
# sorted by fully-qualified names, including namespaces. If set to
291
# NO (the default), the class list will be sorted only by class name,
292
# not including the namespace part.
293
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
294
# Note: This option applies only to the class list, not to the
297
33
SORT_BY_SCOPE_NAME = NO
299
# The GENERATE_TODOLIST tag can be used to enable (YES) or
300
# disable (NO) the todo list. This list is created by putting \todo
301
# commands in the documentation.
303
GENERATE_TODOLIST = NO
305
# The GENERATE_TESTLIST tag can be used to enable (YES) or
306
# disable (NO) the test list. This list is created by putting \test
307
# commands in the documentation.
309
34
GENERATE_TESTLIST = NO
311
# The GENERATE_BUGLIST tag can be used to enable (YES) or
312
# disable (NO) the bug list. This list is created by putting \bug
313
# commands in the documentation.
315
35
GENERATE_BUGLIST = YES
317
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
318
# disable (NO) the deprecated list. This list is created by putting
319
# \deprecated commands in the documentation.
321
36
GENERATE_DEPRECATEDLIST= YES
323
# The ENABLED_SECTIONS tag can be used to enable conditional
324
# documentation sections, marked by \if sectionname ... \endif.
326
37
ENABLED_SECTIONS =
328
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
329
# the initial value of a variable or define consists of for it to appear in
330
# the documentation. If the initializer consists of more lines than specified
331
# here it will be hidden. Use a value of 0 to hide initializers completely.
332
# The appearance of the initializer of individual variables and defines in the
333
# documentation can be controlled using \showinitializer or \hideinitializer
334
# command in the documentation regardless of this setting.
336
38
MAX_INITIALIZER_LINES = 30
338
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
339
# at the bottom of the documentation of classes and structs. If set to YES the
340
# list will mention the files that were used to generate the documentation.
342
39
SHOW_USED_FILES = YES
344
#---------------------------------------------------------------------------
345
# configuration options related to warning and progress messages
346
#---------------------------------------------------------------------------
348
# The QUIET tag can be used to turn on/off the messages that are generated
349
# by doxygen. Possible values are YES and NO. If left blank NO is used.
353
# The WARNINGS tag can be used to turn on/off the warning messages that are
354
# generated by doxygen. Possible values are YES and NO. If left blank
359
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
360
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
361
# automatically be disabled.
363
42
WARN_IF_UNDOCUMENTED = NO
365
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
366
# potential errors in the documentation, such as not documenting some
367
# parameters in a documented function, or documenting parameters that
368
# don't exist or using markup commands wrongly.
370
43
WARN_IF_DOC_ERROR = YES
372
# The WARN_FORMAT tag determines the format of the warning messages that
373
# doxygen can produce. The string should contain the $file, $line, and $text
374
# tags, which will be replaced by the file and line number from which the
375
# warning originated and the warning text.
379
# The WARN_LOGFILE tag can be used to specify a file to which warning
380
# and error messages should be written. If left blank the output is written
385
#---------------------------------------------------------------------------
386
# configuration options related to the input files
387
#---------------------------------------------------------------------------
389
# The INPUT tag can be used to specify the files and/or directories that contain
390
# documented source files. You may enter file names like "myfile.cpp" or
391
# directories like "/usr/src/myproject". Separate the files or directories
396
# If the value of the INPUT tag contains directories, you can use the
397
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
398
# and *.h) to filter out the source-files in the directories. If left
399
# blank the following patterns are tested:
400
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
401
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
403
47
FILE_PATTERNS = *.h \
442
# The EXAMPLE_PATH tag can be used to specify one or more files or
443
# directories that contain example code fragments that are included (see
444
# the \include command).
448
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
449
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
450
# and *.h) to filter out the source-files in the directories. If left
451
# blank all files are included.
453
67
EXAMPLE_PATTERNS =
455
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
456
# searched for input files to be used with the \include or \dontinclude
457
# commands irrespective of the value of the RECURSIVE tag.
458
# Possible values are YES and NO. If left blank NO is used.
460
68
EXAMPLE_RECURSIVE = NO
462
# The IMAGE_PATH tag can be used to specify one or more files or
463
# directories that contain image that are included in the documentation (see
464
# the \image command).
468
# The INPUT_FILTER tag can be used to specify a program that doxygen should
469
# invoke to filter for each input file. Doxygen will invoke the filter program
470
# by executing (via popen()) the command <filter> <input-file>, where <filter>
471
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
472
# input file. Doxygen will then use the output that the filter program writes
473
# to standard output.
477
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
478
# INPUT_FILTER) will be used to filter the input files when producing source
479
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
481
71
FILTER_SOURCE_FILES = NO
483
#---------------------------------------------------------------------------
484
# configuration options related to source browsing
485
#---------------------------------------------------------------------------
487
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
488
# be generated. Documented entities will be cross-referenced with these sources.
489
# Note: To get rid of all source code in the generated output, make sure also
490
# VERBATIM_HEADERS is set to NO.
492
72
SOURCE_BROWSER = YES
494
# Setting the INLINE_SOURCES tag to YES will include the body
495
# of functions and classes directly in the documentation.
497
73
INLINE_SOURCES = NO
499
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
500
# doxygen to hide any special comment blocks from generated source code
501
# fragments. Normal C and C++ comments will always remain visible.
503
74
STRIP_CODE_COMMENTS = YES
505
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
506
# then for each documented function all documented
507
# functions referencing it will be listed.
509
75
REFERENCED_BY_RELATION = YES
511
# If the REFERENCES_RELATION tag is set to YES (the default)
512
# then for each documented function all documented entities
513
# called/used by that function will be listed.
515
76
REFERENCES_RELATION = YES
517
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
518
# will generate a verbatim copy of the header file for each class for
519
# which an include is specified. Set to NO to disable this.
521
77
VERBATIM_HEADERS = YES
523
#---------------------------------------------------------------------------
524
# configuration options related to the alphabetical class index
525
#---------------------------------------------------------------------------
527
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
528
# of all compounds will be generated. Enable this if the project
529
# contains a lot of classes, structs, unions or interfaces.
531
78
ALPHABETICAL_INDEX = YES
533
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
534
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
535
# in which this list will be split (can be a number in the range [1..20])
537
79
COLS_IN_ALPHA_INDEX = 3
539
# In case all classes in a project start with a common prefix, all
540
# classes will be put under the same header in the alphabetical index.
541
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
542
# should be ignored while generating the index headers.
546
#---------------------------------------------------------------------------
547
# configuration options related to the HTML output
548
#---------------------------------------------------------------------------
550
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
551
# generate HTML output.
555
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
556
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
557
# put in front of it. If left blank `html' will be used as the default path.
561
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
562
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
563
# doxygen will generate files with .html extension.
565
81
HTML_FILE_EXTENSION = .html
567
# The HTML_HEADER tag can be used to specify a personal HTML header for
568
# each generated HTML page. If it is left blank doxygen will generate a
571
82
HTML_HEADER = ../apidocs/common/header.html
573
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
574
# each generated HTML page. If it is left blank doxygen will generate a
577
83
HTML_FOOTER = ../apidocs/common/footer.html
579
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
580
# style sheet that is used by each HTML page. It can be used to
581
# fine-tune the look of the HTML output. If the tag is left blank doxygen
582
# will generate a default style sheet. Note that doxygen will try to copy
583
# the style sheet file to the HTML output directory, so don't put your own
584
# stylesheet in the HTML output directory as well, or it will be erased!
586
84
HTML_STYLESHEET = ../apidocs/common/doxygen.css
588
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
589
# files or namespaces will be aligned in HTML using tables. If set to
590
# NO a bullet list will be used.
592
85
HTML_ALIGN_MEMBERS = YES
594
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
595
# will be generated that can be used as input for tools like the
596
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
597
# of the generated HTML documentation.
599
86
GENERATE_HTMLHELP = NO
601
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
602
# be used to specify the file name of the resulting .chm file. You
603
# can add a path in front of the file if the result should not be
604
# written to the html output directory.
608
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
609
# be used to specify the location (absolute path including file name) of
610
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
611
# the HTML help compiler on the generated index.hhp.
615
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
616
# controls if a separate .chi index file is generated (YES) or that
617
# it should be included in the master .chm file (NO).
621
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
622
# controls whether a binary table of contents is generated (YES) or a
623
# normal table of contents (NO) in the .chm file.
627
# The TOC_EXPAND flag can be set to YES to add extra items for group members
628
# to the contents of the HTML help documentation and to the tree view.
632
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
633
# top of each HTML page. The value NO (the default) enables the index and
634
# the value YES disables it.
636
92
DISABLE_INDEX = YES
638
# This tag can be used to set the number of enum values (range [1..20])
639
# that doxygen will group on one line in the generated HTML documentation.
641
93
ENUM_VALUES_PER_LINE = 4
643
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
644
# generated containing a tree-like index structure (just like the one that
645
# is generated for HTML Help). For this to work a browser that supports
646
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
647
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
648
# probably better off using the HTML help feature.
650
94
GENERATE_TREEVIEW = NO
652
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
653
# used to set the initial width (in pixels) of the frame in which the tree
656
95
TREEVIEW_WIDTH = 250
658
#---------------------------------------------------------------------------
659
# configuration options related to the LaTeX output
660
#---------------------------------------------------------------------------
662
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
663
# generate Latex output.
665
96
GENERATE_LATEX = NO
667
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
668
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
669
# put in front of it. If left blank `latex' will be used as the default path.
673
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
674
# invoked. If left blank `latex' will be used as the default command name.
676
98
LATEX_CMD_NAME = latex
678
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
679
# generate index for LaTeX. If left blank `makeindex' will be used as the
680
# default command name.
682
99
MAKEINDEX_CMD_NAME = makeindex
684
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
685
# LaTeX documents. This may be useful for small projects and may help to
686
# save some trees in general.
688
100
COMPACT_LATEX = NO
690
# The PAPER_TYPE tag can be used to set the paper type that is used
691
# by the printer. Possible values are: a4, a4wide, letter, legal and
692
# executive. If left blank a4wide will be used.
694
101
PAPER_TYPE = a4wide
696
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
697
# packages that should be included in the LaTeX output.
701
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
702
# the generated latex document. The header should contain everything until
703
# the first chapter. If it is left blank doxygen will generate a
704
# standard header. Notice: only use this tag if you know what you are doing!
708
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
709
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
710
# contain links (just like the HTML output) instead of page references
711
# This makes the output suitable for online browsing using a pdf viewer.
713
104
PDF_HYPERLINKS = NO
715
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
716
# plain latex in the generated Makefile. Set this option to YES to get a
717
# higher quality PDF documentation.
719
105
USE_PDFLATEX = NO
721
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
722
# command to the generated LaTeX files. This will instruct LaTeX to keep
723
# running if errors occur, instead of asking the user for help.
724
# This option is also used when generating formulas in HTML.
726
106
LATEX_BATCHMODE = NO
728
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
729
# include the index chapters (such as File Index, Compound Index, etc.)
732
107
LATEX_HIDE_INDICES = NO
734
#---------------------------------------------------------------------------
735
# configuration options related to the RTF output
736
#---------------------------------------------------------------------------
738
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
739
# The RTF output is optimized for Word 97 and may not look very pretty with
740
# other RTF readers or editors.
742
108
GENERATE_RTF = NO
744
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
745
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
746
# put in front of it. If left blank `rtf' will be used as the default path.
750
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
751
# RTF documents. This may be useful for small projects and may help to
752
# save some trees in general.
756
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
757
# will contain hyperlink fields. The RTF file will
758
# contain links (just like the HTML output) instead of page references.
759
# This makes the output suitable for online browsing using WORD or other
760
# programs which support those fields.
761
# Note: wordpad (write) and others do not support links.
763
111
RTF_HYPERLINKS = NO
765
# Load stylesheet definitions from file. Syntax is similar to doxygen's
766
# config file, i.e. a series of assignments. You only have to provide
767
# replacements, missing definitions are set to their default value.
769
112
RTF_STYLESHEET_FILE =
771
# Set optional variables used in the generation of an rtf document.
772
# Syntax is similar to doxygen's config file.
774
113
RTF_EXTENSIONS_FILE =
776
#---------------------------------------------------------------------------
777
# configuration options related to the man page output
778
#---------------------------------------------------------------------------
780
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
783
114
GENERATE_MAN = NO
785
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
786
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
787
# put in front of it. If left blank `man' will be used as the default path.
791
# The MAN_EXTENSION tag determines the extension that is added to
792
# the generated man pages (default is the subroutine's section .3)
794
116
MAN_EXTENSION = .kde3
796
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
797
# then it will generate one additional man file for each entity
798
# documented in the real man page(s). These additional files
799
# only source the real man page, but without them the man command
800
# would be unable to find the correct page. The default is NO.
804
#---------------------------------------------------------------------------
805
# configuration options related to the XML output
806
#---------------------------------------------------------------------------
808
# If the GENERATE_XML tag is set to YES Doxygen will
809
# generate an XML file that captures the structure of
810
# the code including all documentation.
812
118
GENERATE_XML = NO
814
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
815
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
816
# put in front of it. If left blank `xml' will be used as the default path.
820
# The XML_SCHEMA tag can be used to specify an XML schema,
821
# which can be used by a validating XML parser to check the
822
# syntax of the XML files.
826
# The XML_DTD tag can be used to specify an XML DTD,
827
# which can be used by a validating XML parser to check the
828
# syntax of the XML files.
832
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
833
# dump the program listings (including syntax highlighting
834
# and cross-referencing information) to the XML output. Note that
835
# enabling this will significantly increase the size of the XML output.
837
122
XML_PROGRAMLISTING = NO
839
#---------------------------------------------------------------------------
840
# configuration options for the AutoGen Definitions output
841
#---------------------------------------------------------------------------
843
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
844
# generate an AutoGen Definitions (see autogen.sf.net) file
845
# that captures the structure of the code including all
846
# documentation. Note that this feature is still experimental
847
# and incomplete at the moment.
849
123
GENERATE_AUTOGEN_DEF = NO
851
#---------------------------------------------------------------------------
852
# configuration options related to the Perl module output
853
#---------------------------------------------------------------------------
855
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
856
# generate a Perl module file that captures the structure of
857
# the code including all documentation. Note that this
858
# feature is still experimental and incomplete at the
861
124
GENERATE_PERLMOD = NO
863
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
864
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
865
# to generate PDF and DVI output from the Perl module output.
867
125
PERLMOD_LATEX = NO
869
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
870
# nicely formatted so it can be parsed by a human reader. This is useful
871
# if you want to understand what is going on. On the other hand, if this
872
# tag is set to NO the size of the Perl module output will be much smaller
873
# and Perl will parse it just the same.
875
126
PERLMOD_PRETTY = YES
877
# The names of the make variables in the generated doxyrules.make file
878
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
879
# This is useful so different doxyrules.make files included by the same
880
# Makefile don't overwrite each other's variables.
882
127
PERLMOD_MAKEVAR_PREFIX =
884
#---------------------------------------------------------------------------
885
# Configuration options related to the preprocessor
886
#---------------------------------------------------------------------------
888
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
889
# evaluate all C-preprocessor directives found in the sources and include
892
128
ENABLE_PREPROCESSING = YES
894
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
895
# names in the source code. If set to NO (the default) only conditional
896
# compilation will be performed. Macro expansion can be done in a controlled
897
# way by setting EXPAND_ONLY_PREDEF to YES.
901
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
902
# then the macro expansion is limited to the macros specified with the
903
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
905
EXPAND_ONLY_PREDEF = NO
907
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
908
# in the INCLUDE_PATH (see below) will be search if a #include is found.
910
129
SEARCH_INCLUDES = YES
912
# The INCLUDE_PATH tag can be used to specify one or more directories that
913
# contain include files that are not input files but should be processed by
918
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
919
# patterns (like *.h and *.hpp) to filter out the header-files in the
920
# directories. If left blank, the patterns specified with FILE_PATTERNS will
923
131
INCLUDE_FILE_PATTERNS =
925
# The PREDEFINED tag can be used to specify one or more macro names that
926
# are defined before the preprocessor is started (similar to the -D option of
927
# gcc). The argument of the tag is a list of macros of the form: name
928
# or name=definition (no spaces). If the definition and the = are
929
# omitted =1 is assumed.
931
132
PREDEFINED = QT_VERSION=320 \
935
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
936
# this tag can be used to specify a list of macro names that should be expanded.
937
# The macro definition that is found in the sources will be used.
938
# Use the PREDEFINED tag if you want to use a different macro definition.
940
135
EXPAND_AS_DEFINED =
942
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
943
# doxygen's preprocessor will remove all function-like macros that are alone
944
# on a line, have an all uppercase name, and do not end with a semicolon. Such
945
# function macros are typically used for boiler-plate code, and will confuse the
946
# parser if not removed.
948
136
SKIP_FUNCTION_MACROS = YES
950
#---------------------------------------------------------------------------
951
# Configuration::additions related to external references
952
#---------------------------------------------------------------------------
954
# The TAGFILES option can be used to specify one or more tagfiles.
955
# Optionally an initial location of the external documentation
956
# can be added for each tagfile. The format of a tag file without
957
# this location is as follows:
958
# TAGFILES = file1 file2 ...
959
# Adding location for the tag files is done as follows:
960
# TAGFILES = file1=loc1 "file2 = loc2" ...
961
# where "loc1" and "loc2" can be relative or absolute paths or
962
# URLs. If a location is present for each tag, the installdox tool
963
# does not have to be run to correct the links.
964
# Note that each tag file must have a unique name
965
# (where the name does NOT include the path)
966
# If a tag file is not located in the directory in which doxygen
967
# is run, you must also specify the path to the tagfile here.
971
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
972
# a tag file that is based on the input files it reads.
974
138
GENERATE_TAGFILE =
976
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
977
# in the class index. If set to NO only the inherited external classes
980
139
ALLEXTERNALS = NO
982
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
983
# in the modules index. If set to NO, only the current project's groups will
986
140
EXTERNAL_GROUPS = NO
988
# The PERL_PATH should be the absolute path and name of the perl script
989
# interpreter (i.e. the result of `which perl').
993
#---------------------------------------------------------------------------
994
# Configuration options related to the dot tool
995
#---------------------------------------------------------------------------
997
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
998
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
999
# super classes. Setting the tag to NO turns the diagrams off. Note that this
1000
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1001
# recommended to install and use dot, since it yields more powerful graphs.
1003
142
CLASS_DIAGRAMS = YES
1005
# If set to YES, the inheritance and collaboration graphs will hide
1006
# inheritance and usage relations if the target is undocumented
1007
# or is not a class.
1009
143
HIDE_UNDOC_RELATIONS = NO
1011
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1012
# available from the path. This tool is part of Graphviz, a graph visualization
1013
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1014
# have no effect if this option is set to NO (the default)
1018
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1019
# will generate a graph for each documented class showing the direct and
1020
# indirect inheritance relations. Setting this tag to YES will force the
1021
# the CLASS_DIAGRAMS tag to NO.
1025
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1026
# will generate a graph for each documented class showing the direct and
1027
# indirect implementation dependencies (inheritance, containment, and
1028
# class references variables) of the class with other documented classes.
1030
COLLABORATION_GRAPH = YES
1032
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1033
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1038
# If set to YES, the inheritance and collaboration graphs will show the
1039
# relations between templates and their instances.
1041
146
TEMPLATE_RELATIONS = YES
1043
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1044
# tags are set to YES then doxygen will generate a graph for each documented
1045
# file showing the direct and indirect include dependencies of the file with
1046
# other documented files.
1048
147
INCLUDE_GRAPH = YES
1050
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1051
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1052
# documented header file showing the documented files that directly or
1053
# indirectly include this file.
1055
148
INCLUDED_BY_GRAPH = YES
1057
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1058
# generate a call dependency graph for every global function or class method.
1059
# Note that enabling this option will significantly increase the time of a run.
1060
# So in most cases it will be better to enable call graphs for selected
1061
# functions only using the \callgraph command.
1065
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1066
# will graphical hierarchy of all classes instead of a textual one.
1068
150
GRAPHICAL_HIERARCHY = YES
1070
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1071
# generated by dot. Possible values are png, jpg, or gif
1072
# If left blank png will be used.
1074
151
DOT_IMAGE_FORMAT = png
1076
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1077
# found. If left blank, it is assumed the dot tool can be found on the path.
1081
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1082
# contain dot files that are included in the documentation (see the
1083
# \dotfile command).
1087
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1088
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1089
# this value, doxygen will try to truncate the graph, so that it fits within
1090
# the specified constraint. Beware that most browsers cannot cope with very
1093
154
MAX_DOT_GRAPH_WIDTH = 800
1095
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1096
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1097
# this value, doxygen will try to truncate the graph, so that it fits within
1098
# the specified constraint. Beware that most browsers cannot cope with very
1101
155
MAX_DOT_GRAPH_HEIGHT = 1024
1103
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1104
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1105
# from the root by following a path via at most 3 edges will be shown. Nodes that
1106
# lay further from the root node will be omitted. Note that setting this option to
1107
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1108
# note that a graph may be further truncated if the graph's image dimensions are
1109
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1110
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1112
156
MAX_DOT_GRAPH_DEPTH = 0
1114
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1115
# generate a legend page explaining the meaning of the various boxes and
1116
# arrows in the dot generated graphs.
1118
157
GENERATE_LEGEND = YES
1120
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1121
# remove the intermediate dot files that are used to generate
1122
# the various graphs.
1124
158
DOT_CLEANUP = YES
1126
#---------------------------------------------------------------------------
1127
# Configuration::additions related to the search engine
1128
#---------------------------------------------------------------------------
1130
# The SEARCHENGINE tag specifies whether or not a search engine should be
1131
# used. If set to NO the values of all tags below this one will be ignored.
1133
159
SEARCHENGINE = NO
163
"intern=\par<b>Internal use only.</b>" \
164
"reimp=\par<b>Reimplemented from superclass.</b>" \
165
"obsolete=@deprecated" \
166
"feature=\xrefitem features \"Feature(s)\" \"Features\"" \
167
"maintainer=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
168
"unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \
169
"requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \
170
"faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \
171
"authors=\xrefitem authors \"Author(s)\" \"Authors\"" \
172
"FIXME=\xrefitem fixme \"Fixme\" \"Fixme\""
174
HTML_ALIGN_MEMBERS = YES
175
REFERENCED_BY_RELATION = NO
176
REFERENCES_RELATION = NO
177
VERBATIM_HEADERS = NO
180
GENERATE_AUTOGEN_DEF = NO
182
SORT_MEMBER_DOCS = YES
183
GENERATE_TODOLIST = YES
187
COLLABORATION_GRAPH = NO
190
MACRO_EXPANSION = YES
191
EXPAND_ONLY_PREDEF = YES