summaryrefslogtreecommitdiffabout
path: root/Doxyfile.in
authorMichael Krelin <hacker@klever.net>2007-08-09 11:22:27 (UTC)
committer Michael Krelin <hacker@klever.net>2007-08-09 11:22:27 (UTC)
commit1f347795ef5eba50892fd777c173a2a6db1755f2 (patch) (unidiff)
treee65d40827a5eac43282e5db0690fa35001e3f836 /Doxyfile.in
parent94e566c912f97b4c9e47353e10e86649ee8060a4 (diff)
downloadlibopkele-1f347795ef5eba50892fd777c173a2a6db1755f2.zip
libopkele-1f347795ef5eba50892fd777c173a2a6db1755f2.tar.gz
libopkele-1f347795ef5eba50892fd777c173a2a6db1755f2.tar.bz2
updated Doxyfile.in for use with recent Doxygen
Diffstat (limited to 'Doxyfile.in') (more/less context) (ignore whitespace changes)
-rw-r--r--Doxyfile.in1030
1 files changed, 1021 insertions, 9 deletions
diff --git a/Doxyfile.in b/Doxyfile.in
index ce2fb20..3ff39b3 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -1,247 +1,1259 @@
1# Doxyfile 1.3.9.1 1# Doxyfile 1.5.2
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
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 (" ")
2 12
3#--------------------------------------------------------------------------- 13#---------------------------------------------------------------------------
4# Project related configuration options 14# Project related configuration options
5#--------------------------------------------------------------------------- 15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file that
18# follow. The default is UTF-8 which is also the encoding used for all text before
19# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
21# possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
6PROJECT_NAME = @PACKAGE@ 28PROJECT_NAME = @PACKAGE@
29
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
7PROJECT_NUMBER = @VERSION@ 34PROJECT_NUMBER = @VERSION@
35
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
39# where doxygen was started. If left blank the current directory will be used.
40
8OUTPUT_DIRECTORY = @builddir@/doxydox 41OUTPUT_DIRECTORY = @builddir@/doxydox
42
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
9CREATE_SUBDIRS = NO 50CREATE_SUBDIRS = NO
51
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
58# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
61
10OUTPUT_LANGUAGE = English 62OUTPUT_LANGUAGE = English
11USE_WINDOWS_ENCODING = NO 63
64# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65# include brief member descriptions after the members that are listed in
66# the file and class documentation (similar to JavaDoc).
67# Set to NO to disable this.
68
12BRIEF_MEMBER_DESC = YES 69BRIEF_MEMBER_DESC = YES
70
71# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72# the brief description of a member or function before the detailed description.
73# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74# brief descriptions will be completely suppressed.
75
13REPEAT_BRIEF = YES 76REPEAT_BRIEF = YES
77
78# This tag implements a quasi-intelligent brief description abbreviator
79# that is used to form the text in various listings. Each string
80# in this list, if found as the leading text of the brief description, will be
81# stripped from the text and the result after processing the whole list, is
82# used as the annotated text. Otherwise, the brief description is used as-is.
83# If left blank, the following values are used ("$name" is automatically
84# replaced with the name of the entity): "The $name class" "The $name widget"
85# "The $name file" "is" "provides" "specifies" "contains"
86# "represents" "a" "an" "the"
87
14ABBREVIATE_BRIEF = 88ABBREVIATE_BRIEF =
89
90# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91# Doxygen will generate a detailed section even if there is only a brief
92# description.
93
15ALWAYS_DETAILED_SEC = NO 94ALWAYS_DETAILED_SEC = NO
95
96# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97# inherited members of a class in the documentation of that class as if those
98# members were ordinary class members. Constructors, destructors and assignment
99# operators of the base classes will not be shown.
100
16INLINE_INHERITED_MEMB = NO 101INLINE_INHERITED_MEMB = NO
102
103# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104# path before files name in the file list and in the header files. If set
105# to NO the shortest path that makes the file name unique will be used.
106
17FULL_PATH_NAMES = YES 107FULL_PATH_NAMES = YES
108
109# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110# can be used to strip a user-defined part of the path. Stripping is
111# only done if one of the specified strings matches the left-hand part of
112# the path. The tag can be used to show relative paths in the file list.
113# If left blank the directory from which doxygen is run is used as the
114# path to strip.
115
18STRIP_FROM_PATH = include 116STRIP_FROM_PATH = include
117
118# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119# the path mentioned in the documentation of a class, which tells
120# the reader which header file to include in order to use a class.
121# If left blank only the name of the header file containing the class
122# definition is used. Otherwise one should specify the include paths that
123# are normally passed to the compiler using the -I flag.
124
19STRIP_FROM_INC_PATH = include 125STRIP_FROM_INC_PATH = include
126
127# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128# (but less readable) file names. This can be useful is your file systems
129# doesn't support long names like on DOS, Mac, or CD-ROM.
130
20SHORT_NAMES = NO 131SHORT_NAMES = NO
132
133# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134# will interpret the first line (until the first dot) of a JavaDoc-style
135# comment as the brief description. If set to NO, the JavaDoc
136# comments will behave just like the Qt-style comments (thus requiring an
137# explicit @brief command for a brief description.
138
21JAVADOC_AUTOBRIEF = NO 139JAVADOC_AUTOBRIEF = NO
140
141# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
142# treat a multi-line C++ special comment block (i.e. a block of //! or ///
143# comments) as a brief description. This used to be the default behaviour.
144# The new default is to treat a multi-line C++ comment block as a detailed
145# description. Set this tag to YES if you prefer the old behaviour instead.
146
22MULTILINE_CPP_IS_BRIEF = NO 147MULTILINE_CPP_IS_BRIEF = NO
148
149# If the DETAILS_AT_TOP tag is set to YES then Doxygen
150# will output the detailed description near the top, like JavaDoc.
151# If set to NO, the detailed description appears after the member
152# documentation.
153
23DETAILS_AT_TOP = NO 154DETAILS_AT_TOP = NO
155
156# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
157# member inherits the documentation from any documented member that it
158# re-implements.
159
24INHERIT_DOCS = YES 160INHERIT_DOCS = YES
25DISTRIBUTE_GROUP_DOC = NO 161
162# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
163# a new page for each member. If set to NO, the documentation of a member will
164# be part of the file/class/namespace that contains it.
165
166SEPARATE_MEMBER_PAGES = NO
167
168# The TAB_SIZE tag can be used to set the number of spaces in a tab.
169# Doxygen uses this value to replace tabs by spaces in code fragments.
170
26TAB_SIZE = 8 171TAB_SIZE = 8
172
173# This tag can be used to specify a number of aliases that acts
174# as commands in the documentation. An alias has the form "name=value".
175# For example adding "sideeffect=\par Side Effects:\n" will allow you to
176# put the command \sideeffect (or @sideeffect) in the documentation, which
177# will result in a user-defined paragraph with heading "Side Effects:".
178# You can put \n's in the value part of an alias to insert newlines.
179
27ALIASES = 180ALIASES =
181
182# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
183# sources only. Doxygen will then generate output that is more tailored for C.
184# For instance, some of the names that are used will be different. The list
185# of all members will be omitted, etc.
186
28OPTIMIZE_OUTPUT_FOR_C = NO 187OPTIMIZE_OUTPUT_FOR_C = NO
188
189# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
190# sources only. Doxygen will then generate output that is more tailored for Java.
191# For instance, namespaces will be presented as packages, qualified scopes
192# will look different, etc.
193
29OPTIMIZE_OUTPUT_JAVA = NO 194OPTIMIZE_OUTPUT_JAVA = NO
195
196# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
197# include (a tag file for) the STL sources as input, then you should
198# set this tag to YES in order to let doxygen match functions declarations and
199# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
200# func(std::string) {}). This also make the inheritance and collaboration
201# diagrams that involve STL classes more complete and accurate.
202
203BUILTIN_STL_SUPPORT = YES
204
205# If you use Microsoft's C++/CLI language, you should set this option to YES to
206# enable parsing support.
207
208CPP_CLI_SUPPORT = NO
209
210# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
211# tag is set to YES, then doxygen will reuse the documentation of the first
212# member in the group (if any) for the other members of the group. By default
213# all members of a group must be documented explicitly.
214
215DISTRIBUTE_GROUP_DOC = NO
216
217# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
218# the same type (for instance a group of public functions) to be put as a
219# subgroup of that type (e.g. under the Public Functions section). Set it to
220# NO to prevent subgrouping. Alternatively, this can be done per class using
221# the \nosubgrouping command.
222
30SUBGROUPING = YES 223SUBGROUPING = YES
31 224
32#--------------------------------------------------------------------------- 225#---------------------------------------------------------------------------
33# Build related configuration options 226# Build related configuration options
34#--------------------------------------------------------------------------- 227#---------------------------------------------------------------------------
35 228
229# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
230# documentation are documented, even if no documentation was available.
231# Private class members and static file members will be hidden unless
232# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
233
36EXTRACT_ALL = NO 234EXTRACT_ALL = NO
235
236# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
237# will be included in the documentation.
238
37EXTRACT_PRIVATE = NO 239EXTRACT_PRIVATE = NO
240
241# If the EXTRACT_STATIC tag is set to YES all static members of a file
242# will be included in the documentation.
243
38EXTRACT_STATIC = NO 244EXTRACT_STATIC = NO
245
246# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
247# defined locally in source files will be included in the documentation.
248# If set to NO only classes defined in header files are included.
249
39EXTRACT_LOCAL_CLASSES = YES 250EXTRACT_LOCAL_CLASSES = YES
251
252# This flag is only useful for Objective-C code. When set to YES local
253# methods, which are defined in the implementation section but not in
254# the interface are included in the documentation.
255# If set to NO (the default) only methods in the interface are included.
256
40EXTRACT_LOCAL_METHODS = NO 257EXTRACT_LOCAL_METHODS = NO
258
259# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
260# undocumented members of documented classes, files or namespaces.
261# If set to NO (the default) these members will be included in the
262# various overviews, but no documentation section is generated.
263# This option has no effect if EXTRACT_ALL is enabled.
264
41HIDE_UNDOC_MEMBERS = YES 265HIDE_UNDOC_MEMBERS = YES
266
267# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
268# undocumented classes that are normally visible in the class hierarchy.
269# If set to NO (the default) these classes will be included in the various
270# overviews. This option has no effect if EXTRACT_ALL is enabled.
271
42HIDE_UNDOC_CLASSES = YES 272HIDE_UNDOC_CLASSES = YES
273
274# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
275# friend (class|struct|union) declarations.
276# If set to NO (the default) these declarations will be included in the
277# documentation.
278
43HIDE_FRIEND_COMPOUNDS = NO 279HIDE_FRIEND_COMPOUNDS = NO
280
281# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
282# documentation blocks found inside the body of a function.
283# If set to NO (the default) these blocks will be appended to the
284# function's detailed documentation block.
285
44HIDE_IN_BODY_DOCS = NO 286HIDE_IN_BODY_DOCS = NO
287
288# The INTERNAL_DOCS tag determines if documentation
289# that is typed after a \internal command is included. If the tag is set
290# to NO (the default) then the documentation will be excluded.
291# Set it to YES to include the internal documentation.
292
45INTERNAL_DOCS = NO 293INTERNAL_DOCS = NO
294
295# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
296# file names in lower-case letters. If set to YES upper-case letters are also
297# allowed. This is useful if you have classes or files whose names only differ
298# in case and if your file system supports case sensitive file names. Windows
299# and Mac users are advised to set this option to NO.
300
46CASE_SENSE_NAMES = YES 301CASE_SENSE_NAMES = YES
302
303# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
304# will show members with their full class and namespace scopes in the
305# documentation. If set to YES the scope will be hidden.
306
47HIDE_SCOPE_NAMES = NO 307HIDE_SCOPE_NAMES = NO
308
309# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
310# will put a list of the files that are included by a file in the documentation
311# of that file.
312
48SHOW_INCLUDE_FILES = NO 313SHOW_INCLUDE_FILES = NO
314
315# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
316# is inserted in the documentation for inline members.
317
49INLINE_INFO = YES 318INLINE_INFO = YES
319
320# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
321# will sort the (detailed) documentation of file and class members
322# alphabetically by member name. If set to NO the members will appear in
323# declaration order.
324
50SORT_MEMBER_DOCS = YES 325SORT_MEMBER_DOCS = YES
326
327# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
328# brief documentation of file, namespace and class members alphabetically
329# by member name. If set to NO (the default) the members will appear in
330# declaration order.
331
51SORT_BRIEF_DOCS = NO 332SORT_BRIEF_DOCS = NO
333
334# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
335# sorted by fully-qualified names, including namespaces. If set to
336# NO (the default), the class list will be sorted only by class name,
337# not including the namespace part.
338# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
339# Note: This option applies only to the class list, not to the
340# alphabetical list.
341
52SORT_BY_SCOPE_NAME = YES 342SORT_BY_SCOPE_NAME = YES
343
344# The GENERATE_TODOLIST tag can be used to enable (YES) or
345# disable (NO) the todo list. This list is created by putting \todo
346# commands in the documentation.
347
53GENERATE_TODOLIST = YES 348GENERATE_TODOLIST = YES
349
350# The GENERATE_TESTLIST tag can be used to enable (YES) or
351# disable (NO) the test list. This list is created by putting \test
352# commands in the documentation.
353
54GENERATE_TESTLIST = YES 354GENERATE_TESTLIST = YES
355
356# The GENERATE_BUGLIST tag can be used to enable (YES) or
357# disable (NO) the bug list. This list is created by putting \bug
358# commands in the documentation.
359
55GENERATE_BUGLIST = YES 360GENERATE_BUGLIST = YES
361
362# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
363# disable (NO) the deprecated list. This list is created by putting
364# \deprecated commands in the documentation.
365
56GENERATE_DEPRECATEDLIST= YES 366GENERATE_DEPRECATEDLIST= YES
367
368# The ENABLED_SECTIONS tag can be used to enable conditional
369# documentation sections, marked by \if sectionname ... \endif.
370
57ENABLED_SECTIONS = 371ENABLED_SECTIONS =
372
373# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
374# the initial value of a variable or define consists of for it to appear in
375# the documentation. If the initializer consists of more lines than specified
376# here it will be hidden. Use a value of 0 to hide initializers completely.
377# The appearance of the initializer of individual variables and defines in the
378# documentation can be controlled using \showinitializer or \hideinitializer
379# command in the documentation regardless of this setting.
380
58MAX_INITIALIZER_LINES = 30 381MAX_INITIALIZER_LINES = 30
382
383# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
384# at the bottom of the documentation of classes and structs. If set to YES the
385# list will mention the files that were used to generate the documentation.
386
59SHOW_USED_FILES = NO 387SHOW_USED_FILES = NO
388
389# If the sources in your project are distributed over multiple directories
390# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
391# in the documentation. The default is NO.
392
60SHOW_DIRECTORIES = YES 393SHOW_DIRECTORIES = YES
61 394
395# The FILE_VERSION_FILTER tag can be used to specify a program or script that
396# doxygen should invoke to get the current version for each file (typically from the
397# version control system). Doxygen will invoke the program by executing (via
398# popen()) the command <command> <input-file>, where <command> is the value of
399# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
400# provided by doxygen. Whatever the program writes to standard output
401# is used as the file version. See the manual for examples.
402
403FILE_VERSION_FILTER =
404
62#--------------------------------------------------------------------------- 405#---------------------------------------------------------------------------
63# configuration options related to warning and progress messages 406# configuration options related to warning and progress messages
64#--------------------------------------------------------------------------- 407#---------------------------------------------------------------------------
65 408
409# The QUIET tag can be used to turn on/off the messages that are generated
410# by doxygen. Possible values are YES and NO. If left blank NO is used.
411
66QUIET = NO 412QUIET = NO
413
414# The WARNINGS tag can be used to turn on/off the warning messages that are
415# generated by doxygen. Possible values are YES and NO. If left blank
416# NO is used.
417
67WARNINGS = YES 418WARNINGS = YES
419
420# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
421# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
422# automatically be disabled.
423
68WARN_IF_UNDOCUMENTED = YES 424WARN_IF_UNDOCUMENTED = YES
425
426# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
427# potential errors in the documentation, such as not documenting some
428# parameters in a documented function, or documenting parameters that
429# don't exist or using markup commands wrongly.
430
69WARN_IF_DOC_ERROR = YES 431WARN_IF_DOC_ERROR = YES
432
433# This WARN_NO_PARAMDOC option can be abled to get warnings for
434# functions that are documented, but have no documentation for their parameters
435# or return value. If set to NO (the default) doxygen will only warn about
436# wrong or incomplete parameter documentation, but not about the absence of
437# documentation.
438
439WARN_NO_PARAMDOC = NO
440
441# The WARN_FORMAT tag determines the format of the warning messages that
442# doxygen can produce. The string should contain the $file, $line, and $text
443# tags, which will be replaced by the file and line number from which the
444# warning originated and the warning text. Optionally the format may contain
445# $version, which will be replaced by the version of the file (if it could
446# be obtained via FILE_VERSION_FILTER)
447
70WARN_FORMAT = "$file:$line: $text" 448WARN_FORMAT = "$file:$line: $text"
449
450# The WARN_LOGFILE tag can be used to specify a file to which warning
451# and error messages should be written. If left blank the output is written
452# to stderr.
453
71WARN_LOGFILE = 454WARN_LOGFILE =
72 455
73#--------------------------------------------------------------------------- 456#---------------------------------------------------------------------------
74# configuration options related to the input files 457# configuration options related to the input files
75#--------------------------------------------------------------------------- 458#---------------------------------------------------------------------------
76 459
77INPUT = \ 460# The INPUT tag can be used to specify the files and/or directories that contain
78 @srcdir@/include/opkele/ @srcdir@/lib/ 461# documented source files. You may enter file names like "myfile.cpp" or
79FILE_PATTERNS = *.h *.cc 462# directories like "/usr/src/myproject". Separate the files or directories
463# with spaces.
464
465INPUT = @srcdir@/include/opkele/ \
466 @srcdir@/lib/
467
468# This tag can be used to specify the character encoding of the source files that
469# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
470# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
471# See http://www.gnu.org/software/libiconv for the list of possible encodings.
472
473INPUT_ENCODING = UTF-8
474
475# If the value of the INPUT tag contains directories, you can use the
476# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
477# and *.h) to filter out the source-files in the directories. If left
478# blank the following patterns are tested:
479# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
480# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
481
482FILE_PATTERNS = *.h \
483 *.cc
484
485# The RECURSIVE tag can be used to turn specify whether or not subdirectories
486# should be searched for input files as well. Possible values are YES and NO.
487# If left blank NO is used.
488
80RECURSIVE = NO 489RECURSIVE = NO
490
491# The EXCLUDE tag can be used to specify files and/or directories that should
492# excluded from the INPUT source files. This way you can easily exclude a
493# subdirectory from a directory tree whose root is specified with the INPUT tag.
494
81EXCLUDE = 495EXCLUDE =
496
497# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
498# directories that are symbolic links (a Unix filesystem feature) are excluded
499# from the input.
500
82EXCLUDE_SYMLINKS = NO 501EXCLUDE_SYMLINKS = NO
502
503# If the value of the INPUT tag contains directories, you can use the
504# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
505# certain files from those directories. Note that the wildcards are matched
506# against the file with absolute path, so to exclude all test directories
507# for example use the pattern */test/*
508
83EXCLUDE_PATTERNS = 509EXCLUDE_PATTERNS =
510
511# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
512# (namespaces, classes, functions, etc.) that should be excluded from the output.
513# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
514# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
515
516EXCLUDE_SYMBOLS =
517
518# The EXAMPLE_PATH tag can be used to specify one or more files or
519# directories that contain example code fragments that are included (see
520# the \include command).
521
84EXAMPLE_PATH = 522EXAMPLE_PATH =
523
524# If the value of the EXAMPLE_PATH tag contains directories, you can use the
525# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
526# and *.h) to filter out the source-files in the directories. If left
527# blank all files are included.
528
85EXAMPLE_PATTERNS = 529EXAMPLE_PATTERNS =
530
531# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
532# searched for input files to be used with the \include or \dontinclude
533# commands irrespective of the value of the RECURSIVE tag.
534# Possible values are YES and NO. If left blank NO is used.
535
86EXAMPLE_RECURSIVE = NO 536EXAMPLE_RECURSIVE = NO
537
538# The IMAGE_PATH tag can be used to specify one or more files or
539# directories that contain image that are included in the documentation (see
540# the \image command).
541
87IMAGE_PATH = 542IMAGE_PATH =
543
544# The INPUT_FILTER tag can be used to specify a program that doxygen should
545# invoke to filter for each input file. Doxygen will invoke the filter program
546# by executing (via popen()) the command <filter> <input-file>, where <filter>
547# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
548# input file. Doxygen will then use the output that the filter program writes
549# to standard output. If FILTER_PATTERNS is specified, this tag will be
550# ignored.
551
88INPUT_FILTER = 552INPUT_FILTER =
553
554# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
555# basis. Doxygen will compare the file name with each pattern and apply the
556# filter if there is a match. The filters are a list of the form:
557# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
558# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
559# is applied to all files.
560
89FILTER_PATTERNS = 561FILTER_PATTERNS =
562
563# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
564# INPUT_FILTER) will be used to filter the input files when producing source
565# files to browse (i.e. when SOURCE_BROWSER is set to YES).
566
90FILTER_SOURCE_FILES = NO 567FILTER_SOURCE_FILES = NO
91 568
92#--------------------------------------------------------------------------- 569#---------------------------------------------------------------------------
93# configuration options related to source browsing 570# configuration options related to source browsing
94#--------------------------------------------------------------------------- 571#---------------------------------------------------------------------------
95 572
573# If the SOURCE_BROWSER tag is set to YES then a list of source files will
574# be generated. Documented entities will be cross-referenced with these sources.
575# Note: To get rid of all source code in the generated output, make sure also
576# VERBATIM_HEADERS is set to NO.
577
96SOURCE_BROWSER = YES 578SOURCE_BROWSER = YES
579
580# Setting the INLINE_SOURCES tag to YES will include the body
581# of functions and classes directly in the documentation.
582
97INLINE_SOURCES = NO 583INLINE_SOURCES = NO
584
585# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
586# doxygen to hide any special comment blocks from generated source code
587# fragments. Normal C and C++ comments will always remain visible.
588
98STRIP_CODE_COMMENTS = YES 589STRIP_CODE_COMMENTS = YES
590
591# If the REFERENCED_BY_RELATION tag is set to YES (the default)
592# then for each documented function all documented
593# functions referencing it will be listed.
594
99REFERENCED_BY_RELATION = YES 595REFERENCED_BY_RELATION = YES
596
597# If the REFERENCES_RELATION tag is set to YES (the default)
598# then for each documented function all documented entities
599# called/used by that function will be listed.
600
100REFERENCES_RELATION = YES 601REFERENCES_RELATION = YES
602
603# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
604# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
605# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
606# link to the source code. Otherwise they will link to the documentstion.
607
608REFERENCES_LINK_SOURCE = YES
609
610# If the USE_HTAGS tag is set to YES then the references to source code
611# will point to the HTML generated by the htags(1) tool instead of doxygen
612# built-in source browser. The htags tool is part of GNU's global source
613# tagging system (see http://www.gnu.org/software/global/global.html). You
614# will need version 4.8.6 or higher.
615
616USE_HTAGS = NO
617
618# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
619# will generate a verbatim copy of the header file for each class for
620# which an include is specified. Set to NO to disable this.
621
101VERBATIM_HEADERS = YES 622VERBATIM_HEADERS = YES
102 623
103#--------------------------------------------------------------------------- 624#---------------------------------------------------------------------------
104# configuration options related to the alphabetical class index 625# configuration options related to the alphabetical class index
105#--------------------------------------------------------------------------- 626#---------------------------------------------------------------------------
106 627
628# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
629# of all compounds will be generated. Enable this if the project
630# contains a lot of classes, structs, unions or interfaces.
631
107ALPHABETICAL_INDEX = YES 632ALPHABETICAL_INDEX = YES
633
634# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
635# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
636# in which this list will be split (can be a number in the range [1..20])
637
108COLS_IN_ALPHA_INDEX = 2 638COLS_IN_ALPHA_INDEX = 2
639
640# In case all classes in a project start with a common prefix, all
641# classes will be put under the same header in the alphabetical index.
642# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
643# should be ignored while generating the index headers.
644
109IGNORE_PREFIX = 645IGNORE_PREFIX =
110 646
111#--------------------------------------------------------------------------- 647#---------------------------------------------------------------------------
112# configuration options related to the HTML output 648# configuration options related to the HTML output
113#--------------------------------------------------------------------------- 649#---------------------------------------------------------------------------
114 650
651# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
652# generate HTML output.
653
115GENERATE_HTML = YES 654GENERATE_HTML = YES
655
656# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
657# If a relative path is entered the value of OUTPUT_DIRECTORY will be
658# put in front of it. If left blank `html' will be used as the default path.
659
116HTML_OUTPUT = html 660HTML_OUTPUT = html
661
662# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
663# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
664# doxygen will generate files with .html extension.
665
117HTML_FILE_EXTENSION = .html 666HTML_FILE_EXTENSION = .html
667
668# The HTML_HEADER tag can be used to specify a personal HTML header for
669# each generated HTML page. If it is left blank doxygen will generate a
670# standard header.
671
118HTML_HEADER = 672HTML_HEADER =
673
674# The HTML_FOOTER tag can be used to specify a personal HTML footer for
675# each generated HTML page. If it is left blank doxygen will generate a
676# standard footer.
677
119HTML_FOOTER = 678HTML_FOOTER =
679
680# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
681# style sheet that is used by each HTML page. It can be used to
682# fine-tune the look of the HTML output. If the tag is left blank doxygen
683# will generate a default style sheet. Note that doxygen will try to copy
684# the style sheet file to the HTML output directory, so don't put your own
685# stylesheet in the HTML output directory as well, or it will be erased!
686
120HTML_STYLESHEET = 687HTML_STYLESHEET =
688
689# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
690# files or namespaces will be aligned in HTML using tables. If set to
691# NO a bullet list will be used.
692
121HTML_ALIGN_MEMBERS = YES 693HTML_ALIGN_MEMBERS = YES
694
695# If the GENERATE_HTMLHELP tag is set to YES, additional index files
696# will be generated that can be used as input for tools like the
697# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
698# of the generated HTML documentation.
699
122GENERATE_HTMLHELP = NO 700GENERATE_HTMLHELP = NO
701
702# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
703# be used to specify the file name of the resulting .chm file. You
704# can add a path in front of the file if the result should not be
705# written to the html output directory.
706
123CHM_FILE = 707CHM_FILE =
708
709# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
710# be used to specify the location (absolute path including file name) of
711# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
712# the HTML help compiler on the generated index.hhp.
713
124HHC_LOCATION = 714HHC_LOCATION =
715
716# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
717# controls if a separate .chi index file is generated (YES) or that
718# it should be included in the master .chm file (NO).
719
125GENERATE_CHI = NO 720GENERATE_CHI = NO
721
722# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
723# controls whether a binary table of contents is generated (YES) or a
724# normal table of contents (NO) in the .chm file.
725
126BINARY_TOC = NO 726BINARY_TOC = NO
727
728# The TOC_EXPAND flag can be set to YES to add extra items for group members
729# to the contents of the HTML help documentation and to the tree view.
730
127TOC_EXPAND = NO 731TOC_EXPAND = NO
732
733# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
734# top of each HTML page. The value NO (the default) enables the index and
735# the value YES disables it.
736
128DISABLE_INDEX = NO 737DISABLE_INDEX = NO
738
739# This tag can be used to set the number of enum values (range [1..20])
740# that doxygen will group on one line in the generated HTML documentation.
741
129ENUM_VALUES_PER_LINE = 4 742ENUM_VALUES_PER_LINE = 4
743
744# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
745# generated containing a tree-like index structure (just like the one that
746# is generated for HTML Help). For this to work a browser that supports
747# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
748# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
749# probably better off using the HTML help feature.
750
130GENERATE_TREEVIEW = NO 751GENERATE_TREEVIEW = NO
752
753# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
754# used to set the initial width (in pixels) of the frame in which the tree
755# is shown.
756
131TREEVIEW_WIDTH = 250 757TREEVIEW_WIDTH = 250
132 758
133#--------------------------------------------------------------------------- 759#---------------------------------------------------------------------------
134# configuration options related to the LaTeX output 760# configuration options related to the LaTeX output
135#--------------------------------------------------------------------------- 761#---------------------------------------------------------------------------
136 762
763# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
764# generate Latex output.
765
137GENERATE_LATEX = NO 766GENERATE_LATEX = NO
767
768# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
769# If a relative path is entered the value of OUTPUT_DIRECTORY will be
770# put in front of it. If left blank `latex' will be used as the default path.
771
138LATEX_OUTPUT = latex 772LATEX_OUTPUT = latex
773
774# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
775# invoked. If left blank `latex' will be used as the default command name.
776
139LATEX_CMD_NAME = latex 777LATEX_CMD_NAME = latex
778
779# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
780# generate index for LaTeX. If left blank `makeindex' will be used as the
781# default command name.
782
140MAKEINDEX_CMD_NAME = makeindex 783MAKEINDEX_CMD_NAME = makeindex
784
785# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
786# LaTeX documents. This may be useful for small projects and may help to
787# save some trees in general.
788
141COMPACT_LATEX = NO 789COMPACT_LATEX = NO
790
791# The PAPER_TYPE tag can be used to set the paper type that is used
792# by the printer. Possible values are: a4, a4wide, letter, legal and
793# executive. If left blank a4wide will be used.
794
142PAPER_TYPE = a4wide 795PAPER_TYPE = a4wide
796
797# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
798# packages that should be included in the LaTeX output.
799
143EXTRA_PACKAGES = 800EXTRA_PACKAGES =
801
802# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
803# the generated latex document. The header should contain everything until
804# the first chapter. If it is left blank doxygen will generate a
805# standard header. Notice: only use this tag if you know what you are doing!
806
144LATEX_HEADER = 807LATEX_HEADER =
808
809# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
810# is prepared for conversion to pdf (using ps2pdf). The pdf file will
811# contain links (just like the HTML output) instead of page references
812# This makes the output suitable for online browsing using a pdf viewer.
813
145PDF_HYPERLINKS = NO 814PDF_HYPERLINKS = NO
815
816# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
817# plain latex in the generated Makefile. Set this option to YES to get a
818# higher quality PDF documentation.
819
146USE_PDFLATEX = NO 820USE_PDFLATEX = NO
821
822# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
823# command to the generated LaTeX files. This will instruct LaTeX to keep
824# running if errors occur, instead of asking the user for help.
825# This option is also used when generating formulas in HTML.
826
147LATEX_BATCHMODE = NO 827LATEX_BATCHMODE = NO
828
829# If LATEX_HIDE_INDICES is set to YES then doxygen will not
830# include the index chapters (such as File Index, Compound Index, etc.)
831# in the output.
832
148LATEX_HIDE_INDICES = NO 833LATEX_HIDE_INDICES = NO
149 834
150#--------------------------------------------------------------------------- 835#---------------------------------------------------------------------------
151# configuration options related to the RTF output 836# configuration options related to the RTF output
152#--------------------------------------------------------------------------- 837#---------------------------------------------------------------------------
153 838
839# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
840# The RTF output is optimized for Word 97 and may not look very pretty with
841# other RTF readers or editors.
842
154GENERATE_RTF = NO 843GENERATE_RTF = NO
844
845# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
846# If a relative path is entered the value of OUTPUT_DIRECTORY will be
847# put in front of it. If left blank `rtf' will be used as the default path.
848
155RTF_OUTPUT = rtf 849RTF_OUTPUT = rtf
850
851# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
852# RTF documents. This may be useful for small projects and may help to
853# save some trees in general.
854
156COMPACT_RTF = NO 855COMPACT_RTF = NO
856
857# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
858# will contain hyperlink fields. The RTF file will
859# contain links (just like the HTML output) instead of page references.
860# This makes the output suitable for online browsing using WORD or other
861# programs which support those fields.
862# Note: wordpad (write) and others do not support links.
863
157RTF_HYPERLINKS = NO 864RTF_HYPERLINKS = NO
865
866# Load stylesheet definitions from file. Syntax is similar to doxygen's
867# config file, i.e. a series of assignments. You only have to provide
868# replacements, missing definitions are set to their default value.
869
158RTF_STYLESHEET_FILE = 870RTF_STYLESHEET_FILE =
871
872# Set optional variables used in the generation of an rtf document.
873# Syntax is similar to doxygen's config file.
874
159RTF_EXTENSIONS_FILE = 875RTF_EXTENSIONS_FILE =
160 876
161#--------------------------------------------------------------------------- 877#---------------------------------------------------------------------------
162# configuration options related to the man page output 878# configuration options related to the man page output
163#--------------------------------------------------------------------------- 879#---------------------------------------------------------------------------
164 880
881# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
882# generate man pages
883
165GENERATE_MAN = NO 884GENERATE_MAN = NO
885
886# The MAN_OUTPUT tag is used to specify where the man pages will be put.
887# If a relative path is entered the value of OUTPUT_DIRECTORY will be
888# put in front of it. If left blank `man' will be used as the default path.
889
166MAN_OUTPUT = man 890MAN_OUTPUT = man
891
892# The MAN_EXTENSION tag determines the extension that is added to
893# the generated man pages (default is the subroutine's section .3)
894
167MAN_EXTENSION = .3 895MAN_EXTENSION = .3
896
897# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
898# then it will generate one additional man file for each entity
899# documented in the real man page(s). These additional files
900# only source the real man page, but without them the man command
901# would be unable to find the correct page. The default is NO.
902
168MAN_LINKS = YES 903MAN_LINKS = YES
169 904
170#--------------------------------------------------------------------------- 905#---------------------------------------------------------------------------
171# configuration options related to the XML output 906# configuration options related to the XML output
172#--------------------------------------------------------------------------- 907#---------------------------------------------------------------------------
173 908
909# If the GENERATE_XML tag is set to YES Doxygen will
910# generate an XML file that captures the structure of
911# the code including all documentation.
912
174GENERATE_XML = YES 913GENERATE_XML = YES
914
915# The XML_OUTPUT tag is used to specify where the XML pages will be put.
916# If a relative path is entered the value of OUTPUT_DIRECTORY will be
917# put in front of it. If left blank `xml' will be used as the default path.
918
175XML_OUTPUT = xml 919XML_OUTPUT = xml
920
921# The XML_SCHEMA tag can be used to specify an XML schema,
922# which can be used by a validating XML parser to check the
923# syntax of the XML files.
924
176XML_SCHEMA = 925XML_SCHEMA =
926
927# The XML_DTD tag can be used to specify an XML DTD,
928# which can be used by a validating XML parser to check the
929# syntax of the XML files.
930
177XML_DTD = 931XML_DTD =
932
933# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
934# dump the program listings (including syntax highlighting
935# and cross-referencing information) to the XML output. Note that
936# enabling this will significantly increase the size of the XML output.
937
178XML_PROGRAMLISTING = YES 938XML_PROGRAMLISTING = YES
179 939
180#--------------------------------------------------------------------------- 940#---------------------------------------------------------------------------
181# configuration options for the AutoGen Definitions output 941# configuration options for the AutoGen Definitions output
182#--------------------------------------------------------------------------- 942#---------------------------------------------------------------------------
183 943
944# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
945# generate an AutoGen Definitions (see autogen.sf.net) file
946# that captures the structure of the code including all
947# documentation. Note that this feature is still experimental
948# and incomplete at the moment.
949
184GENERATE_AUTOGEN_DEF = NO 950GENERATE_AUTOGEN_DEF = NO
185 951
186#--------------------------------------------------------------------------- 952#---------------------------------------------------------------------------
187# configuration options related to the Perl module output 953# configuration options related to the Perl module output
188#--------------------------------------------------------------------------- 954#---------------------------------------------------------------------------
189 955
956# If the GENERATE_PERLMOD tag is set to YES Doxygen will
957# generate a Perl module file that captures the structure of
958# the code including all documentation. Note that this
959# feature is still experimental and incomplete at the
960# moment.
961
190GENERATE_PERLMOD = NO 962GENERATE_PERLMOD = NO
963
964# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
965# the necessary Makefile rules, Perl scripts and LaTeX code to be able
966# to generate PDF and DVI output from the Perl module output.
967
191PERLMOD_LATEX = NO 968PERLMOD_LATEX = NO
969
970# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
971# nicely formatted so it can be parsed by a human reader. This is useful
972# if you want to understand what is going on. On the other hand, if this
973# tag is set to NO the size of the Perl module output will be much smaller
974# and Perl will parse it just the same.
975
192PERLMOD_PRETTY = YES 976PERLMOD_PRETTY = YES
977
978# The names of the make variables in the generated doxyrules.make file
979# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
980# This is useful so different doxyrules.make files included by the same
981# Makefile don't overwrite each other's variables.
982
193PERLMOD_MAKEVAR_PREFIX = 983PERLMOD_MAKEVAR_PREFIX =
194 984
195#--------------------------------------------------------------------------- 985#---------------------------------------------------------------------------
196# Configuration options related to the preprocessor 986# Configuration options related to the preprocessor
197#--------------------------------------------------------------------------- 987#---------------------------------------------------------------------------
198 988
989# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
990# evaluate all C-preprocessor directives found in the sources and include
991# files.
992
199ENABLE_PREPROCESSING = YES 993ENABLE_PREPROCESSING = YES
994
995# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
996# names in the source code. If set to NO (the default) only conditional
997# compilation will be performed. Macro expansion can be done in a controlled
998# way by setting EXPAND_ONLY_PREDEF to YES.
999
200MACRO_EXPANSION = NO 1000MACRO_EXPANSION = NO
1001
1002# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1003# then the macro expansion is limited to the macros specified with the
1004# PREDEFINED and EXPAND_AS_DEFINED tags.
1005
201EXPAND_ONLY_PREDEF = NO 1006EXPAND_ONLY_PREDEF = NO
1007
1008# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1009# in the INCLUDE_PATH (see below) will be search if a #include is found.
1010
202SEARCH_INCLUDES = YES 1011SEARCH_INCLUDES = YES
1012
1013# The INCLUDE_PATH tag can be used to specify one or more directories that
1014# contain include files that are not input files but should be processed by
1015# the preprocessor.
1016
203INCLUDE_PATH = 1017INCLUDE_PATH =
1018
1019# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1020# patterns (like *.h and *.hpp) to filter out the header-files in the
1021# directories. If left blank, the patterns specified with FILE_PATTERNS will
1022# be used.
1023
204INCLUDE_FILE_PATTERNS = 1024INCLUDE_FILE_PATTERNS =
1025
1026# The PREDEFINED tag can be used to specify one or more macro names that
1027# are defined before the preprocessor is started (similar to the -D option of
1028# gcc). The argument of the tag is a list of macros of the form: name
1029# or name=definition (no spaces). If the definition and the = are
1030# omitted =1 is assumed. To prevent a macro definition from being
1031# undefined via #undef or recursively expanded use the := operator
1032# instead of the = operator.
1033
205PREDEFINED = 1034PREDEFINED =
1035
1036# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1037# this tag can be used to specify a list of macro names that should be expanded.
1038# The macro definition that is found in the sources will be used.
1039# Use the PREDEFINED tag if you want to use a different macro definition.
1040
206EXPAND_AS_DEFINED = 1041EXPAND_AS_DEFINED =
1042
1043# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1044# doxygen's preprocessor will remove all function-like macros that are alone
1045# on a line, have an all uppercase name, and do not end with a semicolon. Such
1046# function macros are typically used for boiler-plate code, and will confuse
1047# the parser if not removed.
1048
207SKIP_FUNCTION_MACROS = YES 1049SKIP_FUNCTION_MACROS = YES
208 1050
209#--------------------------------------------------------------------------- 1051#---------------------------------------------------------------------------
210# Configuration::additions related to external references 1052# Configuration::additions related to external references
211#--------------------------------------------------------------------------- 1053#---------------------------------------------------------------------------
212 1054
1055# The TAGFILES option can be used to specify one or more tagfiles.
1056# Optionally an initial location of the external documentation
1057# can be added for each tagfile. The format of a tag file without
1058# this location is as follows:
1059# TAGFILES = file1 file2 ...
1060# Adding location for the tag files is done as follows:
1061# TAGFILES = file1=loc1 "file2 = loc2" ...
1062# where "loc1" and "loc2" can be relative or absolute paths or
1063# URLs. If a location is present for each tag, the installdox tool
1064# does not have to be run to correct the links.
1065# Note that each tag file must have a unique name
1066# (where the name does NOT include the path)
1067# If a tag file is not located in the directory in which doxygen
1068# is run, you must also specify the path to the tagfile here.
1069
213TAGFILES = 1070TAGFILES =
1071
1072# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1073# a tag file that is based on the input files it reads.
1074
214GENERATE_TAGFILE = 1075GENERATE_TAGFILE =
1076
1077# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1078# in the class index. If set to NO only the inherited external classes
1079# will be listed.
1080
215ALLEXTERNALS = NO 1081ALLEXTERNALS = NO
1082
1083# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1084# in the modules index. If set to NO, only the current project's groups will
1085# be listed.
1086
216EXTERNAL_GROUPS = YES 1087EXTERNAL_GROUPS = YES
1088
1089# The PERL_PATH should be the absolute path and name of the perl script
1090# interpreter (i.e. the result of `which perl').
1091
217PERL_PATH = /usr/bin/perl 1092PERL_PATH = /usr/bin/perl
218 1093
219#--------------------------------------------------------------------------- 1094#---------------------------------------------------------------------------
220# Configuration options related to the dot tool 1095# Configuration options related to the dot tool
221#--------------------------------------------------------------------------- 1096#---------------------------------------------------------------------------
222 1097
1098# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1099# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1100# or super classes. Setting the tag to NO turns the diagrams off. Note that
1101# this option is superseded by the HAVE_DOT option below. This is only a
1102# fallback. It is recommended to install and use dot, since it yields more
1103# powerful graphs.
1104
223CLASS_DIAGRAMS = YES 1105CLASS_DIAGRAMS = YES
1106
1107# You can define message sequence charts within doxygen comments using the \msc
1108# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1109# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1110# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1111# be found in the default search path.
1112
1113MSCGEN_PATH =
1114
1115# If set to YES, the inheritance and collaboration graphs will hide
1116# inheritance and usage relations if the target is undocumented
1117# or is not a class.
1118
224HIDE_UNDOC_RELATIONS = YES 1119HIDE_UNDOC_RELATIONS = YES
1120
1121# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1122# available from the path. This tool is part of Graphviz, a graph visualization
1123# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1124# have no effect if this option is set to NO (the default)
1125
225HAVE_DOT = @HAVE_DOT@ 1126HAVE_DOT = @HAVE_DOT@
1127
1128# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1129# will generate a graph for each documented class showing the direct and
1130# indirect inheritance relations. Setting this tag to YES will force the
1131# the CLASS_DIAGRAMS tag to NO.
1132
226CLASS_GRAPH = YES 1133CLASS_GRAPH = YES
1134
1135# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1136# will generate a graph for each documented class showing the direct and
1137# indirect implementation dependencies (inheritance, containment, and
1138# class references variables) of the class with other documented classes.
1139
227COLLABORATION_GRAPH = YES 1140COLLABORATION_GRAPH = YES
1141
1142# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1143# will generate a graph for groups, showing the direct groups dependencies
1144
1145GROUP_GRAPHS = YES
1146
1147# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1148# collaboration diagrams in a style similar to the OMG's Unified Modeling
1149# Language.
1150
228UML_LOOK = NO 1151UML_LOOK = NO
1152
1153# If set to YES, the inheritance and collaboration graphs will show the
1154# relations between templates and their instances.
1155
229TEMPLATE_RELATIONS = YES 1156TEMPLATE_RELATIONS = YES
1157
1158# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1159# tags are set to YES then doxygen will generate a graph for each documented
1160# file showing the direct and indirect include dependencies of the file with
1161# other documented files.
1162
230INCLUDE_GRAPH = YES 1163INCLUDE_GRAPH = YES
1164
1165# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1166# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1167# documented header file showing the documented files that directly or
1168# indirectly include this file.
1169
231INCLUDED_BY_GRAPH = YES 1170INCLUDED_BY_GRAPH = YES
1171
1172# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1173# generate a call dependency graph for every global function or class method.
1174# Note that enabling this option will significantly increase the time of a run.
1175# So in most cases it will be better to enable call graphs for selected
1176# functions only using the \callgraph command.
1177
232CALL_GRAPH = NO 1178CALL_GRAPH = NO
1179
1180# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1181# generate a caller dependency graph for every global function or class method.
1182# Note that enabling this option will significantly increase the time of a run.
1183# So in most cases it will be better to enable caller graphs for selected
1184# functions only using the \callergraph command.
1185
1186CALLER_GRAPH = NO
1187
1188# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1189# will graphical hierarchy of all classes instead of a textual one.
1190
233GRAPHICAL_HIERARCHY = YES 1191GRAPHICAL_HIERARCHY = YES
1192
1193# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1194# then doxygen will show the dependencies a directory has on other directories
1195# in a graphical way. The dependency relations are determined by the #include
1196# relations between the files in the directories.
1197
1198DIRECTORY_GRAPH = YES
1199
1200# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1201# generated by dot. Possible values are png, jpg, or gif
1202# If left blank png will be used.
1203
234DOT_IMAGE_FORMAT = png 1204DOT_IMAGE_FORMAT = png
1205
1206# The tag DOT_PATH can be used to specify the path where the dot tool can be
1207# found. If left blank, it is assumed the dot tool can be found in the path.
1208
235DOT_PATH = @DOT@ 1209DOT_PATH = @DOT@
1210
1211# The DOTFILE_DIRS tag can be used to specify one or more directories that
1212# contain dot files that are included in the documentation (see the
1213# \dotfile command).
1214
236DOTFILE_DIRS = 1215DOTFILE_DIRS =
237MAX_DOT_GRAPH_WIDTH = 1024 1216
238MAX_DOT_GRAPH_HEIGHT = 1024 1217# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
239MAX_DOT_GRAPH_DEPTH = 0 1218# nodes that will be shown in the graph. If the number of nodes in a graph
1219# becomes larger than this value, doxygen will truncate the graph, which is
1220# visualized by representing a node as a red box. Note that doxygen will always
1221# show the root nodes and its direct children regardless of this setting.
1222
1223DOT_GRAPH_MAX_NODES = 50
1224
1225# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1226# background. This is disabled by default, which results in a white background.
1227# Warning: Depending on the platform used, enabling this option may lead to
1228# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1229# read).
1230
1231DOT_TRANSPARENT = NO
1232
1233# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1234# files in one run (i.e. multiple -o and -T options on the command line). This
1235# makes dot run faster, but since only newer versions of dot (>1.8.10)
1236# support this, this feature is disabled by default.
1237
1238DOT_MULTI_TARGETS = NO
1239
1240# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1241# generate a legend page explaining the meaning of the various boxes and
1242# arrows in the dot generated graphs.
1243
240GENERATE_LEGEND = YES 1244GENERATE_LEGEND = YES
1245
1246# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1247# remove the intermediate dot files that are used to generate
1248# the various graphs.
1249
241DOT_CLEANUP = YES 1250DOT_CLEANUP = YES
242 1251
243#--------------------------------------------------------------------------- 1252#---------------------------------------------------------------------------
244# Configuration::additions related to the search engine 1253# Configuration::additions related to the search engine
245#--------------------------------------------------------------------------- 1254#---------------------------------------------------------------------------
246 1255
1256# The SEARCHENGINE tag specifies whether or not a search engine should be
1257# used. If set to NO the values of all tags below this one will be ignored.
1258
247SEARCHENGINE = NO 1259SEARCHENGINE = NO