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