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