3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
8
# TAG = value [value, ...]
9
# For lists items can also be appended using:
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
13
#---------------------------------------------------------------------------
14
# General configuration options
15
#---------------------------------------------------------------------------
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23
# This could be handy for archiving the generated documentation or
24
# if some version control system is used.
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
31
# where doxygen was started. If left blank the current directory will be used.
33
OUTPUT_DIRECTORY = docs
35
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36
# documentation generated by doxygen is written. Doxygen will use this
37
# information to generate all constant output in the proper language.
38
# The default language is English, other supported languages are:
39
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
44
OUTPUT_LANGUAGE = English
46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47
# documentation are documented, even if no documentation was available.
48
# Private class members and static file members will be hidden unless
49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
54
# will be included in the documentation.
58
# If the EXTRACT_STATIC tag is set to YES all static members of a file
59
# will be included in the documentation.
63
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64
# defined locally in source files will be included in the documentation.
65
# If set to NO only classes defined in header files are included.
67
EXTRACT_LOCAL_CLASSES = NO
69
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70
# undocumented members of documented classes, files or namespaces.
71
# If set to NO (the default) these members will be included in the
72
# various overviews, but no documentation section is generated.
73
# This option has no effect if EXTRACT_ALL is enabled.
75
HIDE_UNDOC_MEMBERS = NO
77
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78
# undocumented classes that are normally visible in the class hierarchy.
79
# If set to NO (the default) these class will be included in the various
80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
82
HIDE_UNDOC_CLASSES = NO
84
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
85
# friend (class|struct|union) declarations.
86
# If set to NO (the default) these declarations will be included in the
89
HIDE_FRIEND_COMPOUNDS = NO
91
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
92
# include brief member descriptions after the members that are listed in
93
# the file and class documentation (similar to JavaDoc).
94
# Set to NO to disable this.
96
BRIEF_MEMBER_DESC = YES
98
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
99
# the brief description of a member or function before the detailed description.
100
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
101
# brief descriptions will be completely suppressed.
105
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106
# Doxygen will generate a detailed section even if there is only a brief
109
ALWAYS_DETAILED_SEC = NO
111
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
112
# members of a class in the documentation of that class as if those members were
113
# ordinary class members. Constructors, destructors and assignment operators of
114
# the base classes will not be shown.
116
INLINE_INHERITED_MEMB = NO
118
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119
# path before files name in the file list and in the header files. If set
120
# to NO the shortest path that makes the file name unique will be used.
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125
# can be used to strip a user defined part of the path. Stripping is
126
# only done if one of the specified strings matches the left-hand part of
127
# the path. It is allowed to use relative paths in the argument list.
131
# The INTERNAL_DOCS tag determines if documentation
132
# that is typed after a \internal command is included. If the tag is set
133
# to NO (the default) then the documentation will be excluded.
134
# Set it to YES to include the internal documentation.
138
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
139
# doxygen to hide any special comment blocks from generated source code
140
# fragments. Normal C and C++ comments will always remain visible.
142
STRIP_CODE_COMMENTS = YES
144
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
145
# file names in lower case letters. If set to YES upper case letters are also
146
# allowed. This is useful if you have classes or files whose names only differ
147
# in case and if your file system supports case sensitive file names. Windows
148
# users are adviced to set this option to NO.
150
CASE_SENSE_NAMES = YES
152
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
153
# (but less readable) file names. This can be useful is your file systems
154
# doesn't support long names like on DOS, Mac, or CD-ROM.
158
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
159
# will show members with their full class and namespace scopes in the
160
# documentation. If set to YES the scope will be hidden.
162
HIDE_SCOPE_NAMES = NO
164
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
165
# will generate a verbatim copy of the header file for each class for
166
# which an include is specified. Set to NO to disable this.
168
VERBATIM_HEADERS = YES
170
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
171
# will put list of the files that are included by a file in the documentation
174
SHOW_INCLUDE_FILES = YES
176
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
177
# will interpret the first line (until the first dot) of a JavaDoc-style
178
# comment as the brief description. If set to NO, the JavaDoc
179
# comments will behave just like the Qt-style comments (thus requiring an
180
# explict @brief command for a brief description.
182
JAVADOC_AUTOBRIEF = YES
184
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
185
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
186
# comments) as a brief description. This used to be the default behaviour.
187
# The new default is to treat a multi-line C++ comment block as a detailed
188
# description. Set this tag to YES if you prefer the old behaviour instead.
190
MULTILINE_CPP_IS_BRIEF = NO
192
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
193
# will output the detailed description near the top, like JavaDoc.
194
# If set to NO, the detailed description appears after the member
199
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
200
# member inherits the documentation from any documented member that it
205
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
206
# is inserted in the documentation for inline members.
210
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
211
# will sort the (detailed) documentation of file and class members
212
# alphabetically by member name. If set to NO the members will appear in
215
SORT_MEMBER_DOCS = YES
217
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
218
# tag is set to YES, then doxygen will reuse the documentation of the first
219
# member in the group (if any) for the other members of the group. By default
220
# all members of a group must be documented explicitly.
222
DISTRIBUTE_GROUP_DOC = NO
224
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
225
# Doxygen uses this value to replace tabs by spaces in code fragments.
229
# The GENERATE_TODOLIST tag can be used to enable (YES) or
230
# disable (NO) the todo list. This list is created by putting \todo
231
# commands in the documentation.
233
GENERATE_TODOLIST = YES
235
# The GENERATE_TESTLIST tag can be used to enable (YES) or
236
# disable (NO) the test list. This list is created by putting \test
237
# commands in the documentation.
239
GENERATE_TESTLIST = YES
241
# The GENERATE_BUGLIST tag can be used to enable (YES) or
242
# disable (NO) the bug list. This list is created by putting \bug
243
# commands in the documentation.
245
GENERATE_BUGLIST = YES
247
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
248
# disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation.
250
GENERATE_DEPRECATEDLIST= YES
252
# This tag can be used to specify a number of aliases that acts
253
# as commands in the documentation. An alias has the form "name=value".
254
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
255
# put the command \sideeffect (or @sideeffect) in the documentation, which
256
# will result in a user defined paragraph with heading "Side Effects:".
257
# You can put \n's in the value part of an alias to insert newlines.
261
# The ENABLED_SECTIONS tag can be used to enable conditional
262
# documentation sections, marked by \if sectionname ... \endif.
266
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
267
# the initial value of a variable or define consist of for it to appear in
268
# the documentation. If the initializer consists of more lines than specified
269
# here it will be hidden. Use a value of 0 to hide initializers completely.
270
# The appearance of the initializer of individual variables and defines in the
271
# documentation can be controlled using \showinitializer or \hideinitializer
272
# command in the documentation regardless of this setting.
274
MAX_INITIALIZER_LINES = 30
276
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
277
# only. Doxygen will then generate output that is more tailored for C.
278
# For instance some of the names that are used will be different. The list
279
# of all members will be omitted, etc.
281
OPTIMIZE_OUTPUT_FOR_C = YES
283
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
284
# only. Doxygen will then generate output that is more tailored for Java.
285
# For instance namespaces will be presented as packages, qualified scopes
286
# will look different, etc.
288
OPTIMIZE_OUTPUT_JAVA = NO
290
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
291
# at the bottom of the documentation of classes and structs. If set to YES the
292
# list will mention the files that were used to generate the documentation.
294
SHOW_USED_FILES = YES
296
#---------------------------------------------------------------------------
297
# configuration options related to warning and progress messages
298
#---------------------------------------------------------------------------
300
# The QUIET tag can be used to turn on/off the messages that are generated
301
# by doxygen. Possible values are YES and NO. If left blank NO is used.
305
# The WARNINGS tag can be used to turn on/off the warning messages that are
306
# generated by doxygen. Possible values are YES and NO. If left blank
311
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
312
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
313
# automatically be disabled.
315
WARN_IF_UNDOCUMENTED = YES
317
# The WARN_FORMAT tag determines the format of the warning messages that
318
# doxygen can produce. The string should contain the $file, $line, and $text
319
# tags, which will be replaced by the file and line number from which the
320
# warning originated and the warning text.
322
WARN_FORMAT = "$file:$line: $text"
324
# The WARN_LOGFILE tag can be used to specify a file to which warning
325
# and error messages should be written. If left blank the output is written
330
#---------------------------------------------------------------------------
331
# configuration options related to the input files
332
#---------------------------------------------------------------------------
334
# The INPUT tag can be used to specify the files and/or directories that contain
335
# documented source files. You may enter file names like "myfile.cpp" or
336
# directories like "/usr/src/myproject". Separate the files or directories
339
INPUT = . include/enet docs
341
# If the value of the INPUT tag contains directories, you can use the
342
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
343
# and *.h) to filter out the source-files in the directories. If left
344
# blank the following patterns are tested:
345
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
348
FILE_PATTERNS = *.c *.h *.dox
350
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
351
# should be searched for input files as well. Possible values are YES and NO.
352
# If left blank NO is used.
356
# The EXCLUDE tag can be used to specify files and/or directories that should
357
# excluded from the INPUT source files. This way you can easily exclude a
358
# subdirectory from a directory tree whose root is specified with the INPUT tag.
362
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
363
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
365
EXCLUDE_SYMLINKS = NO
367
# If the value of the INPUT tag contains directories, you can use the
368
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
369
# certain files from those directories.
373
# The EXAMPLE_PATH tag can be used to specify one or more files or
374
# directories that contain example code fragments that are included (see
375
# the \include command).
379
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
380
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
381
# and *.h) to filter out the source-files in the directories. If left
382
# blank all files are included.
386
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
387
# searched for input files to be used with the \include or \dontinclude
388
# commands irrespective of the value of the RECURSIVE tag.
389
# Possible values are YES and NO. If left blank NO is used.
391
EXAMPLE_RECURSIVE = NO
393
# The IMAGE_PATH tag can be used to specify one or more files or
394
# directories that contain image that are included in the documentation (see
395
# the \image command).
399
# The INPUT_FILTER tag can be used to specify a program that doxygen should
400
# invoke to filter for each input file. Doxygen will invoke the filter program
401
# by executing (via popen()) the command <filter> <input-file>, where <filter>
402
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
403
# input file. Doxygen will then use the output that the filter program writes
404
# to standard output.
408
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
409
# INPUT_FILTER) will be used to filter the input files when producing source
410
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
412
FILTER_SOURCE_FILES = NO
414
#---------------------------------------------------------------------------
415
# configuration options related to source browsing
416
#---------------------------------------------------------------------------
418
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
419
# be generated. Documented entities will be cross-referenced with these sources.
423
# Setting the INLINE_SOURCES tag to YES will include the body
424
# of functions and classes directly in the documentation.
428
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
429
# then for each documented function all documented
430
# functions referencing it will be listed.
432
REFERENCED_BY_RELATION = YES
434
# If the REFERENCES_RELATION tag is set to YES (the default)
435
# then for each documented function all documented entities
436
# called/used by that function will be listed.
438
REFERENCES_RELATION = YES
440
#---------------------------------------------------------------------------
441
# configuration options related to the alphabetical class index
442
#---------------------------------------------------------------------------
444
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
445
# of all compounds will be generated. Enable this if the project
446
# contains a lot of classes, structs, unions or interfaces.
448
ALPHABETICAL_INDEX = YES
450
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
451
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
452
# in which this list will be split (can be a number in the range [1..20])
454
COLS_IN_ALPHA_INDEX = 5
456
# In case all classes in a project start with a common prefix, all
457
# classes will be put under the same header in the alphabetical index.
458
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
459
# should be ignored while generating the index headers.
463
#---------------------------------------------------------------------------
464
# configuration options related to the HTML output
465
#---------------------------------------------------------------------------
467
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
468
# generate HTML output.
472
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
473
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
474
# put in front of it. If left blank `html' will be used as the default path.
478
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
479
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
480
# doxygen will generate files with .html extension.
482
HTML_FILE_EXTENSION = .html
484
# The HTML_HEADER tag can be used to specify a personal HTML header for
485
# each generated HTML page. If it is left blank doxygen will generate a
490
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
491
# each generated HTML page. If it is left blank doxygen will generate a
496
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
497
# style sheet that is used by each HTML page. It can be used to
498
# fine-tune the look of the HTML output. If the tag is left blank doxygen
499
# will generate a default style sheet
503
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
504
# files or namespaces will be aligned in HTML using tables. If set to
505
# NO a bullet list will be used.
507
HTML_ALIGN_MEMBERS = YES
509
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
510
# will be generated that can be used as input for tools like the
511
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
512
# of the generated HTML documentation.
514
GENERATE_HTMLHELP = NO
516
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
517
# be used to specify the file name of the resulting .chm file. You
518
# can add a path in front of the file if the result should not be
519
# written to the html output dir.
523
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
524
# be used to specify the location (absolute path including file name) of
525
# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
526
# the html help compiler on the generated index.hhp.
530
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
531
# controls if a separate .chi index file is generated (YES) or that
532
# it should be included in the master .chm file (NO).
536
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
537
# controls whether a binary table of contents is generated (YES) or a
538
# normal table of contents (NO) in the .chm file.
542
# The TOC_EXPAND flag can be set to YES to add extra items for group members
543
# to the contents of the Html help documentation and to the tree view.
547
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
548
# top of each HTML page. The value NO (the default) enables the index and
549
# the value YES disables it.
553
# This tag can be used to set the number of enum values (range [1..20])
554
# that doxygen will group on one line in the generated HTML documentation.
556
ENUM_VALUES_PER_LINE = 4
558
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
559
# generated containing a tree-like index structure (just like the one that
560
# is generated for HTML Help). For this to work a browser that supports
561
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
562
# or Internet explorer 4.0+). Note that for large projects the tree generation
563
# can take a very long time. In such cases it is better to disable this feature.
564
# Windows users are probably better off using the HTML help feature.
566
GENERATE_TREEVIEW = NO
568
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
569
# used to set the initial width (in pixels) of the frame in which the tree
574
#---------------------------------------------------------------------------
575
# configuration options related to the LaTeX output
576
#---------------------------------------------------------------------------
578
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
579
# generate Latex output.
583
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
584
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
585
# put in front of it. If left blank `latex' will be used as the default path.
589
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
591
LATEX_CMD_NAME = latex
593
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
594
# generate index for LaTeX. If left blank `makeindex' will be used as the
595
# default command name.
597
MAKEINDEX_CMD_NAME = makeindex
599
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
600
# LaTeX documents. This may be useful for small projects and may help to
601
# save some trees in general.
605
# The PAPER_TYPE tag can be used to set the paper type that is used
606
# by the printer. Possible values are: a4, a4wide, letter, legal and
607
# executive. If left blank a4wide will be used.
611
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
612
# packages that should be included in the LaTeX output.
616
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
617
# the generated latex document. The header should contain everything until
618
# the first chapter. If it is left blank doxygen will generate a
619
# standard header. Notice: only use this tag if you know what you are doing!
623
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
624
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
625
# contain links (just like the HTML output) instead of page references
626
# This makes the output suitable for online browsing using a pdf viewer.
630
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
631
# plain latex in the generated Makefile. Set this option to YES to get a
632
# higher quality PDF documentation.
636
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
637
# command to the generated LaTeX files. This will instruct LaTeX to keep
638
# running if errors occur, instead of asking the user for help.
639
# This option is also used when generating formulas in HTML.
643
#---------------------------------------------------------------------------
644
# configuration options related to the RTF output
645
#---------------------------------------------------------------------------
647
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
648
# The RTF output is optimised for Word 97 and may not look very pretty with
649
# other RTF readers or editors.
653
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
654
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
655
# put in front of it. If left blank `rtf' will be used as the default path.
659
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
660
# RTF documents. This may be useful for small projects and may help to
661
# save some trees in general.
665
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
666
# will contain hyperlink fields. The RTF file will
667
# contain links (just like the HTML output) instead of page references.
668
# This makes the output suitable for online browsing using WORD or other
669
# programs which support those fields.
670
# Note: wordpad (write) and others do not support links.
674
# Load stylesheet definitions from file. Syntax is similar to doxygen's
675
# config file, i.e. a series of assigments. You only have to provide
676
# replacements, missing definitions are set to their default value.
678
RTF_STYLESHEET_FILE =
680
# Set optional variables used in the generation of an rtf document.
681
# Syntax is similar to doxygen's config file.
683
RTF_EXTENSIONS_FILE =
685
#---------------------------------------------------------------------------
686
# configuration options related to the man page output
687
#---------------------------------------------------------------------------
689
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
694
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
695
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
696
# put in front of it. If left blank `man' will be used as the default path.
700
# The MAN_EXTENSION tag determines the extension that is added to
701
# the generated man pages (default is the subroutine's section .3)
705
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
706
# then it will generate one additional man file for each entity
707
# documented in the real man page(s). These additional files
708
# only source the real man page, but without them the man command
709
# would be unable to find the correct page. The default is NO.
713
#---------------------------------------------------------------------------
714
# configuration options related to the XML output
715
#---------------------------------------------------------------------------
717
# If the GENERATE_XML tag is set to YES Doxygen will
718
# generate an XML file that captures the structure of
719
# the code including all documentation. Note that this
720
# feature is still experimental and incomplete at the
725
# The XML_SCHEMA tag can be used to specify an XML schema,
726
# which can be used by a validating XML parser to check the
727
# syntax of the XML files.
731
# The XML_DTD tag can be used to specify an XML DTD,
732
# which can be used by a validating XML parser to check the
733
# syntax of the XML files.
737
#---------------------------------------------------------------------------
738
# configuration options for the AutoGen Definitions output
739
#---------------------------------------------------------------------------
741
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
742
# generate an AutoGen Definitions (see autogen.sf.net) file
743
# that captures the structure of the code including all
744
# documentation. Note that this feature is still experimental
745
# and incomplete at the moment.
747
GENERATE_AUTOGEN_DEF = NO
749
#---------------------------------------------------------------------------
750
# Configuration options related to the preprocessor
751
#---------------------------------------------------------------------------
753
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
754
# evaluate all C-preprocessor directives found in the sources and include
757
ENABLE_PREPROCESSING = YES
759
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
760
# names in the source code. If set to NO (the default) only conditional
761
# compilation will be performed. Macro expansion can be done in a controlled
762
# way by setting EXPAND_ONLY_PREDEF to YES.
766
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
767
# then the macro expansion is limited to the macros specified with the
768
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
770
EXPAND_ONLY_PREDEF = NO
772
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
773
# in the INCLUDE_PATH (see below) will be search if a #include is found.
775
SEARCH_INCLUDES = YES
777
# The INCLUDE_PATH tag can be used to specify one or more directories that
778
# contain include files that are not input files but should be processed by
783
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
784
# patterns (like *.h and *.hpp) to filter out the header-files in the
785
# directories. If left blank, the patterns specified with FILE_PATTERNS will
788
INCLUDE_FILE_PATTERNS =
790
# The PREDEFINED tag can be used to specify one or more macro names that
791
# are defined before the preprocessor is started (similar to the -D option of
792
# gcc). The argument of the tag is a list of macros of the form: name
793
# or name=definition (no spaces). If the definition and the = are
794
# omitted =1 is assumed.
796
PREDEFINED = FORCE_DOXYGEN
798
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
799
# this tag can be used to specify a list of macro names that should be expanded.
800
# The macro definition that is found in the sources will be used.
801
# Use the PREDEFINED tag if you want to use a different macro definition.
805
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
806
# doxygen's preprocessor will remove all function-like macros that are alone
807
# on a line, have an all uppercase name, and do not end with a semicolon. Such
808
# function macros are typically used for boiler-plate code, and will confuse the
809
# parser if not removed.
811
SKIP_FUNCTION_MACROS = YES
813
#---------------------------------------------------------------------------
814
# Configuration::addtions related to external references
815
#---------------------------------------------------------------------------
817
# The TAGFILES tag can be used to specify one or more tagfiles.
821
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
822
# a tag file that is based on the input files it reads.
826
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
827
# in the class index. If set to NO only the inherited external classes
832
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
833
# in the modules index. If set to NO, only the current project's groups will
836
EXTERNAL_GROUPS = YES
838
# The PERL_PATH should be the absolute path and name of the perl script
839
# interpreter (i.e. the result of `which perl').
841
PERL_PATH = /usr/bin/perl
843
#---------------------------------------------------------------------------
844
# Configuration options related to the dot tool
845
#---------------------------------------------------------------------------
847
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
848
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
849
# super classes. Setting the tag to NO turns the diagrams off. Note that this
850
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
851
# recommended to install and use dot, since it yield more powerful graphs.
855
# If set to YES, the inheritance and collaboration graphs will hide
856
# inheritance and usage relations if the target is undocumented
859
HIDE_UNDOC_RELATIONS = YES
861
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
862
# available from the path. This tool is part of Graphviz, a graph visualization
863
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
864
# have no effect if this option is set to NO (the default)
868
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
869
# will generate a graph for each documented class showing the direct and
870
# indirect inheritance relations. Setting this tag to YES will force the
871
# the CLASS_DIAGRAMS tag to NO.
875
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
876
# will generate a graph for each documented class showing the direct and
877
# indirect implementation dependencies (inheritance, containment, and
878
# class references variables) of the class with other documented classes.
880
COLLABORATION_GRAPH = YES
882
# If set to YES, the inheritance and collaboration graphs will show the
883
# relations between templates and their instances.
885
TEMPLATE_RELATIONS = YES
887
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
888
# tags are set to YES then doxygen will generate a graph for each documented
889
# file showing the direct and indirect include dependencies of the file with
890
# other documented files.
894
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
895
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
896
# documented header file showing the documented files that directly or
897
# indirectly include this file.
899
INCLUDED_BY_GRAPH = YES
901
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
902
# will graphical hierarchy of all classes instead of a textual one.
904
GRAPHICAL_HIERARCHY = YES
906
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
907
# generated by dot. Possible values are png, jpg, or gif
908
# If left blank png will be used.
910
DOT_IMAGE_FORMAT = png
912
# The tag DOT_PATH can be used to specify the path where the dot tool can be
913
# found. If left blank, it is assumed the dot tool can be found on the path.
917
# The DOTFILE_DIRS tag can be used to specify one or more directories that
918
# contain dot files that are included in the documentation (see the
923
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
924
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
925
# this value, doxygen will try to truncate the graph, so that it fits within
926
# the specified constraint. Beware that most browsers cannot cope with very
929
MAX_DOT_GRAPH_WIDTH = 1024
931
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
932
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
933
# this value, doxygen will try to truncate the graph, so that it fits within
934
# the specified constraint. Beware that most browsers cannot cope with very
937
MAX_DOT_GRAPH_HEIGHT = 1024
939
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
940
# generate a legend page explaining the meaning of the various boxes and
941
# arrows in the dot generated graphs.
943
GENERATE_LEGEND = YES
945
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
946
# remove the intermedate dot files that are used to generate
947
# the various graphs.
951
#---------------------------------------------------------------------------
952
# Configuration::addtions related to the search engine
953
#---------------------------------------------------------------------------
955
# The SEARCHENGINE tag specifies whether or not a search engine should be
956
# used. If set to NO the values of all tags below this one will be ignored.
960
# The CGI_NAME tag should be the name of the CGI script that
961
# starts the search engine (doxysearch) with the correct parameters.
962
# A script with this name will be generated by doxygen.
964
CGI_NAME = search.cgi
966
# The CGI_URL tag should be the absolute URL to the directory where the
967
# cgi binaries are located. See the documentation of your http daemon for
972
# The DOC_URL tag should be the absolute URL to the directory where the
973
# documentation is located. If left blank the absolute path to the
974
# documentation, with file:// prepended to it, will be used.
978
# The DOC_ABSPATH tag should be the absolute path to the directory where the
979
# documentation is located. If left blank the directory on the local machine
984
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
987
BIN_ABSPATH = /usr/local/bin/
989
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
990
# documentation generated for other projects. This allows doxysearch to search
991
# the documentation for these projects as well.