Debian Codegraph @

doc/spec/Doxyfile

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