Debian Codegraph @

prov/efa/docs/Doxyfile

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