source: doc/full.cfg @ b209eda

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since b209eda was b209eda, checked in by Paul Brossier <piem@piem.org>, 7 years ago

doc/{full,web}.cfg: remove custom LAYOUT_FILE

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