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