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