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
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
23
DOXYFILE_ENCODING = UTF-8
25
# The PROJECT_NAME tag is a single word (or sequence of words) that should
26
# identify the project. Note that if you do not use Doxywizard you need
27
# to put quotes around the project name if it contains spaces.
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
# This could be handy for archiving the generated documentation or
33
# if some version control system is used.
37
# Using the PROJECT_BRIEF tag one can provide an optional one line description
38
# for a project that appears at the top of each page and should give viewer
39
# a quick idea about the purpose of the project. Keep the description short.
43
# With the PROJECT_LOGO tag one can specify an logo or icon that is
44
# included in the documentation. The maximum height of the logo should not
45
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46
# Doxygen will copy the logo to the output directory.
50
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51
# base path where the generated documentation will be put.
52
# If a relative path is entered, it will be relative to the location
53
# where doxygen was started. If left blank the current directory will be used.
55
OUTPUT_DIRECTORY = doxydocs
57
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58
# 4096 sub-directories (in 2 levels) under the output directory of each output
59
# format and will distribute the generated files over these directories.
60
# Enabling this option can be useful when feeding doxygen a huge amount of
61
# source files, where putting all generated files in the same directory would
62
# otherwise cause performance problems for the file system.
66
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67
# documentation generated by doxygen is written. Doxygen will use this
68
# information to generate all constant output in the proper language.
69
# The default language is English, other supported languages are:
70
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
77
OUTPUT_LANGUAGE = English
79
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80
# include brief member descriptions after the members that are listed in
81
# the file and class documentation (similar to JavaDoc).
82
# Set to NO to disable this.
84
BRIEF_MEMBER_DESC = YES
86
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87
# the brief description of a member or function before the detailed description.
88
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89
# brief descriptions will be completely suppressed.
93
# This tag implements a quasi-intelligent brief description abbreviator
94
# that is used to form the text in various listings. Each string
95
# in this list, if found as the leading text of the brief description, will be
96
# stripped from the text and the result after processing the whole list, is
97
# used as the annotated text. Otherwise, the brief description is used as-is.
98
# If left blank, the following values are used ("$name" is automatically
99
# replaced with the name of the entity): "The $name class" "The $name widget"
100
# "The $name file" "is" "provides" "specifies" "contains"
101
# "represents" "a" "an" "the"
105
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106
# Doxygen will generate a detailed section even if there is only a brief
109
ALWAYS_DETAILED_SEC = NO
111
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112
# inherited members of a class in the documentation of that class as if those
113
# members were ordinary class members. Constructors, destructors and assignment
114
# operators of the base classes will not be shown.
116
INLINE_INHERITED_MEMB = NO
118
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119
# path before files name in the file list and in the header files. If set
120
# to NO the shortest path that makes the file name unique will be used.
122
FULL_PATH_NAMES = YES
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125
# can be used to strip a user-defined part of the path. Stripping is
126
# only done if one of the specified strings matches the left-hand part of
127
# the path. The tag can be used to show relative paths in the file list.
128
# If left blank the directory from which doxygen is run is used as the
133
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134
# the path mentioned in the documentation of a class, which tells
135
# the reader which header file to include in order to use a class.
136
# If left blank only the name of the header file containing the class
137
# definition is used. Otherwise one should specify the include paths that
138
# are normally passed to the compiler using the -I flag.
140
STRIP_FROM_INC_PATH =
142
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143
# (but less readable) file names. This can be useful if your file system
144
# doesn't support long names like on DOS, Mac, or CD-ROM.
148
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149
# will interpret the first line (until the first dot) of a JavaDoc-style
150
# comment as the brief description. If set to NO, the JavaDoc
151
# comments will behave just like regular Qt-style comments
152
# (thus requiring an explicit @brief command for a brief description.)
154
JAVADOC_AUTOBRIEF = NO
156
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157
# interpret the first line (until the first dot) of a Qt-style
158
# comment as the brief description. If set to NO, the comments
159
# will behave just like regular Qt-style comments (thus requiring
160
# an explicit \brief command for a brief description.)
164
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
166
# comments) as a brief description. This used to be the default behaviour.
167
# The new default is to treat a multi-line C++ comment block as a detailed
168
# description. Set this tag to YES if you prefer the old behaviour instead.
170
MULTILINE_CPP_IS_BRIEF = NO
172
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173
# member inherits the documentation from any documented member that it
178
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179
# a new page for each member. If set to NO, the documentation of a member will
180
# be part of the file/class/namespace that contains it.
182
SEPARATE_MEMBER_PAGES = NO
184
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
185
# Doxygen uses this value to replace tabs by spaces in code fragments.
189
# This tag can be used to specify a number of aliases that acts
190
# as commands in the documentation. An alias has the form "name=value".
191
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
192
# put the command \sideeffect (or @sideeffect) in the documentation, which
193
# will result in a user-defined paragraph with heading "Side Effects:".
194
# You can put \n's in the value part of an alias to insert newlines.
198
# This tag can be used to specify a number of word-keyword mappings (TCL only).
199
# A mapping has the form "name=value". For example adding
200
# "class=itcl::class" will allow you to use the command class in the
201
# itcl::class meaning.
205
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206
# sources only. Doxygen will then generate output that is more tailored for C.
207
# For instance, some of the names that are used will be different. The list
208
# of all members will be omitted, etc.
210
OPTIMIZE_OUTPUT_FOR_C = NO
212
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
213
# sources only. Doxygen will then generate output that is more tailored for
214
# Java. For instance, namespaces will be presented as packages, qualified
215
# scopes will look different, etc.
217
OPTIMIZE_OUTPUT_JAVA = NO
219
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
220
# sources only. Doxygen will then generate output that is more tailored for
223
OPTIMIZE_FOR_FORTRAN = YES
225
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
226
# sources. Doxygen will then generate output that is tailored for
229
OPTIMIZE_OUTPUT_VHDL = NO
231
# Doxygen selects the parser to use depending on the extension of the files it
232
# parses. With this tag you can assign which parser to use for a given extension.
233
# Doxygen has a built-in mapping, but you can override or extend it using this
234
# tag. The format is ext=language, where ext is a file extension, and language
235
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
236
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
237
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
238
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
241
EXTENSION_MAPPING = F=fortran fh=fortran
243
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
244
# comments according to the Markdown format, which allows for more readable
245
# documentation. See http://daringfireball.net/projects/markdown/ for details.
246
# The output of markdown processing is further processed by doxygen, so you
247
# can mix doxygen, HTML, and XML commands with Markdown formatting.
248
# Disable only in case of backward compatibilities issues.
250
MARKDOWN_SUPPORT = YES
252
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
253
# to include (a tag file for) the STL sources as input, then you should
254
# set this tag to YES in order to let doxygen match functions declarations and
255
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
256
# func(std::string) {}). This also makes the inheritance and collaboration
257
# diagrams that involve STL classes more complete and accurate.
259
BUILTIN_STL_SUPPORT = NO
261
# If you use Microsoft's C++/CLI language, you should set this option to YES to
262
# enable parsing support.
266
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
267
# Doxygen will parse them like normal C++ but will assume all classes use public
268
# instead of private inheritance when no explicit protection keyword is present.
272
# For Microsoft's IDL there are propget and propput attributes to indicate getter
273
# and setter methods for a property. Setting this option to YES (the default)
274
# will make doxygen replace the get and set methods by a property in the
275
# documentation. This will only work if the methods are indeed getting or
276
# setting a simple type. If this is not the case, or you want to show the
277
# methods anyway, you should set this option to NO.
279
IDL_PROPERTY_SUPPORT = YES
281
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
282
# tag is set to YES, then doxygen will reuse the documentation of the first
283
# member in the group (if any) for the other members of the group. By default
284
# all members of a group must be documented explicitly.
286
DISTRIBUTE_GROUP_DOC = NO
288
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
289
# the same type (for instance a group of public functions) to be put as a
290
# subgroup of that type (e.g. under the Public Functions section). Set it to
291
# NO to prevent subgrouping. Alternatively, this can be done per class using
292
# the \nosubgrouping command.
296
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
297
# unions are shown inside the group in which they are included (e.g. using
298
# @ingroup) instead of on a separate page (for HTML and Man pages) or
299
# section (for LaTeX and RTF).
301
INLINE_GROUPED_CLASSES = NO
303
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
304
# unions with only public data fields will be shown inline in the documentation
305
# of the scope in which they are defined (i.e. file, namespace, or group
306
# documentation), provided this scope is documented. If set to NO (the default),
307
# structs, classes, and unions are shown on a separate page (for HTML and Man
308
# pages) or section (for LaTeX and RTF).
310
INLINE_SIMPLE_STRUCTS = NO
312
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
313
# is documented as struct, union, or enum with the name of the typedef. So
314
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
315
# with name TypeT. When disabled the typedef will appear as a member of a file,
316
# namespace, or class. And the struct will be named TypeS. This can typically
317
# be useful for C code in case the coding convention dictates that all compound
318
# types are typedef'ed and only the typedef is referenced, never the tag name.
320
TYPEDEF_HIDES_STRUCT = NO
322
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
323
# determine which symbols to keep in memory and which to flush to disk.
324
# When the cache is full, less often used symbols will be written to disk.
325
# For small to medium size projects (<1000 input files) the default value is
326
# probably good enough. For larger projects a too small cache size can cause
327
# doxygen to be busy swapping symbols to and from disk most of the time
328
# causing a significant performance penalty.
329
# If the system has enough physical memory increasing the cache will improve the
330
# performance by keeping more symbols in memory. Note that the value works on
331
# a logarithmic scale so increasing the size by one will roughly double the
332
# memory usage. The cache size is given by this formula:
333
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
334
# corresponding to a cache size of 2^16 = 65536 symbols.
336
SYMBOL_CACHE_SIZE = 4
338
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
339
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
340
# their name and scope. Since this can be an expensive process and often the
341
# same symbol appear multiple times in the code, doxygen keeps a cache of
342
# pre-resolved symbols. If the cache is too small doxygen will become slower.
343
# If the cache is too large, memory is wasted. The cache size is given by this
344
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
345
# corresponding to a cache size of 2^16 = 65536 symbols.
347
LOOKUP_CACHE_SIZE = 0
349
#---------------------------------------------------------------------------
350
# Build related configuration options
351
#---------------------------------------------------------------------------
353
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
354
# documentation are documented, even if no documentation was available.
355
# Private class members and static file members will be hidden unless
356
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
360
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
361
# will be included in the documentation.
365
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
369
# If the EXTRACT_STATIC tag is set to YES all static members of a file
370
# will be included in the documentation.
374
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
375
# defined locally in source files will be included in the documentation.
376
# If set to NO only classes defined in header files are included.
378
EXTRACT_LOCAL_CLASSES = YES
380
# This flag is only useful for Objective-C code. When set to YES local
381
# methods, which are defined in the implementation section but not in
382
# the interface are included in the documentation.
383
# If set to NO (the default) only methods in the interface are included.
385
EXTRACT_LOCAL_METHODS = NO
387
# If this flag is set to YES, the members of anonymous namespaces will be
388
# extracted and appear in the documentation as a namespace called
389
# 'anonymous_namespace{file}', where file will be replaced with the base
390
# name of the file that contains the anonymous namespace. By default
391
# anonymous namespaces are hidden.
393
EXTRACT_ANON_NSPACES = NO
395
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
396
# undocumented members of documented classes, files or namespaces.
397
# If set to NO (the default) these members will be included in the
398
# various overviews, but no documentation section is generated.
399
# This option has no effect if EXTRACT_ALL is enabled.
401
HIDE_UNDOC_MEMBERS = NO
403
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
404
# undocumented classes that are normally visible in the class hierarchy.
405
# If set to NO (the default) these classes will be included in the various
406
# overviews. This option has no effect if EXTRACT_ALL is enabled.
408
HIDE_UNDOC_CLASSES = NO
410
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
411
# friend (class|struct|union) declarations.
412
# If set to NO (the default) these declarations will be included in the
415
HIDE_FRIEND_COMPOUNDS = NO
417
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
418
# documentation blocks found inside the body of a function.
419
# If set to NO (the default) these blocks will be appended to the
420
# function's detailed documentation block.
422
HIDE_IN_BODY_DOCS = NO
424
# The INTERNAL_DOCS tag determines if documentation
425
# that is typed after a \internal command is included. If the tag is set
426
# to NO (the default) then the documentation will be excluded.
427
# Set it to YES to include the internal documentation.
431
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
432
# file names in lower-case letters. If set to YES upper-case letters are also
433
# allowed. This is useful if you have classes or files whose names only differ
434
# in case and if your file system supports case sensitive file names. Windows
435
# and Mac users are advised to set this option to NO.
437
CASE_SENSE_NAMES = YES
439
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
440
# will show members with their full class and namespace scopes in the
441
# documentation. If set to YES the scope will be hidden.
443
HIDE_SCOPE_NAMES = NO
445
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
446
# will put a list of the files that are included by a file in the documentation
449
SHOW_INCLUDE_FILES = YES
451
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
452
# will list include files with double quotes in the documentation
453
# rather than with sharp brackets.
455
FORCE_LOCAL_INCLUDES = NO
457
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
458
# is inserted in the documentation for inline members.
462
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
463
# will sort the (detailed) documentation of file and class members
464
# alphabetically by member name. If set to NO the members will appear in
467
SORT_MEMBER_DOCS = YES
469
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
470
# brief documentation of file, namespace and class members alphabetically
471
# by member name. If set to NO (the default) the members will appear in
476
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
477
# will sort the (brief and detailed) documentation of class members so that
478
# constructors and destructors are listed first. If set to NO (the default)
479
# the constructors will appear in the respective orders defined by
480
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
481
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
482
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
484
SORT_MEMBERS_CTORS_1ST = NO
486
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
487
# hierarchy of group names into alphabetical order. If set to NO (the default)
488
# the group names will appear in their defined order.
490
SORT_GROUP_NAMES = NO
492
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
493
# sorted by fully-qualified names, including namespaces. If set to
494
# NO (the default), the class list will be sorted only by class name,
495
# not including the namespace part.
496
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
497
# Note: This option applies only to the class list, not to the
500
SORT_BY_SCOPE_NAME = NO
502
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
503
# do proper type resolution of all parameters of a function it will reject a
504
# match between the prototype and the implementation of a member function even
505
# if there is only one candidate or it is obvious which candidate to choose
506
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
507
# will still accept a match between prototype and implementation in such cases.
509
STRICT_PROTO_MATCHING = NO
511
# The GENERATE_TODOLIST tag can be used to enable (YES) or
512
# disable (NO) the todo list. This list is created by putting \todo
513
# commands in the documentation.
515
GENERATE_TODOLIST = YES
517
# The GENERATE_TESTLIST tag can be used to enable (YES) or
518
# disable (NO) the test list. This list is created by putting \test
519
# commands in the documentation.
521
GENERATE_TESTLIST = YES
523
# The GENERATE_BUGLIST tag can be used to enable (YES) or
524
# disable (NO) the bug list. This list is created by putting \bug
525
# commands in the documentation.
527
GENERATE_BUGLIST = YES
529
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
530
# disable (NO) the deprecated list. This list is created by putting
531
# \deprecated commands in the documentation.
533
GENERATE_DEPRECATEDLIST= YES
535
# The ENABLED_SECTIONS tag can be used to enable conditional
536
# documentation sections, marked by \if sectionname ... \endif.
540
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
541
# the initial value of a variable or macro consists of for it to appear in
542
# the documentation. If the initializer consists of more lines than specified
543
# here it will be hidden. Use a value of 0 to hide initializers completely.
544
# The appearance of the initializer of individual variables and macros in the
545
# documentation can be controlled using \showinitializer or \hideinitializer
546
# command in the documentation regardless of this setting.
548
MAX_INITIALIZER_LINES = 30
550
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
551
# at the bottom of the documentation of classes and structs. If set to YES the
552
# list will mention the files that were used to generate the documentation.
554
SHOW_USED_FILES = YES
556
# If the sources in your project are distributed over multiple directories
557
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
558
# in the documentation. The default is NO.
560
SHOW_DIRECTORIES = NO
562
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
563
# This will remove the Files entry from the Quick Index and from the
564
# Folder Tree View (if specified). The default is YES.
568
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
570
# This will remove the Namespaces entry from the Quick Index
571
# and from the Folder Tree View (if specified). The default is YES.
573
SHOW_NAMESPACES = YES
575
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
576
# doxygen should invoke to get the current version for each file (typically from
577
# the version control system). Doxygen will invoke the program by executing (via
578
# popen()) the command <command> <input-file>, where <command> is the value of
579
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
580
# provided by doxygen. Whatever the program writes to standard output
581
# is used as the file version. See the manual for examples.
583
FILE_VERSION_FILTER =
585
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
586
# by doxygen. The layout file controls the global structure of the generated
587
# output files in an output format independent way. The create the layout file
588
# that represents doxygen's defaults, run doxygen with the -l option.
589
# You can optionally specify a file name after the option, if omitted
590
# DoxygenLayout.xml will be used as the name of the layout file.
594
# The CITE_BIB_FILES tag can be used to specify one or more bib files
595
# containing the references data. This must be a list of .bib files. The
596
# .bib extension is automatically appended if omitted. Using this command
597
# requires the bibtex tool to be installed. See also
598
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
599
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
600
# feature you need bibtex and perl available in the search path.
604
#---------------------------------------------------------------------------
605
# configuration options related to warning and progress messages
606
#---------------------------------------------------------------------------
608
# The QUIET tag can be used to turn on/off the messages that are generated
609
# by doxygen. Possible values are YES and NO. If left blank NO is used.
613
# The WARNINGS tag can be used to turn on/off the warning messages that are
614
# generated by doxygen. Possible values are YES and NO. If left blank
619
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
620
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
621
# automatically be disabled.
623
WARN_IF_UNDOCUMENTED = YES
625
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
626
# potential errors in the documentation, such as not documenting some
627
# parameters in a documented function, or documenting parameters that
628
# don't exist or using markup commands wrongly.
630
WARN_IF_DOC_ERROR = YES
632
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
633
# functions that are documented, but have no documentation for their parameters
634
# or return value. If set to NO (the default) doxygen will only warn about
635
# wrong or incomplete parameter documentation, but not about the absence of
638
WARN_NO_PARAMDOC = NO
640
# The WARN_FORMAT tag determines the format of the warning messages that
641
# doxygen can produce. The string should contain the $file, $line, and $text
642
# tags, which will be replaced by the file and line number from which the
643
# warning originated and the warning text. Optionally the format may contain
644
# $version, which will be replaced by the version of the file (if it could
645
# be obtained via FILE_VERSION_FILTER)
647
WARN_FORMAT = "$file:$line: $text"
649
# The WARN_LOGFILE tag can be used to specify a file to which warning
650
# and error messages should be written. If left blank the output is written
655
#---------------------------------------------------------------------------
656
# configuration options related to the input files
657
#---------------------------------------------------------------------------
659
# The INPUT tag can be used to specify the files and/or directories that contain
660
# documented source files. You may enter file names like "myfile.cpp" or
661
# directories like "/usr/src/myproject". Separate the files or directories
666
# This tag can be used to specify the character encoding of the source files
667
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
668
# also the default input encoding. Doxygen uses libiconv (or the iconv built
669
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
670
# the list of possible encodings.
672
INPUT_ENCODING = UTF-8
674
# If the value of the INPUT tag contains directories, you can use the
675
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
676
# and *.h) to filter out the source-files in the directories. If left
677
# blank the following patterns are tested:
678
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
679
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
680
# *.f90 *.f *.for *.vhd *.vhdl
682
FILE_PATTERNS = *.c \
689
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
690
# should be searched for input files as well. Possible values are YES and NO.
691
# If left blank NO is used.
695
# The EXCLUDE tag can be used to specify files and/or directories that should be
696
# excluded from the INPUT source files. This way you can easily exclude a
697
# subdirectory from a directory tree whose root is specified with the INPUT tag.
698
# Note that relative paths are relative to the directory from which doxygen is
703
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
704
# directories that are symbolic links (a Unix file system feature) are excluded
707
EXCLUDE_SYMLINKS = NO
709
# If the value of the INPUT tag contains directories, you can use the
710
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
711
# certain files from those directories. Note that the wildcards are matched
712
# against the file with absolute path, so to exclude all test directories
713
# for example use the pattern */test/*
715
EXCLUDE_PATTERNS = */graveyard/* \
721
*/install/include/* \
725
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
726
# (namespaces, classes, functions, etc.) that should be excluded from the
727
# output. The symbol name can be a fully qualified name, a word, or if the
728
# wildcard * is used, a substring. Examples: ANamespace, AClass,
729
# AClass::ANamespace, ANamespace::*Test
733
# The EXAMPLE_PATH tag can be used to specify one or more files or
734
# directories that contain example code fragments that are included (see
735
# the \include command).
739
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
740
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
741
# and *.h) to filter out the source-files in the directories. If left
742
# blank all files are included.
746
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
747
# searched for input files to be used with the \include or \dontinclude
748
# commands irrespective of the value of the RECURSIVE tag.
749
# Possible values are YES and NO. If left blank NO is used.
751
EXAMPLE_RECURSIVE = NO
753
# The IMAGE_PATH tag can be used to specify one or more files or
754
# directories that contain image that are included in the documentation (see
755
# the \image command).
759
# The INPUT_FILTER tag can be used to specify a program that doxygen should
760
# invoke to filter for each input file. Doxygen will invoke the filter program
761
# by executing (via popen()) the command <filter> <input-file>, where <filter>
762
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
763
# input file. Doxygen will then use the output that the filter program writes
764
# to standard output.
765
# If FILTER_PATTERNS is specified, this tag will be
770
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
772
# Doxygen will compare the file name with each pattern and apply the
773
# filter if there is a match.
774
# The filters are a list of the form:
775
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
776
# info on how filters are used. If FILTER_PATTERNS is empty or if
777
# non of the patterns match the file name, INPUT_FILTER is applied.
781
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
782
# INPUT_FILTER) will be used to filter the input files when producing source
783
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
785
FILTER_SOURCE_FILES = NO
787
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
788
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
789
# and it is also possible to disable source filtering for a specific pattern
790
# using *.ext= (so without naming a filter). This option only has effect when
791
# FILTER_SOURCE_FILES is enabled.
793
FILTER_SOURCE_PATTERNS =
795
#---------------------------------------------------------------------------
796
# configuration options related to source browsing
797
#---------------------------------------------------------------------------
799
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
800
# be generated. Documented entities will be cross-referenced with these sources.
801
# Note: To get rid of all source code in the generated output, make sure also
802
# VERBATIM_HEADERS is set to NO.
806
# Setting the INLINE_SOURCES tag to YES will include the body
807
# of functions and classes directly in the documentation.
811
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
812
# doxygen to hide any special comment blocks from generated source code
813
# fragments. Normal C and C++ comments will always remain visible.
815
STRIP_CODE_COMMENTS = YES
817
# If the REFERENCED_BY_RELATION tag is set to YES
818
# then for each documented function all documented
819
# functions referencing it will be listed.
821
REFERENCED_BY_RELATION = YES
823
# If the REFERENCES_RELATION tag is set to YES
824
# then for each documented function all documented entities
825
# called/used by that function will be listed.
827
REFERENCES_RELATION = YES
829
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
830
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
831
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
832
# link to the source code.
833
# Otherwise they will link to the documentation.
835
REFERENCES_LINK_SOURCE = YES
837
# If the USE_HTAGS tag is set to YES then the references to source code
838
# will point to the HTML generated by the htags(1) tool instead of doxygen
839
# built-in source browser. The htags tool is part of GNU's global source
840
# tagging system (see http://www.gnu.org/software/global/global.html). You
841
# will need version 4.8.6 or higher.
845
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
846
# will generate a verbatim copy of the header file for each class for
847
# which an include is specified. Set to NO to disable this.
849
VERBATIM_HEADERS = YES
851
#---------------------------------------------------------------------------
852
# configuration options related to the alphabetical class index
853
#---------------------------------------------------------------------------
855
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
856
# of all compounds will be generated. Enable this if the project
857
# contains a lot of classes, structs, unions or interfaces.
859
ALPHABETICAL_INDEX = YES
861
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
862
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
863
# in which this list will be split (can be a number in the range [1..20])
865
COLS_IN_ALPHA_INDEX = 5
867
# In case all classes in a project start with a common prefix, all
868
# classes will be put under the same header in the alphabetical index.
869
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
870
# should be ignored while generating the index headers.
874
#---------------------------------------------------------------------------
875
# configuration options related to the HTML output
876
#---------------------------------------------------------------------------
878
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
879
# generate HTML output.
883
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
884
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
885
# put in front of it. If left blank `html' will be used as the default path.
889
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
890
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
891
# doxygen will generate files with .html extension.
893
HTML_FILE_EXTENSION = .html
895
# The HTML_HEADER tag can be used to specify a personal HTML header for
896
# each generated HTML page. If it is left blank doxygen will generate a
897
# standard header. Note that when using a custom header you are responsible
898
# for the proper inclusion of any scripts and style sheets that doxygen
899
# needs, which is dependent on the configuration options used.
900
# It is advised to generate a default header using "doxygen -w html
901
# header.html footer.html stylesheet.css YourConfigFile" and then modify
902
# that header. Note that the header is subject to change so you typically
903
# have to redo this when upgrading to a newer version of doxygen or when
904
# changing the value of configuration settings such as GENERATE_TREEVIEW!
908
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
909
# each generated HTML page. If it is left blank doxygen will generate a
914
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
915
# style sheet that is used by each HTML page. It can be used to
916
# fine-tune the look of the HTML output. If the tag is left blank doxygen
917
# will generate a default style sheet. Note that doxygen will try to copy
918
# the style sheet file to the HTML output directory, so don't put your own
919
# style sheet in the HTML output directory as well, or it will be erased!
923
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
924
# other source files which should be copied to the HTML output directory. Note
925
# that these files will be copied to the base HTML output directory. Use the
926
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
927
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
928
# the files will be copied as-is; there are no commands or markers available.
932
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
933
# Doxygen will adjust the colors in the style sheet and background images
934
# according to this color. Hue is specified as an angle on a colorwheel,
935
# see http://en.wikipedia.org/wiki/Hue for more information.
936
# For instance the value 0 represents red, 60 is yellow, 120 is green,
937
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
938
# The allowed range is 0 to 359.
940
HTML_COLORSTYLE_HUE = 220
942
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
943
# the colors in the HTML output. For a value of 0 the output will use
944
# grayscales only. A value of 255 will produce the most vivid colors.
946
HTML_COLORSTYLE_SAT = 100
948
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
949
# the luminance component of the colors in the HTML output. Values below
950
# 100 gradually make the output lighter, whereas values above 100 make
951
# the output darker. The value divided by 100 is the actual gamma applied,
952
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
953
# and 100 does not change the gamma.
955
HTML_COLORSTYLE_GAMMA = 80
957
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
958
# page will contain the date and time when the page was generated. Setting
959
# this to NO can help when comparing the output of multiple runs.
963
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
964
# files or namespaces will be aligned in HTML using tables. If set to
965
# NO a bullet list will be used.
967
HTML_ALIGN_MEMBERS = YES
969
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
970
# documentation will contain sections that can be hidden and shown after the
971
# page has loaded. For this to work a browser that supports
972
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
973
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
975
HTML_DYNAMIC_SECTIONS = NO
977
# If the GENERATE_DOCSET tag is set to YES, additional index files
978
# will be generated that can be used as input for Apple's Xcode 3
979
# integrated development environment, introduced with OSX 10.5 (Leopard).
980
# To create a documentation set, doxygen will generate a Makefile in the
981
# HTML output directory. Running make will produce the docset in that
982
# directory and running "make install" will install the docset in
983
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
985
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
986
# for more information.
990
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
991
# feed. A documentation feed provides an umbrella under which multiple
992
# documentation sets from a single provider (such as a company or product suite)
995
DOCSET_FEEDNAME = "Doxygen generated docs"
997
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
998
# should uniquely identify the documentation set bundle. This should be a
999
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1000
# will append .docset to the name.
1002
DOCSET_BUNDLE_ID = org.doxygen.Project
1004
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1005
# the documentation publisher. This should be a reverse domain-name style
1006
# string, e.g. com.mycompany.MyDocSet.documentation.
1008
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1010
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1012
DOCSET_PUBLISHER_NAME = Publisher
1014
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1015
# will be generated that can be used as input for tools like the
1016
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1017
# of the generated HTML documentation.
1019
GENERATE_HTMLHELP = NO
1021
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1022
# be used to specify the file name of the resulting .chm file. You
1023
# can add a path in front of the file if the result should not be
1024
# written to the html output directory.
1028
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1029
# be used to specify the location (absolute path including file name) of
1030
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1031
# the HTML help compiler on the generated index.hhp.
1035
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1036
# controls if a separate .chi index file is generated (YES) or that
1037
# it should be included in the master .chm file (NO).
1041
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1042
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1045
CHM_INDEX_ENCODING =
1047
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1048
# controls whether a binary table of contents is generated (YES) or a
1049
# normal table of contents (NO) in the .chm file.
1053
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1054
# to the contents of the HTML help documentation and to the tree view.
1058
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1059
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1060
# that can be used as input for Qt's qhelpgenerator to generate a
1061
# Qt Compressed Help (.qch) of the generated HTML documentation.
1065
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1066
# be used to specify the file name of the resulting .qch file.
1067
# The path specified is relative to the HTML output folder.
1071
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1072
# Qt Help Project output. For more information please see
1073
# http://doc.trolltech.com/qthelpproject.html#namespace
1075
QHP_NAMESPACE = org.doxygen.Project
1077
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1078
# Qt Help Project output. For more information please see
1079
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1081
QHP_VIRTUAL_FOLDER = doc
1083
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1084
# add. For more information please see
1085
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1087
QHP_CUST_FILTER_NAME =
1089
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1090
# custom filter to add. For more information please see
1091
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1092
# Qt Help Project / Custom Filters</a>.
1094
QHP_CUST_FILTER_ATTRS =
1096
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1098
# filter section matches.
1099
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1100
# Qt Help Project / Filter Attributes</a>.
1102
QHP_SECT_FILTER_ATTRS =
1104
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1105
# be used to specify the location of Qt's qhelpgenerator.
1106
# If non-empty doxygen will try to run qhelpgenerator on the generated
1111
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1112
# will be generated, which together with the HTML files, form an Eclipse help
1113
# plugin. To install this plugin and make it available under the help contents
1114
# menu in Eclipse, the contents of the directory containing the HTML and XML
1115
# files needs to be copied into the plugins directory of eclipse. The name of
1116
# the directory within the plugins directory should be the same as
1117
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1120
GENERATE_ECLIPSEHELP = NO
1122
# A unique identifier for the eclipse help plugin. When installing the plugin
1123
# the directory name containing the HTML and XML files should also have
1126
ECLIPSE_DOC_ID = org.doxygen.Project
1128
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1129
# at top of each HTML page. The value NO (the default) enables the index and
1130
# the value YES disables it. Since the tabs have the same information as the
1131
# navigation tree you can set this option to NO if you already set
1132
# GENERATE_TREEVIEW to YES.
1136
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1137
# structure should be generated to display hierarchical information.
1138
# If the tag value is set to YES, a side panel will be generated
1139
# containing a tree-like index structure (just like the one that
1140
# is generated for HTML Help). For this to work a browser that supports
1141
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1142
# Windows users are probably better off using the HTML help feature.
1143
# Since the tree basically has the same information as the tab index you
1144
# could consider to set DISABLE_INDEX to NO when enabling this option.
1146
GENERATE_TREEVIEW = NO
1148
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1149
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1150
# documentation. Note that a value of 0 will completely suppress the enum
1151
# values from appearing in the overview section.
1153
ENUM_VALUES_PER_LINE = 4
1155
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1156
# and Class Hierarchy pages using a tree view instead of an ordered list.
1158
USE_INLINE_TREES = NO
1160
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1161
# used to set the initial width (in pixels) of the frame in which the tree
1164
TREEVIEW_WIDTH = 250
1166
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1167
# links to external symbols imported via tag files in a separate window.
1169
EXT_LINKS_IN_WINDOW = NO
1171
# Use this tag to change the font size of Latex formulas included
1172
# as images in the HTML documentation. The default is 10. Note that
1173
# when you change the font size after a successful doxygen run you need
1174
# to manually remove any form_*.png images from the HTML output directory
1175
# to force them to be regenerated.
1177
FORMULA_FONTSIZE = 10
1179
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1180
# generated for formulas are transparent PNGs. Transparent PNGs are
1181
# not supported properly for IE 6.0, but are supported on all modern browsers.
1182
# Note that when changing this option you need to delete any form_*.png files
1183
# in the HTML output before the changes have effect.
1185
FORMULA_TRANSPARENT = YES
1187
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1188
# (see http://www.mathjax.org) which uses client side Javascript for the
1189
# rendering instead of using prerendered bitmaps. Use this if you do not
1190
# have LaTeX installed or if you want to formulas look prettier in the HTML
1191
# output. When enabled you may also need to install MathJax separately and
1192
# configure the path to it using the MATHJAX_RELPATH option.
1196
# When MathJax is enabled you need to specify the location relative to the
1197
# HTML output directory using the MATHJAX_RELPATH option. The destination
1198
# directory should contain the MathJax.js script. For instance, if the mathjax
1199
# directory is located at the same level as the HTML output directory, then
1200
# MATHJAX_RELPATH should be ../mathjax. The default value points to
1201
# the MathJax Content Delivery Network so you can quickly see the result without
1202
# installing MathJax.
1203
# However, it is strongly recommended to install a local
1204
# copy of MathJax from http://www.mathjax.org before deployment.
1206
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1208
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1209
# names that should be enabled during MathJax rendering.
1211
MATHJAX_EXTENSIONS =
1213
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1214
# for the HTML output. The underlying search engine uses javascript
1215
# and DHTML and should work on any modern browser. Note that when using
1216
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1217
# (GENERATE_DOCSET) there is already a search function so this one should
1218
# typically be disabled. For large projects the javascript based search engine
1219
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1223
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1224
# implemented using a PHP enabled web server instead of at the web client
1225
# using Javascript. Doxygen will generate the search PHP script and index
1226
# file to put on the web server. The advantage of the server
1227
# based approach is that it scales better to large projects and allows
1228
# full text search. The disadvantages are that it is more difficult to setup
1229
# and does not have live searching capabilities.
1231
SERVER_BASED_SEARCH = NO
1233
#---------------------------------------------------------------------------
1234
# configuration options related to the LaTeX output
1235
#---------------------------------------------------------------------------
1237
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1238
# generate Latex output.
1242
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1243
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1244
# put in front of it. If left blank `latex' will be used as the default path.
1246
LATEX_OUTPUT = latex
1248
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1249
# invoked. If left blank `latex' will be used as the default command name.
1250
# Note that when enabling USE_PDFLATEX this option is only used for
1251
# generating bitmaps for formulas in the HTML output, but not in the
1252
# Makefile that is written to the output directory.
1254
LATEX_CMD_NAME = latex
1256
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1257
# generate index for LaTeX. If left blank `makeindex' will be used as the
1258
# default command name.
1260
MAKEINDEX_CMD_NAME = makeindex
1262
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1263
# LaTeX documents. This may be useful for small projects and may help to
1264
# save some trees in general.
1268
# The PAPER_TYPE tag can be used to set the paper type that is used
1269
# by the printer. Possible values are: a4, letter, legal and
1270
# executive. If left blank a4wide will be used.
1274
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1275
# packages that should be included in the LaTeX output.
1279
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1280
# the generated latex document. The header should contain everything until
1281
# the first chapter. If it is left blank doxygen will generate a
1282
# standard header. Notice: only use this tag if you know what you are doing!
1286
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1287
# the generated latex document. The footer should contain everything after
1288
# the last chapter. If it is left blank doxygen will generate a
1289
# standard footer. Notice: only use this tag if you know what you are doing!
1293
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1294
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1295
# contain links (just like the HTML output) instead of page references
1296
# This makes the output suitable for online browsing using a pdf viewer.
1300
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1301
# plain latex in the generated Makefile. Set this option to YES to get a
1302
# higher quality PDF documentation.
1306
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1307
# command to the generated LaTeX files. This will instruct LaTeX to keep
1308
# running if errors occur, instead of asking the user for help.
1309
# This option is also used when generating formulas in HTML.
1311
LATEX_BATCHMODE = NO
1313
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1314
# include the index chapters (such as File Index, Compound Index, etc.)
1317
LATEX_HIDE_INDICES = NO
1319
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1320
# source code with syntax highlighting in the LaTeX output.
1321
# Note that which sources are shown also depends on other settings
1322
# such as SOURCE_BROWSER.
1324
LATEX_SOURCE_CODE = NO
1326
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1327
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1328
# http://en.wikipedia.org/wiki/BibTeX for more info.
1330
LATEX_BIB_STYLE = plain
1332
#---------------------------------------------------------------------------
1333
# configuration options related to the RTF output
1334
#---------------------------------------------------------------------------
1336
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1337
# The RTF output is optimized for Word 97 and may not look very pretty with
1338
# other RTF readers or editors.
1342
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1343
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1344
# put in front of it. If left blank `rtf' will be used as the default path.
1348
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1349
# RTF documents. This may be useful for small projects and may help to
1350
# save some trees in general.
1354
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1355
# will contain hyperlink fields. The RTF file will
1356
# contain links (just like the HTML output) instead of page references.
1357
# This makes the output suitable for online browsing using WORD or other
1358
# programs which support those fields.
1359
# Note: wordpad (write) and others do not support links.
1363
# Load style sheet definitions from file. Syntax is similar to doxygen's
1364
# config file, i.e. a series of assignments. You only have to provide
1365
# replacements, missing definitions are set to their default value.
1367
RTF_STYLESHEET_FILE =
1369
# Set optional variables used in the generation of an rtf document.
1370
# Syntax is similar to doxygen's config file.
1372
RTF_EXTENSIONS_FILE =
1374
#---------------------------------------------------------------------------
1375
# configuration options related to the man page output
1376
#---------------------------------------------------------------------------
1378
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1379
# generate man pages
1383
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1384
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1385
# put in front of it. If left blank `man' will be used as the default path.
1389
# The MAN_EXTENSION tag determines the extension that is added to
1390
# the generated man pages (default is the subroutine's section .3)
1394
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1395
# then it will generate one additional man file for each entity
1396
# documented in the real man page(s). These additional files
1397
# only source the real man page, but without them the man command
1398
# would be unable to find the correct page. The default is NO.
1402
#---------------------------------------------------------------------------
1403
# configuration options related to the XML output
1404
#---------------------------------------------------------------------------
1406
# If the GENERATE_XML tag is set to YES Doxygen will
1407
# generate an XML file that captures the structure of
1408
# the code including all documentation.
1412
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1413
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1414
# put in front of it. If left blank `xml' will be used as the default path.
1418
# The XML_SCHEMA tag can be used to specify an XML schema,
1419
# which can be used by a validating XML parser to check the
1420
# syntax of the XML files.
1424
# The XML_DTD tag can be used to specify an XML DTD,
1425
# which can be used by a validating XML parser to check the
1426
# syntax of the XML files.
1430
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1431
# dump the program listings (including syntax highlighting
1432
# and cross-referencing information) to the XML output. Note that
1433
# enabling this will significantly increase the size of the XML output.
1435
XML_PROGRAMLISTING = YES
1437
#---------------------------------------------------------------------------
1438
# configuration options for the AutoGen Definitions output
1439
#---------------------------------------------------------------------------
1441
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1442
# generate an AutoGen Definitions (see autogen.sf.net) file
1443
# that captures the structure of the code including all
1444
# documentation. Note that this feature is still experimental
1445
# and incomplete at the moment.
1447
GENERATE_AUTOGEN_DEF = NO
1449
#---------------------------------------------------------------------------
1450
# configuration options related to the Perl module output
1451
#---------------------------------------------------------------------------
1453
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1454
# generate a Perl module file that captures the structure of
1455
# the code including all documentation. Note that this
1456
# feature is still experimental and incomplete at the
1459
GENERATE_PERLMOD = NO
1461
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1462
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1463
# to generate PDF and DVI output from the Perl module output.
1467
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1468
# nicely formatted so it can be parsed by a human reader.
1470
# if you want to understand what is going on.
1471
# On the other hand, if this
1472
# tag is set to NO the size of the Perl module output will be much smaller
1473
# and Perl will parse it just the same.
1475
PERLMOD_PRETTY = YES
1477
# The names of the make variables in the generated doxyrules.make file
1478
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1479
# This is useful so different doxyrules.make files included by the same
1480
# Makefile don't overwrite each other's variables.
1482
PERLMOD_MAKEVAR_PREFIX =
1484
#---------------------------------------------------------------------------
1485
# Configuration options related to the preprocessor
1486
#---------------------------------------------------------------------------
1488
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1489
# evaluate all C-preprocessor directives found in the sources and include
1492
ENABLE_PREPROCESSING = YES
1494
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1495
# names in the source code. If set to NO (the default) only conditional
1496
# compilation will be performed. Macro expansion can be done in a controlled
1497
# way by setting EXPAND_ONLY_PREDEF to YES.
1499
MACRO_EXPANSION = NO
1501
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1502
# then the macro expansion is limited to the macros specified with the
1503
# PREDEFINED and EXPAND_AS_DEFINED tags.
1505
EXPAND_ONLY_PREDEF = NO
1507
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1508
# pointed to by INCLUDE_PATH will be searched when a #include is found.
1510
SEARCH_INCLUDES = YES
1512
# The INCLUDE_PATH tag can be used to specify one or more directories that
1513
# contain include files that are not input files but should be processed by
1518
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1519
# patterns (like *.h and *.hpp) to filter out the header-files in the
1520
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1523
INCLUDE_FILE_PATTERNS = *.h *.fh
1525
# The PREDEFINED tag can be used to specify one or more macro names that
1526
# are defined before the preprocessor is started (similar to the -D option of
1527
# gcc). The argument of the tag is a list of macros of the form: name
1528
# or name=definition (no spaces). If the definition and the = are
1529
# omitted =1 is assumed. To prevent a macro definition from being
1530
# undefined via #undef or recursively expanded use the := operator
1531
# instead of the = operator.
1535
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1536
# this tag can be used to specify a list of macro names that should be expanded.
1537
# The macro definition that is found in the sources will be used.
1538
# Use the PREDEFINED tag if you want to use a different macro definition that
1539
# overrules the definition found in the source code.
1543
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1544
# doxygen's preprocessor will remove all references to function-like macros
1545
# that are alone on a line, have an all uppercase name, and do not end with a
1546
# semicolon, because these will confuse the parser if not removed.
1548
SKIP_FUNCTION_MACROS = YES
1550
#---------------------------------------------------------------------------
1551
# Configuration::additions related to external references
1552
#---------------------------------------------------------------------------
1554
# The TAGFILES option can be used to specify one or more tagfiles. For each
1555
# tag file the location of the external documentation should be added. The
1556
# format of a tag file without this location is as follows:
1558
# TAGFILES = file1 file2 ...
1559
# Adding location for the tag files is done as follows:
1561
# TAGFILES = file1=loc1 "file2 = loc2" ...
1562
# where "loc1" and "loc2" can be relative or absolute paths
1563
# or URLs. Note that each tag file must have a unique name (where the name does
1564
# NOT include the path). If a tag file is not located in the directory in which
1565
# doxygen is run, you must also specify the path to the tagfile here.
1569
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1570
# a tag file that is based on the input files it reads.
1574
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1575
# in the class index. If set to NO only the inherited external classes
1580
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1581
# in the modules index. If set to NO, only the current project's groups will
1584
EXTERNAL_GROUPS = YES
1586
# The PERL_PATH should be the absolute path and name of the perl script
1587
# interpreter (i.e. the result of `which perl').
1589
PERL_PATH = /usr/bin/perl
1591
#---------------------------------------------------------------------------
1592
# Configuration options related to the dot tool
1593
#---------------------------------------------------------------------------
1595
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1596
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1597
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1598
# this option also works with HAVE_DOT disabled, but it is recommended to
1599
# install and use dot, since it yields more powerful graphs.
1601
CLASS_DIAGRAMS = YES
1603
# You can define message sequence charts within doxygen comments using the \msc
1604
# command. Doxygen will then run the mscgen tool (see
1605
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1606
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1607
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1608
# default search path.
1612
# If set to YES, the inheritance and collaboration graphs will hide
1613
# inheritance and usage relations if the target is undocumented
1614
# or is not a class.
1616
HIDE_UNDOC_RELATIONS = YES
1618
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1619
# available from the path. This tool is part of Graphviz, a graph visualization
1620
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1621
# have no effect if this option is set to NO (the default)
1625
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1626
# allowed to run in parallel. When set to 0 (the default) doxygen will
1627
# base this on the number of processors available in the system. You can set it
1628
# explicitly to a value larger than 0 to get control over the balance
1629
# between CPU load and processing speed.
1633
# By default doxygen will use the Helvetica font for all dot files that
1634
# doxygen generates. When you want a differently looking font you can specify
1635
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1636
# the font, which can be done by putting it in a standard location or by setting
1637
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1638
# directory containing the font.
1640
DOT_FONTNAME = Helvetica
1642
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1643
# The default size is 10pt.
1647
# By default doxygen will tell dot to use the Helvetica font.
1648
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1649
# set the path where dot can find it.
1653
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1654
# will generate a graph for each documented class showing the direct and
1655
# indirect inheritance relations. Setting this tag to YES will force the
1656
# CLASS_DIAGRAMS tag to NO.
1660
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1661
# will generate a graph for each documented class showing the direct and
1662
# indirect implementation dependencies (inheritance, containment, and
1663
# class references variables) of the class with other documented classes.
1665
COLLABORATION_GRAPH = YES
1667
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1668
# will generate a graph for groups, showing the direct groups dependencies
1672
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1673
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1678
# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1679
# the class node. If there are many fields or methods and many nodes the
1680
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1681
# threshold limits the number of items for each type to make the size more
1682
# managable. Set this to 0 for no limit. Note that the threshold may be
1683
# exceeded by 50% before the limit is enforced.
1685
UML_LIMIT_NUM_FIELDS = 10
1687
# If set to YES, the inheritance and collaboration graphs will show the
1688
# relations between templates and their instances.
1690
TEMPLATE_RELATIONS = NO
1692
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1693
# tags are set to YES then doxygen will generate a graph for each documented
1694
# file showing the direct and indirect include dependencies of the file with
1695
# other documented files.
1699
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1700
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1701
# documented header file showing the documented files that directly or
1702
# indirectly include this file.
1704
INCLUDED_BY_GRAPH = YES
1706
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1707
# doxygen will generate a call dependency graph for every global function
1708
# or class method. Note that enabling this option will significantly increase
1709
# the time of a run. So in most cases it will be better to enable call graphs
1710
# for selected functions only using the \callgraph command.
1714
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1715
# doxygen will generate a caller dependency graph for every global function
1716
# or class method. Note that enabling this option will significantly increase
1717
# the time of a run. So in most cases it will be better to enable caller
1718
# graphs for selected functions only using the \callergraph command.
1722
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1723
# will generate a graphical hierarchy of all classes instead of a textual one.
1725
GRAPHICAL_HIERARCHY = YES
1727
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1728
# then doxygen will show the dependencies a directory has on other directories
1729
# in a graphical way. The dependency relations are determined by the #include
1730
# relations between the files in the directories.
1732
DIRECTORY_GRAPH = YES
1734
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1735
# generated by dot. Possible values are svg, png, jpg, or gif.
1736
# If left blank png will be used. If you choose svg you need to set
1737
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1738
# visible in IE 9+ (other browsers do not have this requirement).
1740
DOT_IMAGE_FORMAT = png
1742
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1743
# enable generation of interactive SVG images that allow zooming and panning.
1744
# Note that this requires a modern browser other than Internet Explorer.
1745
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1746
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1747
# visible. Older versions of IE do not have SVG support.
1749
INTERACTIVE_SVG = NO
1751
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1752
# found. If left blank, it is assumed the dot tool can be found in the path.
1756
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1757
# contain dot files that are included in the documentation (see the
1758
# \dotfile command).
1762
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1763
# contain msc files that are included in the documentation (see the
1764
# \mscfile command).
1768
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1769
# nodes that will be shown in the graph. If the number of nodes in a graph
1770
# becomes larger than this value, doxygen will truncate the graph, which is
1771
# visualized by representing a node as a red box. Note that doxygen if the
1772
# number of direct children of the root node in a graph is already larger than
1773
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1774
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1776
DOT_GRAPH_MAX_NODES = 50
1778
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1779
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1780
# from the root by following a path via at most 3 edges will be shown. Nodes
1781
# that lay further from the root node will be omitted. Note that setting this
1782
# option to 1 or 2 may greatly reduce the computation time needed for large
1783
# code bases. Also note that the size of a graph can be further restricted by
1784
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1786
MAX_DOT_GRAPH_DEPTH = 0
1788
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1789
# background. This is disabled by default, because dot on Windows does not
1790
# seem to support this out of the box. Warning: Depending on the platform used,
1791
# enabling this option may lead to badly anti-aliased labels on the edges of
1792
# a graph (i.e. they become hard to read).
1794
DOT_TRANSPARENT = NO
1796
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1797
# files in one run (i.e. multiple -o and -T options on the command line). This
1798
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1799
# support this, this feature is disabled by default.
1801
DOT_MULTI_TARGETS = NO
1803
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1804
# generate a legend page explaining the meaning of the various boxes and
1805
# arrows in the dot generated graphs.
1807
GENERATE_LEGEND = YES
1809
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1810
# remove the intermediate dot files that are used to generate
1811
# the various graphs.
added
removed
contrib/doxygen/doxygen.rc
