3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
8
# TAG = value [value, ...]
9
# For lists items can also be appended using:
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23
# This could be handy for archiving the generated documentation or
24
# if some version control system is used.
26
PROJECT_NUMBER = @VERSION@
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 = doxygen
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36
# 4096 sub-directories (in 2 levels) under the output directory of each output
37
# format and will distribute the generated files over these directories.
38
# Enabling this option can be useful when feeding doxygen a huge amount of
39
# source files, where putting all generated files in the same directory would
40
# otherwise cause performance problems for the file system.
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45
# documentation generated by doxygen is written. Doxygen will use this
46
# information to generate all constant output in the proper language.
47
# The default language is English, other supported languages are:
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52
# Swedish, and Ukrainian.
54
OUTPUT_LANGUAGE = English
56
# This tag can be used to specify the encoding used in the generated output.
57
# The encoding is not always determined by the language that is chosen,
58
# but also whether or not the output is meant for Windows or non-Windows users.
59
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60
# forces the Windows encoding (this is the default for the Windows binary),
61
# whereas setting the tag to NO uses a Unix-style encoding (the default for
62
# all platforms other than Windows).
64
USE_WINDOWS_ENCODING = NO
66
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67
# include brief member descriptions after the members that are listed in
68
# the file and class documentation (similar to JavaDoc).
69
# Set to NO to disable this.
71
BRIEF_MEMBER_DESC = YES
73
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74
# the brief description of a member or function before the detailed description.
75
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76
# brief descriptions will be completely suppressed.
80
# This tag implements a quasi-intelligent brief description abbreviator
81
# that is used to form the text in various listings. Each string
82
# in this list, if found as the leading text of the brief description, will be
83
# stripped from the text and the result after processing the whole list, is
84
# used as the annotated text. Otherwise, the brief description is used as-is.
85
# If left blank, the following values are used ("$name" is automatically
86
# replaced with the name of the entity): "The $name class" "The $name widget"
87
# "The $name file" "is" "provides" "specifies" "contains"
88
# "represents" "a" "an" "the"
92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93
# Doxygen will generate a detailed section even if there is only a brief
96
ALWAYS_DETAILED_SEC = NO
98
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99
# inherited members of a class in the documentation of that class as if those
100
# members were ordinary class members. Constructors, destructors and assignment
101
# operators of the base classes will not be shown.
103
INLINE_INHERITED_MEMB = NO
105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106
# path before files name in the file list and in the header files. If set
107
# to NO the shortest path that makes the file name unique will be used.
109
FULL_PATH_NAMES = YES
111
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112
# can be used to strip a user-defined part of the path. Stripping is
113
# only done if one of the specified strings matches the left-hand part of
114
# the path. The tag can be used to show relative paths in the file list.
115
# If left blank the directory from which doxygen is run is used as the
120
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121
# the path mentioned in the documentation of a class, which tells
122
# the reader which header file to include in order to use a class.
123
# If left blank only the name of the header file containing the class
124
# definition is used. Otherwise one should specify the include paths that
125
# are normally passed to the compiler using the -I flag.
127
STRIP_FROM_INC_PATH =
129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130
# (but less readable) file names. This can be useful is your file systems
131
# doesn't support long names like on DOS, Mac, or CD-ROM.
135
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136
# will interpret the first line (until the first dot) of a JavaDoc-style
137
# comment as the brief description. If set to NO, the JavaDoc
138
# comments will behave just like the Qt-style comments (thus requiring an
139
# explicit @brief command for a brief description.
141
JAVADOC_AUTOBRIEF = YES
143
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
145
# comments) as a brief description. This used to be the default behaviour.
146
# The new default is to treat a multi-line C++ comment block as a detailed
147
# description. Set this tag to YES if you prefer the old behaviour instead.
149
MULTILINE_CPP_IS_BRIEF = NO
151
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
152
# will output the detailed description near the top, like JavaDoc.
153
# If set to NO, the detailed description appears after the member
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
# member inherits the documentation from any documented member that it
164
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
165
# tag is set to YES, then doxygen will reuse the documentation of the first
166
# member in the group (if any) for the other members of the group. By default
167
# all members of a group must be documented explicitly.
169
DISTRIBUTE_GROUP_DOC = NO
171
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172
# a new page for each member. If set to NO, the documentation of a member will
173
# be part of the file/class/namespace that contains it.
175
SEPARATE_MEMBER_PAGES = NO
177
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178
# Doxygen uses this value to replace tabs by spaces in code fragments.
182
# This tag can be used to specify a number of aliases that acts
183
# as commands in the documentation. An alias has the form "name=value".
184
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
185
# put the command \sideeffect (or @sideeffect) in the documentation, which
186
# will result in a user-defined paragraph with heading "Side Effects:".
187
# You can put \n's in the value part of an alias to insert newlines.
191
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192
# sources only. Doxygen will then generate output that is more tailored for C.
193
# For instance, some of the names that are used will be different. The list
194
# of all members will be omitted, etc.
196
OPTIMIZE_OUTPUT_FOR_C = YES
198
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
199
# only. Doxygen will then generate output that is more tailored for Java.
200
# For instance, namespaces will be presented as packages, qualified scopes
201
# will look different, etc.
203
OPTIMIZE_OUTPUT_JAVA = NO
205
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206
# the same type (for instance a group of public functions) to be put as a
207
# subgroup of that type (e.g. under the Public Functions section). Set it to
208
# NO to prevent subgrouping. Alternatively, this can be done per class using
209
# the \nosubgrouping command.
213
#---------------------------------------------------------------------------
214
# Build related configuration options
215
#---------------------------------------------------------------------------
217
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
218
# documentation are documented, even if no documentation was available.
219
# Private class members and static file members will be hidden unless
220
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
224
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
225
# will be included in the documentation.
229
# If the EXTRACT_STATIC tag is set to YES all static members of a file
230
# will be included in the documentation.
234
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
235
# defined locally in source files will be included in the documentation.
236
# If set to NO only classes defined in header files are included.
238
EXTRACT_LOCAL_CLASSES = YES
240
# This flag is only useful for Objective-C code. When set to YES local
241
# methods, which are defined in the implementation section but not in
242
# the interface are included in the documentation.
243
# If set to NO (the default) only methods in the interface are included.
245
EXTRACT_LOCAL_METHODS = NO
247
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
248
# undocumented members of documented classes, files or namespaces.
249
# If set to NO (the default) these members will be included in the
250
# various overviews, but no documentation section is generated.
251
# This option has no effect if EXTRACT_ALL is enabled.
253
HIDE_UNDOC_MEMBERS = NO
255
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
256
# undocumented classes that are normally visible in the class hierarchy.
257
# If set to NO (the default) these classes will be included in the various
258
# overviews. This option has no effect if EXTRACT_ALL is enabled.
260
HIDE_UNDOC_CLASSES = NO
262
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
263
# friend (class|struct|union) declarations.
264
# If set to NO (the default) these declarations will be included in the
267
HIDE_FRIEND_COMPOUNDS = NO
269
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
270
# documentation blocks found inside the body of a function.
271
# If set to NO (the default) these blocks will be appended to the
272
# function's detailed documentation block.
274
HIDE_IN_BODY_DOCS = NO
276
# The INTERNAL_DOCS tag determines if documentation
277
# that is typed after a \internal command is included. If the tag is set
278
# to NO (the default) then the documentation will be excluded.
279
# Set it to YES to include the internal documentation.
283
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
284
# file names in lower-case letters. If set to YES upper-case letters are also
285
# allowed. This is useful if you have classes or files whose names only differ
286
# in case and if your file system supports case sensitive file names. Windows
287
# and Mac users are advised to set this option to NO.
289
CASE_SENSE_NAMES = YES
291
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
292
# will show members with their full class and namespace scopes in the
293
# documentation. If set to YES the scope will be hidden.
295
HIDE_SCOPE_NAMES = NO
297
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
298
# will put a list of the files that are included by a file in the documentation
301
SHOW_INCLUDE_FILES = NO
303
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
304
# is inserted in the documentation for inline members.
308
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
309
# will sort the (detailed) documentation of file and class members
310
# alphabetically by member name. If set to NO the members will appear in
313
SORT_MEMBER_DOCS = YES
315
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
316
# brief documentation of file, namespace and class members alphabetically
317
# by member name. If set to NO (the default) the members will appear in
322
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
323
# sorted by fully-qualified names, including namespaces. If set to
324
# NO (the default), the class list will be sorted only by class name,
325
# not including the namespace part.
326
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
327
# Note: This option applies only to the class list, not to the
330
SORT_BY_SCOPE_NAME = NO
332
# The GENERATE_TODOLIST tag can be used to enable (YES) or
333
# disable (NO) the todo list. This list is created by putting \todo
334
# commands in the documentation.
336
GENERATE_TODOLIST = YES
338
# The GENERATE_TESTLIST tag can be used to enable (YES) or
339
# disable (NO) the test list. This list is created by putting \test
340
# commands in the documentation.
342
GENERATE_TESTLIST = YES
344
# The GENERATE_BUGLIST tag can be used to enable (YES) or
345
# disable (NO) the bug list. This list is created by putting \bug
346
# commands in the documentation.
348
GENERATE_BUGLIST = YES
350
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
351
# disable (NO) the deprecated list. This list is created by putting
352
# \deprecated commands in the documentation.
354
GENERATE_DEPRECATEDLIST= YES
356
# The ENABLED_SECTIONS tag can be used to enable conditional
357
# documentation sections, marked by \if sectionname ... \endif.
361
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
362
# the initial value of a variable or define consists of for it to appear in
363
# the documentation. If the initializer consists of more lines than specified
364
# here it will be hidden. Use a value of 0 to hide initializers completely.
365
# The appearance of the initializer of individual variables and defines in the
366
# documentation can be controlled using \showinitializer or \hideinitializer
367
# command in the documentation regardless of this setting.
369
MAX_INITIALIZER_LINES = 30
371
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
372
# at the bottom of the documentation of classes and structs. If set to YES the
373
# list will mention the files that were used to generate the documentation.
375
SHOW_USED_FILES = YES
377
# If the sources in your project are distributed over multiple directories
378
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
379
# in the documentation.
381
SHOW_DIRECTORIES = YES
383
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
384
# doxygen should invoke to get the current version for each file (typically from the
385
# version control system). Doxygen will invoke the program by executing (via
386
# popen()) the command <command> <input-file>, where <command> is the value of
387
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
388
# provided by doxygen. Whatever the progam writes to standard output
389
# is used as the file version. See the manual for examples.
391
FILE_VERSION_FILTER =
393
#---------------------------------------------------------------------------
394
# configuration options related to warning and progress messages
395
#---------------------------------------------------------------------------
397
# The QUIET tag can be used to turn on/off the messages that are generated
398
# by doxygen. Possible values are YES and NO. If left blank NO is used.
402
# The WARNINGS tag can be used to turn on/off the warning messages that are
403
# generated by doxygen. Possible values are YES and NO. If left blank
408
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
409
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
410
# automatically be disabled.
412
WARN_IF_UNDOCUMENTED = YES
414
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
415
# potential errors in the documentation, such as not documenting some
416
# parameters in a documented function, or documenting parameters that
417
# don't exist or using markup commands wrongly.
419
WARN_IF_DOC_ERROR = YES
421
# This WARN_NO_PARAMDOC option can be abled to get warnings for
422
# functions that are documented, but have no documentation for their parameters
423
# or return value. If set to NO (the default) doxygen will only warn about
424
# wrong or incomplete parameter documentation, but not about the absence of
427
WARN_NO_PARAMDOC = NO
429
# The WARN_FORMAT tag determines the format of the warning messages that
430
# doxygen can produce. The string should contain the $file, $line, and $text
431
# tags, which will be replaced by the file and line number from which the
432
# warning originated and the warning text. Optionally the format may contain
433
# $version, which will be replaced by the version of the file (if it could
434
# be obtained via FILE_VERSION_FILTER)
436
WARN_FORMAT = "$file:$line: $text"
438
# The WARN_LOGFILE tag can be used to specify a file to which warning
439
# and error messages should be written. If left blank the output is written
444
#---------------------------------------------------------------------------
445
# configuration options related to the input files
446
#---------------------------------------------------------------------------
448
# The INPUT tag can be used to specify the files and/or directories that contain
449
# documented source files. You may enter file names like "myfile.cpp" or
450
# directories like "/usr/src/myproject". Separate the files or directories
453
INPUT = @top_srcdir@/src \
454
@top_srcdir@/include \
457
# If the value of the INPUT tag contains directories, you can use the
458
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
459
# and *.h) to filter out the source-files in the directories. If left
460
# blank the following patterns are tested:
461
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
462
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
466
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
467
# should be searched for input files as well. Possible values are YES and NO.
468
# If left blank NO is used.
472
# The EXCLUDE tag can be used to specify files and/or directories that should
473
# excluded from the INPUT source files. This way you can easily exclude a
474
# subdirectory from a directory tree whose root is specified with the INPUT tag.
476
EXCLUDE = @top_srcdir@/src/extras
478
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
479
# directories that are symbolic links (a Unix filesystem feature) are excluded
482
EXCLUDE_SYMLINKS = NO
484
# If the value of the INPUT tag contains directories, you can use the
485
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
486
# certain files from those directories.
490
# The EXAMPLE_PATH tag can be used to specify one or more files or
491
# directories that contain example code fragments that are included (see
492
# the \include command).
496
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
497
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
498
# and *.h) to filter out the source-files in the directories. If left
499
# blank all files are included.
503
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
504
# searched for input files to be used with the \include or \dontinclude
505
# commands irrespective of the value of the RECURSIVE tag.
506
# Possible values are YES and NO. If left blank NO is used.
508
EXAMPLE_RECURSIVE = NO
510
# The IMAGE_PATH tag can be used to specify one or more files or
511
# directories that contain image that are included in the documentation (see
512
# the \image command).
516
# The INPUT_FILTER tag can be used to specify a program that doxygen should
517
# invoke to filter for each input file. Doxygen will invoke the filter program
518
# by executing (via popen()) the command <filter> <input-file>, where <filter>
519
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
520
# input file. Doxygen will then use the output that the filter program writes
521
# to standard output. If FILTER_PATTERNS is specified, this tag will be
524
INPUT_FILTER = "@top_srcdir@/toolbox --add-include"
526
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
527
# basis. Doxygen will compare the file name with each pattern and apply the
528
# filter if there is a match. The filters are a list of the form:
529
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
530
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
531
# is applied to all files.
535
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
536
# INPUT_FILTER) will be used to filter the input files when producing source
537
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
539
FILTER_SOURCE_FILES = NO
541
#---------------------------------------------------------------------------
542
# configuration options related to source browsing
543
#---------------------------------------------------------------------------
545
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
546
# be generated. Documented entities will be cross-referenced with these sources.
547
# Note: To get rid of all source code in the generated output, make sure also
548
# VERBATIM_HEADERS is set to NO.
552
# Setting the INLINE_SOURCES tag to YES will include the body
553
# of functions and classes directly in the documentation.
557
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
558
# doxygen to hide any special comment blocks from generated source code
559
# fragments. Normal C and C++ comments will always remain visible.
561
STRIP_CODE_COMMENTS = NO
563
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
564
# then for each documented function all documented
565
# functions referencing it will be listed.
567
REFERENCED_BY_RELATION = YES
569
# If the REFERENCES_RELATION tag is set to YES (the default)
570
# then for each documented function all documented entities
571
# called/used by that function will be listed.
573
REFERENCES_RELATION = YES
575
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
576
# will generate a verbatim copy of the header file for each class for
577
# which an include is specified. Set to NO to disable this.
579
VERBATIM_HEADERS = YES
581
#---------------------------------------------------------------------------
582
# configuration options related to the alphabetical class index
583
#---------------------------------------------------------------------------
585
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
586
# of all compounds will be generated. Enable this if the project
587
# contains a lot of classes, structs, unions or interfaces.
589
ALPHABETICAL_INDEX = NO
591
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
592
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
593
# in which this list will be split (can be a number in the range [1..20])
595
COLS_IN_ALPHA_INDEX = 5
597
# In case all classes in a project start with a common prefix, all
598
# classes will be put under the same header in the alphabetical index.
599
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
600
# should be ignored while generating the index headers.
604
#---------------------------------------------------------------------------
605
# configuration options related to the HTML output
606
#---------------------------------------------------------------------------
608
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
609
# generate HTML output.
613
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
614
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
615
# put in front of it. If left blank `html' will be used as the default path.
619
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
620
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
621
# doxygen will generate files with .html extension.
623
HTML_FILE_EXTENSION = .html
625
# The HTML_HEADER tag can be used to specify a personal HTML header for
626
# each generated HTML page. If it is left blank doxygen will generate a
631
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
632
# each generated HTML page. If it is left blank doxygen will generate a
637
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
638
# style sheet that is used by each HTML page. It can be used to
639
# fine-tune the look of the HTML output. If the tag is left blank doxygen
640
# will generate a default style sheet. Note that doxygen will try to copy
641
# the style sheet file to the HTML output directory, so don't put your own
642
# stylesheet in the HTML output directory as well, or it will be erased!
646
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
647
# files or namespaces will be aligned in HTML using tables. If set to
648
# NO a bullet list will be used.
650
HTML_ALIGN_MEMBERS = YES
652
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
653
# will be generated that can be used as input for tools like the
654
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
655
# of the generated HTML documentation.
657
GENERATE_HTMLHELP = NO
659
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
660
# be used to specify the file name of the resulting .chm file. You
661
# can add a path in front of the file if the result should not be
662
# written to the html output directory.
666
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
667
# be used to specify the location (absolute path including file name) of
668
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
669
# the HTML help compiler on the generated index.hhp.
673
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
674
# controls if a separate .chi index file is generated (YES) or that
675
# it should be included in the master .chm file (NO).
679
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
680
# controls whether a binary table of contents is generated (YES) or a
681
# normal table of contents (NO) in the .chm file.
685
# The TOC_EXPAND flag can be set to YES to add extra items for group members
686
# to the contents of the HTML help documentation and to the tree view.
690
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
691
# top of each HTML page. The value NO (the default) enables the index and
692
# the value YES disables it.
696
# This tag can be used to set the number of enum values (range [1..20])
697
# that doxygen will group on one line in the generated HTML documentation.
699
ENUM_VALUES_PER_LINE = 4
701
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
702
# generated containing a tree-like index structure (just like the one that
703
# is generated for HTML Help). For this to work a browser that supports
704
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
705
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
706
# probably better off using the HTML help feature.
708
GENERATE_TREEVIEW = NO
710
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
711
# used to set the initial width (in pixels) of the frame in which the tree
716
#---------------------------------------------------------------------------
717
# configuration options related to the LaTeX output
718
#---------------------------------------------------------------------------
720
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
721
# generate Latex output.
725
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
726
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
727
# put in front of it. If left blank `latex' will be used as the default path.
731
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
732
# invoked. If left blank `latex' will be used as the default command name.
734
LATEX_CMD_NAME = latex
736
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
737
# generate index for LaTeX. If left blank `makeindex' will be used as the
738
# default command name.
740
MAKEINDEX_CMD_NAME = makeindex
742
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
743
# LaTeX documents. This may be useful for small projects and may help to
744
# save some trees in general.
748
# The PAPER_TYPE tag can be used to set the paper type that is used
749
# by the printer. Possible values are: a4, a4wide, letter, legal and
750
# executive. If left blank a4wide will be used.
754
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
755
# packages that should be included in the LaTeX output.
759
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
760
# the generated latex document. The header should contain everything until
761
# the first chapter. If it is left blank doxygen will generate a
762
# standard header. Notice: only use this tag if you know what you are doing!
766
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
767
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
768
# contain links (just like the HTML output) instead of page references
769
# This makes the output suitable for online browsing using a pdf viewer.
773
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
774
# plain latex in the generated Makefile. Set this option to YES to get a
775
# higher quality PDF documentation.
779
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
780
# command to the generated LaTeX files. This will instruct LaTeX to keep
781
# running if errors occur, instead of asking the user for help.
782
# This option is also used when generating formulas in HTML.
786
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
787
# include the index chapters (such as File Index, Compound Index, etc.)
790
LATEX_HIDE_INDICES = NO
792
#---------------------------------------------------------------------------
793
# configuration options related to the RTF output
794
#---------------------------------------------------------------------------
796
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
797
# The RTF output is optimized for Word 97 and may not look very pretty with
798
# other RTF readers or editors.
802
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
803
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
804
# put in front of it. If left blank `rtf' will be used as the default path.
808
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
809
# RTF documents. This may be useful for small projects and may help to
810
# save some trees in general.
814
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
815
# will contain hyperlink fields. The RTF file will
816
# contain links (just like the HTML output) instead of page references.
817
# This makes the output suitable for online browsing using WORD or other
818
# programs which support those fields.
819
# Note: wordpad (write) and others do not support links.
823
# Load stylesheet definitions from file. Syntax is similar to doxygen's
824
# config file, i.e. a series of assignments. You only have to provide
825
# replacements, missing definitions are set to their default value.
827
RTF_STYLESHEET_FILE =
829
# Set optional variables used in the generation of an rtf document.
830
# Syntax is similar to doxygen's config file.
832
RTF_EXTENSIONS_FILE =
834
#---------------------------------------------------------------------------
835
# configuration options related to the man page output
836
#---------------------------------------------------------------------------
838
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
843
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
844
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
845
# put in front of it. If left blank `man' will be used as the default path.
849
# The MAN_EXTENSION tag determines the extension that is added to
850
# the generated man pages (default is the subroutine's section .3)
854
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
855
# then it will generate one additional man file for each entity
856
# documented in the real man page(s). These additional files
857
# only source the real man page, but without them the man command
858
# would be unable to find the correct page. The default is NO.
862
#---------------------------------------------------------------------------
863
# configuration options related to the XML output
864
#---------------------------------------------------------------------------
866
# If the GENERATE_XML tag is set to YES Doxygen will
867
# generate an XML file that captures the structure of
868
# the code including all documentation.
872
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
873
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
874
# put in front of it. If left blank `xml' will be used as the default path.
878
# The XML_SCHEMA tag can be used to specify an XML schema,
879
# which can be used by a validating XML parser to check the
880
# syntax of the XML files.
884
# The XML_DTD tag can be used to specify an XML DTD,
885
# which can be used by a validating XML parser to check the
886
# syntax of the XML files.
890
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
891
# dump the program listings (including syntax highlighting
892
# and cross-referencing information) to the XML output. Note that
893
# enabling this will significantly increase the size of the XML output.
895
XML_PROGRAMLISTING = YES
897
#---------------------------------------------------------------------------
898
# configuration options for the AutoGen Definitions output
899
#---------------------------------------------------------------------------
901
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
902
# generate an AutoGen Definitions (see autogen.sf.net) file
903
# that captures the structure of the code including all
904
# documentation. Note that this feature is still experimental
905
# and incomplete at the moment.
907
GENERATE_AUTOGEN_DEF = NO
909
#---------------------------------------------------------------------------
910
# configuration options related to the Perl module output
911
#---------------------------------------------------------------------------
913
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
914
# generate a Perl module file that captures the structure of
915
# the code including all documentation. Note that this
916
# feature is still experimental and incomplete at the
919
GENERATE_PERLMOD = NO
921
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
922
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
923
# to generate PDF and DVI output from the Perl module output.
927
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
928
# nicely formatted so it can be parsed by a human reader. This is useful
929
# if you want to understand what is going on. On the other hand, if this
930
# tag is set to NO the size of the Perl module output will be much smaller
931
# and Perl will parse it just the same.
935
# The names of the make variables in the generated doxyrules.make file
936
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
937
# This is useful so different doxyrules.make files included by the same
938
# Makefile don't overwrite each other's variables.
940
PERLMOD_MAKEVAR_PREFIX =
942
#---------------------------------------------------------------------------
943
# Configuration options related to the preprocessor
944
#---------------------------------------------------------------------------
946
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
947
# evaluate all C-preprocessor directives found in the sources and include
950
ENABLE_PREPROCESSING = YES
952
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
953
# names in the source code. If set to NO (the default) only conditional
954
# compilation will be performed. Macro expansion can be done in a controlled
955
# way by setting EXPAND_ONLY_PREDEF to YES.
957
MACRO_EXPANSION = YES
959
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
960
# then the macro expansion is limited to the macros specified with the
961
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
963
EXPAND_ONLY_PREDEF = NO
965
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
966
# in the INCLUDE_PATH (see below) will be search if a #include is found.
968
SEARCH_INCLUDES = YES
970
# The INCLUDE_PATH tag can be used to specify one or more directories that
971
# contain include files that are not input files but should be processed by
974
INCLUDE_PATH = @top_srcdir@/include \
975
@top_srcdir@/include/vlc
977
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
978
# patterns (like *.h and *.hpp) to filter out the header-files in the
979
# directories. If left blank, the patterns specified with FILE_PATTERNS will
982
INCLUDE_FILE_PATTERNS =
984
# The PREDEFINED tag can be used to specify one or more macro names that
985
# are defined before the preprocessor is started (similar to the -D option of
986
# gcc). The argument of the tag is a list of macros of the form: name
987
# or name=definition (no spaces). If the definition and the = are
988
# omitted =1 is assumed. To prevent a macro definition from being
989
# undefined via #undef or recursively expanded use the := operator
990
# instead of the = operator.
994
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
995
# this tag can be used to specify a list of macro names that should be expanded.
996
# The macro definition that is found in the sources will be used.
997
# Use the PREDEFINED tag if you want to use a different macro definition.
1001
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1002
# doxygen's preprocessor will remove all function-like macros that are alone
1003
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1004
# function macros are typically used for boiler-plate code, and will confuse
1005
# the parser if not removed.
1007
SKIP_FUNCTION_MACROS = NO
1009
#---------------------------------------------------------------------------
1010
# Configuration::additions related to external references
1011
#---------------------------------------------------------------------------
1013
# The TAGFILES option can be used to specify one or more tagfiles.
1014
# Optionally an initial location of the external documentation
1015
# can be added for each tagfile. The format of a tag file without
1016
# this location is as follows:
1017
# TAGFILES = file1 file2 ...
1018
# Adding location for the tag files is done as follows:
1019
# TAGFILES = file1=loc1 "file2 = loc2" ...
1020
# where "loc1" and "loc2" can be relative or absolute paths or
1021
# URLs. If a location is present for each tag, the installdox tool
1022
# does not have to be run to correct the links.
1023
# Note that each tag file must have a unique name
1024
# (where the name does NOT include the path)
1025
# If a tag file is not located in the directory in which doxygen
1026
# is run, you must also specify the path to the tagfile here.
1030
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1031
# a tag file that is based on the input files it reads.
1033
GENERATE_TAGFILE = vlc.tags
1035
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1036
# in the class index. If set to NO only the inherited external classes
1041
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1042
# in the modules index. If set to NO, only the current project's groups will
1045
EXTERNAL_GROUPS = YES
1047
# The PERL_PATH should be the absolute path and name of the perl script
1048
# interpreter (i.e. the result of `which perl').
1050
PERL_PATH = /usr/bin/perl
1052
#---------------------------------------------------------------------------
1053
# Configuration options related to the dot tool
1054
#---------------------------------------------------------------------------
1056
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1057
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1058
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1059
# this option is superseded by the HAVE_DOT option below. This is only a
1060
# fallback. It is recommended to install and use dot, since it yields more
1063
CLASS_DIAGRAMS = YES
1065
# If set to YES, the inheritance and collaboration graphs will hide
1066
# inheritance and usage relations if the target is undocumented
1067
# or is not a class.
1069
HIDE_UNDOC_RELATIONS = YES
1071
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1072
# available from the path. This tool is part of Graphviz, a graph visualization
1073
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1074
# have no effect if this option is set to NO (the default)
1078
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1079
# will generate a graph for each documented class showing the direct and
1080
# indirect inheritance relations. Setting this tag to YES will force the
1081
# the CLASS_DIAGRAMS tag to NO.
1085
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1086
# will generate a graph for each documented class showing the direct and
1087
# indirect implementation dependencies (inheritance, containment, and
1088
# class references variables) of the class with other documented classes.
1090
COLLABORATION_GRAPH = YES
1092
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1093
# will generate a graph for groups, showing the direct groups dependencies
1097
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1098
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1103
# If set to YES, the inheritance and collaboration graphs will show the
1104
# relations between templates and their instances.
1106
TEMPLATE_RELATIONS = YES
1108
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1109
# tags are set to YES then doxygen will generate a graph for each documented
1110
# file showing the direct and indirect include dependencies of the file with
1111
# other documented files.
1115
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1116
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1117
# documented header file showing the documented files that directly or
1118
# indirectly include this file.
1120
INCLUDED_BY_GRAPH = NO
1122
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1123
# generate a call dependency graph for every global function or class method.
1124
# Note that enabling this option will significantly increase the time of a run.
1125
# So in most cases it will be better to enable call graphs for selected
1126
# functions only using the \callgraph command.
1130
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1131
# will graphical hierarchy of all classes instead of a textual one.
1133
GRAPHICAL_HIERARCHY = YES
1135
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1136
# then doxygen will show the dependencies a directory has on other directories
1137
# in a graphical way. The dependency relations are determined by the #include
1138
# relations between the files in the directories.
1140
DIRECTORY_GRAPH = YES
1142
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1143
# generated by dot. Possible values are png, jpg, or gif
1144
# If left blank png will be used.
1146
DOT_IMAGE_FORMAT = png
1148
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1149
# found. If left blank, it is assumed the dot tool can be found in the path.
1153
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1154
# contain dot files that are included in the documentation (see the
1155
# \dotfile command).
1159
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1160
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1161
# this value, doxygen will try to truncate the graph, so that it fits within
1162
# the specified constraint. Beware that most browsers cannot cope with very
1165
MAX_DOT_GRAPH_WIDTH = 1024
1167
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1168
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1169
# this value, doxygen will try to truncate the graph, so that it fits within
1170
# the specified constraint. Beware that most browsers cannot cope with very
1173
MAX_DOT_GRAPH_HEIGHT = 1024
1175
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1176
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1177
# from the root by following a path via at most 3 edges will be shown. Nodes
1178
# that lay further from the root node will be omitted. Note that setting this
1179
# option to 1 or 2 may greatly reduce the computation time needed for large
1180
# code bases. Also note that a graph may be further truncated if the graph's
1181
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1182
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1183
# the graph is not depth-constrained.
1185
MAX_DOT_GRAPH_DEPTH = 0
1187
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1188
# background. This is disabled by default, which results in a white background.
1189
# Warning: Depending on the platform used, enabling this option may lead to
1190
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1193
DOT_TRANSPARENT = NO
1195
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1196
# files in one run (i.e. multiple -o and -T options on the command line). This
1197
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1198
# support this, this feature is disabled by default.
1200
DOT_MULTI_TARGETS = NO
1202
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1203
# generate a legend page explaining the meaning of the various boxes and
1204
# arrows in the dot generated graphs.
1206
GENERATE_LEGEND = YES
1208
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1209
# remove the intermediate dot files that are used to generate
1210
# the various graphs.
1214
#---------------------------------------------------------------------------
1215
# Configuration::additions related to the search engine
1216
#---------------------------------------------------------------------------
1218
# The SEARCHENGINE tag specifies whether or not a search engine should be
1219
# used. If set to NO the values of all tags below this one will be ignored.
added
removed
doc/Doxyfile.in
