Debian Codegraph @

documentation/doxygen/config.doxyfile

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