source: mod_gnutls/doc/doxygen.conf.in

debianupstream
Last change on this file was e0e0b0f, checked in by Thomas Klute <thomas2.klute@…>, 12 months ago

Include memcached cache functions in Doxygen documentation, if enabled

  • Property mode set to 100644
File size: 103.8 KB
Line 
1# Doxyfile 1.8.11
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 double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING      = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME           = "@PACKAGE_NAME@"
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41PROJECT_NUMBER         = @PACKAGE_VERSION@
42
43# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
47PROJECT_BRIEF          = "TLS module for Apache HTTPD based on GnuTLS"
48
49# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50# in the documentation. The maximum height of the logo should not exceed 55
51# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52# the logo to the output directory.
53
54PROJECT_LOGO           =
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
61OUTPUT_DIRECTORY       = doc/api
62
63# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
70
71CREATE_SUBDIRS         = NO
72
73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES    = NO
80
81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
93
94OUTPUT_LANGUAGE        = English
95
96# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC      = YES
102
103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF           = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
121ABBREVIATE_BRIEF       =
122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
125# description.
126# The default value is: NO.
127
128ALWAYS_DETAILED_SEC    = NO
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
134# The default value is: NO.
135
136INLINE_INHERITED_MEMB  = NO
137
138# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
142
143FULL_PATH_NAMES        = YES
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155STRIP_FROM_PATH        =
156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
164STRIP_FROM_INC_PATH    =
165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES            = NO
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
180JAVADOC_AUTOBRIEF      = YES
181
182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
187
188QT_AUTOBRIEF           = NO
189
190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
199
200MULTILINE_CPP_IS_BRIEF = NO
201
202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
205
206INHERIT_DOCS           = YES
207
208# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209# page for each member. If set to NO, the documentation of a member will be part
210# of the file/class/namespace that contains it.
211# The default value is: NO.
212
213SEPARATE_MEMBER_PAGES  = NO
214
215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
218
219TAB_SIZE               = 4
220
221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
224# For example adding
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
230
231ALIASES                =
232
233# This tag can be used to specify a number of word-keyword mappings (TCL only).
234# A mapping has the form "name=value". For example adding "class=itcl::class"
235# will allow you to use the command class in the itcl::class meaning.
236
237TCL_SUBST              =
238
239# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240# only. Doxygen will then generate output that is more tailored for C. For
241# instance, some of the names that are used will be different. The list of all
242# members will be omitted, etc.
243# The default value is: NO.
244
245OPTIMIZE_OUTPUT_FOR_C  = NO
246
247# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248# Python sources only. Doxygen will then generate output that is more tailored
249# for that language. For instance, namespaces will be presented as packages,
250# qualified scopes will look different, etc.
251# The default value is: NO.
252
253OPTIMIZE_OUTPUT_JAVA   = NO
254
255# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256# sources. Doxygen will then generate output that is tailored for Fortran.
257# The default value is: NO.
258
259OPTIMIZE_FOR_FORTRAN   = NO
260
261# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262# sources. Doxygen will then generate output that is tailored for VHDL.
263# The default value is: NO.
264
265OPTIMIZE_OUTPUT_VHDL   = NO
266
267# Doxygen selects the parser to use depending on the extension of the files it
268# parses. With this tag you can assign which parser to use for a given
269# extension. Doxygen has a built-in mapping, but you can override or extend it
270# using this tag. The format is ext=language, where ext is a file extension, and
271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274# Fortran. In the later case the parser tries to guess whether the code is fixed
275# or free formatted code, this is the default for Fortran type files), VHDL. For
276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
278#
279# Note: For files without extension you can use no_extension as a placeholder.
280#
281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282# the files are not read by doxygen.
283
284EXTENSION_MAPPING      =
285
286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287# according to the Markdown format, which allows for more readable
288# documentation. See http://daringfireball.net/projects/markdown/ for details.
289# The output of markdown processing is further processed by doxygen, so you can
290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291# case of backward compatibilities issues.
292# The default value is: YES.
293
294MARKDOWN_SUPPORT       = YES
295
296# When enabled doxygen tries to link words that correspond to documented
297# classes, or namespaces to their corresponding documentation. Such a link can
298# be prevented in individual cases by putting a % sign in front of the word or
299# globally by setting AUTOLINK_SUPPORT to NO.
300# The default value is: YES.
301
302AUTOLINK_SUPPORT       = YES
303
304# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305# to include (a tag file for) the STL sources as input, then you should set this
306# tag to YES in order to let doxygen match functions declarations and
307# definitions whose arguments contain STL classes (e.g. func(std::string);
308# versus func(std::string) {}). This also make the inheritance and collaboration
309# diagrams that involve STL classes more complete and accurate.
310# The default value is: NO.
311
312BUILTIN_STL_SUPPORT    = NO
313
314# If you use Microsoft's C++/CLI language, you should set this option to YES to
315# enable parsing support.
316# The default value is: NO.
317
318CPP_CLI_SUPPORT        = NO
319
320# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322# will parse them like normal C++ but will assume all classes use public instead
323# of private inheritance when no explicit protection keyword is present.
324# The default value is: NO.
325
326SIP_SUPPORT            = NO
327
328# For Microsoft's IDL there are propget and propput attributes to indicate
329# getter and setter methods for a property. Setting this option to YES will make
330# doxygen to replace the get and set methods by a property in the documentation.
331# This will only work if the methods are indeed getting or setting a simple
332# type. If this is not the case, or you want to show the methods anyway, you
333# should set this option to NO.
334# The default value is: YES.
335
336IDL_PROPERTY_SUPPORT   = YES
337
338# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339# tag is set to YES then doxygen will reuse the documentation of the first
340# member in the group (if any) for the other members of the group. By default
341# all members of a group must be documented explicitly.
342# The default value is: NO.
343
344DISTRIBUTE_GROUP_DOC   = NO
345
346# If one adds a struct or class to a group and this option is enabled, then also
347# any nested class or struct is added to the same group. By default this option
348# is disabled and one has to add nested compounds explicitly via \ingroup.
349# The default value is: NO.
350
351GROUP_NESTED_COMPOUNDS = NO
352
353# Set the SUBGROUPING tag to YES to allow class member groups of the same type
354# (for instance a group of public functions) to be put as a subgroup of that
355# type (e.g. under the Public Functions section). Set it to NO to prevent
356# subgrouping. Alternatively, this can be done per class using the
357# \nosubgrouping command.
358# The default value is: YES.
359
360SUBGROUPING            = YES
361
362# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
363# are shown inside the group in which they are included (e.g. using \ingroup)
364# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
365# and RTF).
366#
367# Note that this feature does not work in combination with
368# SEPARATE_MEMBER_PAGES.
369# The default value is: NO.
370
371INLINE_GROUPED_CLASSES = NO
372
373# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
374# with only public data fields or simple typedef fields will be shown inline in
375# the documentation of the scope in which they are defined (i.e. file,
376# namespace, or group documentation), provided this scope is documented. If set
377# to NO, structs, classes, and unions are shown on a separate page (for HTML and
378# Man pages) or section (for LaTeX and RTF).
379# The default value is: NO.
380
381INLINE_SIMPLE_STRUCTS  = NO
382
383# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
384# enum is documented as struct, union, or enum with the name of the typedef. So
385# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
386# with name TypeT. When disabled the typedef will appear as a member of a file,
387# namespace, or class. And the struct will be named TypeS. This can typically be
388# useful for C code in case the coding convention dictates that all compound
389# types are typedef'ed and only the typedef is referenced, never the tag name.
390# The default value is: NO.
391
392TYPEDEF_HIDES_STRUCT   = NO
393
394# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
395# cache is used to resolve symbols given their name and scope. Since this can be
396# an expensive process and often the same symbol appears multiple times in the
397# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
398# doxygen will become slower. If the cache is too large, memory is wasted. The
399# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
400# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
401# symbols. At the end of a run doxygen will report the cache usage and suggest
402# the optimal cache size from a speed point of view.
403# Minimum value: 0, maximum value: 9, default value: 0.
404
405LOOKUP_CACHE_SIZE      = 0
406
407#---------------------------------------------------------------------------
408# Build related configuration options
409#---------------------------------------------------------------------------
410
411# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
412# documentation are documented, even if no documentation was available. Private
413# class members and static file members will be hidden unless the
414# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
415# Note: This will also disable the warnings about undocumented members that are
416# normally produced when WARNINGS is set to YES.
417# The default value is: NO.
418
419EXTRACT_ALL            = YES
420
421# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
422# be included in the documentation.
423# The default value is: NO.
424
425EXTRACT_PRIVATE        = NO
426
427# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
428# scope will be included in the documentation.
429# The default value is: NO.
430
431EXTRACT_PACKAGE        = NO
432
433# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
434# included in the documentation.
435# The default value is: NO.
436
437EXTRACT_STATIC         = YES
438
439# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
440# locally in source files will be included in the documentation. If set to NO,
441# only classes defined in header files are included. Does not have any effect
442# for Java sources.
443# The default value is: YES.
444
445EXTRACT_LOCAL_CLASSES  = YES
446
447# This flag is only useful for Objective-C code. If set to YES, local methods,
448# which are defined in the implementation section but not in the interface are
449# included in the documentation. If set to NO, only methods in the interface are
450# included.
451# The default value is: NO.
452
453EXTRACT_LOCAL_METHODS  = NO
454
455# If this flag is set to YES, the members of anonymous namespaces will be
456# extracted and appear in the documentation as a namespace called
457# 'anonymous_namespace{file}', where file will be replaced with the base name of
458# the file that contains the anonymous namespace. By default anonymous namespace
459# are hidden.
460# The default value is: NO.
461
462EXTRACT_ANON_NSPACES   = NO
463
464# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
465# undocumented members inside documented classes or files. If set to NO these
466# members will be included in the various overviews, but no documentation
467# section is generated. This option has no effect if EXTRACT_ALL is enabled.
468# The default value is: NO.
469
470HIDE_UNDOC_MEMBERS     = NO
471
472# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
473# undocumented classes that are normally visible in the class hierarchy. If set
474# to NO, these classes will be included in the various overviews. This option
475# has no effect if EXTRACT_ALL is enabled.
476# The default value is: NO.
477
478HIDE_UNDOC_CLASSES     = NO
479
480# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
481# (class|struct|union) declarations. If set to NO, these declarations will be
482# included in the documentation.
483# The default value is: NO.
484
485HIDE_FRIEND_COMPOUNDS  = NO
486
487# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
488# documentation blocks found inside the body of a function. If set to NO, these
489# blocks will be appended to the function's detailed documentation block.
490# The default value is: NO.
491
492HIDE_IN_BODY_DOCS      = NO
493
494# The INTERNAL_DOCS tag determines if documentation that is typed after a
495# \internal command is included. If the tag is set to NO then the documentation
496# will be excluded. Set it to YES to include the internal documentation.
497# The default value is: NO.
498
499INTERNAL_DOCS          = NO
500
501# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
502# names in lower-case letters. If set to YES, upper-case letters are also
503# allowed. This is useful if you have classes or files whose names only differ
504# in case and if your file system supports case sensitive file names. Windows
505# and Mac users are advised to set this option to NO.
506# The default value is: system dependent.
507
508CASE_SENSE_NAMES       = YES
509
510# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
511# their full class and namespace scopes in the documentation. If set to YES, the
512# scope will be hidden.
513# The default value is: NO.
514
515HIDE_SCOPE_NAMES       = NO
516
517# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
518# append additional text to a page's title, such as Class Reference. If set to
519# YES the compound reference will be hidden.
520# The default value is: NO.
521
522HIDE_COMPOUND_REFERENCE= NO
523
524# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
525# the files that are included by a file in the documentation of that file.
526# The default value is: YES.
527
528SHOW_INCLUDE_FILES     = YES
529
530# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
531# grouped member an include statement to the documentation, telling the reader
532# which file to include in order to use the member.
533# The default value is: NO.
534
535SHOW_GROUPED_MEMB_INC  = NO
536
537# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
538# files with double quotes in the documentation rather than with sharp brackets.
539# The default value is: NO.
540
541FORCE_LOCAL_INCLUDES   = NO
542
543# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
544# documentation for inline members.
545# The default value is: YES.
546
547INLINE_INFO            = YES
548
549# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
550# (detailed) documentation of file and class members alphabetically by member
551# name. If set to NO, the members will appear in declaration order.
552# The default value is: YES.
553
554SORT_MEMBER_DOCS       = YES
555
556# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
557# descriptions of file, namespace and class members alphabetically by member
558# name. If set to NO, the members will appear in declaration order. Note that
559# this will also influence the order of the classes in the class list.
560# The default value is: NO.
561
562SORT_BRIEF_DOCS        = NO
563
564# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
565# (brief and detailed) documentation of class members so that constructors and
566# destructors are listed first. If set to NO the constructors will appear in the
567# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
568# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
569# member documentation.
570# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
571# detailed member documentation.
572# The default value is: NO.
573
574SORT_MEMBERS_CTORS_1ST = NO
575
576# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
577# of group names into alphabetical order. If set to NO the group names will
578# appear in their defined order.
579# The default value is: NO.
580
581SORT_GROUP_NAMES       = NO
582
583# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
584# fully-qualified names, including namespaces. If set to NO, the class list will
585# be sorted only by class name, not including the namespace part.
586# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
587# Note: This option applies only to the class list, not to the alphabetical
588# list.
589# The default value is: NO.
590
591SORT_BY_SCOPE_NAME     = NO
592
593# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
594# type resolution of all parameters of a function it will reject a match between
595# the prototype and the implementation of a member function even if there is
596# only one candidate or it is obvious which candidate to choose by doing a
597# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
598# accept a match between prototype and implementation in such cases.
599# The default value is: NO.
600
601STRICT_PROTO_MATCHING  = NO
602
603# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
604# list. This list is created by putting \todo commands in the documentation.
605# The default value is: YES.
606
607GENERATE_TODOLIST      = YES
608
609# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
610# list. This list is created by putting \test commands in the documentation.
611# The default value is: YES.
612
613GENERATE_TESTLIST      = YES
614
615# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
616# list. This list is created by putting \bug commands in the documentation.
617# The default value is: YES.
618
619GENERATE_BUGLIST       = YES
620
621# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
622# the deprecated list. This list is created by putting \deprecated commands in
623# the documentation.
624# The default value is: YES.
625
626GENERATE_DEPRECATEDLIST= YES
627
628# The ENABLED_SECTIONS tag can be used to enable conditional documentation
629# sections, marked by \if <section_label> ... \endif and \cond <section_label>
630# ... \endcond blocks.
631
632ENABLED_SECTIONS       =
633
634# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
635# initial value of a variable or macro / define can have for it to appear in the
636# documentation. If the initializer consists of more lines than specified here
637# it will be hidden. Use a value of 0 to hide initializers completely. The
638# appearance of the value of individual variables and macros / defines can be
639# controlled using \showinitializer or \hideinitializer command in the
640# documentation regardless of this setting.
641# Minimum value: 0, maximum value: 10000, default value: 30.
642
643MAX_INITIALIZER_LINES  = 30
644
645# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
646# the bottom of the documentation of classes and structs. If set to YES, the
647# list will mention the files that were used to generate the documentation.
648# The default value is: YES.
649
650SHOW_USED_FILES        = YES
651
652# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
653# will remove the Files entry from the Quick Index and from the Folder Tree View
654# (if specified).
655# The default value is: YES.
656
657SHOW_FILES             = YES
658
659# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
660# page. This will remove the Namespaces entry from the Quick Index and from the
661# Folder Tree View (if specified).
662# The default value is: YES.
663
664SHOW_NAMESPACES        = YES
665
666# The FILE_VERSION_FILTER tag can be used to specify a program or script that
667# doxygen should invoke to get the current version for each file (typically from
668# the version control system). Doxygen will invoke the program by executing (via
669# popen()) the command command input-file, where command is the value of the
670# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
671# by doxygen. Whatever the program writes to standard output is used as the file
672# version. For an example see the documentation.
673
674FILE_VERSION_FILTER    =
675
676# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
677# by doxygen. The layout file controls the global structure of the generated
678# output files in an output format independent way. To create the layout file
679# that represents doxygen's defaults, run doxygen with the -l option. You can
680# optionally specify a file name after the option, if omitted DoxygenLayout.xml
681# will be used as the name of the layout file.
682#
683# Note that if you run doxygen from a directory containing a file called
684# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
685# tag is left empty.
686
687LAYOUT_FILE            =
688
689# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
690# the reference definitions. This must be a list of .bib files. The .bib
691# extension is automatically appended if omitted. This requires the bibtex tool
692# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
693# For LaTeX the style of the bibliography can be controlled using
694# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
695# search path. See also \cite for info how to create references.
696
697CITE_BIB_FILES         =
698
699#---------------------------------------------------------------------------
700# Configuration options related to warning and progress messages
701#---------------------------------------------------------------------------
702
703# The QUIET tag can be used to turn on/off the messages that are generated to
704# standard output by doxygen. If QUIET is set to YES this implies that the
705# messages are off.
706# The default value is: NO.
707
708QUIET                  = NO
709
710# The WARNINGS tag can be used to turn on/off the warning messages that are
711# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
712# this implies that the warnings are on.
713#
714# Tip: Turn warnings on while writing the documentation.
715# The default value is: YES.
716
717WARNINGS               = YES
718
719# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
720# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
721# will automatically be disabled.
722# The default value is: YES.
723
724WARN_IF_UNDOCUMENTED   = YES
725
726# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
727# potential errors in the documentation, such as not documenting some parameters
728# in a documented function, or documenting parameters that don't exist or using
729# markup commands wrongly.
730# The default value is: YES.
731
732WARN_IF_DOC_ERROR      = YES
733
734# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
735# are documented, but have no documentation for their parameters or return
736# value. If set to NO, doxygen will only warn about wrong or incomplete
737# parameter documentation, but not about the absence of documentation.
738# The default value is: NO.
739
740WARN_NO_PARAMDOC       = NO
741
742# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
743# a warning is encountered.
744# The default value is: NO.
745
746WARN_AS_ERROR          = NO
747
748# The WARN_FORMAT tag determines the format of the warning messages that doxygen
749# can produce. The string should contain the $file, $line, and $text tags, which
750# will be replaced by the file and line number from which the warning originated
751# and the warning text. Optionally the format may contain $version, which will
752# be replaced by the version of the file (if it could be obtained via
753# FILE_VERSION_FILTER)
754# The default value is: $file:$line: $text.
755
756WARN_FORMAT            = "$file:$line: $text"
757
758# The WARN_LOGFILE tag can be used to specify a file to which warning and error
759# messages should be written. If left blank the output is written to standard
760# error (stderr).
761
762WARN_LOGFILE           =
763
764#---------------------------------------------------------------------------
765# Configuration options related to the input files
766#---------------------------------------------------------------------------
767
768# The INPUT tag is used to specify the files and/or directories that contain
769# documented source files. You may enter file names like myfile.cpp or
770# directories like /usr/src/myproject. Separate the files or directories with
771# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
772# Note: If this tag is empty the current directory is searched.
773
774INPUT                  = include/ src/
775
776# This tag can be used to specify the character encoding of the source files
777# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
778# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
779# documentation (see: http://www.gnu.org/software/libiconv) for the list of
780# possible encodings.
781# The default value is: UTF-8.
782
783INPUT_ENCODING         = UTF-8
784
785# If the value of the INPUT tag contains directories, you can use the
786# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
787# *.h) to filter out the source-files in the directories.
788#
789# Note that for custom extensions or not directly supported extensions you also
790# need to set EXTENSION_MAPPING for the extension otherwise the files are not
791# read by doxygen.
792#
793# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
794# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
795# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
796# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
797# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
798
799FILE_PATTERNS          =
800
801# The RECURSIVE tag can be used to specify whether or not subdirectories should
802# be searched for input files as well.
803# The default value is: NO.
804
805RECURSIVE              = NO
806
807# The EXCLUDE tag can be used to specify files and/or directories that should be
808# excluded from the INPUT source files. This way you can easily exclude a
809# subdirectory from a directory tree whose root is specified with the INPUT tag.
810#
811# Note that relative paths are relative to the directory from which doxygen is
812# run.
813
814EXCLUDE                =
815
816# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
817# directories that are symbolic links (a Unix file system feature) are excluded
818# from the input.
819# The default value is: NO.
820
821EXCLUDE_SYMLINKS       = NO
822
823# If the value of the INPUT tag contains directories, you can use the
824# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
825# certain files from those directories.
826#
827# Note that the wildcards are matched against the file with absolute path, so to
828# exclude all test directories for example use the pattern */test/*
829
830EXCLUDE_PATTERNS       =
831
832# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
833# (namespaces, classes, functions, etc.) that should be excluded from the
834# output. The symbol name can be a fully qualified name, a word, or if the
835# wildcard * is used, a substring. Examples: ANamespace, AClass,
836# AClass::ANamespace, ANamespace::*Test
837#
838# Note that the wildcards are matched against the file with absolute path, so to
839# exclude all test directories use the pattern */test/*
840
841EXCLUDE_SYMBOLS        =
842
843# The EXAMPLE_PATH tag can be used to specify one or more files or directories
844# that contain example code fragments that are included (see the \include
845# command).
846
847EXAMPLE_PATH           =
848
849# If the value of the EXAMPLE_PATH tag contains directories, you can use the
850# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
851# *.h) to filter out the source-files in the directories. If left blank all
852# files are included.
853
854EXAMPLE_PATTERNS       =
855
856# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
857# searched for input files to be used with the \include or \dontinclude commands
858# irrespective of the value of the RECURSIVE tag.
859# The default value is: NO.
860
861EXAMPLE_RECURSIVE      = NO
862
863# The IMAGE_PATH tag can be used to specify one or more files or directories
864# that contain images that are to be included in the documentation (see the
865# \image command).
866
867IMAGE_PATH             =
868
869# The INPUT_FILTER tag can be used to specify a program that doxygen should
870# invoke to filter for each input file. Doxygen will invoke the filter program
871# by executing (via popen()) the command:
872#
873# <filter> <input-file>
874#
875# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
876# name of an input file. Doxygen will then use the output that the filter
877# program writes to standard output. If FILTER_PATTERNS is specified, this tag
878# will be ignored.
879#
880# Note that the filter must not add or remove lines; it is applied before the
881# code is scanned, but not when the output code is generated. If lines are added
882# or removed, the anchors will not be placed correctly.
883#
884# Note that for custom extensions or not directly supported extensions you also
885# need to set EXTENSION_MAPPING for the extension otherwise the files are not
886# properly processed by doxygen.
887
888INPUT_FILTER           =
889
890# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
891# basis. Doxygen will compare the file name with each pattern and apply the
892# filter if there is a match. The filters are a list of the form: pattern=filter
893# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
894# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
895# patterns match the file name, INPUT_FILTER is applied.
896#
897# Note that for custom extensions or not directly supported extensions you also
898# need to set EXTENSION_MAPPING for the extension otherwise the files are not
899# properly processed by doxygen.
900
901FILTER_PATTERNS        =
902
903# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
904# INPUT_FILTER) will also be used to filter the input files that are used for
905# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
906# The default value is: NO.
907
908FILTER_SOURCE_FILES    = NO
909
910# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
911# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
912# it is also possible to disable source filtering for a specific pattern using
913# *.ext= (so without naming a filter).
914# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
915
916FILTER_SOURCE_PATTERNS =
917
918# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
919# is part of the input, its contents will be placed on the main page
920# (index.html). This can be useful if you have a project on for instance GitHub
921# and want to reuse the introduction page also for the doxygen output.
922
923USE_MDFILE_AS_MAINPAGE =
924
925#---------------------------------------------------------------------------
926# Configuration options related to source browsing
927#---------------------------------------------------------------------------
928
929# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
930# generated. Documented entities will be cross-referenced with these sources.
931#
932# Note: To get rid of all source code in the generated output, make sure that
933# also VERBATIM_HEADERS is set to NO.
934# The default value is: NO.
935
936SOURCE_BROWSER         = NO
937
938# Setting the INLINE_SOURCES tag to YES will include the body of functions,
939# classes and enums directly into the documentation.
940# The default value is: NO.
941
942INLINE_SOURCES         = NO
943
944# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
945# special comment blocks from generated source code fragments. Normal C, C++ and
946# Fortran comments will always remain visible.
947# The default value is: YES.
948
949STRIP_CODE_COMMENTS    = YES
950
951# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
952# function all documented functions referencing it will be listed.
953# The default value is: NO.
954
955REFERENCED_BY_RELATION = NO
956
957# If the REFERENCES_RELATION tag is set to YES then for each documented function
958# all documented entities called/used by that function will be listed.
959# The default value is: NO.
960
961REFERENCES_RELATION    = NO
962
963# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
964# to YES then the hyperlinks from functions in REFERENCES_RELATION and
965# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
966# link to the documentation.
967# The default value is: YES.
968
969REFERENCES_LINK_SOURCE = YES
970
971# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
972# source code will show a tooltip with additional information such as prototype,
973# brief description and links to the definition and documentation. Since this
974# will make the HTML file larger and loading of large files a bit slower, you
975# can opt to disable this feature.
976# The default value is: YES.
977# This tag requires that the tag SOURCE_BROWSER is set to YES.
978
979SOURCE_TOOLTIPS        = YES
980
981# If the USE_HTAGS tag is set to YES then the references to source code will
982# point to the HTML generated by the htags(1) tool instead of doxygen built-in
983# source browser. The htags tool is part of GNU's global source tagging system
984# (see http://www.gnu.org/software/global/global.html). You will need version
985# 4.8.6 or higher.
986#
987# To use it do the following:
988# - Install the latest version of global
989# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
990# - Make sure the INPUT points to the root of the source tree
991# - Run doxygen as normal
992#
993# Doxygen will invoke htags (and that will in turn invoke gtags), so these
994# tools must be available from the command line (i.e. in the search path).
995#
996# The result: instead of the source browser generated by doxygen, the links to
997# source code will now point to the output of htags.
998# The default value is: NO.
999# This tag requires that the tag SOURCE_BROWSER is set to YES.
1000
1001USE_HTAGS              = NO
1002
1003# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1004# verbatim copy of the header file for each class for which an include is
1005# specified. Set to NO to disable this.
1006# See also: Section \class.
1007# The default value is: YES.
1008
1009VERBATIM_HEADERS       = YES
1010
1011# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1012# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1013# cost of reduced performance. This can be particularly helpful with template
1014# rich C++ code for which doxygen's built-in parser lacks the necessary type
1015# information.
1016# Note: The availability of this option depends on whether or not doxygen was
1017# generated with the -Duse-libclang=ON option for CMake.
1018# The default value is: NO.
1019
1020CLANG_ASSISTED_PARSING = NO
1021
1022# If clang assisted parsing is enabled you can provide the compiler with command
1023# line options that you would normally use when invoking the compiler. Note that
1024# the include paths will already be set by doxygen for the files and directories
1025# specified with INPUT and INCLUDE_PATH.
1026# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1027
1028CLANG_OPTIONS          =
1029
1030#---------------------------------------------------------------------------
1031# Configuration options related to the alphabetical class index
1032#---------------------------------------------------------------------------
1033
1034# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1035# compounds will be generated. Enable this if the project contains a lot of
1036# classes, structs, unions or interfaces.
1037# The default value is: YES.
1038
1039ALPHABETICAL_INDEX     = YES
1040
1041# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1042# which the alphabetical index list will be split.
1043# Minimum value: 1, maximum value: 20, default value: 5.
1044# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1045
1046COLS_IN_ALPHA_INDEX    = 5
1047
1048# In case all classes in a project start with a common prefix, all classes will
1049# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1050# can be used to specify a prefix (or a list of prefixes) that should be ignored
1051# while generating the index headers.
1052# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1053
1054IGNORE_PREFIX          =
1055
1056#---------------------------------------------------------------------------
1057# Configuration options related to the HTML output
1058#---------------------------------------------------------------------------
1059
1060# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1061# The default value is: YES.
1062
1063GENERATE_HTML          = YES
1064
1065# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1066# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1067# it.
1068# The default directory is: html.
1069# This tag requires that the tag GENERATE_HTML is set to YES.
1070
1071HTML_OUTPUT            = html
1072
1073# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1074# generated HTML page (for example: .htm, .php, .asp).
1075# The default value is: .html.
1076# This tag requires that the tag GENERATE_HTML is set to YES.
1077
1078HTML_FILE_EXTENSION    = .html
1079
1080# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1081# each generated HTML page. If the tag is left blank doxygen will generate a
1082# standard header.
1083#
1084# To get valid HTML the header file that includes any scripts and style sheets
1085# that doxygen needs, which is dependent on the configuration options used (e.g.
1086# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1087# default header using
1088# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1089# YourConfigFile
1090# and then modify the file new_header.html. See also section "Doxygen usage"
1091# for information on how to generate the default header that doxygen normally
1092# uses.
1093# Note: The header is subject to change so you typically have to regenerate the
1094# default header when upgrading to a newer version of doxygen. For a description
1095# of the possible markers and block names see the documentation.
1096# This tag requires that the tag GENERATE_HTML is set to YES.
1097
1098HTML_HEADER            =
1099
1100# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1101# generated HTML page. If the tag is left blank doxygen will generate a standard
1102# footer. See HTML_HEADER for more information on how to generate a default
1103# footer and what special commands can be used inside the footer. See also
1104# section "Doxygen usage" for information on how to generate the default footer
1105# that doxygen normally uses.
1106# This tag requires that the tag GENERATE_HTML is set to YES.
1107
1108HTML_FOOTER            =
1109
1110# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1111# sheet that is used by each HTML page. It can be used to fine-tune the look of
1112# the HTML output. If left blank doxygen will generate a default style sheet.
1113# See also section "Doxygen usage" for information on how to generate the style
1114# sheet that doxygen normally uses.
1115# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1116# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1117# obsolete.
1118# This tag requires that the tag GENERATE_HTML is set to YES.
1119
1120HTML_STYLESHEET        =
1121
1122# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1123# cascading style sheets that are included after the standard style sheets
1124# created by doxygen. Using this option one can overrule certain style aspects.
1125# This is preferred over using HTML_STYLESHEET since it does not replace the
1126# standard style sheet and is therefore more robust against future updates.
1127# Doxygen will copy the style sheet files to the output directory.
1128# Note: The order of the extra style sheet files is of importance (e.g. the last
1129# style sheet in the list overrules the setting of the previous ones in the
1130# list). For an example see the documentation.
1131# This tag requires that the tag GENERATE_HTML is set to YES.
1132
1133HTML_EXTRA_STYLESHEET  =
1134
1135# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1136# other source files which should be copied to the HTML output directory. Note
1137# that these files will be copied to the base HTML output directory. Use the
1138# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1139# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1140# files will be copied as-is; there are no commands or markers available.
1141# This tag requires that the tag GENERATE_HTML is set to YES.
1142
1143HTML_EXTRA_FILES       =
1144
1145# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1146# will adjust the colors in the style sheet and background images according to
1147# this color. Hue is specified as an angle on a colorwheel, see
1148# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1149# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1150# purple, and 360 is red again.
1151# Minimum value: 0, maximum value: 359, default value: 220.
1152# This tag requires that the tag GENERATE_HTML is set to YES.
1153
1154HTML_COLORSTYLE_HUE    = 220
1155
1156# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1157# in the HTML output. For a value of 0 the output will use grayscales only. A
1158# value of 255 will produce the most vivid colors.
1159# Minimum value: 0, maximum value: 255, default value: 100.
1160# This tag requires that the tag GENERATE_HTML is set to YES.
1161
1162HTML_COLORSTYLE_SAT    = 100
1163
1164# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1165# luminance component of the colors in the HTML output. Values below 100
1166# gradually make the output lighter, whereas values above 100 make the output
1167# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1168# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1169# change the gamma.
1170# Minimum value: 40, maximum value: 240, default value: 80.
1171# This tag requires that the tag GENERATE_HTML is set to YES.
1172
1173HTML_COLORSTYLE_GAMMA  = 80
1174
1175# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1176# page will contain the date and time when the page was generated. Setting this
1177# to YES can help to show when doxygen was last run and thus if the
1178# documentation is up to date.
1179# The default value is: NO.
1180# This tag requires that the tag GENERATE_HTML is set to YES.
1181
1182HTML_TIMESTAMP         = NO
1183
1184# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1185# documentation will contain sections that can be hidden and shown after the
1186# page has loaded.
1187# The default value is: NO.
1188# This tag requires that the tag GENERATE_HTML is set to YES.
1189
1190HTML_DYNAMIC_SECTIONS  = NO
1191
1192# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1193# shown in the various tree structured indices initially; the user can expand
1194# and collapse entries dynamically later on. Doxygen will expand the tree to
1195# such a level that at most the specified number of entries are visible (unless
1196# a fully collapsed tree already exceeds this amount). So setting the number of
1197# entries 1 will produce a full collapsed tree by default. 0 is a special value
1198# representing an infinite number of entries and will result in a full expanded
1199# tree by default.
1200# Minimum value: 0, maximum value: 9999, default value: 100.
1201# This tag requires that the tag GENERATE_HTML is set to YES.
1202
1203HTML_INDEX_NUM_ENTRIES = 100
1204
1205# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1206# generated that can be used as input for Apple's Xcode 3 integrated development
1207# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1208# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1209# Makefile in the HTML output directory. Running make will produce the docset in
1210# that directory and running make install will install the docset in
1211# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1212# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1213# for more information.
1214# The default value is: NO.
1215# This tag requires that the tag GENERATE_HTML is set to YES.
1216
1217GENERATE_DOCSET        = NO
1218
1219# This tag determines the name of the docset feed. A documentation feed provides
1220# an umbrella under which multiple documentation sets from a single provider
1221# (such as a company or product suite) can be grouped.
1222# The default value is: Doxygen generated docs.
1223# This tag requires that the tag GENERATE_DOCSET is set to YES.
1224
1225DOCSET_FEEDNAME        = "Doxygen generated docs"
1226
1227# This tag specifies a string that should uniquely identify the documentation
1228# set bundle. This should be a reverse domain-name style string, e.g.
1229# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1230# The default value is: org.doxygen.Project.
1231# This tag requires that the tag GENERATE_DOCSET is set to YES.
1232
1233DOCSET_BUNDLE_ID       = org.doxygen.Project
1234
1235# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1236# the documentation publisher. This should be a reverse domain-name style
1237# string, e.g. com.mycompany.MyDocSet.documentation.
1238# The default value is: org.doxygen.Publisher.
1239# This tag requires that the tag GENERATE_DOCSET is set to YES.
1240
1241DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1242
1243# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1244# The default value is: Publisher.
1245# This tag requires that the tag GENERATE_DOCSET is set to YES.
1246
1247DOCSET_PUBLISHER_NAME  = Publisher
1248
1249# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1250# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1251# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1252# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1253# Windows.
1254#
1255# The HTML Help Workshop contains a compiler that can convert all HTML output
1256# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1257# files are now used as the Windows 98 help format, and will replace the old
1258# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1259# HTML files also contain an index, a table of contents, and you can search for
1260# words in the documentation. The HTML workshop also contains a viewer for
1261# compressed HTML files.
1262# The default value is: NO.
1263# This tag requires that the tag GENERATE_HTML is set to YES.
1264
1265GENERATE_HTMLHELP      = NO
1266
1267# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1268# file. You can add a path in front of the file if the result should not be
1269# written to the html output directory.
1270# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271
1272CHM_FILE               =
1273
1274# The HHC_LOCATION tag can be used to specify the location (absolute path
1275# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1276# doxygen will try to run the HTML help compiler on the generated index.hhp.
1277# The file has to be specified with full path.
1278# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1279
1280HHC_LOCATION           =
1281
1282# The GENERATE_CHI flag controls if a separate .chi index file is generated
1283# (YES) or that it should be included in the master .chm file (NO).
1284# The default value is: NO.
1285# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1286
1287GENERATE_CHI           = NO
1288
1289# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1290# and project file content.
1291# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1292
1293CHM_INDEX_ENCODING     =
1294
1295# The BINARY_TOC flag controls whether a binary table of contents is generated
1296# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1297# enables the Previous and Next buttons.
1298# The default value is: NO.
1299# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1300
1301BINARY_TOC             = NO
1302
1303# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1304# the table of contents of the HTML help documentation and to the tree view.
1305# The default value is: NO.
1306# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1307
1308TOC_EXPAND             = NO
1309
1310# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1311# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1312# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1313# (.qch) of the generated HTML documentation.
1314# The default value is: NO.
1315# This tag requires that the tag GENERATE_HTML is set to YES.
1316
1317GENERATE_QHP           = NO
1318
1319# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1320# the file name of the resulting .qch file. The path specified is relative to
1321# the HTML output folder.
1322# This tag requires that the tag GENERATE_QHP is set to YES.
1323
1324QCH_FILE               =
1325
1326# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1327# Project output. For more information please see Qt Help Project / Namespace
1328# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1329# The default value is: org.doxygen.Project.
1330# This tag requires that the tag GENERATE_QHP is set to YES.
1331
1332QHP_NAMESPACE          = org.doxygen.Project
1333
1334# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1335# Help Project output. For more information please see Qt Help Project / Virtual
1336# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1337# folders).
1338# The default value is: doc.
1339# This tag requires that the tag GENERATE_QHP is set to YES.
1340
1341QHP_VIRTUAL_FOLDER     = doc
1342
1343# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1344# filter to add. For more information please see Qt Help Project / Custom
1345# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1346# filters).
1347# This tag requires that the tag GENERATE_QHP is set to YES.
1348
1349QHP_CUST_FILTER_NAME   =
1350
1351# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1352# custom filter to add. For more information please see Qt Help Project / Custom
1353# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1354# filters).
1355# This tag requires that the tag GENERATE_QHP is set to YES.
1356
1357QHP_CUST_FILTER_ATTRS  =
1358
1359# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1360# project's filter section matches. Qt Help Project / Filter Attributes (see:
1361# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1362# This tag requires that the tag GENERATE_QHP is set to YES.
1363
1364QHP_SECT_FILTER_ATTRS  =
1365
1366# The QHG_LOCATION tag can be used to specify the location of Qt's
1367# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1368# generated .qhp file.
1369# This tag requires that the tag GENERATE_QHP is set to YES.
1370
1371QHG_LOCATION           =
1372
1373# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1374# generated, together with the HTML files, they form an Eclipse help plugin. To
1375# install this plugin and make it available under the help contents menu in
1376# Eclipse, the contents of the directory containing the HTML and XML files needs
1377# to be copied into the plugins directory of eclipse. The name of the directory
1378# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1379# After copying Eclipse needs to be restarted before the help appears.
1380# The default value is: NO.
1381# This tag requires that the tag GENERATE_HTML is set to YES.
1382
1383GENERATE_ECLIPSEHELP   = NO
1384
1385# A unique identifier for the Eclipse help plugin. When installing the plugin
1386# the directory name containing the HTML and XML files should also have this
1387# name. Each documentation set should have its own identifier.
1388# The default value is: org.doxygen.Project.
1389# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1390
1391ECLIPSE_DOC_ID         = org.doxygen.Project
1392
1393# If you want full control over the layout of the generated HTML pages it might
1394# be necessary to disable the index and replace it with your own. The
1395# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1396# of each HTML page. A value of NO enables the index and the value YES disables
1397# it. Since the tabs in the index contain the same information as the navigation
1398# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1399# The default value is: NO.
1400# This tag requires that the tag GENERATE_HTML is set to YES.
1401
1402DISABLE_INDEX          = NO
1403
1404# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1405# structure should be generated to display hierarchical information. If the tag
1406# value is set to YES, a side panel will be generated containing a tree-like
1407# index structure (just like the one that is generated for HTML Help). For this
1408# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1409# (i.e. any modern browser). Windows users are probably better off using the
1410# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1411# further fine-tune the look of the index. As an example, the default style
1412# sheet generated by doxygen has an example that shows how to put an image at
1413# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1414# the same information as the tab index, you could consider setting
1415# DISABLE_INDEX to YES when enabling this option.
1416# The default value is: NO.
1417# This tag requires that the tag GENERATE_HTML is set to YES.
1418
1419GENERATE_TREEVIEW      = NO
1420
1421# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1422# doxygen will group on one line in the generated HTML documentation.
1423#
1424# Note that a value of 0 will completely suppress the enum values from appearing
1425# in the overview section.
1426# Minimum value: 0, maximum value: 20, default value: 4.
1427# This tag requires that the tag GENERATE_HTML is set to YES.
1428
1429ENUM_VALUES_PER_LINE   = 4
1430
1431# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1432# to set the initial width (in pixels) of the frame in which the tree is shown.
1433# Minimum value: 0, maximum value: 1500, default value: 250.
1434# This tag requires that the tag GENERATE_HTML is set to YES.
1435
1436TREEVIEW_WIDTH         = 250
1437
1438# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1439# external symbols imported via tag files in a separate window.
1440# The default value is: NO.
1441# This tag requires that the tag GENERATE_HTML is set to YES.
1442
1443EXT_LINKS_IN_WINDOW    = NO
1444
1445# Use this tag to change the font size of LaTeX formulas included as images in
1446# the HTML documentation. When you change the font size after a successful
1447# doxygen run you need to manually remove any form_*.png images from the HTML
1448# output directory to force them to be regenerated.
1449# Minimum value: 8, maximum value: 50, default value: 10.
1450# This tag requires that the tag GENERATE_HTML is set to YES.
1451
1452FORMULA_FONTSIZE       = 10
1453
1454# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1455# generated for formulas are transparent PNGs. Transparent PNGs are not
1456# supported properly for IE 6.0, but are supported on all modern browsers.
1457#
1458# Note that when changing this option you need to delete any form_*.png files in
1459# the HTML output directory before the changes have effect.
1460# The default value is: YES.
1461# This tag requires that the tag GENERATE_HTML is set to YES.
1462
1463FORMULA_TRANSPARENT    = YES
1464
1465# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1466# http://www.mathjax.org) which uses client side Javascript for the rendering
1467# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1468# installed or if you want to formulas look prettier in the HTML output. When
1469# enabled you may also need to install MathJax separately and configure the path
1470# to it using the MATHJAX_RELPATH option.
1471# The default value is: NO.
1472# This tag requires that the tag GENERATE_HTML is set to YES.
1473
1474USE_MATHJAX            = NO
1475
1476# When MathJax is enabled you can set the default output format to be used for
1477# the MathJax output. See the MathJax site (see:
1478# http://docs.mathjax.org/en/latest/output.html) for more details.
1479# Possible values are: HTML-CSS (which is slower, but has the best
1480# compatibility), NativeMML (i.e. MathML) and SVG.
1481# The default value is: HTML-CSS.
1482# This tag requires that the tag USE_MATHJAX is set to YES.
1483
1484MATHJAX_FORMAT         = HTML-CSS
1485
1486# When MathJax is enabled you need to specify the location relative to the HTML
1487# output directory using the MATHJAX_RELPATH option. The destination directory
1488# should contain the MathJax.js script. For instance, if the mathjax directory
1489# is located at the same level as the HTML output directory, then
1490# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1491# Content Delivery Network so you can quickly see the result without installing
1492# MathJax. However, it is strongly recommended to install a local copy of
1493# MathJax from http://www.mathjax.org before deployment.
1494# The default value is: http://cdn.mathjax.org/mathjax/latest.
1495# This tag requires that the tag USE_MATHJAX is set to YES.
1496
1497MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1498
1499# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1500# extension names that should be enabled during MathJax rendering. For example
1501# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1502# This tag requires that the tag USE_MATHJAX is set to YES.
1503
1504MATHJAX_EXTENSIONS     =
1505
1506# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1507# of code that will be used on startup of the MathJax code. See the MathJax site
1508# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1509# example see the documentation.
1510# This tag requires that the tag USE_MATHJAX is set to YES.
1511
1512MATHJAX_CODEFILE       =
1513
1514# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1515# the HTML output. The underlying search engine uses javascript and DHTML and
1516# should work on any modern browser. Note that when using HTML help
1517# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1518# there is already a search function so this one should typically be disabled.
1519# For large projects the javascript based search engine can be slow, then
1520# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1521# search using the keyboard; to jump to the search box use <access key> + S
1522# (what the <access key> is depends on the OS and browser, but it is typically
1523# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1524# key> to jump into the search results window, the results can be navigated
1525# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1526# the search. The filter options can be selected when the cursor is inside the
1527# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1528# to select a filter and <Enter> or <escape> to activate or cancel the filter
1529# option.
1530# The default value is: YES.
1531# This tag requires that the tag GENERATE_HTML is set to YES.
1532
1533SEARCHENGINE           = YES
1534
1535# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1536# implemented using a web server instead of a web client using Javascript. There
1537# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1538# setting. When disabled, doxygen will generate a PHP script for searching and
1539# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1540# and searching needs to be provided by external tools. See the section
1541# "External Indexing and Searching" for details.
1542# The default value is: NO.
1543# This tag requires that the tag SEARCHENGINE is set to YES.
1544
1545SERVER_BASED_SEARCH    = NO
1546
1547# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1548# script for searching. Instead the search results are written to an XML file
1549# which needs to be processed by an external indexer. Doxygen will invoke an
1550# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1551# search results.
1552#
1553# Doxygen ships with an example indexer (doxyindexer) and search engine
1554# (doxysearch.cgi) which are based on the open source search engine library
1555# Xapian (see: http://xapian.org/).
1556#
1557# See the section "External Indexing and Searching" for details.
1558# The default value is: NO.
1559# This tag requires that the tag SEARCHENGINE is set to YES.
1560
1561EXTERNAL_SEARCH        = NO
1562
1563# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1564# which will return the search results when EXTERNAL_SEARCH is enabled.
1565#
1566# Doxygen ships with an example indexer (doxyindexer) and search engine
1567# (doxysearch.cgi) which are based on the open source search engine library
1568# Xapian (see: http://xapian.org/). See the section "External Indexing and
1569# Searching" for details.
1570# This tag requires that the tag SEARCHENGINE is set to YES.
1571
1572SEARCHENGINE_URL       =
1573
1574# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1575# search data is written to a file for indexing by an external tool. With the
1576# SEARCHDATA_FILE tag the name of this file can be specified.
1577# The default file is: searchdata.xml.
1578# This tag requires that the tag SEARCHENGINE is set to YES.
1579
1580SEARCHDATA_FILE        = searchdata.xml
1581
1582# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1583# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1584# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1585# projects and redirect the results back to the right project.
1586# This tag requires that the tag SEARCHENGINE is set to YES.
1587
1588EXTERNAL_SEARCH_ID     =
1589
1590# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1591# projects other than the one defined by this configuration file, but that are
1592# all added to the same external search index. Each project needs to have a
1593# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1594# to a relative location where the documentation can be found. The format is:
1595# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1596# This tag requires that the tag SEARCHENGINE is set to YES.
1597
1598EXTRA_SEARCH_MAPPINGS  =
1599
1600#---------------------------------------------------------------------------
1601# Configuration options related to the LaTeX output
1602#---------------------------------------------------------------------------
1603
1604# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1605# The default value is: YES.
1606
1607GENERATE_LATEX         = YES
1608
1609# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1610# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1611# it.
1612# The default directory is: latex.
1613# This tag requires that the tag GENERATE_LATEX is set to YES.
1614
1615LATEX_OUTPUT           = latex
1616
1617# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1618# invoked.
1619#
1620# Note that when enabling USE_PDFLATEX this option is only used for generating
1621# bitmaps for formulas in the HTML output, but not in the Makefile that is
1622# written to the output directory.
1623# The default file is: latex.
1624# This tag requires that the tag GENERATE_LATEX is set to YES.
1625
1626LATEX_CMD_NAME         = latex
1627
1628# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1629# index for LaTeX.
1630# The default file is: makeindex.
1631# This tag requires that the tag GENERATE_LATEX is set to YES.
1632
1633MAKEINDEX_CMD_NAME     = makeindex
1634
1635# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1636# documents. This may be useful for small projects and may help to save some
1637# trees in general.
1638# The default value is: NO.
1639# This tag requires that the tag GENERATE_LATEX is set to YES.
1640
1641COMPACT_LATEX          = NO
1642
1643# The PAPER_TYPE tag can be used to set the paper type that is used by the
1644# printer.
1645# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1646# 14 inches) and executive (7.25 x 10.5 inches).
1647# The default value is: a4.
1648# This tag requires that the tag GENERATE_LATEX is set to YES.
1649
1650PAPER_TYPE             = a4
1651
1652# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1653# that should be included in the LaTeX output. The package can be specified just
1654# by its name or with the correct syntax as to be used with the LaTeX
1655# \usepackage command. To get the times font for instance you can specify :
1656# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1657# To use the option intlimits with the amsmath package you can specify:
1658# EXTRA_PACKAGES=[intlimits]{amsmath}
1659# If left blank no extra packages will be included.
1660# This tag requires that the tag GENERATE_LATEX is set to YES.
1661
1662EXTRA_PACKAGES         =
1663
1664# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1665# generated LaTeX document. The header should contain everything until the first
1666# chapter. If it is left blank doxygen will generate a standard header. See
1667# section "Doxygen usage" for information on how to let doxygen write the
1668# default header to a separate file.
1669#
1670# Note: Only use a user-defined header if you know what you are doing! The
1671# following commands have a special meaning inside the header: $title,
1672# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1673# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1674# string, for the replacement values of the other commands the user is referred
1675# to HTML_HEADER.
1676# This tag requires that the tag GENERATE_LATEX is set to YES.
1677
1678LATEX_HEADER           =
1679
1680# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1681# generated LaTeX document. The footer should contain everything after the last
1682# chapter. If it is left blank doxygen will generate a standard footer. See
1683# LATEX_HEADER for more information on how to generate a default footer and what
1684# special commands can be used inside the footer.
1685#
1686# Note: Only use a user-defined footer if you know what you are doing!
1687# This tag requires that the tag GENERATE_LATEX is set to YES.
1688
1689LATEX_FOOTER           =
1690
1691# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1692# LaTeX style sheets that are included after the standard style sheets created
1693# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1694# will copy the style sheet files to the output directory.
1695# Note: The order of the extra style sheet files is of importance (e.g. the last
1696# style sheet in the list overrules the setting of the previous ones in the
1697# list).
1698# This tag requires that the tag GENERATE_LATEX is set to YES.
1699
1700LATEX_EXTRA_STYLESHEET =
1701
1702# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1703# other source files which should be copied to the LATEX_OUTPUT output
1704# directory. Note that the files will be copied as-is; there are no commands or
1705# markers available.
1706# This tag requires that the tag GENERATE_LATEX is set to YES.
1707
1708LATEX_EXTRA_FILES      =
1709
1710# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1711# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1712# contain links (just like the HTML output) instead of page references. This
1713# makes the output suitable for online browsing using a PDF viewer.
1714# The default value is: YES.
1715# This tag requires that the tag GENERATE_LATEX is set to YES.
1716
1717PDF_HYPERLINKS         = YES
1718
1719# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1720# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1721# higher quality PDF documentation.
1722# The default value is: YES.
1723# This tag requires that the tag GENERATE_LATEX is set to YES.
1724
1725USE_PDFLATEX           = YES
1726
1727# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1728# command to the generated LaTeX files. This will instruct LaTeX to keep running
1729# if errors occur, instead of asking the user for help. This option is also used
1730# when generating formulas in HTML.
1731# The default value is: NO.
1732# This tag requires that the tag GENERATE_LATEX is set to YES.
1733
1734LATEX_BATCHMODE        = NO
1735
1736# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1737# index chapters (such as File Index, Compound Index, etc.) in the output.
1738# The default value is: NO.
1739# This tag requires that the tag GENERATE_LATEX is set to YES.
1740
1741LATEX_HIDE_INDICES     = NO
1742
1743# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1744# code with syntax highlighting in the LaTeX output.
1745#
1746# Note that which sources are shown also depends on other settings such as
1747# SOURCE_BROWSER.
1748# The default value is: NO.
1749# This tag requires that the tag GENERATE_LATEX is set to YES.
1750
1751LATEX_SOURCE_CODE      = NO
1752
1753# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1754# bibliography, e.g. plainnat, or ieeetr. See
1755# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1756# The default value is: plain.
1757# This tag requires that the tag GENERATE_LATEX is set to YES.
1758
1759LATEX_BIB_STYLE        = plain
1760
1761# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1762# page will contain the date and time when the page was generated. Setting this
1763# to NO can help when comparing the output of multiple runs.
1764# The default value is: NO.
1765# This tag requires that the tag GENERATE_LATEX is set to YES.
1766
1767LATEX_TIMESTAMP        = NO
1768
1769#---------------------------------------------------------------------------
1770# Configuration options related to the RTF output
1771#---------------------------------------------------------------------------
1772
1773# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1774# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1775# readers/editors.
1776# The default value is: NO.
1777
1778GENERATE_RTF           = NO
1779
1780# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1781# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1782# it.
1783# The default directory is: rtf.
1784# This tag requires that the tag GENERATE_RTF is set to YES.
1785
1786RTF_OUTPUT             = rtf
1787
1788# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1789# documents. This may be useful for small projects and may help to save some
1790# trees in general.
1791# The default value is: NO.
1792# This tag requires that the tag GENERATE_RTF is set to YES.
1793
1794COMPACT_RTF            = NO
1795
1796# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1797# contain hyperlink fields. The RTF file will contain links (just like the HTML
1798# output) instead of page references. This makes the output suitable for online
1799# browsing using Word or some other Word compatible readers that support those
1800# fields.
1801#
1802# Note: WordPad (write) and others do not support links.
1803# The default value is: NO.
1804# This tag requires that the tag GENERATE_RTF is set to YES.
1805
1806RTF_HYPERLINKS         = NO
1807
1808# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1809# file, i.e. a series of assignments. You only have to provide replacements,
1810# missing definitions are set to their default value.
1811#
1812# See also section "Doxygen usage" for information on how to generate the
1813# default style sheet that doxygen normally uses.
1814# This tag requires that the tag GENERATE_RTF is set to YES.
1815
1816RTF_STYLESHEET_FILE    =
1817
1818# Set optional variables used in the generation of an RTF document. Syntax is
1819# similar to doxygen's config file. A template extensions file can be generated
1820# using doxygen -e rtf extensionFile.
1821# This tag requires that the tag GENERATE_RTF is set to YES.
1822
1823RTF_EXTENSIONS_FILE    =
1824
1825# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1826# with syntax highlighting in the RTF output.
1827#
1828# Note that which sources are shown also depends on other settings such as
1829# SOURCE_BROWSER.
1830# The default value is: NO.
1831# This tag requires that the tag GENERATE_RTF is set to YES.
1832
1833RTF_SOURCE_CODE        = NO
1834
1835#---------------------------------------------------------------------------
1836# Configuration options related to the man page output
1837#---------------------------------------------------------------------------
1838
1839# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1840# classes and files.
1841# The default value is: NO.
1842
1843GENERATE_MAN           = NO
1844
1845# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1846# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1847# it. A directory man3 will be created inside the directory specified by
1848# MAN_OUTPUT.
1849# The default directory is: man.
1850# This tag requires that the tag GENERATE_MAN is set to YES.
1851
1852MAN_OUTPUT             = man
1853
1854# The MAN_EXTENSION tag determines the extension that is added to the generated
1855# man pages. In case the manual section does not start with a number, the number
1856# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1857# optional.
1858# The default value is: .3.
1859# This tag requires that the tag GENERATE_MAN is set to YES.
1860
1861MAN_EXTENSION          = .3
1862
1863# The MAN_SUBDIR tag determines the name of the directory created within
1864# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1865# MAN_EXTENSION with the initial . removed.
1866# This tag requires that the tag GENERATE_MAN is set to YES.
1867
1868MAN_SUBDIR             =
1869
1870# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1871# will generate one additional man file for each entity documented in the real
1872# man page(s). These additional files only source the real man page, but without
1873# them the man command would be unable to find the correct page.
1874# The default value is: NO.
1875# This tag requires that the tag GENERATE_MAN is set to YES.
1876
1877MAN_LINKS              = NO
1878
1879#---------------------------------------------------------------------------
1880# Configuration options related to the XML output
1881#---------------------------------------------------------------------------
1882
1883# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1884# captures the structure of the code including all documentation.
1885# The default value is: NO.
1886
1887GENERATE_XML           = NO
1888
1889# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1890# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1891# it.
1892# The default directory is: xml.
1893# This tag requires that the tag GENERATE_XML is set to YES.
1894
1895XML_OUTPUT             = xml
1896
1897# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1898# listings (including syntax highlighting and cross-referencing information) to
1899# the XML output. Note that enabling this will significantly increase the size
1900# of the XML output.
1901# The default value is: YES.
1902# This tag requires that the tag GENERATE_XML is set to YES.
1903
1904XML_PROGRAMLISTING     = YES
1905
1906#---------------------------------------------------------------------------
1907# Configuration options related to the DOCBOOK output
1908#---------------------------------------------------------------------------
1909
1910# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1911# that can be used to generate PDF.
1912# The default value is: NO.
1913
1914GENERATE_DOCBOOK       = NO
1915
1916# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1917# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1918# front of it.
1919# The default directory is: docbook.
1920# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1921
1922DOCBOOK_OUTPUT         = docbook
1923
1924# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1925# program listings (including syntax highlighting and cross-referencing
1926# information) to the DOCBOOK output. Note that enabling this will significantly
1927# increase the size of the DOCBOOK output.
1928# The default value is: NO.
1929# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1930
1931DOCBOOK_PROGRAMLISTING = NO
1932
1933#---------------------------------------------------------------------------
1934# Configuration options for the AutoGen Definitions output
1935#---------------------------------------------------------------------------
1936
1937# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1938# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1939# structure of the code including all documentation. Note that this feature is
1940# still experimental and incomplete at the moment.
1941# The default value is: NO.
1942
1943GENERATE_AUTOGEN_DEF   = NO
1944
1945#---------------------------------------------------------------------------
1946# Configuration options related to the Perl module output
1947#---------------------------------------------------------------------------
1948
1949# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1950# file that captures the structure of the code including all documentation.
1951#
1952# Note that this feature is still experimental and incomplete at the moment.
1953# The default value is: NO.
1954
1955GENERATE_PERLMOD       = NO
1956
1957# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1958# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1959# output from the Perl module output.
1960# The default value is: NO.
1961# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1962
1963PERLMOD_LATEX          = NO
1964
1965# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1966# formatted so it can be parsed by a human reader. This is useful if you want to
1967# understand what is going on. On the other hand, if this tag is set to NO, the
1968# size of the Perl module output will be much smaller and Perl will parse it
1969# just the same.
1970# The default value is: YES.
1971# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1972
1973PERLMOD_PRETTY         = YES
1974
1975# The names of the make variables in the generated doxyrules.make file are
1976# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1977# so different doxyrules.make files included by the same Makefile don't
1978# overwrite each other's variables.
1979# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1980
1981PERLMOD_MAKEVAR_PREFIX =
1982
1983#---------------------------------------------------------------------------
1984# Configuration options related to the preprocessor
1985#---------------------------------------------------------------------------
1986
1987# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1988# C-preprocessor directives found in the sources and include files.
1989# The default value is: YES.
1990
1991ENABLE_PREPROCESSING   = YES
1992
1993# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1994# in the source code. If set to NO, only conditional compilation will be
1995# performed. Macro expansion can be done in a controlled way by setting
1996# EXPAND_ONLY_PREDEF to YES.
1997# The default value is: NO.
1998# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1999
2000MACRO_EXPANSION        = NO
2001
2002# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2003# the macro expansion is limited to the macros specified with the PREDEFINED and
2004# EXPAND_AS_DEFINED tags.
2005# The default value is: NO.
2006# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2007
2008EXPAND_ONLY_PREDEF     = NO
2009
2010# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2011# INCLUDE_PATH will be searched if a #include is found.
2012# The default value is: YES.
2013# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2014
2015SEARCH_INCLUDES        = YES
2016
2017# The INCLUDE_PATH tag can be used to specify one or more directories that
2018# contain include files that are not input files but should be processed by the
2019# preprocessor.
2020# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2021
2022INCLUDE_PATH           =
2023
2024# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2025# patterns (like *.h and *.hpp) to filter out the header-files in the
2026# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2027# used.
2028# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2029
2030INCLUDE_FILE_PATTERNS  =
2031
2032# The PREDEFINED tag can be used to specify one or more macro names that are
2033# defined before the preprocessor is started (similar to the -D option of e.g.
2034# gcc). The argument of the tag is a list of macros of the form: name or
2035# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2036# is assumed. To prevent a macro definition from being undefined via #undef or
2037# recursively expanded use the := operator instead of the = operator.
2038# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2039
2040PREDEFINED             = HAVE_APR_MEMCACHE=@have_apr_memcache@
2041
2042# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2043# tag can be used to specify a list of macro names that should be expanded. The
2044# macro definition that is found in the sources will be used. Use the PREDEFINED
2045# tag if you want to use a different macro definition that overrules the
2046# definition found in the source code.
2047# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2048
2049EXPAND_AS_DEFINED      =
2050
2051# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2052# remove all references to function-like macros that are alone on a line, have
2053# an all uppercase name, and do not end with a semicolon. Such function macros
2054# are typically used for boiler-plate code, and will confuse the parser if not
2055# removed.
2056# The default value is: YES.
2057# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2058
2059SKIP_FUNCTION_MACROS   = YES
2060
2061#---------------------------------------------------------------------------
2062# Configuration options related to external references
2063#---------------------------------------------------------------------------
2064
2065# The TAGFILES tag can be used to specify one or more tag files. For each tag
2066# file the location of the external documentation should be added. The format of
2067# a tag file without this location is as follows:
2068# TAGFILES = file1 file2 ...
2069# Adding location for the tag files is done as follows:
2070# TAGFILES = file1=loc1 "file2 = loc2" ...
2071# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2072# section "Linking to external documentation" for more information about the use
2073# of tag files.
2074# Note: Each tag file must have a unique name (where the name does NOT include
2075# the path). If a tag file is not located in the directory in which doxygen is
2076# run, you must also specify the path to the tagfile here.
2077
2078TAGFILES               =
2079
2080# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2081# tag file that is based on the input files it reads. See section "Linking to
2082# external documentation" for more information about the usage of tag files.
2083
2084GENERATE_TAGFILE       =
2085
2086# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2087# the class index. If set to NO, only the inherited external classes will be
2088# listed.
2089# The default value is: NO.
2090
2091ALLEXTERNALS           = NO
2092
2093# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2094# in the modules index. If set to NO, only the current project's groups will be
2095# listed.
2096# The default value is: YES.
2097
2098EXTERNAL_GROUPS        = YES
2099
2100# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2101# the related pages index. If set to NO, only the current project's pages will
2102# be listed.
2103# The default value is: YES.
2104
2105EXTERNAL_PAGES         = YES
2106
2107# The PERL_PATH should be the absolute path and name of the perl script
2108# interpreter (i.e. the result of 'which perl').
2109# The default file (with absolute path) is: /usr/bin/perl.
2110
2111PERL_PATH              = /usr/bin/perl
2112
2113#---------------------------------------------------------------------------
2114# Configuration options related to the dot tool
2115#---------------------------------------------------------------------------
2116
2117# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2118# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2119# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2120# disabled, but it is recommended to install and use dot, since it yields more
2121# powerful graphs.
2122# The default value is: YES.
2123
2124CLASS_DIAGRAMS         = YES
2125
2126# You can define message sequence charts within doxygen comments using the \msc
2127# command. Doxygen will then run the mscgen tool (see:
2128# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2129# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2130# the mscgen tool resides. If left empty the tool is assumed to be found in the
2131# default search path.
2132
2133MSCGEN_PATH            =
2134
2135# You can include diagrams made with dia in doxygen documentation. Doxygen will
2136# then run dia to produce the diagram and insert it in the documentation. The
2137# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2138# If left empty dia is assumed to be found in the default search path.
2139
2140DIA_PATH               =
2141
2142# If set to YES the inheritance and collaboration graphs will hide inheritance
2143# and usage relations if the target is undocumented or is not a class.
2144# The default value is: YES.
2145
2146HIDE_UNDOC_RELATIONS   = YES
2147
2148# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2149# available from the path. This tool is part of Graphviz (see:
2150# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2151# Bell Labs. The other options in this section have no effect if this option is
2152# set to NO
2153# The default value is: YES.
2154
2155HAVE_DOT               = YES
2156
2157# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2158# to run in parallel. When set to 0 doxygen will base this on the number of
2159# processors available in the system. You can set it explicitly to a value
2160# larger than 0 to get control over the balance between CPU load and processing
2161# speed.
2162# Minimum value: 0, maximum value: 32, default value: 0.
2163# This tag requires that the tag HAVE_DOT is set to YES.
2164
2165DOT_NUM_THREADS        = 0
2166
2167# When you want a differently looking font in the dot files that doxygen
2168# generates you can specify the font name using DOT_FONTNAME. You need to make
2169# sure dot is able to find the font, which can be done by putting it in a
2170# standard location or by setting the DOTFONTPATH environment variable or by
2171# setting DOT_FONTPATH to the directory containing the font.
2172# The default value is: Helvetica.
2173# This tag requires that the tag HAVE_DOT is set to YES.
2174
2175DOT_FONTNAME           = Helvetica
2176
2177# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2178# dot graphs.
2179# Minimum value: 4, maximum value: 24, default value: 10.
2180# This tag requires that the tag HAVE_DOT is set to YES.
2181
2182DOT_FONTSIZE           = 10
2183
2184# By default doxygen will tell dot to use the default font as specified with
2185# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2186# the path where dot can find it using this tag.
2187# This tag requires that the tag HAVE_DOT is set to YES.
2188
2189DOT_FONTPATH           =
2190
2191# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2192# each documented class showing the direct and indirect inheritance relations.
2193# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2194# The default value is: YES.
2195# This tag requires that the tag HAVE_DOT is set to YES.
2196
2197CLASS_GRAPH            = YES
2198
2199# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2200# graph for each documented class showing the direct and indirect implementation
2201# dependencies (inheritance, containment, and class references variables) of the
2202# class with other documented classes.
2203# The default value is: YES.
2204# This tag requires that the tag HAVE_DOT is set to YES.
2205
2206COLLABORATION_GRAPH    = YES
2207
2208# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2209# groups, showing the direct groups dependencies.
2210# The default value is: YES.
2211# This tag requires that the tag HAVE_DOT is set to YES.
2212
2213GROUP_GRAPHS           = YES
2214
2215# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2216# collaboration diagrams in a style similar to the OMG's Unified Modeling
2217# Language.
2218# The default value is: NO.
2219# This tag requires that the tag HAVE_DOT is set to YES.
2220
2221UML_LOOK               = NO
2222
2223# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2224# class node. If there are many fields or methods and many nodes the graph may
2225# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2226# number of items for each type to make the size more manageable. Set this to 0
2227# for no limit. Note that the threshold may be exceeded by 50% before the limit
2228# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2229# but if the number exceeds 15, the total amount of fields shown is limited to
2230# 10.
2231# Minimum value: 0, maximum value: 100, default value: 10.
2232# This tag requires that the tag HAVE_DOT is set to YES.
2233
2234UML_LIMIT_NUM_FIELDS   = 10
2235
2236# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2237# collaboration graphs will show the relations between templates and their
2238# instances.
2239# The default value is: NO.
2240# This tag requires that the tag HAVE_DOT is set to YES.
2241
2242TEMPLATE_RELATIONS     = NO
2243
2244# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2245# YES then doxygen will generate a graph for each documented file showing the
2246# direct and indirect include dependencies of the file with other documented
2247# files.
2248# The default value is: YES.
2249# This tag requires that the tag HAVE_DOT is set to YES.
2250
2251INCLUDE_GRAPH          = YES
2252
2253# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2254# set to YES then doxygen will generate a graph for each documented file showing
2255# the direct and indirect include dependencies of the file with other documented
2256# files.
2257# The default value is: YES.
2258# This tag requires that the tag HAVE_DOT is set to YES.
2259
2260INCLUDED_BY_GRAPH      = YES
2261
2262# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2263# dependency graph for every global function or class method.
2264#
2265# Note that enabling this option will significantly increase the time of a run.
2266# So in most cases it will be better to enable call graphs for selected
2267# functions only using the \callgraph command. Disabling a call graph can be
2268# accomplished by means of the command \hidecallgraph.
2269# The default value is: NO.
2270# This tag requires that the tag HAVE_DOT is set to YES.
2271
2272CALL_GRAPH             = NO
2273
2274# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2275# dependency graph for every global function or class method.
2276#
2277# Note that enabling this option will significantly increase the time of a run.
2278# So in most cases it will be better to enable caller graphs for selected
2279# functions only using the \callergraph command. Disabling a caller graph can be
2280# accomplished by means of the command \hidecallergraph.
2281# The default value is: NO.
2282# This tag requires that the tag HAVE_DOT is set to YES.
2283
2284CALLER_GRAPH           = NO
2285
2286# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2287# hierarchy of all classes instead of a textual one.
2288# The default value is: YES.
2289# This tag requires that the tag HAVE_DOT is set to YES.
2290
2291GRAPHICAL_HIERARCHY    = YES
2292
2293# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2294# dependencies a directory has on other directories in a graphical way. The
2295# dependency relations are determined by the #include relations between the
2296# files in the directories.
2297# The default value is: YES.
2298# This tag requires that the tag HAVE_DOT is set to YES.
2299
2300DIRECTORY_GRAPH        = YES
2301
2302# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2303# generated by dot. For an explanation of the image formats see the section
2304# output formats in the documentation of the dot tool (Graphviz (see:
2305# http://www.graphviz.org/)).
2306# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2307# to make the SVG files visible in IE 9+ (other browsers do not have this
2308# requirement).
2309# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2310# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2311# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2312# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2313# png:gdiplus:gdiplus.
2314# The default value is: png.
2315# This tag requires that the tag HAVE_DOT is set to YES.
2316
2317DOT_IMAGE_FORMAT       = png
2318
2319# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2320# enable generation of interactive SVG images that allow zooming and panning.
2321#
2322# Note that this requires a modern browser other than Internet Explorer. Tested
2323# and working are Firefox, Chrome, Safari, and Opera.
2324# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2325# the SVG files visible. Older versions of IE do not have SVG support.
2326# The default value is: NO.
2327# This tag requires that the tag HAVE_DOT is set to YES.
2328
2329INTERACTIVE_SVG        = NO
2330
2331# The DOT_PATH tag can be used to specify the path where the dot tool can be
2332# found. If left blank, it is assumed the dot tool can be found in the path.
2333# This tag requires that the tag HAVE_DOT is set to YES.
2334
2335DOT_PATH               =
2336
2337# The DOTFILE_DIRS tag can be used to specify one or more directories that
2338# contain dot files that are included in the documentation (see the \dotfile
2339# command).
2340# This tag requires that the tag HAVE_DOT is set to YES.
2341
2342DOTFILE_DIRS           =
2343
2344# The MSCFILE_DIRS tag can be used to specify one or more directories that
2345# contain msc files that are included in the documentation (see the \mscfile
2346# command).
2347
2348MSCFILE_DIRS           =
2349
2350# The DIAFILE_DIRS tag can be used to specify one or more directories that
2351# contain dia files that are included in the documentation (see the \diafile
2352# command).
2353
2354DIAFILE_DIRS           =
2355
2356# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2357# path where java can find the plantuml.jar file. If left blank, it is assumed
2358# PlantUML is not used or called during a preprocessing step. Doxygen will
2359# generate a warning when it encounters a \startuml command in this case and
2360# will not generate output for the diagram.
2361
2362PLANTUML_JAR_PATH      =
2363
2364# When using plantuml, the specified paths are searched for files specified by
2365# the !include statement in a plantuml block.
2366
2367PLANTUML_INCLUDE_PATH  =
2368
2369# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2370# that will be shown in the graph. If the number of nodes in a graph becomes
2371# larger than this value, doxygen will truncate the graph, which is visualized
2372# by representing a node as a red box. Note that doxygen if the number of direct
2373# children of the root node in a graph is already larger than
2374# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2375# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2376# Minimum value: 0, maximum value: 10000, default value: 50.
2377# This tag requires that the tag HAVE_DOT is set to YES.
2378
2379DOT_GRAPH_MAX_NODES    = 50
2380
2381# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2382# generated by dot. A depth value of 3 means that only nodes reachable from the
2383# root by following a path via at most 3 edges will be shown. Nodes that lay
2384# further from the root node will be omitted. Note that setting this option to 1
2385# or 2 may greatly reduce the computation time needed for large code bases. Also
2386# note that the size of a graph can be further restricted by
2387# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2388# Minimum value: 0, maximum value: 1000, default value: 0.
2389# This tag requires that the tag HAVE_DOT is set to YES.
2390
2391MAX_DOT_GRAPH_DEPTH    = 0
2392
2393# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2394# background. This is disabled by default, because dot on Windows does not seem
2395# to support this out of the box.
2396#
2397# Warning: Depending on the platform used, enabling this option may lead to
2398# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2399# read).
2400# The default value is: NO.
2401# This tag requires that the tag HAVE_DOT is set to YES.
2402
2403DOT_TRANSPARENT        = NO
2404
2405# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2406# files in one run (i.e. multiple -o and -T options on the command line). This
2407# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2408# this, this feature is disabled by default.
2409# The default value is: NO.
2410# This tag requires that the tag HAVE_DOT is set to YES.
2411
2412DOT_MULTI_TARGETS      = NO
2413
2414# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2415# explaining the meaning of the various boxes and arrows in the dot generated
2416# graphs.
2417# The default value is: YES.
2418# This tag requires that the tag HAVE_DOT is set to YES.
2419
2420GENERATE_LEGEND        = YES
2421
2422# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2423# files that are used to generate the various graphs.
2424# The default value is: YES.
2425# This tag requires that the tag HAVE_DOT is set to YES.
2426
2427DOT_CLEANUP            = YES
Note: See TracBrowser for help on using the repository browser.