aboutsummaryrefslogtreecommitdiff
path: root/Doxyfile
diff options
context:
space:
mode:
authorMike Buland <eichlan@xagasoft.com>2009-08-09 05:30:34 +0000
committerMike Buland <eichlan@xagasoft.com>2009-08-09 05:30:34 +0000
commit4e86c50016ecfea40a72930cdd0460143f9edf4a (patch)
treee13c153b8042752a64134b3565e0e87a61d51398 /Doxyfile
parent9e48c6f7d602364eb1c18de7e1e4c00e4852839c (diff)
downloadlibbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.gz
libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.bz2
libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.xz
libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.zip
Really, just a lot of documenting.
Diffstat (limited to '')
-rw-r--r--Doxyfile1311
1 files changed, 1303 insertions, 8 deletions
diff --git a/Doxyfile b/Doxyfile
index 220119a..bdd9467 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1,16 +1,91 @@
1# Doxyfile 1.4.1-KDevelop 1# Doxyfile 1.5.9
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
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
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 = libbu++ 28PROJECT_NAME = libbu++
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 = api 41OUTPUT_DIRECTORY = api
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, Esperanto, Farsi, Finnish, French, German,
58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
10OUTPUT_LANGUAGE = English 63OUTPUT_LANGUAGE = English
11USE_WINDOWS_ENCODING = NO 64
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
12BRIEF_MEMBER_DESC = YES 70BRIEF_MEMBER_DESC = YES
71
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
13REPEAT_BRIEF = YES 77REPEAT_BRIEF = YES
78
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
14ABBREVIATE_BRIEF = "The $name class" \ 89ABBREVIATE_BRIEF = "The $name class" \
15 "The $name widget" \ 90 "The $name widget" \
16 "The $name file" \ 91 "The $name file" \
@@ -22,65 +97,501 @@ ABBREVIATE_BRIEF = "The $name class" \
22 a \ 97 a \
23 an \ 98 an \
24 the 99 the
100
101# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102# Doxygen will generate a detailed section even if there is only a brief
103# description.
104
25ALWAYS_DETAILED_SEC = NO 105ALWAYS_DETAILED_SEC = NO
106
107# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108# inherited members of a class in the documentation of that class as if those
109# members were ordinary class members. Constructors, destructors and assignment
110# operators of the base classes will not be shown.
111
26INLINE_INHERITED_MEMB = NO 112INLINE_INHERITED_MEMB = NO
113
114# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115# path before files name in the file list and in the header files. If set
116# to NO the shortest path that makes the file name unique will be used.
117
27FULL_PATH_NAMES = NO 118FULL_PATH_NAMES = NO
119
120# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121# can be used to strip a user-defined part of the path. Stripping is
122# only done if one of the specified strings matches the left-hand part of
123# the path. The tag can be used to show relative paths in the file list.
124# If left blank the directory from which doxygen is run is used as the
125# path to strip.
126
28STRIP_FROM_PATH = 127STRIP_FROM_PATH =
128
129# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130# the path mentioned in the documentation of a class, which tells
131# the reader which header file to include in order to use a class.
132# If left blank only the name of the header file containing the class
133# definition is used. Otherwise one should specify the include paths that
134# are normally passed to the compiler using the -I flag.
135
29STRIP_FROM_INC_PATH = 136STRIP_FROM_INC_PATH =
137
138# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139# (but less readable) file names. This can be useful is your file systems
140# doesn't support long names like on DOS, Mac, or CD-ROM.
141
30SHORT_NAMES = NO 142SHORT_NAMES = NO
143
144# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145# will interpret the first line (until the first dot) of a JavaDoc-style
146# comment as the brief description. If set to NO, the JavaDoc
147# comments will behave just like regular Qt-style comments
148# (thus requiring an explicit @brief command for a brief description.)
149
31JAVADOC_AUTOBRIEF = YES 150JAVADOC_AUTOBRIEF = YES
151
152# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153# interpret the first line (until the first dot) of a Qt-style
154# comment as the brief description. If set to NO, the comments
155# will behave just like regular Qt-style comments (thus requiring
156# an explicit \brief command for a brief description.)
157
158QT_AUTOBRIEF = NO
159
160# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162# comments) as a brief description. This used to be the default behaviour.
163# The new default is to treat a multi-line C++ comment block as a detailed
164# description. Set this tag to YES if you prefer the old behaviour instead.
165
32MULTILINE_CPP_IS_BRIEF = NO 166MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP = YES 167
168# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169# member inherits the documentation from any documented member that it
170# re-implements.
171
34INHERIT_DOCS = YES 172INHERIT_DOCS = YES
35DISTRIBUTE_GROUP_DOC = NO 173
174# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175# a new page for each member. If set to NO, the documentation of a member will
176# be part of the file/class/namespace that contains it.
177
178SEPARATE_MEMBER_PAGES = NO
179
180# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181# Doxygen uses this value to replace tabs by spaces in code fragments.
182
36TAB_SIZE = 4 183TAB_SIZE = 4
184
185# This tag can be used to specify a number of aliases that acts
186# as commands in the documentation. An alias has the form "name=value".
187# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188# put the command \sideeffect (or @sideeffect) in the documentation, which
189# will result in a user-defined paragraph with heading "Side Effects:".
190# You can put \n's in the value part of an alias to insert newlines.
191
37ALIASES = 192ALIASES =
193
194# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195# sources only. Doxygen will then generate output that is more tailored for C.
196# For instance, some of the names that are used will be different. The list
197# of all members will be omitted, etc.
198
38OPTIMIZE_OUTPUT_FOR_C = NO 199OPTIMIZE_OUTPUT_FOR_C = NO
200
201# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202# sources only. Doxygen will then generate output that is more tailored for
203# Java. For instance, namespaces will be presented as packages, qualified
204# scopes will look different, etc.
205
39OPTIMIZE_OUTPUT_JAVA = NO 206OPTIMIZE_OUTPUT_JAVA = NO
207
208# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209# sources only. Doxygen will then generate output that is more tailored for
210# Fortran.
211
212OPTIMIZE_FOR_FORTRAN = NO
213
214# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215# sources. Doxygen will then generate output that is tailored for
216# VHDL.
217
218OPTIMIZE_OUTPUT_VHDL = NO
219
220# Doxygen selects the parser to use depending on the extension of the files it parses.
221# With this tag you can assign which parser to use for a given extension.
222# Doxygen has a built-in mapping, but you can override or extend it using this tag.
223# The format is ext=language, where ext is a file extension, and language is one of
224# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
228
229EXTENSION_MAPPING =
230
231# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
232# to include (a tag file for) the STL sources as input, then you should
233# set this tag to YES in order to let doxygen match functions declarations and
234# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
235# func(std::string) {}). This also make the inheritance and collaboration
236# diagrams that involve STL classes more complete and accurate.
237
238BUILTIN_STL_SUPPORT = NO
239
240# If you use Microsoft's C++/CLI language, you should set this option to YES to
241# enable parsing support.
242
243CPP_CLI_SUPPORT = NO
244
245# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
246# Doxygen will parse them like normal C++ but will assume all classes use public
247# instead of private inheritance when no explicit protection keyword is present.
248
249SIP_SUPPORT = NO
250
251# For Microsoft's IDL there are propget and propput attributes to indicate getter
252# and setter methods for a property. Setting this option to YES (the default)
253# will make doxygen to replace the get and set methods by a property in the
254# documentation. This will only work if the methods are indeed getting or
255# setting a simple type. If this is not the case, or you want to show the
256# methods anyway, you should set this option to NO.
257
258IDL_PROPERTY_SUPPORT = YES
259
260# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
261# tag is set to YES, then doxygen will reuse the documentation of the first
262# member in the group (if any) for the other members of the group. By default
263# all members of a group must be documented explicitly.
264
265DISTRIBUTE_GROUP_DOC = NO
266
267# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
268# the same type (for instance a group of public functions) to be put as a
269# subgroup of that type (e.g. under the Public Functions section). Set it to
270# NO to prevent subgrouping. Alternatively, this can be done per class using
271# the \nosubgrouping command.
272
40SUBGROUPING = YES 273SUBGROUPING = YES
274
275# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
276# is documented as struct, union, or enum with the name of the typedef. So
277# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
278# with name TypeT. When disabled the typedef will appear as a member of a file,
279# namespace, or class. And the struct will be named TypeS. This can typically
280# be useful for C code in case the coding convention dictates that all compound
281# types are typedef'ed and only the typedef is referenced, never the tag name.
282
283TYPEDEF_HIDES_STRUCT = NO
284
285# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
286# determine which symbols to keep in memory and which to flush to disk.
287# When the cache is full, less often used symbols will be written to disk.
288# For small to medium size projects (<1000 input files) the default value is
289# probably good enough. For larger projects a too small cache size can cause
290# doxygen to be busy swapping symbols to and from disk most of the time
291# causing a significant performance penality.
292# If the system has enough physical memory increasing the cache will improve the
293# performance by keeping more symbols in memory. Note that the value works on
294# a logarithmic scale so increasing the size by one will rougly double the
295# memory usage. The cache size is given by this formula:
296# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
297# corresponding to a cache size of 2^16 = 65536 symbols
298
299SYMBOL_CACHE_SIZE = 0
300
41#--------------------------------------------------------------------------- 301#---------------------------------------------------------------------------
42# Build related configuration options 302# Build related configuration options
43#--------------------------------------------------------------------------- 303#---------------------------------------------------------------------------
304
305# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
306# documentation are documented, even if no documentation was available.
307# Private class members and static file members will be hidden unless
308# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
309
44EXTRACT_ALL = YES 310EXTRACT_ALL = YES
311
312# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
313# will be included in the documentation.
314
45EXTRACT_PRIVATE = YES 315EXTRACT_PRIVATE = YES
316
317# If the EXTRACT_STATIC tag is set to YES all static members of a file
318# will be included in the documentation.
319
46EXTRACT_STATIC = YES 320EXTRACT_STATIC = YES
321
322# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
323# defined locally in source files will be included in the documentation.
324# If set to NO only classes defined in header files are included.
325
47EXTRACT_LOCAL_CLASSES = YES 326EXTRACT_LOCAL_CLASSES = YES
327
328# This flag is only useful for Objective-C code. When set to YES local
329# methods, which are defined in the implementation section but not in
330# the interface are included in the documentation.
331# If set to NO (the default) only methods in the interface are included.
332
48EXTRACT_LOCAL_METHODS = YES 333EXTRACT_LOCAL_METHODS = YES
334
335# If this flag is set to YES, the members of anonymous namespaces will be
336# extracted and appear in the documentation as a namespace called
337# 'anonymous_namespace{file}', where file will be replaced with the base
338# name of the file that contains the anonymous namespace. By default
339# anonymous namespace are hidden.
340
341EXTRACT_ANON_NSPACES = NO
342
343# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
344# undocumented members of documented classes, files or namespaces.
345# If set to NO (the default) these members will be included in the
346# various overviews, but no documentation section is generated.
347# This option has no effect if EXTRACT_ALL is enabled.
348
49HIDE_UNDOC_MEMBERS = NO 349HIDE_UNDOC_MEMBERS = NO
350
351# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
352# undocumented classes that are normally visible in the class hierarchy.
353# If set to NO (the default) these classes will be included in the various
354# overviews. This option has no effect if EXTRACT_ALL is enabled.
355
50HIDE_UNDOC_CLASSES = NO 356HIDE_UNDOC_CLASSES = NO
357
358# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
359# friend (class|struct|union) declarations.
360# If set to NO (the default) these declarations will be included in the
361# documentation.
362
51HIDE_FRIEND_COMPOUNDS = NO 363HIDE_FRIEND_COMPOUNDS = NO
364
365# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
366# documentation blocks found inside the body of a function.
367# If set to NO (the default) these blocks will be appended to the
368# function's detailed documentation block.
369
52HIDE_IN_BODY_DOCS = NO 370HIDE_IN_BODY_DOCS = NO
371
372# The INTERNAL_DOCS tag determines if documentation
373# that is typed after a \internal command is included. If the tag is set
374# to NO (the default) then the documentation will be excluded.
375# Set it to YES to include the internal documentation.
376
53INTERNAL_DOCS = YES 377INTERNAL_DOCS = YES
378
379# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
380# file names in lower-case letters. If set to YES upper-case letters are also
381# allowed. This is useful if you have classes or files whose names only differ
382# in case and if your file system supports case sensitive file names. Windows
383# and Mac users are advised to set this option to NO.
384
54CASE_SENSE_NAMES = YES 385CASE_SENSE_NAMES = YES
386
387# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
388# will show members with their full class and namespace scopes in the
389# documentation. If set to YES the scope will be hidden.
390
55HIDE_SCOPE_NAMES = NO 391HIDE_SCOPE_NAMES = NO
392
393# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
394# will put a list of the files that are included by a file in the documentation
395# of that file.
396
56SHOW_INCLUDE_FILES = YES 397SHOW_INCLUDE_FILES = YES
398
399# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
400# is inserted in the documentation for inline members.
401
57INLINE_INFO = YES 402INLINE_INFO = YES
403
404# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
405# will sort the (detailed) documentation of file and class members
406# alphabetically by member name. If set to NO the members will appear in
407# declaration order.
408
58SORT_MEMBER_DOCS = YES 409SORT_MEMBER_DOCS = YES
410
411# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
412# brief documentation of file, namespace and class members alphabetically
413# by member name. If set to NO (the default) the members will appear in
414# declaration order.
415
59SORT_BRIEF_DOCS = NO 416SORT_BRIEF_DOCS = NO
417
418# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419# hierarchy of group names into alphabetical order. If set to NO (the default)
420# the group names will appear in their defined order.
421
422SORT_GROUP_NAMES = NO
423
424# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
425# sorted by fully-qualified names, including namespaces. If set to
426# NO (the default), the class list will be sorted only by class name,
427# not including the namespace part.
428# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
429# Note: This option applies only to the class list, not to the
430# alphabetical list.
431
60SORT_BY_SCOPE_NAME = NO 432SORT_BY_SCOPE_NAME = NO
433
434# The GENERATE_TODOLIST tag can be used to enable (YES) or
435# disable (NO) the todo list. This list is created by putting \todo
436# commands in the documentation.
437
61GENERATE_TODOLIST = YES 438GENERATE_TODOLIST = YES
439
440# The GENERATE_TESTLIST tag can be used to enable (YES) or
441# disable (NO) the test list. This list is created by putting \test
442# commands in the documentation.
443
62GENERATE_TESTLIST = YES 444GENERATE_TESTLIST = YES
445
446# The GENERATE_BUGLIST tag can be used to enable (YES) or
447# disable (NO) the bug list. This list is created by putting \bug
448# commands in the documentation.
449
63GENERATE_BUGLIST = YES 450GENERATE_BUGLIST = YES
451
452# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
453# disable (NO) the deprecated list. This list is created by putting
454# \deprecated commands in the documentation.
455
64GENERATE_DEPRECATEDLIST= YES 456GENERATE_DEPRECATEDLIST= YES
457
458# The ENABLED_SECTIONS tag can be used to enable conditional
459# documentation sections, marked by \if sectionname ... \endif.
460
65ENABLED_SECTIONS = 461ENABLED_SECTIONS =
462
463# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
464# the initial value of a variable or define consists of for it to appear in
465# the documentation. If the initializer consists of more lines than specified
466# here it will be hidden. Use a value of 0 to hide initializers completely.
467# The appearance of the initializer of individual variables and defines in the
468# documentation can be controlled using \showinitializer or \hideinitializer
469# command in the documentation regardless of this setting.
470
66MAX_INITIALIZER_LINES = 30 471MAX_INITIALIZER_LINES = 30
472
473# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
474# at the bottom of the documentation of classes and structs. If set to YES the
475# list will mention the files that were used to generate the documentation.
476
67SHOW_USED_FILES = YES 477SHOW_USED_FILES = YES
478
479# If the sources in your project are distributed over multiple directories
480# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
481# in the documentation. The default is NO.
482
68SHOW_DIRECTORIES = NO 483SHOW_DIRECTORIES = NO
484
485# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
486# This will remove the Files entry from the Quick Index and from the
487# Folder Tree View (if specified). The default is YES.
488
489SHOW_FILES = YES
490
491# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
492# Namespaces page.
493# This will remove the Namespaces entry from the Quick Index
494# and from the Folder Tree View (if specified). The default is YES.
495
496SHOW_NAMESPACES = YES
497
498# The FILE_VERSION_FILTER tag can be used to specify a program or script that
499# doxygen should invoke to get the current version for each file (typically from
500# the version control system). Doxygen will invoke the program by executing (via
501# popen()) the command <command> <input-file>, where <command> is the value of
502# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
503# provided by doxygen. Whatever the program writes to standard output
504# is used as the file version. See the manual for examples.
505
69FILE_VERSION_FILTER = 506FILE_VERSION_FILTER =
507
508# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
509# doxygen. The layout file controls the global structure of the generated output files
510# in an output format independent way. The create the layout file that represents
511# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
512# file name after the option, if omitted DoxygenLayout.xml will be used as the name
513# of the layout file.
514
515LAYOUT_FILE =
516
70#--------------------------------------------------------------------------- 517#---------------------------------------------------------------------------
71# configuration options related to warning and progress messages 518# configuration options related to warning and progress messages
72#--------------------------------------------------------------------------- 519#---------------------------------------------------------------------------
520
521# The QUIET tag can be used to turn on/off the messages that are generated
522# by doxygen. Possible values are YES and NO. If left blank NO is used.
523
73QUIET = NO 524QUIET = NO
525
526# The WARNINGS tag can be used to turn on/off the warning messages that are
527# generated by doxygen. Possible values are YES and NO. If left blank
528# NO is used.
529
74WARNINGS = YES 530WARNINGS = YES
531
532# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
533# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
534# automatically be disabled.
535
75WARN_IF_UNDOCUMENTED = YES 536WARN_IF_UNDOCUMENTED = YES
537
538# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
539# potential errors in the documentation, such as not documenting some
540# parameters in a documented function, or documenting parameters that
541# don't exist or using markup commands wrongly.
542
76WARN_IF_DOC_ERROR = YES 543WARN_IF_DOC_ERROR = YES
544
545# This WARN_NO_PARAMDOC option can be abled to get warnings for
546# functions that are documented, but have no documentation for their parameters
547# or return value. If set to NO (the default) doxygen will only warn about
548# wrong or incomplete parameter documentation, but not about the absence of
549# documentation.
550
77WARN_NO_PARAMDOC = YES 551WARN_NO_PARAMDOC = YES
552
553# The WARN_FORMAT tag determines the format of the warning messages that
554# doxygen can produce. The string should contain the $file, $line, and $text
555# tags, which will be replaced by the file and line number from which the
556# warning originated and the warning text. Optionally the format may contain
557# $version, which will be replaced by the version of the file (if it could
558# be obtained via FILE_VERSION_FILTER)
559
78WARN_FORMAT = "$file:$line: $text" 560WARN_FORMAT = "$file:$line: $text"
561
562# The WARN_LOGFILE tag can be used to specify a file to which warning
563# and error messages should be written. If left blank the output is written
564# to stderr.
565
79WARN_LOGFILE = Doxywarn 566WARN_LOGFILE = Doxywarn
567
80#--------------------------------------------------------------------------- 568#---------------------------------------------------------------------------
81# configuration options related to the input files 569# configuration options related to the input files
82#--------------------------------------------------------------------------- 570#---------------------------------------------------------------------------
83INPUT = src src/doxy 571
572# The INPUT tag can be used to specify the files and/or directories that contain
573# documented source files. You may enter file names like "myfile.cpp" or
574# directories like "/usr/src/myproject". Separate the files or directories
575# with spaces.
576
577INPUT = src \
578 src/doxy
579
580# This tag can be used to specify the character encoding of the source files
581# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
582# also the default input encoding. Doxygen uses libiconv (or the iconv built
583# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
584# the list of possible encodings.
585
586INPUT_ENCODING = UTF-8
587
588# If the value of the INPUT tag contains directories, you can use the
589# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
590# and *.h) to filter out the source-files in the directories. If left
591# blank the following patterns are tested:
592# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
593# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
594
84FILE_PATTERNS = *.c \ 595FILE_PATTERNS = *.c \
85 *.cc \ 596 *.cc \
86 *.cxx \ 597 *.cxx \
@@ -127,149 +638,933 @@ FILE_PATTERNS = *.c \
127 *.moc \ 638 *.moc \
128 *.xpm \ 639 *.xpm \
129 *.dox 640 *.dox
641
642# The RECURSIVE tag can be used to turn specify whether or not subdirectories
643# should be searched for input files as well. Possible values are YES and NO.
644# If left blank NO is used.
645
130RECURSIVE = NO 646RECURSIVE = NO
647
648# The EXCLUDE tag can be used to specify files and/or directories that should
649# excluded from the INPUT source files. This way you can easily exclude a
650# subdirectory from a directory tree whose root is specified with the INPUT tag.
651
131EXCLUDE = 652EXCLUDE =
653
654# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
655# directories that are symbolic links (a Unix filesystem feature) are excluded
656# from the input.
657
132EXCLUDE_SYMLINKS = NO 658EXCLUDE_SYMLINKS = NO
659
660# If the value of the INPUT tag contains directories, you can use the
661# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
662# certain files from those directories. Note that the wildcards are matched
663# against the file with absolute path, so to exclude all test directories
664# for example use the pattern */test/*
665
133EXCLUDE_PATTERNS = 666EXCLUDE_PATTERNS =
667
668# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
669# (namespaces, classes, functions, etc.) that should be excluded from the
670# output. The symbol name can be a fully qualified name, a word, or if the
671# wildcard * is used, a substring. Examples: ANamespace, AClass,
672# AClass::ANamespace, ANamespace::*Test
673
674EXCLUDE_SYMBOLS =
675
676# The EXAMPLE_PATH tag can be used to specify one or more files or
677# directories that contain example code fragments that are included (see
678# the \include command).
679
134EXAMPLE_PATH = 680EXAMPLE_PATH =
681
682# If the value of the EXAMPLE_PATH tag contains directories, you can use the
683# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
684# and *.h) to filter out the source-files in the directories. If left
685# blank all files are included.
686
135EXAMPLE_PATTERNS = * 687EXAMPLE_PATTERNS = *
688
689# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
690# searched for input files to be used with the \include or \dontinclude
691# commands irrespective of the value of the RECURSIVE tag.
692# Possible values are YES and NO. If left blank NO is used.
693
136EXAMPLE_RECURSIVE = NO 694EXAMPLE_RECURSIVE = NO
695
696# The IMAGE_PATH tag can be used to specify one or more files or
697# directories that contain image that are included in the documentation (see
698# the \image command).
699
137IMAGE_PATH = 700IMAGE_PATH =
701
702# The INPUT_FILTER tag can be used to specify a program that doxygen should
703# invoke to filter for each input file. Doxygen will invoke the filter program
704# by executing (via popen()) the command <filter> <input-file>, where <filter>
705# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
706# input file. Doxygen will then use the output that the filter program writes
707# to standard output.
708# If FILTER_PATTERNS is specified, this tag will be
709# ignored.
710
138INPUT_FILTER = 711INPUT_FILTER =
712
713# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
714# basis.
715# Doxygen will compare the file name with each pattern and apply the
716# filter if there is a match.
717# The filters are a list of the form:
718# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
719# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
720# is applied to all files.
721
139FILTER_PATTERNS = 722FILTER_PATTERNS =
723
724# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
725# INPUT_FILTER) will be used to filter the input files when producing source
726# files to browse (i.e. when SOURCE_BROWSER is set to YES).
727
140FILTER_SOURCE_FILES = NO 728FILTER_SOURCE_FILES = NO
729
141#--------------------------------------------------------------------------- 730#---------------------------------------------------------------------------
142# configuration options related to source browsing 731# configuration options related to source browsing
143#--------------------------------------------------------------------------- 732#---------------------------------------------------------------------------
733
734# If the SOURCE_BROWSER tag is set to YES then a list of source files will
735# be generated. Documented entities will be cross-referenced with these sources.
736# Note: To get rid of all source code in the generated output, make sure also
737# VERBATIM_HEADERS is set to NO.
738
144SOURCE_BROWSER = YES 739SOURCE_BROWSER = YES
740
741# Setting the INLINE_SOURCES tag to YES will include the body
742# of functions and classes directly in the documentation.
743
145INLINE_SOURCES = NO 744INLINE_SOURCES = NO
745
746# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
747# doxygen to hide any special comment blocks from generated source code
748# fragments. Normal C and C++ comments will always remain visible.
749
146STRIP_CODE_COMMENTS = YES 750STRIP_CODE_COMMENTS = YES
751
752# If the REFERENCED_BY_RELATION tag is set to YES
753# then for each documented function all documented
754# functions referencing it will be listed.
755
147REFERENCED_BY_RELATION = YES 756REFERENCED_BY_RELATION = YES
757
758# If the REFERENCES_RELATION tag is set to YES
759# then for each documented function all documented entities
760# called/used by that function will be listed.
761
148REFERENCES_RELATION = YES 762REFERENCES_RELATION = YES
763
764# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
765# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
766# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
767# link to the source code.
768# Otherwise they will link to the documentation.
769
770REFERENCES_LINK_SOURCE = YES
771
772# If the USE_HTAGS tag is set to YES then the references to source code
773# will point to the HTML generated by the htags(1) tool instead of doxygen
774# built-in source browser. The htags tool is part of GNU's global source
775# tagging system (see http://www.gnu.org/software/global/global.html). You
776# will need version 4.8.6 or higher.
777
778USE_HTAGS = NO
779
780# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
781# will generate a verbatim copy of the header file for each class for
782# which an include is specified. Set to NO to disable this.
783
149VERBATIM_HEADERS = YES 784VERBATIM_HEADERS = YES
785
150#--------------------------------------------------------------------------- 786#---------------------------------------------------------------------------
151# configuration options related to the alphabetical class index 787# configuration options related to the alphabetical class index
152#--------------------------------------------------------------------------- 788#---------------------------------------------------------------------------
789
790# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
791# of all compounds will be generated. Enable this if the project
792# contains a lot of classes, structs, unions or interfaces.
793
153ALPHABETICAL_INDEX = YES 794ALPHABETICAL_INDEX = YES
795
796# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
797# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
798# in which this list will be split (can be a number in the range [1..20])
799
154COLS_IN_ALPHA_INDEX = 4 800COLS_IN_ALPHA_INDEX = 4
801
802# In case all classes in a project start with a common prefix, all
803# classes will be put under the same header in the alphabetical index.
804# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
805# should be ignored while generating the index headers.
806
155IGNORE_PREFIX = 807IGNORE_PREFIX =
808
156#--------------------------------------------------------------------------- 809#---------------------------------------------------------------------------
157# configuration options related to the HTML output 810# configuration options related to the HTML output
158#--------------------------------------------------------------------------- 811#---------------------------------------------------------------------------
812
813# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
814# generate HTML output.
815
159GENERATE_HTML = YES 816GENERATE_HTML = YES
817
818# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
819# If a relative path is entered the value of OUTPUT_DIRECTORY will be
820# put in front of it. If left blank `html' will be used as the default path.
821
160HTML_OUTPUT = html 822HTML_OUTPUT = html
823
824# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
825# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
826# doxygen will generate files with .html extension.
827
161HTML_FILE_EXTENSION = .html 828HTML_FILE_EXTENSION = .html
829
830# The HTML_HEADER tag can be used to specify a personal HTML header for
831# each generated HTML page. If it is left blank doxygen will generate a
832# standard header.
833
162HTML_HEADER = 834HTML_HEADER =
835
836# The HTML_FOOTER tag can be used to specify a personal HTML footer for
837# each generated HTML page. If it is left blank doxygen will generate a
838# standard footer.
839
163HTML_FOOTER = 840HTML_FOOTER =
841
842# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
843# style sheet that is used by each HTML page. It can be used to
844# fine-tune the look of the HTML output. If the tag is left blank doxygen
845# will generate a default style sheet. Note that doxygen will try to copy
846# the style sheet file to the HTML output directory, so don't put your own
847# stylesheet in the HTML output directory as well, or it will be erased!
848
164HTML_STYLESHEET = 849HTML_STYLESHEET =
850
851# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
852# files or namespaces will be aligned in HTML using tables. If set to
853# NO a bullet list will be used.
854
165HTML_ALIGN_MEMBERS = YES 855HTML_ALIGN_MEMBERS = YES
856
857# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
858# documentation will contain sections that can be hidden and shown after the
859# page has loaded. For this to work a browser that supports
860# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
861# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
862
863HTML_DYNAMIC_SECTIONS = YES
864
865# If the GENERATE_DOCSET tag is set to YES, additional index files
866# will be generated that can be used as input for Apple's Xcode 3
867# integrated development environment, introduced with OSX 10.5 (Leopard).
868# To create a documentation set, doxygen will generate a Makefile in the
869# HTML output directory. Running make will produce the docset in that
870# directory and running "make install" will install the docset in
871# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
872# it at startup.
873# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
874
875GENERATE_DOCSET = NO
876
877# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
878# feed. A documentation feed provides an umbrella under which multiple
879# documentation sets from a single provider (such as a company or product suite)
880# can be grouped.
881
882DOCSET_FEEDNAME = "Doxygen generated docs"
883
884# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
885# should uniquely identify the documentation set bundle. This should be a
886# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
887# will append .docset to the name.
888
889DOCSET_BUNDLE_ID = org.doxygen.Project
890
891# If the GENERATE_HTMLHELP tag is set to YES, additional index files
892# will be generated that can be used as input for tools like the
893# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
894# of the generated HTML documentation.
895
166GENERATE_HTMLHELP = NO 896GENERATE_HTMLHELP = NO
897
898# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
899# be used to specify the file name of the resulting .chm file. You
900# can add a path in front of the file if the result should not be
901# written to the html output directory.
902
167CHM_FILE = 903CHM_FILE =
904
905# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
906# be used to specify the location (absolute path including file name) of
907# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
908# the HTML help compiler on the generated index.hhp.
909
168HHC_LOCATION = 910HHC_LOCATION =
911
912# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
913# controls if a separate .chi index file is generated (YES) or that
914# it should be included in the master .chm file (NO).
915
169GENERATE_CHI = NO 916GENERATE_CHI = NO
917
918# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
919# is used to encode HtmlHelp index (hhk), content (hhc) and project file
920# content.
921
922CHM_INDEX_ENCODING =
923
924# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
925# controls whether a binary table of contents is generated (YES) or a
926# normal table of contents (NO) in the .chm file.
927
170BINARY_TOC = NO 928BINARY_TOC = NO
929
930# The TOC_EXPAND flag can be set to YES to add extra items for group members
931# to the contents of the HTML help documentation and to the tree view.
932
171TOC_EXPAND = NO 933TOC_EXPAND = NO
934
935# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
936# are set, an additional index file will be generated that can be used as input for
937# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
938# HTML documentation.
939
940GENERATE_QHP = NO
941
942# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
943# be used to specify the file name of the resulting .qch file.
944# The path specified is relative to the HTML output folder.
945
946QCH_FILE =
947
948# The QHP_NAMESPACE tag specifies the namespace to use when generating
949# Qt Help Project output. For more information please see
950# http://doc.trolltech.com/qthelpproject.html#namespace
951
952QHP_NAMESPACE =
953
954# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
955# Qt Help Project output. For more information please see
956# http://doc.trolltech.com/qthelpproject.html#virtual-folders
957
958QHP_VIRTUAL_FOLDER = doc
959
960# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
961# For more information please see
962# http://doc.trolltech.com/qthelpproject.html#custom-filters
963
964QHP_CUST_FILTER_NAME =
965
966# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
967# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
968
969QHP_CUST_FILTER_ATTRS =
970
971# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
972# filter section matches.
973# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
974
975QHP_SECT_FILTER_ATTRS =
976
977# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
978# be used to specify the location of Qt's qhelpgenerator.
979# If non-empty doxygen will try to run qhelpgenerator on the generated
980# .qhp file.
981
982QHG_LOCATION =
983
984# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
985# top of each HTML page. The value NO (the default) enables the index and
986# the value YES disables it.
987
172DISABLE_INDEX = NO 988DISABLE_INDEX = NO
989
990# This tag can be used to set the number of enum values (range [1..20])
991# that doxygen will group on one line in the generated HTML documentation.
992
173ENUM_VALUES_PER_LINE = 4 993ENUM_VALUES_PER_LINE = 4
994
995# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
996# structure should be generated to display hierarchical information.
997# If the tag value is set to FRAME, a side panel will be generated
998# containing a tree-like index structure (just like the one that
999# is generated for HTML Help). For this to work a browser that supports
1000# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1001# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
1002# probably better off using the HTML help feature. Other possible values
1003# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
1004# and Class Hierarchy pages using a tree view instead of an ordered list;
1005# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
1006# disables this behavior completely. For backwards compatibility with previous
1007# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
1008# respectively.
1009
174GENERATE_TREEVIEW = NO 1010GENERATE_TREEVIEW = NO
1011
1012# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1013# used to set the initial width (in pixels) of the frame in which the tree
1014# is shown.
1015
175TREEVIEW_WIDTH = 250 1016TREEVIEW_WIDTH = 250
1017
1018# Use this tag to change the font size of Latex formulas included
1019# as images in the HTML documentation. The default is 10. Note that
1020# when you change the font size after a successful doxygen run you need
1021# to manually remove any form_*.png images from the HTML output directory
1022# to force them to be regenerated.
1023
1024FORMULA_FONTSIZE = 10
1025
176#--------------------------------------------------------------------------- 1026#---------------------------------------------------------------------------
177# configuration options related to the LaTeX output 1027# configuration options related to the LaTeX output
178#--------------------------------------------------------------------------- 1028#---------------------------------------------------------------------------
1029
1030# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1031# generate Latex output.
1032
179GENERATE_LATEX = NO 1033GENERATE_LATEX = NO
1034
1035# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1036# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1037# put in front of it. If left blank `latex' will be used as the default path.
1038
180LATEX_OUTPUT = latex 1039LATEX_OUTPUT = latex
1040
1041# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1042# invoked. If left blank `latex' will be used as the default command name.
1043
181LATEX_CMD_NAME = latex 1044LATEX_CMD_NAME = latex
1045
1046# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1047# generate index for LaTeX. If left blank `makeindex' will be used as the
1048# default command name.
1049
182MAKEINDEX_CMD_NAME = makeindex 1050MAKEINDEX_CMD_NAME = makeindex
1051
1052# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1053# LaTeX documents. This may be useful for small projects and may help to
1054# save some trees in general.
1055
183COMPACT_LATEX = NO 1056COMPACT_LATEX = NO
1057
1058# The PAPER_TYPE tag can be used to set the paper type that is used
1059# by the printer. Possible values are: a4, a4wide, letter, legal and
1060# executive. If left blank a4wide will be used.
1061
184PAPER_TYPE = letter 1062PAPER_TYPE = letter
1063
1064# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1065# packages that should be included in the LaTeX output.
1066
185EXTRA_PACKAGES = 1067EXTRA_PACKAGES =
1068
1069# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1070# the generated latex document. The header should contain everything until
1071# the first chapter. If it is left blank doxygen will generate a
1072# standard header. Notice: only use this tag if you know what you are doing!
1073
186LATEX_HEADER = 1074LATEX_HEADER =
1075
1076# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1077# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1078# contain links (just like the HTML output) instead of page references
1079# This makes the output suitable for online browsing using a pdf viewer.
1080
187PDF_HYPERLINKS = YES 1081PDF_HYPERLINKS = YES
1082
1083# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1084# plain latex in the generated Makefile. Set this option to YES to get a
1085# higher quality PDF documentation.
1086
188USE_PDFLATEX = YES 1087USE_PDFLATEX = YES
1088
1089# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1090# command to the generated LaTeX files. This will instruct LaTeX to keep
1091# running if errors occur, instead of asking the user for help.
1092# This option is also used when generating formulas in HTML.
1093
189LATEX_BATCHMODE = NO 1094LATEX_BATCHMODE = NO
1095
1096# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1097# include the index chapters (such as File Index, Compound Index, etc.)
1098# in the output.
1099
190LATEX_HIDE_INDICES = NO 1100LATEX_HIDE_INDICES = NO
1101
1102# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1103
1104LATEX_SOURCE_CODE = NO
1105
191#--------------------------------------------------------------------------- 1106#---------------------------------------------------------------------------
192# configuration options related to the RTF output 1107# configuration options related to the RTF output
193#--------------------------------------------------------------------------- 1108#---------------------------------------------------------------------------
1109
1110# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1111# The RTF output is optimized for Word 97 and may not look very pretty with
1112# other RTF readers or editors.
1113
194GENERATE_RTF = NO 1114GENERATE_RTF = NO
1115
1116# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1117# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1118# put in front of it. If left blank `rtf' will be used as the default path.
1119
195RTF_OUTPUT = rtf 1120RTF_OUTPUT = rtf
1121
1122# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1123# RTF documents. This may be useful for small projects and may help to
1124# save some trees in general.
1125
196COMPACT_RTF = NO 1126COMPACT_RTF = NO
1127
1128# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1129# will contain hyperlink fields. The RTF file will
1130# contain links (just like the HTML output) instead of page references.
1131# This makes the output suitable for online browsing using WORD or other
1132# programs which support those fields.
1133# Note: wordpad (write) and others do not support links.
1134
197RTF_HYPERLINKS = YES 1135RTF_HYPERLINKS = YES
1136
1137# Load stylesheet definitions from file. Syntax is similar to doxygen's
1138# config file, i.e. a series of assignments. You only have to provide
1139# replacements, missing definitions are set to their default value.
1140
198RTF_STYLESHEET_FILE = 1141RTF_STYLESHEET_FILE =
1142
1143# Set optional variables used in the generation of an rtf document.
1144# Syntax is similar to doxygen's config file.
1145
199RTF_EXTENSIONS_FILE = 1146RTF_EXTENSIONS_FILE =
1147
200#--------------------------------------------------------------------------- 1148#---------------------------------------------------------------------------
201# configuration options related to the man page output 1149# configuration options related to the man page output
202#--------------------------------------------------------------------------- 1150#---------------------------------------------------------------------------
1151
1152# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1153# generate man pages
1154
203GENERATE_MAN = NO 1155GENERATE_MAN = NO
1156
1157# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1158# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1159# put in front of it. If left blank `man' will be used as the default path.
1160
204MAN_OUTPUT = man 1161MAN_OUTPUT = man
1162
1163# The MAN_EXTENSION tag determines the extension that is added to
1164# the generated man pages (default is the subroutine's section .3)
1165
205MAN_EXTENSION = .3 1166MAN_EXTENSION = .3
1167
1168# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1169# then it will generate one additional man file for each entity
1170# documented in the real man page(s). These additional files
1171# only source the real man page, but without them the man command
1172# would be unable to find the correct page. The default is NO.
1173
206MAN_LINKS = NO 1174MAN_LINKS = NO
1175
207#--------------------------------------------------------------------------- 1176#---------------------------------------------------------------------------
208# configuration options related to the XML output 1177# configuration options related to the XML output
209#--------------------------------------------------------------------------- 1178#---------------------------------------------------------------------------
1179
1180# If the GENERATE_XML tag is set to YES Doxygen will
1181# generate an XML file that captures the structure of
1182# the code including all documentation.
1183
210GENERATE_XML = NO 1184GENERATE_XML = NO
1185
1186# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1187# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1188# put in front of it. If left blank `xml' will be used as the default path.
1189
211XML_OUTPUT = xml 1190XML_OUTPUT = xml
1191
1192# The XML_SCHEMA tag can be used to specify an XML schema,
1193# which can be used by a validating XML parser to check the
1194# syntax of the XML files.
1195
212XML_SCHEMA = 1196XML_SCHEMA =
1197
1198# The XML_DTD tag can be used to specify an XML DTD,
1199# which can be used by a validating XML parser to check the
1200# syntax of the XML files.
1201
213XML_DTD = 1202XML_DTD =
1203
1204# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1205# dump the program listings (including syntax highlighting
1206# and cross-referencing information) to the XML output. Note that
1207# enabling this will significantly increase the size of the XML output.
1208
214XML_PROGRAMLISTING = YES 1209XML_PROGRAMLISTING = YES
1210
215#--------------------------------------------------------------------------- 1211#---------------------------------------------------------------------------
216# configuration options for the AutoGen Definitions output 1212# configuration options for the AutoGen Definitions output
217#--------------------------------------------------------------------------- 1213#---------------------------------------------------------------------------
1214
1215# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1216# generate an AutoGen Definitions (see autogen.sf.net) file
1217# that captures the structure of the code including all
1218# documentation. Note that this feature is still experimental
1219# and incomplete at the moment.
1220
218GENERATE_AUTOGEN_DEF = NO 1221GENERATE_AUTOGEN_DEF = NO
1222
219#--------------------------------------------------------------------------- 1223#---------------------------------------------------------------------------
220# configuration options related to the Perl module output 1224# configuration options related to the Perl module output
221#--------------------------------------------------------------------------- 1225#---------------------------------------------------------------------------
1226
1227# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1228# generate a Perl module file that captures the structure of
1229# the code including all documentation. Note that this
1230# feature is still experimental and incomplete at the
1231# moment.
1232
222GENERATE_PERLMOD = NO 1233GENERATE_PERLMOD = NO
1234
1235# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1236# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1237# to generate PDF and DVI output from the Perl module output.
1238
223PERLMOD_LATEX = YES 1239PERLMOD_LATEX = YES
1240
1241# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1242# nicely formatted so it can be parsed by a human reader.
1243# This is useful
1244# if you want to understand what is going on.
1245# On the other hand, if this
1246# tag is set to NO the size of the Perl module output will be much smaller
1247# and Perl will parse it just the same.
1248
224PERLMOD_PRETTY = YES 1249PERLMOD_PRETTY = YES
1250
1251# The names of the make variables in the generated doxyrules.make file
1252# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1253# This is useful so different doxyrules.make files included by the same
1254# Makefile don't overwrite each other's variables.
1255
225PERLMOD_MAKEVAR_PREFIX = 1256PERLMOD_MAKEVAR_PREFIX =
1257
226#--------------------------------------------------------------------------- 1258#---------------------------------------------------------------------------
227# Configuration options related to the preprocessor 1259# Configuration options related to the preprocessor
228#--------------------------------------------------------------------------- 1260#---------------------------------------------------------------------------
1261
1262# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1263# evaluate all C-preprocessor directives found in the sources and include
1264# files.
1265
229ENABLE_PREPROCESSING = YES 1266ENABLE_PREPROCESSING = YES
1267
1268# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1269# names in the source code. If set to NO (the default) only conditional
1270# compilation will be performed. Macro expansion can be done in a controlled
1271# way by setting EXPAND_ONLY_PREDEF to YES.
1272
230MACRO_EXPANSION = YES 1273MACRO_EXPANSION = YES
1274
1275# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1276# then the macro expansion is limited to the macros specified with the
1277# PREDEFINED and EXPAND_AS_DEFINED tags.
1278
231EXPAND_ONLY_PREDEF = NO 1279EXPAND_ONLY_PREDEF = NO
1280
1281# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1282# in the INCLUDE_PATH (see below) will be search if a #include is found.
1283
232SEARCH_INCLUDES = YES 1284SEARCH_INCLUDES = YES
1285
1286# The INCLUDE_PATH tag can be used to specify one or more directories that
1287# contain include files that are not input files but should be processed by
1288# the preprocessor.
1289
233INCLUDE_PATH = 1290INCLUDE_PATH =
1291
1292# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1293# patterns (like *.h and *.hpp) to filter out the header-files in the
1294# directories. If left blank, the patterns specified with FILE_PATTERNS will
1295# be used.
1296
234INCLUDE_FILE_PATTERNS = 1297INCLUDE_FILE_PATTERNS =
1298
1299# The PREDEFINED tag can be used to specify one or more macro names that
1300# are defined before the preprocessor is started (similar to the -D option of
1301# gcc). The argument of the tag is a list of macros of the form: name
1302# or name=definition (no spaces). If the definition and the = are
1303# omitted =1 is assumed. To prevent a macro definition from being
1304# undefined via #undef or recursively expanded use the := operator
1305# instead of the = operator.
1306
235PREDEFINED = 1307PREDEFINED =
1308
1309# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1310# this tag can be used to specify a list of macro names that should be expanded.
1311# The macro definition that is found in the sources will be used.
1312# Use the PREDEFINED tag if you want to use a different macro definition.
1313
236EXPAND_AS_DEFINED = 1314EXPAND_AS_DEFINED =
1315
1316# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1317# doxygen's preprocessor will remove all function-like macros that are alone
1318# on a line, have an all uppercase name, and do not end with a semicolon. Such
1319# function macros are typically used for boiler-plate code, and will confuse
1320# the parser if not removed.
1321
237SKIP_FUNCTION_MACROS = YES 1322SKIP_FUNCTION_MACROS = YES
1323
238#--------------------------------------------------------------------------- 1324#---------------------------------------------------------------------------
239# Configuration::additions related to external references 1325# Configuration::additions related to external references
240#--------------------------------------------------------------------------- 1326#---------------------------------------------------------------------------
1327
1328# The TAGFILES option can be used to specify one or more tagfiles.
1329# Optionally an initial location of the external documentation
1330# can be added for each tagfile. The format of a tag file without
1331# this location is as follows:
1332#
1333# TAGFILES = file1 file2 ...
1334# Adding location for the tag files is done as follows:
1335#
1336# TAGFILES = file1=loc1 "file2 = loc2" ...
1337# where "loc1" and "loc2" can be relative or absolute paths or
1338# URLs. If a location is present for each tag, the installdox tool
1339# does not have to be run to correct the links.
1340# Note that each tag file must have a unique name
1341# (where the name does NOT include the path)
1342# If a tag file is not located in the directory in which doxygen
1343# is run, you must also specify the path to the tagfile here.
1344
241TAGFILES = 1345TAGFILES =
1346
1347# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1348# a tag file that is based on the input files it reads.
1349
242GENERATE_TAGFILE = 1350GENERATE_TAGFILE =
1351
1352# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1353# in the class index. If set to NO only the inherited external classes
1354# will be listed.
1355
243ALLEXTERNALS = NO 1356ALLEXTERNALS = NO
1357
1358# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1359# in the modules index. If set to NO, only the current project's groups will
1360# be listed.
1361
244EXTERNAL_GROUPS = YES 1362EXTERNAL_GROUPS = YES
1363
1364# The PERL_PATH should be the absolute path and name of the perl script
1365# interpreter (i.e. the result of `which perl').
1366
245PERL_PATH = /usr/bin/perl 1367PERL_PATH = /usr/bin/perl
1368
246#--------------------------------------------------------------------------- 1369#---------------------------------------------------------------------------
247# Configuration options related to the dot tool 1370# Configuration options related to the dot tool
248#--------------------------------------------------------------------------- 1371#---------------------------------------------------------------------------
1372
1373# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1374# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1375# or super classes. Setting the tag to NO turns the diagrams off. Note that
1376# this option is superseded by the HAVE_DOT option below. This is only a
1377# fallback. It is recommended to install and use dot, since it yields more
1378# powerful graphs.
1379
249CLASS_DIAGRAMS = YES 1380CLASS_DIAGRAMS = YES
1381
1382# You can define message sequence charts within doxygen comments using the \msc
1383# command. Doxygen will then run the mscgen tool (see
1384# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1385# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1386# the mscgen tool resides. If left empty the tool is assumed to be found in the
1387# default search path.
1388
1389MSCGEN_PATH =
1390
1391# If set to YES, the inheritance and collaboration graphs will hide
1392# inheritance and usage relations if the target is undocumented
1393# or is not a class.
1394
250HIDE_UNDOC_RELATIONS = YES 1395HIDE_UNDOC_RELATIONS = YES
1396
1397# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1398# available from the path. This tool is part of Graphviz, a graph visualization
1399# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1400# have no effect if this option is set to NO (the default)
1401
251HAVE_DOT = YES 1402HAVE_DOT = YES
1403
1404# By default doxygen will write a font called FreeSans.ttf to the output
1405# directory and reference it in all dot files that doxygen generates. This
1406# font does not include all possible unicode characters however, so when you need
1407# these (or just want a differently looking font) you can specify the font name
1408# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1409# which can be done by putting it in a standard location or by setting the
1410# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1411# containing the font.
1412
1413DOT_FONTNAME = FreeSans
1414
1415# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1416# The default size is 10pt.
1417
1418DOT_FONTSIZE = 10
1419
1420# By default doxygen will tell dot to use the output directory to look for the
1421# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1422# different font using DOT_FONTNAME you can set the path where dot
1423# can find it using this tag.
1424
1425DOT_FONTPATH =
1426
1427# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1428# will generate a graph for each documented class showing the direct and
1429# indirect inheritance relations. Setting this tag to YES will force the
1430# the CLASS_DIAGRAMS tag to NO.
1431
252CLASS_GRAPH = YES 1432CLASS_GRAPH = YES
1433
1434# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1435# will generate a graph for each documented class showing the direct and
1436# indirect implementation dependencies (inheritance, containment, and
1437# class references variables) of the class with other documented classes.
1438
253COLLABORATION_GRAPH = YES 1439COLLABORATION_GRAPH = YES
1440
1441# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1442# will generate a graph for groups, showing the direct groups dependencies
1443
254GROUP_GRAPHS = YES 1444GROUP_GRAPHS = YES
1445
1446# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1447# collaboration diagrams in a style similar to the OMG's Unified Modeling
1448# Language.
1449
255UML_LOOK = NO 1450UML_LOOK = NO
1451
1452# If set to YES, the inheritance and collaboration graphs will show the
1453# relations between templates and their instances.
1454
256TEMPLATE_RELATIONS = NO 1455TEMPLATE_RELATIONS = NO
1456
1457# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1458# tags are set to YES then doxygen will generate a graph for each documented
1459# file showing the direct and indirect include dependencies of the file with
1460# other documented files.
1461
257INCLUDE_GRAPH = YES 1462INCLUDE_GRAPH = YES
1463
1464# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1465# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1466# documented header file showing the documented files that directly or
1467# indirectly include this file.
1468
258INCLUDED_BY_GRAPH = YES 1469INCLUDED_BY_GRAPH = YES
1470
1471# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1472# doxygen will generate a call dependency graph for every global function
1473# or class method. Note that enabling this option will significantly increase
1474# the time of a run. So in most cases it will be better to enable call graphs
1475# for selected functions only using the \callgraph command.
1476
259CALL_GRAPH = NO 1477CALL_GRAPH = NO
1478
1479# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1480# doxygen will generate a caller dependency graph for every global function
1481# or class method. Note that enabling this option will significantly increase
1482# the time of a run. So in most cases it will be better to enable caller
1483# graphs for selected functions only using the \callergraph command.
1484
1485CALLER_GRAPH = NO
1486
1487# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1488# will graphical hierarchy of all classes instead of a textual one.
1489
260GRAPHICAL_HIERARCHY = YES 1490GRAPHICAL_HIERARCHY = YES
1491
1492# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1493# then doxygen will show the dependencies a directory has on other directories
1494# in a graphical way. The dependency relations are determined by the #include
1495# relations between the files in the directories.
1496
261DIRECTORY_GRAPH = NO 1497DIRECTORY_GRAPH = NO
1498
1499# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1500# generated by dot. Possible values are png, jpg, or gif
1501# If left blank png will be used.
1502
262DOT_IMAGE_FORMAT = png 1503DOT_IMAGE_FORMAT = png
1504
1505# The tag DOT_PATH can be used to specify the path where the dot tool can be
1506# found. If left blank, it is assumed the dot tool can be found in the path.
1507
263DOT_PATH = 1508DOT_PATH =
1509
1510# The DOTFILE_DIRS tag can be used to specify one or more directories that
1511# contain dot files that are included in the documentation (see the
1512# \dotfile command).
1513
264DOTFILE_DIRS = 1514DOTFILE_DIRS =
265MAX_DOT_GRAPH_WIDTH = 1024 1515
266MAX_DOT_GRAPH_HEIGHT = 1024 1516# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1517# nodes that will be shown in the graph. If the number of nodes in a graph
1518# becomes larger than this value, doxygen will truncate the graph, which is
1519# visualized by representing a node as a red box. Note that doxygen if the
1520# number of direct children of the root node in a graph is already larger than
1521# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1522# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1523
1524DOT_GRAPH_MAX_NODES = 50
1525
1526# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1527# graphs generated by dot. A depth value of 3 means that only nodes reachable
1528# from the root by following a path via at most 3 edges will be shown. Nodes
1529# that lay further from the root node will be omitted. Note that setting this
1530# option to 1 or 2 may greatly reduce the computation time needed for large
1531# code bases. Also note that the size of a graph can be further restricted by
1532# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1533
267MAX_DOT_GRAPH_DEPTH = 1000 1534MAX_DOT_GRAPH_DEPTH = 1000
1535
1536# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1537# background. This is disabled by default, because dot on Windows does not
1538# seem to support this out of the box. Warning: Depending on the platform used,
1539# enabling this option may lead to badly anti-aliased labels on the edges of
1540# a graph (i.e. they become hard to read).
1541
268DOT_TRANSPARENT = NO 1542DOT_TRANSPARENT = NO
1543
1544# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1545# files in one run (i.e. multiple -o and -T options on the command line). This
1546# makes dot run faster, but since only newer versions of dot (>1.8.10)
1547# support this, this feature is disabled by default.
1548
269DOT_MULTI_TARGETS = NO 1549DOT_MULTI_TARGETS = NO
1550
1551# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1552# generate a legend page explaining the meaning of the various boxes and
1553# arrows in the dot generated graphs.
1554
270GENERATE_LEGEND = YES 1555GENERATE_LEGEND = YES
1556
1557# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1558# remove the intermediate dot files that are used to generate
1559# the various graphs.
1560
271DOT_CLEANUP = YES 1561DOT_CLEANUP = YES
1562
272#--------------------------------------------------------------------------- 1563#---------------------------------------------------------------------------
273# Configuration::additions related to the search engine 1564# Options related to the search engine
274#--------------------------------------------------------------------------- 1565#---------------------------------------------------------------------------
1566
1567# The SEARCHENGINE tag specifies whether or not a search engine should be
1568# used. If set to NO the values of all tags below this one will be ignored.
1569
275SEARCHENGINE = NO 1570SEARCHENGINE = NO