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