Debian Codegraph @

docs/Doxyfile.in

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