Debian Codegraph @

libdrgn/Doxyfile

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