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, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44
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
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
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
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
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.
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.
107
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
108
# (but less readable) file names. This can be useful is your file systems
109
# doesn't support long names like on DOS, Mac, or CD-ROM.
113
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
114
# will interpret the first line (until the first dot) of a JavaDoc-style
115
# comment as the brief description. If set to NO, the JavaDoc
116
# comments will behave just like the Qt-style comments (thus requiring an
117
# explicit @brief command for a brief description.
119
JAVADOC_AUTOBRIEF = YES
121
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
122
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
123
# comments) as a brief description. This used to be the default behaviour.
124
# The new default is to treat a multi-line C++ comment block as a detailed
125
# description. Set this tag to YES if you prefer the old behaviour instead.
127
MULTILINE_CPP_IS_BRIEF = NO
129
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
130
# will output the detailed description near the top, like JavaDoc.
131
# If set to NO, the detailed description appears after the member
136
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
137
# member inherits the documentation from any documented member that it
142
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
143
# tag is set to YES, then doxygen will reuse the documentation of the first
144
# member in the group (if any) for the other members of the group. By default
145
# all members of a group must be documented explicitly.
147
DISTRIBUTE_GROUP_DOC = NO
149
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
150
# Doxygen uses this value to replace tabs by spaces in code fragments.
154
# This tag can be used to specify a number of aliases that acts
155
# as commands in the documentation. An alias has the form "name=value".
156
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
157
# put the command \sideeffect (or @sideeffect) in the documentation, which
158
# will result in a user-defined paragraph with heading "Side Effects:".
159
# You can put \n's in the value part of an alias to insert newlines.
161
ALIASES = obsolete=@deprecated
163
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
164
# only. Doxygen will then generate output that is more tailored for C.
165
# For instance, some of the names that are used will be different. The list
166
# of all members will be omitted, etc.
168
OPTIMIZE_OUTPUT_FOR_C = NO
170
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
171
# only. Doxygen will then generate output that is more tailored for Java.
172
# For instance, namespaces will be presented as packages, qualified scopes
173
# will look different, etc.
175
OPTIMIZE_OUTPUT_JAVA = NO
177
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
178
# the same type (for instance a group of public functions) to be put as a
179
# subgroup of that type (e.g. under the Public Functions section). Set it to
180
# NO to prevent subgrouping. Alternatively, this can be done per class using
181
# the \nosubgrouping command.
185
#---------------------------------------------------------------------------
186
# Build related configuration options
187
#---------------------------------------------------------------------------
189
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
190
# documentation are documented, even if no documentation was available.
191
# Private class members and static file members will be hidden unless
192
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
196
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
197
# will be included in the documentation.
201
# If the EXTRACT_STATIC tag is set to YES all static members of a file
202
# will be included in the documentation.
206
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
207
# defined locally in source files will be included in the documentation.
208
# If set to NO only classes defined in header files are included.
210
EXTRACT_LOCAL_CLASSES = NO
212
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
213
# undocumented members of documented classes, files or namespaces.
214
# If set to NO (the default) these members will be included in the
215
# various overviews, but no documentation section is generated.
216
# This option has no effect if EXTRACT_ALL is enabled.
218
HIDE_UNDOC_MEMBERS = NO
220
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
221
# undocumented classes that are normally visible in the class hierarchy.
222
# If set to NO (the default) these classes will be included in the various
223
# overviews. This option has no effect if EXTRACT_ALL is enabled.
225
HIDE_UNDOC_CLASSES = YES
227
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
228
# friend (class|struct|union) declarations.
229
# If set to NO (the default) these declarations will be included in the
232
HIDE_FRIEND_COMPOUNDS = NO
234
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
235
# documentation blocks found inside the body of a function.
236
# If set to NO (the default) these blocks will be appended to the
237
# function's detailed documentation block.
239
HIDE_IN_BODY_DOCS = NO
241
# The INTERNAL_DOCS tag determines if documentation
242
# that is typed after a \internal command is included. If the tag is set
243
# to NO (the default) then the documentation will be excluded.
244
# Set it to YES to include the internal documentation.
248
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
249
# file names in lower-case letters. If set to YES upper-case letters are also
250
# allowed. This is useful if you have classes or files whose names only differ
251
# in case and if your file system supports case sensitive file names. Windows
252
# users are advised to set this option to NO.
254
CASE_SENSE_NAMES = YES
256
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
257
# will show members with their full class and namespace scopes in the
258
# documentation. If set to YES the scope will be hidden.
260
HIDE_SCOPE_NAMES = NO
262
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
263
# will put a list of the files that are included by a file in the documentation
266
SHOW_INCLUDE_FILES = YES
268
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
269
# is inserted in the documentation for inline members.
273
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
274
# will sort the (detailed) documentation of file and class members
275
# alphabetically by member name. If set to NO the members will appear in
278
SORT_MEMBER_DOCS = NO
280
# The GENERATE_TODOLIST tag can be used to enable (YES) or
281
# disable (NO) the todo list. This list is created by putting \todo
282
# commands in the documentation.
284
GENERATE_TODOLIST = NO
286
# The GENERATE_TESTLIST tag can be used to enable (YES) or
287
# disable (NO) the test list. This list is created by putting \test
288
# commands in the documentation.
290
GENERATE_TESTLIST = NO
292
# The GENERATE_BUGLIST tag can be used to enable (YES) or
293
# disable (NO) the bug list. This list is created by putting \bug
294
# commands in the documentation.
296
GENERATE_BUGLIST = YES
298
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
299
# disable (NO) the deprecated list. This list is created by putting
300
# \deprecated commands in the documentation.
302
GENERATE_DEPRECATEDLIST= YES
304
# The ENABLED_SECTIONS tag can be used to enable conditional
305
# documentation sections, marked by \if sectionname ... \endif.
309
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
310
# the initial value of a variable or define consists of for it to appear in
311
# the documentation. If the initializer consists of more lines than specified
312
# here it will be hidden. Use a value of 0 to hide initializers completely.
313
# The appearance of the initializer of individual variables and defines in the
314
# documentation can be controlled using \showinitializer or \hideinitializer
315
# command in the documentation regardless of this setting.
317
MAX_INITIALIZER_LINES = 30
319
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
320
# at the bottom of the documentation of classes and structs. If set to YES the
321
# list will mention the files that were used to generate the documentation.
323
SHOW_USED_FILES = YES
325
#---------------------------------------------------------------------------
326
# configuration options related to warning and progress messages
327
#---------------------------------------------------------------------------
329
# The QUIET tag can be used to turn on/off the messages that are generated
330
# by doxygen. Possible values are YES and NO. If left blank NO is used.
334
# The WARNINGS tag can be used to turn on/off the warning messages that are
335
# generated by doxygen. Possible values are YES and NO. If left blank
340
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
341
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
342
# automatically be disabled.
344
WARN_IF_UNDOCUMENTED = NO
346
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
347
# potential errors in the documentation, such as not documenting some
348
# parameters in a documented function, or documenting parameters that
349
# don't exist or using markup commands wrongly.
351
WARN_IF_DOC_ERROR = YES
353
# The WARN_FORMAT tag determines the format of the warning messages that
354
# doxygen can produce. The string should contain the $file, $line, and $text
355
# tags, which will be replaced by the file and line number from which the
356
# warning originated and the warning text.
360
# The WARN_LOGFILE tag can be used to specify a file to which warning
361
# and error messages should be written. If left blank the output is written
366
#---------------------------------------------------------------------------
367
# configuration options related to the input files
368
#---------------------------------------------------------------------------
370
# The INPUT tag can be used to specify the files and/or directories that contain
371
# documented source files. You may enter file names like "myfile.cpp" or
372
# directories like "/usr/src/myproject". Separate the files or directories
377
# If the value of the INPUT tag contains directories, you can use the
378
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
379
# and *.h) to filter out the source-files in the directories. If left
380
# blank the following patterns are tested:
381
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
382
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
384
FILE_PATTERNS = *.h \
394
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
395
# should be searched for input files as well. Possible values are YES and NO.
396
# If left blank NO is used.
400
# The EXCLUDE tag can be used to specify files and/or directories that should
401
# excluded from the INPUT source files. This way you can easily exclude a
402
# subdirectory from a directory tree whose root is specified with the INPUT tag.
406
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
407
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
409
EXCLUDE_SYMLINKS = NO
411
# If the value of the INPUT tag contains directories, you can use the
412
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
413
# certain files from those directories.
415
EXCLUDE_PATTERNS = *.moc.* \
422
# The EXAMPLE_PATH tag can be used to specify one or more files or
423
# directories that contain example code fragments that are included (see
424
# the \include command).
428
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
429
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
430
# and *.h) to filter out the source-files in the directories. If left
431
# blank all files are included.
435
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
436
# searched for input files to be used with the \include or \dontinclude
437
# commands irrespective of the value of the RECURSIVE tag.
438
# Possible values are YES and NO. If left blank NO is used.
440
EXAMPLE_RECURSIVE = NO
442
# The IMAGE_PATH tag can be used to specify one or more files or
443
# directories that contain image that are included in the documentation (see
444
# the \image command).
448
# The INPUT_FILTER tag can be used to specify a program that doxygen should
449
# invoke to filter for each input file. Doxygen will invoke the filter program
450
# by executing (via popen()) the command <filter> <input-file>, where <filter>
451
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
452
# input file. Doxygen will then use the output that the filter program writes
453
# to standard output.
457
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
458
# INPUT_FILTER) will be used to filter the input files when producing source
459
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
461
FILTER_SOURCE_FILES = NO
463
#---------------------------------------------------------------------------
464
# configuration options related to source browsing
465
#---------------------------------------------------------------------------
467
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
468
# be generated. Documented entities will be cross-referenced with these sources.
469
# Note: To get rid of all source code in the generated output, make sure also
470
# VERBATIM_HEADERS is set to NO.
474
# Setting the INLINE_SOURCES tag to YES will include the body
475
# of functions and classes directly in the documentation.
479
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
480
# doxygen to hide any special comment blocks from generated source code
481
# fragments. Normal C and C++ comments will always remain visible.
483
STRIP_CODE_COMMENTS = YES
485
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
486
# then for each documented function all documented
487
# functions referencing it will be listed.
489
REFERENCED_BY_RELATION = YES
491
# If the REFERENCES_RELATION tag is set to YES (the default)
492
# then for each documented function all documented entities
493
# called/used by that function will be listed.
495
REFERENCES_RELATION = YES
497
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
498
# will generate a verbatim copy of the header file for each class for
499
# which an include is specified. Set to NO to disable this.
501
VERBATIM_HEADERS = YES
503
#---------------------------------------------------------------------------
504
# configuration options related to the alphabetical class index
505
#---------------------------------------------------------------------------
507
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
508
# of all compounds will be generated. Enable this if the project
509
# contains a lot of classes, structs, unions or interfaces.
511
ALPHABETICAL_INDEX = YES
513
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
514
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
515
# in which this list will be split (can be a number in the range [1..20])
517
COLS_IN_ALPHA_INDEX = 3
519
# In case all classes in a project start with a common prefix, all
520
# classes will be put under the same header in the alphabetical index.
521
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
522
# should be ignored while generating the index headers.
526
#---------------------------------------------------------------------------
527
# configuration options related to the HTML output
528
#---------------------------------------------------------------------------
530
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
531
# generate HTML output.
535
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
536
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
537
# put in front of it. If left blank `html' will be used as the default path.
541
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
542
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
543
# doxygen will generate files with .html extension.
545
HTML_FILE_EXTENSION = .html
547
# The HTML_HEADER tag can be used to specify a personal HTML header for
548
# each generated HTML page. If it is left blank doxygen will generate a
551
HTML_HEADER = ../apidocs/common/header.html
553
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
554
# each generated HTML page. If it is left blank doxygen will generate a
557
HTML_FOOTER = ../apidocs/common/footer.html
559
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
560
# style sheet that is used by each HTML page. It can be used to
561
# fine-tune the look of the HTML output. If the tag is left blank doxygen
562
# will generate a default style sheet. Note that doxygen will try to copy
563
# the style sheet file to the HTML output directory, so don't put your own
564
# stylesheet in the HTML output directory as well, or it will be erased!
566
HTML_STYLESHEET = ../apidocs/common/doxygen.css
568
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
569
# files or namespaces will be aligned in HTML using tables. If set to
570
# NO a bullet list will be used.
572
HTML_ALIGN_MEMBERS = YES
574
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
575
# will be generated that can be used as input for tools like the
576
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
577
# of the generated HTML documentation.
579
GENERATE_HTMLHELP = NO
581
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
582
# be used to specify the file name of the resulting .chm file. You
583
# can add a path in front of the file if the result should not be
584
# written to the html output directory.
588
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
589
# be used to specify the location (absolute path including file name) of
590
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
591
# the HTML help compiler on the generated index.hhp.
595
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
596
# controls if a separate .chi index file is generated (YES) or that
597
# it should be included in the master .chm file (NO).
601
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
602
# controls whether a binary table of contents is generated (YES) or a
603
# normal table of contents (NO) in the .chm file.
607
# The TOC_EXPAND flag can be set to YES to add extra items for group members
608
# to the contents of the HTML help documentation and to the tree view.
612
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
613
# top of each HTML page. The value NO (the default) enables the index and
614
# the value YES disables it.
618
# This tag can be used to set the number of enum values (range [1..20])
619
# that doxygen will group on one line in the generated HTML documentation.
621
ENUM_VALUES_PER_LINE = 4
623
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
624
# generated containing a tree-like index structure (just like the one that
625
# is generated for HTML Help). For this to work a browser that supports
626
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
627
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
628
# probably better off using the HTML help feature.
630
GENERATE_TREEVIEW = NO
632
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
633
# used to set the initial width (in pixels) of the frame in which the tree
638
#---------------------------------------------------------------------------
639
# configuration options related to the LaTeX output
640
#---------------------------------------------------------------------------
642
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
643
# generate Latex output.
647
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
648
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
649
# put in front of it. If left blank `latex' will be used as the default path.
653
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
654
# invoked. If left blank `latex' will be used as the default command name.
656
LATEX_CMD_NAME = latex
658
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
659
# generate index for LaTeX. If left blank `makeindex' will be used as the
660
# default command name.
662
MAKEINDEX_CMD_NAME = makeindex
664
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
665
# LaTeX documents. This may be useful for small projects and may help to
666
# save some trees in general.
670
# The PAPER_TYPE tag can be used to set the paper type that is used
671
# by the printer. Possible values are: a4, a4wide, letter, legal and
672
# executive. If left blank a4wide will be used.
676
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
677
# packages that should be included in the LaTeX output.
681
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
682
# the generated latex document. The header should contain everything until
683
# the first chapter. If it is left blank doxygen will generate a
684
# standard header. Notice: only use this tag if you know what you are doing!
688
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
689
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
690
# contain links (just like the HTML output) instead of page references
691
# This makes the output suitable for online browsing using a pdf viewer.
695
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
696
# plain latex in the generated Makefile. Set this option to YES to get a
697
# higher quality PDF documentation.
701
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
702
# command to the generated LaTeX files. This will instruct LaTeX to keep
703
# running if errors occur, instead of asking the user for help.
704
# This option is also used when generating formulas in HTML.
708
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
709
# include the index chapters (such as File Index, Compound Index, etc.)
712
LATEX_HIDE_INDICES = NO
714
#---------------------------------------------------------------------------
715
# configuration options related to the RTF output
716
#---------------------------------------------------------------------------
718
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
719
# The RTF output is optimized for Word 97 and may not look very pretty with
720
# other RTF readers or editors.
724
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
725
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
726
# put in front of it. If left blank `rtf' will be used as the default path.
730
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
731
# RTF documents. This may be useful for small projects and may help to
732
# save some trees in general.
736
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
737
# will contain hyperlink fields. The RTF file will
738
# contain links (just like the HTML output) instead of page references.
739
# This makes the output suitable for online browsing using WORD or other
740
# programs which support those fields.
741
# Note: wordpad (write) and others do not support links.
745
# Load stylesheet definitions from file. Syntax is similar to doxygen's
746
# config file, i.e. a series of assignments. You only have to provide
747
# replacements, missing definitions are set to their default value.
749
RTF_STYLESHEET_FILE =
751
# Set optional variables used in the generation of an rtf document.
752
# Syntax is similar to doxygen's config file.
754
RTF_EXTENSIONS_FILE =
756
#---------------------------------------------------------------------------
757
# configuration options related to the man page output
758
#---------------------------------------------------------------------------
760
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
765
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
766
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
767
# put in front of it. If left blank `man' will be used as the default path.
771
# The MAN_EXTENSION tag determines the extension that is added to
772
# the generated man pages (default is the subroutine's section .3)
774
MAN_EXTENSION = .kde3
776
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
777
# then it will generate one additional man file for each entity
778
# documented in the real man page(s). These additional files
779
# only source the real man page, but without them the man command
780
# would be unable to find the correct page. The default is NO.
784
#---------------------------------------------------------------------------
785
# configuration options related to the XML output
786
#---------------------------------------------------------------------------
788
# If the GENERATE_XML tag is set to YES Doxygen will
789
# generate an XML file that captures the structure of
790
# the code including all documentation.
794
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
795
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
796
# put in front of it. If left blank `xml' will be used as the default path.
800
# The XML_SCHEMA tag can be used to specify an XML schema,
801
# which can be used by a validating XML parser to check the
802
# syntax of the XML files.
806
# The XML_DTD tag can be used to specify an XML DTD,
807
# which can be used by a validating XML parser to check the
808
# syntax of the XML files.
812
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
813
# dump the program listings (including syntax highlighting
814
# and cross-referencing information) to the XML output. Note that
815
# enabling this will significantly increase the size of the XML output.
817
XML_PROGRAMLISTING = NO
819
#---------------------------------------------------------------------------
820
# configuration options for the AutoGen Definitions output
821
#---------------------------------------------------------------------------
823
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
824
# generate an AutoGen Definitions (see autogen.sf.net) file
825
# that captures the structure of the code including all
826
# documentation. Note that this feature is still experimental
827
# and incomplete at the moment.
829
GENERATE_AUTOGEN_DEF = NO
831
#---------------------------------------------------------------------------
832
# configuration options related to the Perl module output
833
#---------------------------------------------------------------------------
835
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
836
# generate a Perl module file that captures the structure of
837
# the code including all documentation. Note that this
838
# feature is still experimental and incomplete at the
841
GENERATE_PERLMOD = NO
843
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
844
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
845
# to generate PDF and DVI output from the Perl module output.
849
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
850
# nicely formatted so it can be parsed by a human reader. This is useful
851
# if you want to understand what is going on. On the other hand, if this
852
# tag is set to NO the size of the Perl module output will be much smaller
853
# and Perl will parse it just the same.
857
# The names of the make variables in the generated doxyrules.make file
858
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
859
# This is useful so different doxyrules.make files included by the same
860
# Makefile don't overwrite each other's variables.
862
PERLMOD_MAKEVAR_PREFIX =
864
#---------------------------------------------------------------------------
865
# Configuration options related to the preprocessor
866
#---------------------------------------------------------------------------
868
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
869
# evaluate all C-preprocessor directives found in the sources and include
872
ENABLE_PREPROCESSING = YES
874
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
875
# names in the source code. If set to NO (the default) only conditional
876
# compilation will be performed. Macro expansion can be done in a controlled
877
# way by setting EXPAND_ONLY_PREDEF to YES.
881
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
882
# then the macro expansion is limited to the macros specified with the
883
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
885
EXPAND_ONLY_PREDEF = NO
887
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
888
# in the INCLUDE_PATH (see below) will be search if a #include is found.
890
SEARCH_INCLUDES = YES
892
# The INCLUDE_PATH tag can be used to specify one or more directories that
893
# contain include files that are not input files but should be processed by
898
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
899
# patterns (like *.h and *.hpp) to filter out the header-files in the
900
# directories. If left blank, the patterns specified with FILE_PATTERNS will
903
INCLUDE_FILE_PATTERNS =
905
# The PREDEFINED tag can be used to specify one or more macro names that
906
# are defined before the preprocessor is started (similar to the -D option of
907
# gcc). The argument of the tag is a list of macros of the form: name
908
# or name=definition (no spaces). If the definition and the = are
909
# omitted =1 is assumed.
911
PREDEFINED = QT_VERSION=320 \
914
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
915
# this tag can be used to specify a list of macro names that should be expanded.
916
# The macro definition that is found in the sources will be used.
917
# Use the PREDEFINED tag if you want to use a different macro definition.
921
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
922
# doxygen's preprocessor will remove all function-like macros that are alone
923
# on a line, have an all uppercase name, and do not end with a semicolon. Such
924
# function macros are typically used for boiler-plate code, and will confuse the
925
# parser if not removed.
927
SKIP_FUNCTION_MACROS = YES
929
#---------------------------------------------------------------------------
930
# Configuration::addtions related to external references
931
#---------------------------------------------------------------------------
933
# The TAGFILES option can be used to specify one or more tagfiles.
934
# Optionally an initial location of the external documentation
935
# can be added for each tagfile. The format of a tag file without
936
# this location is as follows:
937
# TAGFILES = file1 file2 ...
938
# Adding location for the tag files is done as follows:
939
# TAGFILES = file1=loc1 "file2 = loc2" ...
940
# where "loc1" and "loc2" can be relative or absolute paths or
941
# URLs. If a location is present for each tag, the installdox tool
942
# does not have to be run to correct the links.
943
# Note that each tag file must have a unique name
944
# (where the name does NOT include the path)
945
# If a tag file is not located in the directory in which doxygen
946
# is run, you must also specify the path to the tagfile here.
950
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
951
# a tag file that is based on the input files it reads.
955
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
956
# in the class index. If set to NO only the inherited external classes
961
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
962
# in the modules index. If set to NO, only the current project's groups will
967
# The PERL_PATH should be the absolute path and name of the perl script
968
# interpreter (i.e. the result of `which perl').
972
#---------------------------------------------------------------------------
973
# Configuration options related to the dot tool
974
#---------------------------------------------------------------------------
976
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
977
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
978
# super classes. Setting the tag to NO turns the diagrams off. Note that this
979
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
980
# recommended to install and use dot, since it yields more powerful graphs.
984
# If set to YES, the inheritance and collaboration graphs will hide
985
# inheritance and usage relations if the target is undocumented
988
HIDE_UNDOC_RELATIONS = NO
990
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
991
# available from the path. This tool is part of Graphviz, a graph visualization
992
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
993
# have no effect if this option is set to NO (the default)
997
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
998
# will generate a graph for each documented class showing the direct and
999
# indirect inheritance relations. Setting this tag to YES will force the
1000
# the CLASS_DIAGRAMS tag to NO.
1004
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1005
# will generate a graph for each documented class showing the direct and
1006
# indirect implementation dependencies (inheritance, containment, and
1007
# class references variables) of the class with other documented classes.
1009
COLLABORATION_GRAPH = YES
1011
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1012
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1017
# If set to YES, the inheritance and collaboration graphs will show the
1018
# relations between templates and their instances.
1020
TEMPLATE_RELATIONS = YES
1022
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1023
# tags are set to YES then doxygen will generate a graph for each documented
1024
# file showing the direct and indirect include dependencies of the file with
1025
# other documented files.
1029
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1030
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1031
# documented header file showing the documented files that directly or
1032
# indirectly include this file.
1034
INCLUDED_BY_GRAPH = YES
1036
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1037
# generate a call dependency graph for every global function or class method.
1038
# Note that enabling this option will significantly increase the time of a run.
1039
# So in most cases it will be better to enable call graphs for selected
1040
# functions only using the \callgraph command.
1044
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1045
# will graphical hierarchy of all classes instead of a textual one.
1047
GRAPHICAL_HIERARCHY = YES
1049
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1050
# generated by dot. Possible values are png, jpg, or gif
1051
# If left blank png will be used.
1053
DOT_IMAGE_FORMAT = png
1055
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1056
# found. If left blank, it is assumed the dot tool can be found on the path.
1060
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1061
# contain dot files that are included in the documentation (see the
1062
# \dotfile command).
1066
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1067
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1068
# this value, doxygen will try to truncate the graph, so that it fits within
1069
# the specified constraint. Beware that most browsers cannot cope with very
1072
MAX_DOT_GRAPH_WIDTH = 800
1074
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1075
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1076
# this value, doxygen will try to truncate the graph, so that it fits within
1077
# the specified constraint. Beware that most browsers cannot cope with very
1080
MAX_DOT_GRAPH_HEIGHT = 1024
1082
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1083
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1084
# from the root by following a path via at most 3 edges will be shown. Nodes that
1085
# lay further from the root node will be omitted. Note that setting this option to
1086
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1087
# note that a graph may be further truncated if the graph's image dimensions are
1088
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1089
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1091
MAX_DOT_GRAPH_DEPTH = 0
1093
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1094
# generate a legend page explaining the meaning of the various boxes and
1095
# arrows in the dot generated graphs.
1097
GENERATE_LEGEND = YES
1099
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1100
# remove the intermediate dot files that are used to generate
1101
# the various graphs.
1105
#---------------------------------------------------------------------------
1106
# Configuration::addtions related to the search engine
1107
#---------------------------------------------------------------------------
1109
# The SEARCHENGINE tag specifies whether or not a search engine should be
1110
# used. If set to NO the values of all tags below this one will be ignored.
added
removed
admin/Doxyfile.global
