Debian Codegraph @

docs/Doxyfile

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