Debian Codegraph @

Doxyfile

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