Debian Codegraph @

doc/Doxyfile

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