comparison dep/utf8proc/Doxyfile @ 343:1faa72660932

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