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 double hash (##) is considered a comment and is placed in
7
# front of the TAG it is preceding.
9
# All text after a single hash (#) is considered a comment and will be ignored.
11
# TAG = value [value, ...]
12
# For lists, items can also be appended using:
13
# TAG += value [value, ...]
14
# Values that contain spaces should be placed between quotes (\" \").
16
#---------------------------------------------------------------------------
17
# Project related configuration options
18
#---------------------------------------------------------------------------
20
# This tag specifies the encoding used for all characters in the config file
21
# that follow. The default is UTF-8 which is also the encoding used for all text
22
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24
# for the list of possible encodings.
25
# The default value is: UTF-8.
27
DOXYFILE_ENCODING = UTF-8
29
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30
# double-quotes, unless you are using Doxywizard) that should identify the
31
# project for which the documentation is generated. This name is used in the
32
# title of most generated pages and in a few other places.
33
# The default value is: My Project.
37
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38
# could be handy for archiving the generated documentation or if some version
39
# control system is used.
43
# Using the PROJECT_BRIEF tag one can provide an optional one line description
44
# for a project that appears at the top of each page and should give viewer a
45
# quick idea about the purpose of the project. Keep the description short.
49
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50
# the documentation. The maximum height of the logo should not exceed 55 pixels
51
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52
# to the output directory.
56
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57
# into which the generated documentation will be written. If a relative path is
58
# entered, it will be relative to the location where doxygen was started. If
59
# left blank the current directory will be used.
61
OUTPUT_DIRECTORY = doc/
63
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64
# directories (in 2 levels) under the output directory of each output format and
65
# will distribute the generated files over these directories. Enabling this
66
# option can be useful when feeding doxygen a huge amount of source files, where
67
# putting all generated files in the same directory would otherwise causes
68
# performance problems for the file system.
69
# The default value is: NO.
73
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
74
# documentation generated by doxygen is written. Doxygen will use this
75
# information to generate all constant output in the proper language.
76
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
77
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
78
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
79
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
81
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
82
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
83
# Ukrainian and Vietnamese.
84
# The default value is: English.
86
OUTPUT_LANGUAGE = English
88
# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
89
# descriptions after the members that are listed in the file and class
90
# documentation (similar to Javadoc). Set to NO to disable this.
91
# The default value is: YES.
93
BRIEF_MEMBER_DESC = YES
95
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
96
# description of a member or function before the detailed description
98
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
99
# brief descriptions will be completely suppressed.
100
# The default value is: YES.
104
# This tag implements a quasi-intelligent brief description abbreviator that is
105
# used to form the text in various listings. Each string in this list, if found
106
# as the leading text of the brief description, will be stripped from the text
107
# and the result, after processing the whole list, is used as the annotated
108
# text. Otherwise, the brief description is used as-is. If left blank, the
109
# following values are used ($name is automatically replaced with the name of
110
# the entity):The $name class, The $name widget, The $name file, is, provides,
111
# specifies, contains, represents, a, an and the.
115
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116
# doxygen will generate a detailed section even if there is only a brief
118
# The default value is: NO.
120
ALWAYS_DETAILED_SEC = NO
122
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
123
# inherited members of a class in the documentation of that class as if those
124
# members were ordinary class members. Constructors, destructors and assignment
125
# operators of the base classes will not be shown.
126
# The default value is: NO.
128
INLINE_INHERITED_MEMB = NO
130
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
131
# before files name in the file list and in the header files. If set to NO the
132
# shortest path that makes the file name unique will be used
133
# The default value is: YES.
135
FULL_PATH_NAMES = YES
137
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
138
# Stripping is only done if one of the specified strings matches the left-hand
139
# part of the path. The tag can be used to show relative paths in the file list.
140
# If left blank the directory from which doxygen is run is used as the path to
143
# Note that you can specify absolute paths here, but also relative paths, which
144
# will be relative from the directory where doxygen is started.
145
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
149
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150
# path mentioned in the documentation of a class, which tells the reader which
151
# header file to include in order to use a class. If left blank only the name of
152
# the header file containing the class definition is used. Otherwise one should
153
# specify the list of include paths that are normally passed to the compiler
156
STRIP_FROM_INC_PATH =
158
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
159
# less readable) file names. This can be useful is your file systems doesn't
160
# support long names like on DOS, Mac, or CD-ROM.
161
# The default value is: NO.
165
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
166
# first line (until the first dot) of a Javadoc-style comment as the brief
167
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
168
# style comments (thus requiring an explicit @brief command for a brief
170
# The default value is: NO.
172
JAVADOC_AUTOBRIEF = NO
174
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
175
# line (until the first dot) of a Qt-style comment as the brief description. If
176
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
177
# requiring an explicit \brief command for a brief description.)
178
# The default value is: NO.
182
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
183
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
184
# a brief description. This used to be the default behavior. The new default is
185
# to treat a multi-line C++ comment block as a detailed description. Set this
186
# tag to YES if you prefer the old behavior instead.
188
# Note that setting this tag to YES also means that rational rose comments are
189
# not recognized any more.
190
# The default value is: NO.
192
MULTILINE_CPP_IS_BRIEF = NO
194
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
195
# documentation from any documented member that it re-implements.
196
# The default value is: YES.
200
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
201
# new page for each member. If set to NO, the documentation of a member will be
202
# part of the file/class/namespace that contains it.
203
# The default value is: NO.
205
SEPARATE_MEMBER_PAGES = NO
207
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
208
# uses this value to replace tabs by spaces in code fragments.
209
# Minimum value: 1, maximum value: 16, default value: 4.
213
# This tag can be used to specify a number of aliases that act as commands in
214
# the documentation. An alias has the form:
217
# "sideeffect=@par Side Effects:\n"
218
# will allow you to put the command \sideeffect (or @sideeffect) in the
219
# documentation, which will result in a user-defined paragraph with heading
220
# "Side Effects:". You can put \n's in the value part of an alias to insert
225
# This tag can be used to specify a number of word-keyword mappings (TCL only).
226
# A mapping has the form "name=value". For example adding "class=itcl::class"
227
# will allow you to use the command class in the itcl::class meaning.
231
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
232
# only. Doxygen will then generate output that is more tailored for C. For
233
# instance, some of the names that are used will be different. The list of all
234
# members will be omitted, etc.
235
# The default value is: NO.
237
OPTIMIZE_OUTPUT_FOR_C = NO
239
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
240
# Python sources only. Doxygen will then generate output that is more tailored
241
# for that language. For instance, namespaces will be presented as packages,
242
# qualified scopes will look different, etc.
243
# The default value is: NO.
245
OPTIMIZE_OUTPUT_JAVA = NO
247
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
248
# sources. Doxygen will then generate output that is tailored for Fortran.
249
# The default value is: NO.
251
OPTIMIZE_FOR_FORTRAN = NO
253
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
254
# sources. Doxygen will then generate output that is tailored for VHDL.
255
# The default value is: NO.
257
OPTIMIZE_OUTPUT_VHDL = NO
259
# Doxygen selects the parser to use depending on the extension of the files it
260
# parses. With this tag you can assign which parser to use for a given
261
# extension. Doxygen has a built-in mapping, but you can override or extend it
262
# using this tag. The format is ext=language, where ext is a file extension, and
263
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
264
# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
265
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
266
# (default is Fortran), use: inc=Fortran f=C.
268
# Note For files without extension you can use no_extension as a placeholder.
270
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
271
# the files are not read by doxygen.
275
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
276
# according to the Markdown format, which allows for more readable
277
# documentation. See http://daringfireball.net/projects/markdown/ for details.
278
# The output of markdown processing is further processed by doxygen, so you can
279
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
280
# case of backward compatibilities issues.
281
# The default value is: YES.
283
MARKDOWN_SUPPORT = YES
285
# When enabled doxygen tries to link words that correspond to documented
286
# classes, or namespaces to their corresponding documentation. Such a link can
287
# be prevented in individual cases by by putting a % sign in front of the word
288
# or globally by setting AUTOLINK_SUPPORT to NO.
289
# The default value is: YES.
291
AUTOLINK_SUPPORT = YES
293
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
294
# to include (a tag file for) the STL sources as input, then you should set this
295
# tag to YES in order to let doxygen match functions declarations and
296
# definitions whose arguments contain STL classes (e.g. func(std::string);
297
# versus func(std::string) {}). This also make the inheritance and collaboration
298
# diagrams that involve STL classes more complete and accurate.
299
# The default value is: NO.
301
BUILTIN_STL_SUPPORT = NO
303
# If you use Microsoft's C++/CLI language, you should set this option to YES to
304
# enable parsing support.
305
# The default value is: NO.
309
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
310
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
311
# will parse them like normal C++ but will assume all classes use public instead
312
# of private inheritance when no explicit protection keyword is present.
313
# The default value is: NO.
317
# For Microsoft's IDL there are propget and propput attributes to indicate
318
# getter and setter methods for a property. Setting this option to YES will make
319
# doxygen to replace the get and set methods by a property in the documentation.
320
# This will only work if the methods are indeed getting or setting a simple
321
# type. If this is not the case, or you want to show the methods anyway, you
322
# should set this option to NO.
323
# The default value is: YES.
325
IDL_PROPERTY_SUPPORT = YES
327
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
328
# tag is set to YES, then doxygen will reuse the documentation of the first
329
# member in the group (if any) for the other members of the group. By default
330
# all members of a group must be documented explicitly.
331
# The default value is: NO.
333
DISTRIBUTE_GROUP_DOC = NO
335
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
336
# (for instance a group of public functions) to be put as a subgroup of that
337
# type (e.g. under the Public Functions section). Set it to NO to prevent
338
# subgrouping. Alternatively, this can be done per class using the
339
# \nosubgrouping command.
340
# The default value is: YES.
344
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
345
# are shown inside the group in which they are included (e.g. using \ingroup)
346
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
349
# Note that this feature does not work in combination with
350
# SEPARATE_MEMBER_PAGES.
351
# The default value is: NO.
353
INLINE_GROUPED_CLASSES = NO
355
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
356
# with only public data fields or simple typedef fields will be shown inline in
357
# the documentation of the scope in which they are defined (i.e. file,
358
# namespace, or group documentation), provided this scope is documented. If set
359
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
360
# Man pages) or section (for LaTeX and RTF).
361
# The default value is: NO.
363
INLINE_SIMPLE_STRUCTS = NO
365
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
366
# enum is documented as struct, union, or enum with the name of the typedef. So
367
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
368
# with name TypeT. When disabled the typedef will appear as a member of a file,
369
# namespace, or class. And the struct will be named TypeS. This can typically be
370
# useful for C code in case the coding convention dictates that all compound
371
# types are typedef'ed and only the typedef is referenced, never the tag name.
372
# The default value is: NO.
374
TYPEDEF_HIDES_STRUCT = NO
376
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
377
# cache is used to resolve symbols given their name and scope. Since this can be
378
# an expensive process and often the same symbol appears multiple times in the
379
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
380
# doxygen will become slower. If the cache is too large, memory is wasted. The
381
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
382
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
383
# symbols. At the end of a run doxygen will report the cache usage and suggest
384
# the optimal cache size from a speed point of view.
385
# Minimum value: 0, maximum value: 9, default value: 0.
387
LOOKUP_CACHE_SIZE = 0
389
#---------------------------------------------------------------------------
390
# Build related configuration options
391
#---------------------------------------------------------------------------
393
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
394
# documentation are documented, even if no documentation was available. Private
395
# class members and static file members will be hidden unless the
396
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
397
# Note: This will also disable the warnings about undocumented members that are
398
# normally produced when WARNINGS is set to YES.
399
# The default value is: NO.
403
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
404
# be included in the documentation.
405
# The default value is: NO.
407
EXTRACT_PRIVATE = YES
409
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
410
# scope will be included in the documentation.
411
# The default value is: NO.
415
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
416
# included in the documentation.
417
# The default value is: NO.
421
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
422
# locally in source files will be included in the documentation. If set to NO
423
# only classes defined in header files are included. Does not have any effect
425
# The default value is: YES.
427
EXTRACT_LOCAL_CLASSES = YES
429
# This flag is only useful for Objective-C code. When set to YES local methods,
430
# which are defined in the implementation section but not in the interface are
431
# included in the documentation. If set to NO only methods in the interface are
433
# The default value is: NO.
435
EXTRACT_LOCAL_METHODS = NO
437
# If this flag is set to YES, the members of anonymous namespaces will be
438
# extracted and appear in the documentation as a namespace called
439
# 'anonymous_namespace{file}', where file will be replaced with the base name of
440
# the file that contains the anonymous namespace. By default anonymous namespace
442
# The default value is: NO.
444
EXTRACT_ANON_NSPACES = NO
446
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
447
# undocumented members inside documented classes or files. If set to NO these
448
# members will be included in the various overviews, but no documentation
449
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
450
# The default value is: NO.
452
HIDE_UNDOC_MEMBERS = NO
454
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
455
# undocumented classes that are normally visible in the class hierarchy. If set
456
# to NO these classes will be included in the various overviews. This option has
457
# no effect if EXTRACT_ALL is enabled.
458
# The default value is: NO.
460
HIDE_UNDOC_CLASSES = NO
462
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
463
# (class|struct|union) declarations. If set to NO these declarations will be
464
# included in the documentation.
465
# The default value is: NO.
467
HIDE_FRIEND_COMPOUNDS = NO
469
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
470
# documentation blocks found inside the body of a function. If set to NO these
471
# blocks will be appended to the function's detailed documentation block.
472
# The default value is: NO.
474
HIDE_IN_BODY_DOCS = NO
476
# The INTERNAL_DOCS tag determines if documentation that is typed after a
477
# \internal command is included. If the tag is set to NO then the documentation
478
# will be excluded. Set it to YES to include the internal documentation.
479
# The default value is: NO.
483
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
484
# names in lower-case letters. If set to YES upper-case letters are also
485
# allowed. This is useful if you have classes or files whose names only differ
486
# in case and if your file system supports case sensitive file names. Windows
487
# and Mac users are advised to set this option to NO.
488
# The default value is: system dependent.
490
CASE_SENSE_NAMES = NO
492
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
493
# their full class and namespace scopes in the documentation. If set to YES the
494
# scope will be hidden.
495
# The default value is: NO.
497
HIDE_SCOPE_NAMES = NO
499
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
500
# the files that are included by a file in the documentation of that file.
501
# The default value is: YES.
503
SHOW_INCLUDE_FILES = YES
505
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
506
# grouped member an include statement to the documentation, telling the reader
507
# which file to include in order to use the member.
508
# The default value is: NO.
510
SHOW_GROUPED_MEMB_INC = NO
512
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
513
# files with double quotes in the documentation rather than with sharp brackets.
514
# The default value is: NO.
516
FORCE_LOCAL_INCLUDES = NO
518
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
519
# documentation for inline members.
520
# The default value is: YES.
524
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
525
# (detailed) documentation of file and class members alphabetically by member
526
# name. If set to NO the members will appear in declaration order.
527
# The default value is: YES.
529
SORT_MEMBER_DOCS = YES
531
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
532
# descriptions of file, namespace and class members alphabetically by member
533
# name. If set to NO the members will appear in declaration order. Note that
534
# this will also influence the order of the classes in the class list.
535
# The default value is: NO.
539
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
540
# (brief and detailed) documentation of class members so that constructors and
541
# destructors are listed first. If set to NO the constructors will appear in the
542
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
543
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
544
# member documentation.
545
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
546
# detailed member documentation.
547
# The default value is: NO.
549
SORT_MEMBERS_CTORS_1ST = YES
551
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
552
# of group names into alphabetical order. If set to NO the group names will
553
# appear in their defined order.
554
# The default value is: NO.
556
SORT_GROUP_NAMES = NO
558
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
559
# fully-qualified names, including namespaces. If set to NO, the class list will
560
# be sorted only by class name, not including the namespace part.
561
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
562
# Note: This option applies only to the class list, not to the alphabetical
564
# The default value is: NO.
566
SORT_BY_SCOPE_NAME = NO
568
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
569
# type resolution of all parameters of a function it will reject a match between
570
# the prototype and the implementation of a member function even if there is
571
# only one candidate or it is obvious which candidate to choose by doing a
572
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
573
# accept a match between prototype and implementation in such cases.
574
# The default value is: NO.
576
STRICT_PROTO_MATCHING = NO
578
# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
579
# todo list. This list is created by putting \todo commands in the
581
# The default value is: YES.
583
GENERATE_TODOLIST = YES
585
# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
586
# test list. This list is created by putting \test commands in the
588
# The default value is: YES.
590
GENERATE_TESTLIST = YES
592
# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
593
# list. This list is created by putting \bug commands in the documentation.
594
# The default value is: YES.
596
GENERATE_BUGLIST = YES
598
# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
599
# the deprecated list. This list is created by putting \deprecated commands in
601
# The default value is: YES.
603
GENERATE_DEPRECATEDLIST= YES
605
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
606
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
607
# ... \endcond blocks.
611
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
612
# initial value of a variable or macro / define can have for it to appear in the
613
# documentation. If the initializer consists of more lines than specified here
614
# it will be hidden. Use a value of 0 to hide initializers completely. The
615
# appearance of the value of individual variables and macros / defines can be
616
# controlled using \showinitializer or \hideinitializer command in the
617
# documentation regardless of this setting.
618
# Minimum value: 0, maximum value: 10000, default value: 30.
620
MAX_INITIALIZER_LINES = 30
622
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
623
# the bottom of the documentation of classes and structs. If set to YES the list
624
# will mention the files that were used to generate the documentation.
625
# The default value is: YES.
627
SHOW_USED_FILES = YES
629
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
630
# will remove the Files entry from the Quick Index and from the Folder Tree View
632
# The default value is: YES.
636
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
637
# page. This will remove the Namespaces entry from the Quick Index and from the
638
# Folder Tree View (if specified).
639
# The default value is: YES.
641
SHOW_NAMESPACES = YES
643
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
644
# doxygen should invoke to get the current version for each file (typically from
645
# the version control system). Doxygen will invoke the program by executing (via
646
# popen()) the command command input-file, where command is the value of the
647
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
648
# by doxygen. Whatever the program writes to standard output is used as the file
649
# version. For an example see the documentation.
651
FILE_VERSION_FILTER =
653
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
654
# by doxygen. The layout file controls the global structure of the generated
655
# output files in an output format independent way. To create the layout file
656
# that represents doxygen's defaults, run doxygen with the -l option. You can
657
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
658
# will be used as the name of the layout file.
660
# Note that if you run doxygen from a directory containing a file called
661
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
666
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
667
# the reference definitions. This must be a list of .bib files. The .bib
668
# extension is automatically appended if omitted. This requires the bibtex tool
669
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
670
# For LaTeX the style of the bibliography can be controlled using
671
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
672
# search path. Do not use file names with spaces, bibtex cannot handle them. See
673
# also \cite for info how to create references.
677
#---------------------------------------------------------------------------
678
# Configuration options related to warning and progress messages
679
#---------------------------------------------------------------------------
681
# The QUIET tag can be used to turn on/off the messages that are generated to
682
# standard output by doxygen. If QUIET is set to YES this implies that the
684
# The default value is: NO.
688
# The WARNINGS tag can be used to turn on/off the warning messages that are
689
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
690
# this implies that the warnings are on.
692
# Tip: Turn warnings on while writing the documentation.
693
# The default value is: YES.
697
# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
698
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
699
# will automatically be disabled.
700
# The default value is: YES.
702
WARN_IF_UNDOCUMENTED = YES
704
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
705
# potential errors in the documentation, such as not documenting some parameters
706
# in a documented function, or documenting parameters that don't exist or using
707
# markup commands wrongly.
708
# The default value is: YES.
710
WARN_IF_DOC_ERROR = YES
712
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
713
# are documented, but have no documentation for their parameters or return
714
# value. If set to NO doxygen will only warn about wrong or incomplete parameter
715
# documentation, but not about the absence of documentation.
716
# The default value is: NO.
718
WARN_NO_PARAMDOC = NO
720
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
721
# can produce. The string should contain the $file, $line, and $text tags, which
722
# will be replaced by the file and line number from which the warning originated
723
# and the warning text. Optionally the format may contain $version, which will
724
# be replaced by the version of the file (if it could be obtained via
725
# FILE_VERSION_FILTER)
726
# The default value is: $file:$line: $text.
728
WARN_FORMAT = "$file:$line: $text"
730
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
731
# messages should be written. If left blank the output is written to standard
736
#---------------------------------------------------------------------------
737
# Configuration options related to the input files
738
#---------------------------------------------------------------------------
740
# The INPUT tag is used to specify the files and/or directories that contain
741
# documented source files. You may enter file names like myfile.cpp or
742
# directories like /usr/src/myproject. Separate the files or directories with
744
# Note: If this tag is empty the current directory is searched.
746
INPUT = "/tmp/lmms/doc/../src/core" \
747
"/tmp/lmms/doc/../src/gui" \
748
"/tmp/lmms/doc/../src/tracks" \
749
"/tmp/lmms/doc/../include" \
750
"/tmp/lmms/doc/../plugins" \
752
# This tag can be used to specify the character encoding of the source files
753
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
754
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
755
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
756
# possible encodings.
757
# The default value is: UTF-8.
759
INPUT_ENCODING = UTF-8
761
# If the value of the INPUT tag contains directories, you can use the
762
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
763
# *.h) to filter out the source-files in the directories. If left blank the
764
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
765
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
766
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
767
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
768
# *.qsf, *.as and *.js.
770
FILE_PATTERNS = *.cpp \
774
# The RECURSIVE tag can be used to specify whether or not subdirectories should
775
# be searched for input files as well.
776
# The default value is: NO.
780
# The EXCLUDE tag can be used to specify files and/or directories that should be
781
# excluded from the INPUT source files. This way you can easily exclude a
782
# subdirectory from a directory tree whose root is specified with the INPUT tag.
784
# Note that relative paths are relative to the directory from which doxygen is
787
EXCLUDE = plugins/zynaddsubfx/src/ \
788
plugins/zynaddsubfx/fltk/ \
789
plugins/ladspa_effect
791
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
792
# directories that are symbolic links (a Unix file system feature) are excluded
794
# The default value is: NO.
796
EXCLUDE_SYMLINKS = NO
798
# If the value of the INPUT tag contains directories, you can use the
799
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
800
# certain files from those directories.
802
# Note that the wildcards are matched against the file with absolute path, so to
803
# exclude all test directories for example use the pattern */test/*
807
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
808
# (namespaces, classes, functions, etc.) that should be excluded from the
809
# output. The symbol name can be a fully qualified name, a word, or if the
810
# wildcard * is used, a substring. Examples: ANamespace, AClass,
811
# AClass::ANamespace, ANamespace::*Test
813
# Note that the wildcards are matched against the file with absolute path, so to
814
# exclude all test directories use the pattern */test/*
818
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
819
# that contain example code fragments that are included (see the \include
824
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
825
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
826
# *.h) to filter out the source-files in the directories. If left blank all
827
# files are included.
831
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
832
# searched for input files to be used with the \include or \dontinclude commands
833
# irrespective of the value of the RECURSIVE tag.
834
# The default value is: NO.
836
EXAMPLE_RECURSIVE = NO
838
# The IMAGE_PATH tag can be used to specify one or more files or directories
839
# that contain images that are to be included in the documentation (see the
844
# The INPUT_FILTER tag can be used to specify a program that doxygen should
845
# invoke to filter for each input file. Doxygen will invoke the filter program
846
# by executing (via popen()) the command:
848
# <filter> <input-file>
850
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
851
# name of an input file. Doxygen will then use the output that the filter
852
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
855
# Note that the filter must not add or remove lines; it is applied before the
856
# code is scanned, but not when the output code is generated. If lines are added
857
# or removed, the anchors will not be placed correctly.
861
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
862
# basis. Doxygen will compare the file name with each pattern and apply the
863
# filter if there is a match. The filters are a list of the form: pattern=filter
864
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
865
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
866
# patterns match the file name, INPUT_FILTER is applied.
870
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
871
# INPUT_FILTER ) will also be used to filter the input files that are used for
872
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
873
# The default value is: NO.
875
FILTER_SOURCE_FILES = NO
877
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
878
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
879
# it is also possible to disable source filtering for a specific pattern using
880
# *.ext= (so without naming a filter).
881
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
883
FILTER_SOURCE_PATTERNS =
885
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
886
# is part of the input, its contents will be placed on the main page
887
# (index.html). This can be useful if you have a project on for instance GitHub
888
# and want to reuse the introduction page also for the doxygen output.
890
USE_MDFILE_AS_MAINPAGE =
892
#---------------------------------------------------------------------------
893
# Configuration options related to source browsing
894
#---------------------------------------------------------------------------
896
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
897
# generated. Documented entities will be cross-referenced with these sources.
899
# Note: To get rid of all source code in the generated output, make sure that
900
# also VERBATIM_HEADERS is set to NO.
901
# The default value is: NO.
905
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
906
# classes and enums directly into the documentation.
907
# The default value is: NO.
911
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
912
# special comment blocks from generated source code fragments. Normal C, C++ and
913
# Fortran comments will always remain visible.
914
# The default value is: YES.
916
STRIP_CODE_COMMENTS = YES
918
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
919
# function all documented functions referencing it will be listed.
920
# The default value is: NO.
922
REFERENCED_BY_RELATION = NO
924
# If the REFERENCES_RELATION tag is set to YES then for each documented function
925
# all documented entities called/used by that function will be listed.
926
# The default value is: NO.
928
REFERENCES_RELATION = NO
930
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
931
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
932
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
933
# link to the documentation.
934
# The default value is: YES.
936
REFERENCES_LINK_SOURCE = YES
938
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
939
# source code will show a tooltip with additional information such as prototype,
940
# brief description and links to the definition and documentation. Since this
941
# will make the HTML file larger and loading of large files a bit slower, you
942
# can opt to disable this feature.
943
# The default value is: YES.
944
# This tag requires that the tag SOURCE_BROWSER is set to YES.
946
SOURCE_TOOLTIPS = YES
948
# If the USE_HTAGS tag is set to YES then the references to source code will
949
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
950
# source browser. The htags tool is part of GNU's global source tagging system
951
# (see http://www.gnu.org/software/global/global.html). You will need version
954
# To use it do the following:
955
# - Install the latest version of global
956
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
957
# - Make sure the INPUT points to the root of the source tree
958
# - Run doxygen as normal
960
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
961
# tools must be available from the command line (i.e. in the search path).
963
# The result: instead of the source browser generated by doxygen, the links to
964
# source code will now point to the output of htags.
965
# The default value is: NO.
966
# This tag requires that the tag SOURCE_BROWSER is set to YES.
970
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
971
# verbatim copy of the header file for each class for which an include is
972
# specified. Set to NO to disable this.
973
# See also: Section \class.
974
# The default value is: YES.
976
VERBATIM_HEADERS = YES
978
#---------------------------------------------------------------------------
979
# Configuration options related to the alphabetical class index
980
#---------------------------------------------------------------------------
982
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
983
# compounds will be generated. Enable this if the project contains a lot of
984
# classes, structs, unions or interfaces.
985
# The default value is: YES.
987
ALPHABETICAL_INDEX = YES
989
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
990
# which the alphabetical index list will be split.
991
# Minimum value: 1, maximum value: 20, default value: 5.
992
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
994
COLS_IN_ALPHA_INDEX = 5
996
# In case all classes in a project start with a common prefix, all classes will
997
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
998
# can be used to specify a prefix (or a list of prefixes) that should be ignored
999
# while generating the index headers.
1000
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1004
#---------------------------------------------------------------------------
1005
# Configuration options related to the HTML output
1006
#---------------------------------------------------------------------------
1008
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1009
# The default value is: YES.
1013
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1014
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1016
# The default directory is: html.
1017
# This tag requires that the tag GENERATE_HTML is set to YES.
1021
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1022
# generated HTML page (for example: .htm, .php, .asp).
1023
# The default value is: .html.
1024
# This tag requires that the tag GENERATE_HTML is set to YES.
1026
HTML_FILE_EXTENSION = .html
1028
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1029
# each generated HTML page. If the tag is left blank doxygen will generate a
1032
# To get valid HTML the header file that includes any scripts and style sheets
1033
# that doxygen needs, which is dependent on the configuration options used (e.g.
1034
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1035
# default header using
1036
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1038
# and then modify the file new_header.html. See also section "Doxygen usage"
1039
# for information on how to generate the default header that doxygen normally
1041
# Note: The header is subject to change so you typically have to regenerate the
1042
# default header when upgrading to a newer version of doxygen. For a description
1043
# of the possible markers and block names see the documentation.
1044
# This tag requires that the tag GENERATE_HTML is set to YES.
1048
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1049
# generated HTML page. If the tag is left blank doxygen will generate a standard
1050
# footer. See HTML_HEADER for more information on how to generate a default
1051
# footer and what special commands can be used inside the footer. See also
1052
# section "Doxygen usage" for information on how to generate the default footer
1053
# that doxygen normally uses.
1054
# This tag requires that the tag GENERATE_HTML is set to YES.
1058
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1059
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1060
# the HTML output. If left blank doxygen will generate a default style sheet.
1061
# See also section "Doxygen usage" for information on how to generate the style
1062
# sheet that doxygen normally uses.
1063
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1064
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1066
# This tag requires that the tag GENERATE_HTML is set to YES.
1070
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1071
# defined cascading style sheet that is included after the standard style sheets
1072
# created by doxygen. Using this option one can overrule certain style aspects.
1073
# This is preferred over using HTML_STYLESHEET since it does not replace the
1074
# standard style sheet and is therefor more robust against future updates.
1075
# Doxygen will copy the style sheet file to the output directory. For an example
1076
# see the documentation.
1077
# This tag requires that the tag GENERATE_HTML is set to YES.
1079
HTML_EXTRA_STYLESHEET =
1081
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1082
# other source files which should be copied to the HTML output directory. Note
1083
# that these files will be copied to the base HTML output directory. Use the
1084
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1085
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1086
# files will be copied as-is; there are no commands or markers available.
1087
# This tag requires that the tag GENERATE_HTML is set to YES.
1091
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1092
# will adjust the colors in the stylesheet and background images according to
1093
# this color. Hue is specified as an angle on a colorwheel, see
1094
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1095
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1096
# purple, and 360 is red again.
1097
# Minimum value: 0, maximum value: 359, default value: 220.
1098
# This tag requires that the tag GENERATE_HTML is set to YES.
1100
HTML_COLORSTYLE_HUE = 220
1102
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1103
# in the HTML output. For a value of 0 the output will use grayscales only. A
1104
# value of 255 will produce the most vivid colors.
1105
# Minimum value: 0, maximum value: 255, default value: 100.
1106
# This tag requires that the tag GENERATE_HTML is set to YES.
1108
HTML_COLORSTYLE_SAT = 100
1110
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1111
# luminance component of the colors in the HTML output. Values below 100
1112
# gradually make the output lighter, whereas values above 100 make the output
1113
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1114
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1116
# Minimum value: 40, maximum value: 240, default value: 80.
1117
# This tag requires that the tag GENERATE_HTML is set to YES.
1119
HTML_COLORSTYLE_GAMMA = 80
1121
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1122
# page will contain the date and time when the page was generated. Setting this
1123
# to NO can help when comparing the output of multiple runs.
1124
# The default value is: YES.
1125
# This tag requires that the tag GENERATE_HTML is set to YES.
1127
HTML_TIMESTAMP = YES
1129
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1130
# documentation will contain sections that can be hidden and shown after the
1132
# The default value is: NO.
1133
# This tag requires that the tag GENERATE_HTML is set to YES.
1135
HTML_DYNAMIC_SECTIONS = NO
1137
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1138
# shown in the various tree structured indices initially; the user can expand
1139
# and collapse entries dynamically later on. Doxygen will expand the tree to
1140
# such a level that at most the specified number of entries are visible (unless
1141
# a fully collapsed tree already exceeds this amount). So setting the number of
1142
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1143
# representing an infinite number of entries and will result in a full expanded
1145
# Minimum value: 0, maximum value: 9999, default value: 100.
1146
# This tag requires that the tag GENERATE_HTML is set to YES.
1148
HTML_INDEX_NUM_ENTRIES = 100
1150
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1151
# generated that can be used as input for Apple's Xcode 3 integrated development
1152
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1153
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1154
# Makefile in the HTML output directory. Running make will produce the docset in
1155
# that directory and running make install will install the docset in
1156
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1157
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1158
# for more information.
1159
# The default value is: NO.
1160
# This tag requires that the tag GENERATE_HTML is set to YES.
1162
GENERATE_DOCSET = NO
1164
# This tag determines the name of the docset feed. A documentation feed provides
1165
# an umbrella under which multiple documentation sets from a single provider
1166
# (such as a company or product suite) can be grouped.
1167
# The default value is: Doxygen generated docs.
1168
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1170
DOCSET_FEEDNAME = "Doxygen generated docs"
1172
# This tag specifies a string that should uniquely identify the documentation
1173
# set bundle. This should be a reverse domain-name style string, e.g.
1174
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1175
# The default value is: org.doxygen.Project.
1176
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1178
DOCSET_BUNDLE_ID = org.doxygen.Project
1180
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1181
# the documentation publisher. This should be a reverse domain-name style
1182
# string, e.g. com.mycompany.MyDocSet.documentation.
1183
# The default value is: org.doxygen.Publisher.
1184
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1186
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1188
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1189
# The default value is: Publisher.
1190
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1192
DOCSET_PUBLISHER_NAME = Publisher
1194
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1195
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1196
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1197
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1200
# The HTML Help Workshop contains a compiler that can convert all HTML output
1201
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1202
# files are now used as the Windows 98 help format, and will replace the old
1203
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1204
# HTML files also contain an index, a table of contents, and you can search for
1205
# words in the documentation. The HTML workshop also contains a viewer for
1206
# compressed HTML files.
1207
# The default value is: NO.
1208
# This tag requires that the tag GENERATE_HTML is set to YES.
1210
GENERATE_HTMLHELP = NO
1212
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1213
# file. You can add a path in front of the file if the result should not be
1214
# written to the html output directory.
1215
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1219
# The HHC_LOCATION tag can be used to specify the location (absolute path
1220
# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1221
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1222
# The file has to be specified with full path.
1223
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1227
# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1228
# YES) or that it should be included in the master .chm file ( NO).
1229
# The default value is: NO.
1230
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1234
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1235
# and project file content.
1236
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1238
CHM_INDEX_ENCODING =
1240
# The BINARY_TOC flag controls whether a binary table of contents is generated (
1241
# YES) or a normal table of contents ( NO) in the .chm file.
1242
# The default value is: NO.
1243
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1247
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1248
# the table of contents of the HTML help documentation and to the tree view.
1249
# The default value is: NO.
1250
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1254
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1255
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1256
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1257
# (.qch) of the generated HTML documentation.
1258
# The default value is: NO.
1259
# This tag requires that the tag GENERATE_HTML is set to YES.
1263
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1264
# the file name of the resulting .qch file. The path specified is relative to
1265
# the HTML output folder.
1266
# This tag requires that the tag GENERATE_QHP is set to YES.
1270
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1271
# Project output. For more information please see Qt Help Project / Namespace
1272
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1273
# The default value is: org.doxygen.Project.
1274
# This tag requires that the tag GENERATE_QHP is set to YES.
1278
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1279
# Help Project output. For more information please see Qt Help Project / Virtual
1280
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1282
# The default value is: doc.
1283
# This tag requires that the tag GENERATE_QHP is set to YES.
1285
QHP_VIRTUAL_FOLDER = doc
1287
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1288
# filter to add. For more information please see Qt Help Project / Custom
1289
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1291
# This tag requires that the tag GENERATE_QHP is set to YES.
1293
QHP_CUST_FILTER_NAME =
1295
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1296
# custom filter to add. For more information please see Qt Help Project / Custom
1297
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1299
# This tag requires that the tag GENERATE_QHP is set to YES.
1301
QHP_CUST_FILTER_ATTRS =
1303
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1304
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1305
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1306
# This tag requires that the tag GENERATE_QHP is set to YES.
1308
QHP_SECT_FILTER_ATTRS =
1310
# The QHG_LOCATION tag can be used to specify the location of Qt's
1311
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1312
# generated .qhp file.
1313
# This tag requires that the tag GENERATE_QHP is set to YES.
1317
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1318
# generated, together with the HTML files, they form an Eclipse help plugin. To
1319
# install this plugin and make it available under the help contents menu in
1320
# Eclipse, the contents of the directory containing the HTML and XML files needs
1321
# to be copied into the plugins directory of eclipse. The name of the directory
1322
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1323
# After copying Eclipse needs to be restarted before the help appears.
1324
# The default value is: NO.
1325
# This tag requires that the tag GENERATE_HTML is set to YES.
1327
GENERATE_ECLIPSEHELP = NO
1329
# A unique identifier for the Eclipse help plugin. When installing the plugin
1330
# the directory name containing the HTML and XML files should also have this
1331
# name. Each documentation set should have its own identifier.
1332
# The default value is: org.doxygen.Project.
1333
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1335
ECLIPSE_DOC_ID = org.doxygen.Project
1337
# If you want full control over the layout of the generated HTML pages it might
1338
# be necessary to disable the index and replace it with your own. The
1339
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1340
# of each HTML page. A value of NO enables the index and the value YES disables
1341
# it. Since the tabs in the index contain the same information as the navigation
1342
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1343
# The default value is: NO.
1344
# This tag requires that the tag GENERATE_HTML is set to YES.
1348
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1349
# structure should be generated to display hierarchical information. If the tag
1350
# value is set to YES, a side panel will be generated containing a tree-like
1351
# index structure (just like the one that is generated for HTML Help). For this
1352
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1353
# (i.e. any modern browser). Windows users are probably better off using the
1354
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1355
# further fine-tune the look of the index. As an example, the default style
1356
# sheet generated by doxygen has an example that shows how to put an image at
1357
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1358
# the same information as the tab index, you could consider setting
1359
# DISABLE_INDEX to YES when enabling this option.
1360
# The default value is: NO.
1361
# This tag requires that the tag GENERATE_HTML is set to YES.
1363
GENERATE_TREEVIEW = NO
1365
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1366
# doxygen will group on one line in the generated HTML documentation.
1368
# Note that a value of 0 will completely suppress the enum values from appearing
1369
# in the overview section.
1370
# Minimum value: 0, maximum value: 20, default value: 4.
1371
# This tag requires that the tag GENERATE_HTML is set to YES.
1373
ENUM_VALUES_PER_LINE = 4
1375
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1376
# to set the initial width (in pixels) of the frame in which the tree is shown.
1377
# Minimum value: 0, maximum value: 1500, default value: 250.
1378
# This tag requires that the tag GENERATE_HTML is set to YES.
1380
TREEVIEW_WIDTH = 250
1382
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1383
# external symbols imported via tag files in a separate window.
1384
# The default value is: NO.
1385
# This tag requires that the tag GENERATE_HTML is set to YES.
1387
EXT_LINKS_IN_WINDOW = NO
1389
# Use this tag to change the font size of LaTeX formulas included as images in
1390
# the HTML documentation. When you change the font size after a successful
1391
# doxygen run you need to manually remove any form_*.png images from the HTML
1392
# output directory to force them to be regenerated.
1393
# Minimum value: 8, maximum value: 50, default value: 10.
1394
# This tag requires that the tag GENERATE_HTML is set to YES.
1396
FORMULA_FONTSIZE = 10
1398
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1399
# generated for formulas are transparent PNGs. Transparent PNGs are not
1400
# supported properly for IE 6.0, but are supported on all modern browsers.
1402
# Note that when changing this option you need to delete any form_*.png files in
1403
# the HTML output directory before the changes have effect.
1404
# The default value is: YES.
1405
# This tag requires that the tag GENERATE_HTML is set to YES.
1407
FORMULA_TRANSPARENT = YES
1409
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1410
# http://www.mathjax.org) which uses client side Javascript for the rendering
1411
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1412
# installed or if you want to formulas look prettier in the HTML output. When
1413
# enabled you may also need to install MathJax separately and configure the path
1414
# to it using the MATHJAX_RELPATH option.
1415
# The default value is: NO.
1416
# This tag requires that the tag GENERATE_HTML is set to YES.
1420
# When MathJax is enabled you can set the default output format to be used for
1421
# the MathJax output. See the MathJax site (see:
1422
# http://docs.mathjax.org/en/latest/output.html) for more details.
1423
# Possible values are: HTML-CSS (which is slower, but has the best
1424
# compatibility), NativeMML (i.e. MathML) and SVG.
1425
# The default value is: HTML-CSS.
1426
# This tag requires that the tag USE_MATHJAX is set to YES.
1428
MATHJAX_FORMAT = HTML-CSS
1430
# When MathJax is enabled you need to specify the location relative to the HTML
1431
# output directory using the MATHJAX_RELPATH option. The destination directory
1432
# should contain the MathJax.js script. For instance, if the mathjax directory
1433
# is located at the same level as the HTML output directory, then
1434
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1435
# Content Delivery Network so you can quickly see the result without installing
1436
# MathJax. However, it is strongly recommended to install a local copy of
1437
# MathJax from http://www.mathjax.org before deployment.
1438
# The default value is: http://cdn.mathjax.org/mathjax/latest.
1439
# This tag requires that the tag USE_MATHJAX is set to YES.
1441
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1443
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1444
# extension names that should be enabled during MathJax rendering. For example
1445
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1446
# This tag requires that the tag USE_MATHJAX is set to YES.
1448
MATHJAX_EXTENSIONS =
1450
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1451
# of code that will be used on startup of the MathJax code. See the MathJax site
1452
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1453
# example see the documentation.
1454
# This tag requires that the tag USE_MATHJAX is set to YES.
1458
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1459
# the HTML output. The underlying search engine uses javascript and DHTML and
1460
# should work on any modern browser. Note that when using HTML help
1461
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1462
# there is already a search function so this one should typically be disabled.
1463
# For large projects the javascript based search engine can be slow, then
1464
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1465
# search using the keyboard; to jump to the search box use <access key> + S
1466
# (what the <access key> is depends on the OS and browser, but it is typically
1467
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1468
# key> to jump into the search results window, the results can be navigated
1469
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1470
# the search. The filter options can be selected when the cursor is inside the
1471
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1472
# to select a filter and <Enter> or <escape> to activate or cancel the filter
1474
# The default value is: YES.
1475
# This tag requires that the tag GENERATE_HTML is set to YES.
1479
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1480
# implemented using a web server instead of a web client using Javascript. There
1481
# are two flavours of web server based searching depending on the
1482
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1483
# searching and an index file used by the script. When EXTERNAL_SEARCH is
1484
# enabled the indexing and searching needs to be provided by external tools. See
1485
# the section "External Indexing and Searching" for details.
1486
# The default value is: NO.
1487
# This tag requires that the tag SEARCHENGINE is set to YES.
1489
SERVER_BASED_SEARCH = NO
1491
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1492
# script for searching. Instead the search results are written to an XML file
1493
# which needs to be processed by an external indexer. Doxygen will invoke an
1494
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1497
# Doxygen ships with an example indexer ( doxyindexer) and search engine
1498
# (doxysearch.cgi) which are based on the open source search engine library
1499
# Xapian (see: http://xapian.org/).
1501
# See the section "External Indexing and Searching" for details.
1502
# The default value is: NO.
1503
# This tag requires that the tag SEARCHENGINE is set to YES.
1505
EXTERNAL_SEARCH = NO
1507
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1508
# which will return the search results when EXTERNAL_SEARCH is enabled.
1510
# Doxygen ships with an example indexer ( doxyindexer) and search engine
1511
# (doxysearch.cgi) which are based on the open source search engine library
1512
# Xapian (see: http://xapian.org/). See the section "External Indexing and
1513
# Searching" for details.
1514
# This tag requires that the tag SEARCHENGINE is set to YES.
1518
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1519
# search data is written to a file for indexing by an external tool. With the
1520
# SEARCHDATA_FILE tag the name of this file can be specified.
1521
# The default file is: searchdata.xml.
1522
# This tag requires that the tag SEARCHENGINE is set to YES.
1524
SEARCHDATA_FILE = searchdata.xml
1526
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1527
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1528
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1529
# projects and redirect the results back to the right project.
1530
# This tag requires that the tag SEARCHENGINE is set to YES.
1532
EXTERNAL_SEARCH_ID =
1534
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1535
# projects other than the one defined by this configuration file, but that are
1536
# all added to the same external search index. Each project needs to have a
1537
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1538
# to a relative location where the documentation can be found. The format is:
1539
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1540
# This tag requires that the tag SEARCHENGINE is set to YES.
1542
EXTRA_SEARCH_MAPPINGS =
1544
#---------------------------------------------------------------------------
1545
# Configuration options related to the LaTeX output
1546
#---------------------------------------------------------------------------
1548
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1549
# The default value is: YES.
1553
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1554
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1556
# The default directory is: latex.
1557
# This tag requires that the tag GENERATE_LATEX is set to YES.
1559
LATEX_OUTPUT = latex
1561
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1564
# Note that when enabling USE_PDFLATEX this option is only used for generating
1565
# bitmaps for formulas in the HTML output, but not in the Makefile that is
1566
# written to the output directory.
1567
# The default file is: latex.
1568
# This tag requires that the tag GENERATE_LATEX is set to YES.
1570
LATEX_CMD_NAME = latex
1572
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1574
# The default file is: makeindex.
1575
# This tag requires that the tag GENERATE_LATEX is set to YES.
1577
MAKEINDEX_CMD_NAME = makeindex
1579
# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1580
# documents. This may be useful for small projects and may help to save some
1582
# The default value is: NO.
1583
# This tag requires that the tag GENERATE_LATEX is set to YES.
1587
# The PAPER_TYPE tag can be used to set the paper type that is used by the
1589
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1590
# 14 inches) and executive (7.25 x 10.5 inches).
1591
# The default value is: a4.
1592
# This tag requires that the tag GENERATE_LATEX is set to YES.
1596
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1597
# that should be included in the LaTeX output. To get the times font for
1598
# instance you can specify
1599
# EXTRA_PACKAGES=times
1600
# If left blank no extra packages will be included.
1601
# This tag requires that the tag GENERATE_LATEX is set to YES.
1605
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1606
# generated LaTeX document. The header should contain everything until the first
1607
# chapter. If it is left blank doxygen will generate a standard header. See
1608
# section "Doxygen usage" for information on how to let doxygen write the
1609
# default header to a separate file.
1611
# Note: Only use a user-defined header if you know what you are doing! The
1612
# following commands have a special meaning inside the header: $title,
1613
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1614
# replace them by respectively the title of the page, the current date and time,
1615
# only the current date, the version number of doxygen, the project name (see
1616
# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1617
# This tag requires that the tag GENERATE_LATEX is set to YES.
1621
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1622
# generated LaTeX document. The footer should contain everything after the last
1623
# chapter. If it is left blank doxygen will generate a standard footer.
1625
# Note: Only use a user-defined footer if you know what you are doing!
1626
# This tag requires that the tag GENERATE_LATEX is set to YES.
1630
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1631
# other source files which should be copied to the LATEX_OUTPUT output
1632
# directory. Note that the files will be copied as-is; there are no commands or
1633
# markers available.
1634
# This tag requires that the tag GENERATE_LATEX is set to YES.
1638
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1639
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1640
# contain links (just like the HTML output) instead of page references. This
1641
# makes the output suitable for online browsing using a PDF viewer.
1642
# The default value is: YES.
1643
# This tag requires that the tag GENERATE_LATEX is set to YES.
1645
PDF_HYPERLINKS = YES
1647
# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1648
# the PDF file directly from the LaTeX files. Set this option to YES to get a
1649
# higher quality PDF documentation.
1650
# The default value is: YES.
1651
# This tag requires that the tag GENERATE_LATEX is set to YES.
1655
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1656
# command to the generated LaTeX files. This will instruct LaTeX to keep running
1657
# if errors occur, instead of asking the user for help. This option is also used
1658
# when generating formulas in HTML.
1659
# The default value is: NO.
1660
# This tag requires that the tag GENERATE_LATEX is set to YES.
1662
LATEX_BATCHMODE = NO
1664
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1665
# index chapters (such as File Index, Compound Index, etc.) in the output.
1666
# The default value is: NO.
1667
# This tag requires that the tag GENERATE_LATEX is set to YES.
1669
LATEX_HIDE_INDICES = NO
1671
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1672
# code with syntax highlighting in the LaTeX output.
1674
# Note that which sources are shown also depends on other settings such as
1676
# The default value is: NO.
1677
# This tag requires that the tag GENERATE_LATEX is set to YES.
1679
LATEX_SOURCE_CODE = NO
1681
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1682
# bibliography, e.g. plainnat, or ieeetr. See
1683
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1684
# The default value is: plain.
1685
# This tag requires that the tag GENERATE_LATEX is set to YES.
1687
LATEX_BIB_STYLE = plain
1689
#---------------------------------------------------------------------------
1690
# Configuration options related to the RTF output
1691
#---------------------------------------------------------------------------
1693
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1694
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1696
# The default value is: NO.
1700
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1701
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1703
# The default directory is: rtf.
1704
# This tag requires that the tag GENERATE_RTF is set to YES.
1708
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1709
# documents. This may be useful for small projects and may help to save some
1711
# The default value is: NO.
1712
# This tag requires that the tag GENERATE_RTF is set to YES.
1716
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1717
# contain hyperlink fields. The RTF file will contain links (just like the HTML
1718
# output) instead of page references. This makes the output suitable for online
1719
# browsing using Word or some other Word compatible readers that support those
1722
# Note: WordPad (write) and others do not support links.
1723
# The default value is: NO.
1724
# This tag requires that the tag GENERATE_RTF is set to YES.
1728
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1729
# file, i.e. a series of assignments. You only have to provide replacements,
1730
# missing definitions are set to their default value.
1732
# See also section "Doxygen usage" for information on how to generate the
1733
# default style sheet that doxygen normally uses.
1734
# This tag requires that the tag GENERATE_RTF is set to YES.
1736
RTF_STYLESHEET_FILE =
1738
# Set optional variables used in the generation of an RTF document. Syntax is
1739
# similar to doxygen's config file. A template extensions file can be generated
1740
# using doxygen -e rtf extensionFile.
1741
# This tag requires that the tag GENERATE_RTF is set to YES.
1743
RTF_EXTENSIONS_FILE =
1745
#---------------------------------------------------------------------------
1746
# Configuration options related to the man page output
1747
#---------------------------------------------------------------------------
1749
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1750
# classes and files.
1751
# The default value is: NO.
1755
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1756
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1757
# it. A directory man3 will be created inside the directory specified by
1759
# The default directory is: man.
1760
# This tag requires that the tag GENERATE_MAN is set to YES.
1764
# The MAN_EXTENSION tag determines the extension that is added to the generated
1765
# man pages. In case the manual section does not start with a number, the number
1766
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1768
# The default value is: .3.
1769
# This tag requires that the tag GENERATE_MAN is set to YES.
1773
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1774
# will generate one additional man file for each entity documented in the real
1775
# man page(s). These additional files only source the real man page, but without
1776
# them the man command would be unable to find the correct page.
1777
# The default value is: NO.
1778
# This tag requires that the tag GENERATE_MAN is set to YES.
1782
#---------------------------------------------------------------------------
1783
# Configuration options related to the XML output
1784
#---------------------------------------------------------------------------
1786
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1787
# captures the structure of the code including all documentation.
1788
# The default value is: NO.
1792
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1793
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1795
# The default directory is: xml.
1796
# This tag requires that the tag GENERATE_XML is set to YES.
1800
# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1801
# validating XML parser to check the syntax of the XML files.
1802
# This tag requires that the tag GENERATE_XML is set to YES.
1806
# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1807
# validating XML parser to check the syntax of the XML files.
1808
# This tag requires that the tag GENERATE_XML is set to YES.
1812
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1813
# listings (including syntax highlighting and cross-referencing information) to
1814
# the XML output. Note that enabling this will significantly increase the size
1815
# of the XML output.
1816
# The default value is: YES.
1817
# This tag requires that the tag GENERATE_XML is set to YES.
1819
XML_PROGRAMLISTING = YES
1821
#---------------------------------------------------------------------------
1822
# Configuration options related to the DOCBOOK output
1823
#---------------------------------------------------------------------------
1825
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1826
# that can be used to generate PDF.
1827
# The default value is: NO.
1829
GENERATE_DOCBOOK = NO
1831
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1832
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1834
# The default directory is: docbook.
1835
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1837
DOCBOOK_OUTPUT = docbook
1839
#---------------------------------------------------------------------------
1840
# Configuration options for the AutoGen Definitions output
1841
#---------------------------------------------------------------------------
1843
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1844
# Definitions (see http://autogen.sf.net) file that captures the structure of
1845
# the code including all documentation. Note that this feature is still
1846
# experimental and incomplete at the moment.
1847
# The default value is: NO.
1849
GENERATE_AUTOGEN_DEF = NO
1851
#---------------------------------------------------------------------------
1852
# Configuration options related to the Perl module output
1853
#---------------------------------------------------------------------------
1855
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1856
# file that captures the structure of the code including all documentation.
1858
# Note that this feature is still experimental and incomplete at the moment.
1859
# The default value is: NO.
1861
GENERATE_PERLMOD = NO
1863
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1864
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1865
# output from the Perl module output.
1866
# The default value is: NO.
1867
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1871
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1872
# formatted so it can be parsed by a human reader. This is useful if you want to
1873
# understand what is going on. On the other hand, if this tag is set to NO the
1874
# size of the Perl module output will be much smaller and Perl will parse it
1876
# The default value is: YES.
1877
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1879
PERLMOD_PRETTY = YES
1881
# The names of the make variables in the generated doxyrules.make file are
1882
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1883
# so different doxyrules.make files included by the same Makefile don't
1884
# overwrite each other's variables.
1885
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1887
PERLMOD_MAKEVAR_PREFIX =
1889
#---------------------------------------------------------------------------
1890
# Configuration options related to the preprocessor
1891
#---------------------------------------------------------------------------
1893
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1894
# C-preprocessor directives found in the sources and include files.
1895
# The default value is: YES.
1897
ENABLE_PREPROCESSING = YES
1899
# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1900
# in the source code. If set to NO only conditional compilation will be
1901
# performed. Macro expansion can be done in a controlled way by setting
1902
# EXPAND_ONLY_PREDEF to YES.
1903
# The default value is: NO.
1904
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1906
MACRO_EXPANSION = NO
1908
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1909
# the macro expansion is limited to the macros specified with the PREDEFINED and
1910
# EXPAND_AS_DEFINED tags.
1911
# The default value is: NO.
1912
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1914
EXPAND_ONLY_PREDEF = NO
1916
# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1917
# INCLUDE_PATH will be searched if a #include is found.
1918
# The default value is: YES.
1919
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1921
SEARCH_INCLUDES = YES
1923
# The INCLUDE_PATH tag can be used to specify one or more directories that
1924
# contain include files that are not input files but should be processed by the
1926
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1930
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1931
# patterns (like *.h and *.hpp) to filter out the header-files in the
1932
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1934
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1936
INCLUDE_FILE_PATTERNS =
1938
# The PREDEFINED tag can be used to specify one or more macro names that are
1939
# defined before the preprocessor is started (similar to the -D option of e.g.
1940
# gcc). The argument of the tag is a list of macros of the form: name or
1941
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1942
# is assumed. To prevent a macro definition from being undefined via #undef or
1943
# recursively expanded use the := operator instead of the = operator.
1944
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1948
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1949
# tag can be used to specify a list of macro names that should be expanded. The
1950
# macro definition that is found in the sources will be used. Use the PREDEFINED
1951
# tag if you want to use a different macro definition that overrules the
1952
# definition found in the source code.
1953
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1957
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1958
# remove all refrences to function-like macros that are alone on a line, have an
1959
# all uppercase name, and do not end with a semicolon. Such function macros are
1960
# typically used for boiler-plate code, and will confuse the parser if not
1962
# The default value is: YES.
1963
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1965
SKIP_FUNCTION_MACROS = YES
1967
#---------------------------------------------------------------------------
1968
# Configuration options related to external references
1969
#---------------------------------------------------------------------------
1971
# The TAGFILES tag can be used to specify one or more tag files. For each tag
1972
# file the location of the external documentation should be added. The format of
1973
# a tag file without this location is as follows:
1974
# TAGFILES = file1 file2 ...
1975
# Adding location for the tag files is done as follows:
1976
# TAGFILES = file1=loc1 "file2 = loc2" ...
1977
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1978
# section "Linking to external documentation" for more information about the use
1980
# Note: Each tag file must have an unique name (where the name does NOT include
1981
# the path). If a tag file is not located in the directory in which doxygen is
1982
# run, you must also specify the path to the tagfile here.
1986
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1987
# tag file that is based on the input files it reads. See section "Linking to
1988
# external documentation" for more information about the usage of tag files.
1992
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1993
# class index. If set to NO only the inherited external classes will be listed.
1994
# The default value is: NO.
1998
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1999
# the modules index. If set to NO, only the current project's groups will be
2001
# The default value is: YES.
2003
EXTERNAL_GROUPS = YES
2005
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2006
# the related pages index. If set to NO, only the current project's pages will
2008
# The default value is: YES.
2010
EXTERNAL_PAGES = YES
2012
# The PERL_PATH should be the absolute path and name of the perl script
2013
# interpreter (i.e. the result of 'which perl').
2014
# The default file (with absolute path) is: /usr/bin/perl.
2016
PERL_PATH = /usr/bin/perl
2018
#---------------------------------------------------------------------------
2019
# Configuration options related to the dot tool
2020
#---------------------------------------------------------------------------
2022
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2023
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2024
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2025
# disabled, but it is recommended to install and use dot, since it yields more
2027
# The default value is: YES.
2029
CLASS_DIAGRAMS = YES
2031
# You can define message sequence charts within doxygen comments using the \msc
2032
# command. Doxygen will then run the mscgen tool (see:
2033
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2034
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2035
# the mscgen tool resides. If left empty the tool is assumed to be found in the
2036
# default search path.
2040
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2041
# then run dia to produce the diagram and insert it in the documentation. The
2042
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2043
# If left empty dia is assumed to be found in the default search path.
2047
# If set to YES, the inheritance and collaboration graphs will hide inheritance
2048
# and usage relations if the target is undocumented or is not a class.
2049
# The default value is: YES.
2051
HIDE_UNDOC_RELATIONS = YES
2053
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2054
# available from the path. This tool is part of Graphviz (see:
2055
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2056
# Bell Labs. The other options in this section have no effect if this option is
2058
# The default value is: NO.
2062
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2063
# to run in parallel. When set to 0 doxygen will base this on the number of
2064
# processors available in the system. You can set it explicitly to a value
2065
# larger than 0 to get control over the balance between CPU load and processing
2067
# Minimum value: 0, maximum value: 32, default value: 0.
2068
# This tag requires that the tag HAVE_DOT is set to YES.
2072
# When you want a differently looking font n the dot files that doxygen
2073
# generates you can specify the font name using DOT_FONTNAME. You need to make
2074
# sure dot is able to find the font, which can be done by putting it in a
2075
# standard location or by setting the DOTFONTPATH environment variable or by
2076
# setting DOT_FONTPATH to the directory containing the font.
2077
# The default value is: Helvetica.
2078
# This tag requires that the tag HAVE_DOT is set to YES.
2082
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2084
# Minimum value: 4, maximum value: 24, default value: 10.
2085
# This tag requires that the tag HAVE_DOT is set to YES.
2089
# By default doxygen will tell dot to use the default font as specified with
2090
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2091
# the path where dot can find it using this tag.
2092
# This tag requires that the tag HAVE_DOT is set to YES.
2096
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2097
# each documented class showing the direct and indirect inheritance relations.
2098
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2099
# The default value is: YES.
2100
# This tag requires that the tag HAVE_DOT is set to YES.
2104
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2105
# graph for each documented class showing the direct and indirect implementation
2106
# dependencies (inheritance, containment, and class references variables) of the
2107
# class with other documented classes.
2108
# The default value is: YES.
2109
# This tag requires that the tag HAVE_DOT is set to YES.
2111
COLLABORATION_GRAPH = YES
2113
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2114
# groups, showing the direct groups dependencies.
2115
# The default value is: YES.
2116
# This tag requires that the tag HAVE_DOT is set to YES.
2120
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2121
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2123
# The default value is: NO.
2124
# This tag requires that the tag HAVE_DOT is set to YES.
2128
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2129
# class node. If there are many fields or methods and many nodes the graph may
2130
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2131
# number of items for each type to make the size more manageable. Set this to 0
2132
# for no limit. Note that the threshold may be exceeded by 50% before the limit
2133
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2134
# but if the number exceeds 15, the total amount of fields shown is limited to
2136
# Minimum value: 0, maximum value: 100, default value: 10.
2137
# This tag requires that the tag HAVE_DOT is set to YES.
2139
UML_LIMIT_NUM_FIELDS = 10
2141
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2142
# collaboration graphs will show the relations between templates and their
2144
# The default value is: NO.
2145
# This tag requires that the tag HAVE_DOT is set to YES.
2147
TEMPLATE_RELATIONS = NO
2149
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2150
# YES then doxygen will generate a graph for each documented file showing the
2151
# direct and indirect include dependencies of the file with other documented
2153
# The default value is: YES.
2154
# This tag requires that the tag HAVE_DOT is set to YES.
2158
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2159
# set to YES then doxygen will generate a graph for each documented file showing
2160
# the direct and indirect include dependencies of the file with other documented
2162
# The default value is: YES.
2163
# This tag requires that the tag HAVE_DOT is set to YES.
2165
INCLUDED_BY_GRAPH = YES
2167
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2168
# dependency graph for every global function or class method.
2170
# Note that enabling this option will significantly increase the time of a run.
2171
# So in most cases it will be better to enable call graphs for selected
2172
# functions only using the \callgraph command.
2173
# The default value is: NO.
2174
# This tag requires that the tag HAVE_DOT is set to YES.
2178
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2179
# dependency graph for every global function or class method.
2181
# Note that enabling this option will significantly increase the time of a run.
2182
# So in most cases it will be better to enable caller graphs for selected
2183
# functions only using the \callergraph command.
2184
# The default value is: NO.
2185
# This tag requires that the tag HAVE_DOT is set to YES.
2189
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2190
# hierarchy of all classes instead of a textual one.
2191
# The default value is: YES.
2192
# This tag requires that the tag HAVE_DOT is set to YES.
2194
GRAPHICAL_HIERARCHY = YES
2196
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2197
# dependencies a directory has on other directories in a graphical way. The
2198
# dependency relations are determined by the #include relations between the
2199
# files in the directories.
2200
# The default value is: YES.
2201
# This tag requires that the tag HAVE_DOT is set to YES.
2203
DIRECTORY_GRAPH = YES
2205
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2207
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2208
# to make the SVG files visible in IE 9+ (other browsers do not have this
2210
# Possible values are: png, jpg, gif and svg.
2211
# The default value is: png.
2212
# This tag requires that the tag HAVE_DOT is set to YES.
2214
DOT_IMAGE_FORMAT = png
2216
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2217
# enable generation of interactive SVG images that allow zooming and panning.
2219
# Note that this requires a modern browser other than Internet Explorer. Tested
2220
# and working are Firefox, Chrome, Safari, and Opera.
2221
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2222
# the SVG files visible. Older versions of IE do not have SVG support.
2223
# The default value is: NO.
2224
# This tag requires that the tag HAVE_DOT is set to YES.
2226
INTERACTIVE_SVG = NO
2228
# The DOT_PATH tag can be used to specify the path where the dot tool can be
2229
# found. If left blank, it is assumed the dot tool can be found in the path.
2230
# This tag requires that the tag HAVE_DOT is set to YES.
2234
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2235
# contain dot files that are included in the documentation (see the \dotfile
2237
# This tag requires that the tag HAVE_DOT is set to YES.
2241
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2242
# contain msc files that are included in the documentation (see the \mscfile
2247
# The DIAFILE_DIRS tag can be used to specify one or more directories that
2248
# contain dia files that are included in the documentation (see the \diafile
2253
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2254
# that will be shown in the graph. If the number of nodes in a graph becomes
2255
# larger than this value, doxygen will truncate the graph, which is visualized
2256
# by representing a node as a red box. Note that doxygen if the number of direct
2257
# children of the root node in a graph is already larger than
2258
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2259
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2260
# Minimum value: 0, maximum value: 10000, default value: 50.
2261
# This tag requires that the tag HAVE_DOT is set to YES.
2263
DOT_GRAPH_MAX_NODES = 50
2265
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2266
# generated by dot. A depth value of 3 means that only nodes reachable from the
2267
# root by following a path via at most 3 edges will be shown. Nodes that lay
2268
# further from the root node will be omitted. Note that setting this option to 1
2269
# or 2 may greatly reduce the computation time needed for large code bases. Also
2270
# note that the size of a graph can be further restricted by
2271
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2272
# Minimum value: 0, maximum value: 1000, default value: 0.
2273
# This tag requires that the tag HAVE_DOT is set to YES.
2275
MAX_DOT_GRAPH_DEPTH = 0
2277
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2278
# background. This is disabled by default, because dot on Windows does not seem
2279
# to support this out of the box.
2281
# Warning: Depending on the platform used, enabling this option may lead to
2282
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2284
# The default value is: NO.
2285
# This tag requires that the tag HAVE_DOT is set to YES.
2287
DOT_TRANSPARENT = NO
2289
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2290
# files in one run (i.e. multiple -o and -T options on the command line). This
2291
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2292
# this, this feature is disabled by default.
2293
# The default value is: NO.
2294
# This tag requires that the tag HAVE_DOT is set to YES.
2296
DOT_MULTI_TARGETS = YES
2298
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2299
# explaining the meaning of the various boxes and arrows in the dot generated
2301
# The default value is: YES.
2302
# This tag requires that the tag HAVE_DOT is set to YES.
2304
GENERATE_LEGEND = YES
2306
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2307
# files that are used to generate the various graphs.
2308
# The default value is: YES.
2309
# This tag requires that the tag HAVE_DOT is set to YES.