3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
9 # All text after a single hash (#) is considered a comment and will be ignored.
11 # TAG = value [value, ...]
12 # For lists, items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
20 # This tag specifies the encoding used for all characters in the config file
21 # that follow. The default is UTF-8 which is also the encoding used for all text
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24 # for the list of possible encodings.
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING = UTF-8
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
35 PROJECT_NAME = "My Project"
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52 # to the output directory.
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
74 # documentation generated by doxygen is written. Doxygen will use this
75 # information to generate all constant output in the proper language.
76 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
77 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
78 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
79 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
81 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
82 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
83 # Ukrainian and Vietnamese.
84 # The default value is: English.
86 OUTPUT_LANGUAGE = English
88 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
89 # descriptions after the members that are listed in the file and class
90 # documentation (similar to Javadoc). Set to NO to disable this.
91 # The default value is: YES.
93 BRIEF_MEMBER_DESC = YES
95 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
96 # description of a member or function before the detailed description
98 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
99 # brief descriptions will be completely suppressed.
100 # The default value is: YES.
104 # This tag implements a quasi-intelligent brief description abbreviator that is
105 # used to form the text in various listings. Each string in this list, if found
106 # as the leading text of the brief description, will be stripped from the text
107 # and the result, after processing the whole list, is used as the annotated
108 # text. Otherwise, the brief description is used as-is. If left blank, the
109 # following values are used ($name is automatically replaced with the name of
110 # the entity):The $name class, The $name widget, The $name file, is, provides,
111 # specifies, contains, represents, a, an and the.
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116 # doxygen will generate a detailed section even if there is only a brief
118 # The default value is: NO.
120 ALWAYS_DETAILED_SEC = NO
122 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
123 # inherited members of a class in the documentation of that class as if those
124 # members were ordinary class members. Constructors, destructors and assignment
125 # operators of the base classes will not be shown.
126 # The default value is: NO.
128 INLINE_INHERITED_MEMB = NO
130 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
131 # before files name in the file list and in the header files. If set to NO the
132 # shortest path that makes the file name unique will be used
133 # The default value is: YES.
135 FULL_PATH_NAMES = YES
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
138 # Stripping is only done if one of the specified strings matches the left-hand
139 # part of the path. The tag can be used to show relative paths in the file list.
140 # If left blank the directory from which doxygen is run is used as the path to
143 # Note that you can specify absolute paths here, but also relative paths, which
144 # will be relative from the directory where doxygen is started.
145 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150 # path mentioned in the documentation of a class, which tells the reader which
151 # header file to include in order to use a class. If left blank only the name of
152 # the header file containing the class definition is used. Otherwise one should
153 # specify the list of include paths that are normally passed to the compiler
156 STRIP_FROM_INC_PATH =
158 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
159 # less readable) file names. This can be useful is your file systems doesn't
160 # support long names like on DOS, Mac, or CD-ROM.
161 # The default value is: NO.
165 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
166 # first line (until the first dot) of a Javadoc-style comment as the brief
167 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
168 # style comments (thus requiring an explicit @brief command for a brief
170 # The default value is: NO.
172 JAVADOC_AUTOBRIEF = NO
174 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
175 # line (until the first dot) of a Qt-style comment as the brief description. If
176 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
177 # requiring an explicit \brief command for a brief description.)
178 # The default value is: NO.
182 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
183 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
184 # a brief description. This used to be the default behavior. The new default is
185 # to treat a multi-line C++ comment block as a detailed description. Set this
186 # tag to YES if you prefer the old behavior instead.
188 # Note that setting this tag to YES also means that rational rose comments are
189 # not recognized any more.
190 # The default value is: NO.
192 MULTILINE_CPP_IS_BRIEF = NO
194 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
195 # documentation from any documented member that it re-implements.
196 # The default value is: YES.
200 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
201 # new page for each member. If set to NO, the documentation of a member will be
202 # part of the file/class/namespace that contains it.
203 # The default value is: NO.
205 SEPARATE_MEMBER_PAGES = NO
207 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
208 # uses this value to replace tabs by spaces in code fragments.
209 # Minimum value: 1, maximum value: 16, default value: 4.
213 # This tag can be used to specify a number of aliases that act as commands in
214 # the documentation. An alias has the form:
217 # "sideeffect=@par Side Effects:\n"
218 # will allow you to put the command \sideeffect (or @sideeffect) in the
219 # documentation, which will result in a user-defined paragraph with heading
220 # "Side Effects:". You can put \n's in the value part of an alias to insert
225 # Clip alias inserts the specified file between two text markers.
226 # EG: @clip{"button.h",public,private}
227 # Shows all lines between public and private *inclusive*.
228 ALIASES += clip{3}="\dontinclude \1 \n \skip \2 \n \until \3"
230 # <DALi Doxygen Tagging Rule>
232 # Use @SINCE_1_0, @SINCE_1_1, ... instead of @since,
233 # and use @DEPRECATED_1_0, @DEPRECATED_1_1, ... instead of @deprecated.
234 # It enables integrated management of version tagging between
235 # the open source DALi API reference and Tizen API reference.
236 # Using those tags with different ALIASES settings in each doxygen config file allows us
237 # to generate two versions of "Since" and "Deprecated" generated output
238 # from one set of public header files.
240 # If you need a newer version number like @SINCE_1_5 or @SINCE_2_0, just add new ALIASES for it.
242 # ##################################################3
243 # # Guide for Open Source DALi API Reference
245 # ### @SINCE example:
246 # [some-public-header.h]
251 # void SomeFunction();
253 # [generated html file]
254 # void SomeFunction()
259 # ### @DEPRECATED example 1:
260 # [some-public-header.h]
262 # * @DEPRECATED_1_0.3
265 # void SomeFunction();
267 # [generated html file]
268 # void SomeFunction()
270 # Deprecated since 1.0.3
273 # ### @DEPRECATED example 2:
274 # [some-public-header.h]
277 # * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
280 # void SomeFunction();
282 # [generated html file]
283 # void SomeFunction()
285 # Deprecated since 1.0.3. Use SomeFunction2() instead.
288 # ##################################################3
289 # # Guide for Tizen Native API Reference
291 # ### @SINCE example:
292 # [some-public-header.h]
297 # void SomeFunction();
299 # [generated html file]
300 # void SomeFunction()
303 # 2.4, DALi Version 1.0.1
305 # ### @DEPRECATED example 1:
306 # [some-public-header.h]
308 # * @DEPRECATED_1_0.3
311 # void SomeFunction();
313 # [generated html file]
314 # void SomeFunction()
316 # Deprecated since 3.0, DALi version 1.0.3
319 # ### @DEPRECATED example 2:
320 # [some-public-header.h]
323 # * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
326 # void SomeFunction();
328 # [generated html file]
329 # void SomeFunction()
331 # Deprecated since 3.0, DALi version 1.0.3. Use SomeFunction2() instead.
334 ###########################################
335 # For Open Source DALi API Reference
336 ALIASES += SINCE_1_0="@since 1.0"
337 ALIASES += SINCE_1_1="@since 1.1"
338 ALIASES += SINCE_1_2="@since 1.2"
340 # Extra tags for Tizen 3.0
341 ALIASES += SINCE_1_2_2="@since 1.2.2"
342 ALIASES += SINCE_1_2_4="@since 1.2.4"
343 ALIASES += SINCE_1_2_5="@since 1.2.5"
345 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
346 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
347 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"
349 ALIASES += PLATFORM=""
350 ALIASES += PRIVLEVEL_PLATFORM=""
351 ALIASES += PRIVLEVEL_PUBLIC=""
352 ALIASES += PRIVILEGE_KEYGRAB=""
353 ALIASES += PRIVILEGE_DISPLAY=""
354 ALIASES += REMARK_INTERNET=""
356 ############################################
357 ## For Tizen Native API Reference
358 #ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0"
359 #ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1"
360 #ALIASES += SINCE_1_2="\par Since:\n 4.0, DALi version 1.2"
362 ## Extra tags for Tizen 3.0
363 #ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2"
364 #ALIASES += SINCE_1_2_4="\par Since:\n 3.0, DALi version 1.2.4"
365 #ALIASES += SINCE_1_2_5="\par Since:\n 3.0, DALi version 1.2.5"
367 ## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release.
368 ## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0.
369 #ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0"
370 #ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1"
371 #ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 4.0, DALi version 1.2"
373 #ALIASES += PLATFORM="@platform"
374 #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform"
375 #ALIASES += PRIVLEVEL_PUBLIC="\par Privilege Level:\n public"
376 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
377 #ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
378 #ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."
381 # This tag can be used to specify a number of word-keyword mappings (TCL only).
382 # A mapping has the form "name=value". For example adding "class=itcl::class"
383 # will allow you to use the command class in the itcl::class meaning.
387 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
388 # only. Doxygen will then generate output that is more tailored for C. For
389 # instance, some of the names that are used will be different. The list of all
390 # members will be omitted, etc.
391 # The default value is: NO.
393 OPTIMIZE_OUTPUT_FOR_C = NO
395 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
396 # Python sources only. Doxygen will then generate output that is more tailored
397 # for that language. For instance, namespaces will be presented as packages,
398 # qualified scopes will look different, etc.
399 # The default value is: NO.
401 OPTIMIZE_OUTPUT_JAVA = NO
403 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
404 # sources. Doxygen will then generate output that is tailored for Fortran.
405 # The default value is: NO.
407 OPTIMIZE_FOR_FORTRAN = NO
409 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
410 # sources. Doxygen will then generate output that is tailored for VHDL.
411 # The default value is: NO.
413 OPTIMIZE_OUTPUT_VHDL = NO
415 # Doxygen selects the parser to use depending on the extension of the files it
416 # parses. With this tag you can assign which parser to use for a given
417 # extension. Doxygen has a built-in mapping, but you can override or extend it
418 # using this tag. The format is ext=language, where ext is a file extension, and
419 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
420 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
421 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
422 # (default is Fortran), use: inc=Fortran f=C.
424 # Note For files without extension you can use no_extension as a placeholder.
426 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
427 # the files are not read by doxygen.
431 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
432 # according to the Markdown format, which allows for more readable
433 # documentation. See http://daringfireball.net/projects/markdown/ for details.
434 # The output of markdown processing is further processed by doxygen, so you can
435 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
436 # case of backward compatibilities issues.
437 # The default value is: YES.
439 MARKDOWN_SUPPORT = YES
441 # When enabled doxygen tries to link words that correspond to documented
442 # classes, or namespaces to their corresponding documentation. Such a link can
443 # be prevented in individual cases by by putting a % sign in front of the word
444 # or globally by setting AUTOLINK_SUPPORT to NO.
445 # The default value is: YES.
447 AUTOLINK_SUPPORT = YES
449 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
450 # to include (a tag file for) the STL sources as input, then you should set this
451 # tag to YES in order to let doxygen match functions declarations and
452 # definitions whose arguments contain STL classes (e.g. func(std::string);
453 # versus func(std::string) {}). This also make the inheritance and collaboration
454 # diagrams that involve STL classes more complete and accurate.
455 # The default value is: NO.
457 BUILTIN_STL_SUPPORT = NO
459 # If you use Microsoft's C++/CLI language, you should set this option to YES to
460 # enable parsing support.
461 # The default value is: NO.
465 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
466 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
467 # will parse them like normal C++ but will assume all classes use public instead
468 # of private inheritance when no explicit protection keyword is present.
469 # The default value is: NO.
473 # For Microsoft's IDL there are propget and propput attributes to indicate
474 # getter and setter methods for a property. Setting this option to YES will make
475 # doxygen to replace the get and set methods by a property in the documentation.
476 # This will only work if the methods are indeed getting or setting a simple
477 # type. If this is not the case, or you want to show the methods anyway, you
478 # should set this option to NO.
479 # The default value is: YES.
481 IDL_PROPERTY_SUPPORT = YES
483 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
484 # tag is set to YES, then doxygen will reuse the documentation of the first
485 # member in the group (if any) for the other members of the group. By default
486 # all members of a group must be documented explicitly.
487 # The default value is: NO.
489 DISTRIBUTE_GROUP_DOC = NO
491 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
492 # (for instance a group of public functions) to be put as a subgroup of that
493 # type (e.g. under the Public Functions section). Set it to NO to prevent
494 # subgrouping. Alternatively, this can be done per class using the
495 # \nosubgrouping command.
496 # The default value is: YES.
500 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
501 # are shown inside the group in which they are included (e.g. using \ingroup)
502 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
505 # Note that this feature does not work in combination with
506 # SEPARATE_MEMBER_PAGES.
507 # The default value is: NO.
509 INLINE_GROUPED_CLASSES = NO
511 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
512 # with only public data fields or simple typedef fields will be shown inline in
513 # the documentation of the scope in which they are defined (i.e. file,
514 # namespace, or group documentation), provided this scope is documented. If set
515 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
516 # Man pages) or section (for LaTeX and RTF).
517 # The default value is: NO.
519 INLINE_SIMPLE_STRUCTS = NO
521 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
522 # enum is documented as struct, union, or enum with the name of the typedef. So
523 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
524 # with name TypeT. When disabled the typedef will appear as a member of a file,
525 # namespace, or class. And the struct will be named TypeS. This can typically be
526 # useful for C code in case the coding convention dictates that all compound
527 # types are typedef'ed and only the typedef is referenced, never the tag name.
528 # The default value is: NO.
530 TYPEDEF_HIDES_STRUCT = NO
532 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
533 # cache is used to resolve symbols given their name and scope. Since this can be
534 # an expensive process and often the same symbol appears multiple times in the
535 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
536 # doxygen will become slower. If the cache is too large, memory is wasted. The
537 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
538 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
539 # symbols. At the end of a run doxygen will report the cache usage and suggest
540 # the optimal cache size from a speed point of view.
541 # Minimum value: 0, maximum value: 9, default value: 0.
543 LOOKUP_CACHE_SIZE = 0
545 #---------------------------------------------------------------------------
546 # Build related configuration options
547 #---------------------------------------------------------------------------
549 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
550 # documentation are documented, even if no documentation was available. Private
551 # class members and static file members will be hidden unless the
552 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
553 # Note: This will also disable the warnings about undocumented members that are
554 # normally produced when WARNINGS is set to YES.
555 # The default value is: NO.
559 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
560 # be included in the documentation.
561 # The default value is: NO.
565 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
566 # scope will be included in the documentation.
567 # The default value is: NO.
571 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
572 # included in the documentation.
573 # The default value is: NO.
577 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
578 # locally in source files will be included in the documentation. If set to NO
579 # only classes defined in header files are included. Does not have any effect
581 # The default value is: YES.
583 EXTRACT_LOCAL_CLASSES = YES
585 # This flag is only useful for Objective-C code. When set to YES local methods,
586 # which are defined in the implementation section but not in the interface are
587 # included in the documentation. If set to NO only methods in the interface are
589 # The default value is: NO.
591 EXTRACT_LOCAL_METHODS = NO
593 # If this flag is set to YES, the members of anonymous namespaces will be
594 # extracted and appear in the documentation as a namespace called
595 # 'anonymous_namespace{file}', where file will be replaced with the base name of
596 # the file that contains the anonymous namespace. By default anonymous namespace
598 # The default value is: NO.
600 EXTRACT_ANON_NSPACES = NO
602 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
603 # undocumented members inside documented classes or files. If set to NO these
604 # members will be included in the various overviews, but no documentation
605 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
606 # The default value is: NO.
608 HIDE_UNDOC_MEMBERS = NO
610 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
611 # undocumented classes that are normally visible in the class hierarchy. If set
612 # to NO these classes will be included in the various overviews. This option has
613 # no effect if EXTRACT_ALL is enabled.
614 # The default value is: NO.
616 HIDE_UNDOC_CLASSES = NO
618 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
619 # (class|struct|union) declarations. If set to NO these declarations will be
620 # included in the documentation.
621 # The default value is: NO.
623 HIDE_FRIEND_COMPOUNDS = NO
625 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
626 # documentation blocks found inside the body of a function. If set to NO these
627 # blocks will be appended to the function's detailed documentation block.
628 # The default value is: NO.
630 HIDE_IN_BODY_DOCS = NO
632 # The INTERNAL_DOCS tag determines if documentation that is typed after a
633 # \internal command is included. If the tag is set to NO then the documentation
634 # will be excluded. Set it to YES to include the internal documentation.
635 # The default value is: NO.
639 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
640 # names in lower-case letters. If set to YES upper-case letters are also
641 # allowed. This is useful if you have classes or files whose names only differ
642 # in case and if your file system supports case sensitive file names. Windows
643 # and Mac users are advised to set this option to NO.
644 # The default value is: system dependent.
646 CASE_SENSE_NAMES = YES
648 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
649 # their full class and namespace scopes in the documentation. If set to YES the
650 # scope will be hidden.
651 # The default value is: NO.
653 HIDE_SCOPE_NAMES = NO
655 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
656 # the files that are included by a file in the documentation of that file.
657 # The default value is: YES.
659 SHOW_INCLUDE_FILES = YES
661 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
662 # grouped member an include statement to the documentation, telling the reader
663 # which file to include in order to use the member.
664 # The default value is: NO.
666 SHOW_GROUPED_MEMB_INC = NO
668 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
669 # files with double quotes in the documentation rather than with sharp brackets.
670 # The default value is: NO.
672 FORCE_LOCAL_INCLUDES = NO
674 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
675 # documentation for inline members.
676 # The default value is: YES.
680 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
681 # (detailed) documentation of file and class members alphabetically by member
682 # name. If set to NO the members will appear in declaration order.
683 # The default value is: YES.
685 SORT_MEMBER_DOCS = YES
687 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
688 # descriptions of file, namespace and class members alphabetically by member
689 # name. If set to NO the members will appear in declaration order. Note that
690 # this will also influence the order of the classes in the class list.
691 # The default value is: NO.
695 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
696 # (brief and detailed) documentation of class members so that constructors and
697 # destructors are listed first. If set to NO the constructors will appear in the
698 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
699 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
700 # member documentation.
701 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
702 # detailed member documentation.
703 # The default value is: NO.
705 SORT_MEMBERS_CTORS_1ST = NO
707 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
708 # of group names into alphabetical order. If set to NO the group names will
709 # appear in their defined order.
710 # The default value is: NO.
712 SORT_GROUP_NAMES = NO
714 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
715 # fully-qualified names, including namespaces. If set to NO, the class list will
716 # be sorted only by class name, not including the namespace part.
717 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
718 # Note: This option applies only to the class list, not to the alphabetical
720 # The default value is: NO.
722 SORT_BY_SCOPE_NAME = NO
724 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
725 # type resolution of all parameters of a function it will reject a match between
726 # the prototype and the implementation of a member function even if there is
727 # only one candidate or it is obvious which candidate to choose by doing a
728 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
729 # accept a match between prototype and implementation in such cases.
730 # The default value is: NO.
732 STRICT_PROTO_MATCHING = NO
734 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
735 # todo list. This list is created by putting \todo commands in the
737 # The default value is: YES.
739 GENERATE_TODOLIST = YES
741 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
742 # test list. This list is created by putting \test commands in the
744 # The default value is: YES.
746 GENERATE_TESTLIST = YES
748 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
749 # list. This list is created by putting \bug commands in the documentation.
750 # The default value is: YES.
752 GENERATE_BUGLIST = YES
754 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
755 # the deprecated list. This list is created by putting \deprecated commands in
757 # The default value is: YES.
759 GENERATE_DEPRECATEDLIST= YES
761 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
762 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
763 # ... \endcond blocks.
767 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
768 # initial value of a variable or macro / define can have for it to appear in the
769 # documentation. If the initializer consists of more lines than specified here
770 # it will be hidden. Use a value of 0 to hide initializers completely. The
771 # appearance of the value of individual variables and macros / defines can be
772 # controlled using \showinitializer or \hideinitializer command in the
773 # documentation regardless of this setting.
774 # Minimum value: 0, maximum value: 10000, default value: 30.
776 MAX_INITIALIZER_LINES = 30
778 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
779 # the bottom of the documentation of classes and structs. If set to YES the list
780 # will mention the files that were used to generate the documentation.
781 # The default value is: YES.
783 SHOW_USED_FILES = YES
785 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
786 # will remove the Files entry from the Quick Index and from the Folder Tree View
788 # The default value is: YES.
792 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
793 # page. This will remove the Namespaces entry from the Quick Index and from the
794 # Folder Tree View (if specified).
795 # The default value is: YES.
797 SHOW_NAMESPACES = YES
799 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
800 # doxygen should invoke to get the current version for each file (typically from
801 # the version control system). Doxygen will invoke the program by executing (via
802 # popen()) the command command input-file, where command is the value of the
803 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
804 # by doxygen. Whatever the program writes to standard output is used as the file
805 # version. For an example see the documentation.
807 FILE_VERSION_FILTER =
809 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
810 # by doxygen. The layout file controls the global structure of the generated
811 # output files in an output format independent way. To create the layout file
812 # that represents doxygen's defaults, run doxygen with the -l option. You can
813 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
814 # will be used as the name of the layout file.
816 # Note that if you run doxygen from a directory containing a file called
817 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
822 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
823 # the reference definitions. This must be a list of .bib files. The .bib
824 # extension is automatically appended if omitted. This requires the bibtex tool
825 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
826 # For LaTeX the style of the bibliography can be controlled using
827 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
828 # search path. Do not use file names with spaces, bibtex cannot handle them. See
829 # also \cite for info how to create references.
833 #---------------------------------------------------------------------------
834 # Configuration options related to warning and progress messages
835 #---------------------------------------------------------------------------
837 # The QUIET tag can be used to turn on/off the messages that are generated to
838 # standard output by doxygen. If QUIET is set to YES this implies that the
840 # The default value is: NO.
844 # The WARNINGS tag can be used to turn on/off the warning messages that are
845 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
846 # this implies that the warnings are on.
848 # Tip: Turn warnings on while writing the documentation.
849 # The default value is: YES.
853 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
854 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
855 # will automatically be disabled.
856 # The default value is: YES.
858 WARN_IF_UNDOCUMENTED = YES
860 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
861 # potential errors in the documentation, such as not documenting some parameters
862 # in a documented function, or documenting parameters that don't exist or using
863 # markup commands wrongly.
864 # The default value is: YES.
866 WARN_IF_DOC_ERROR = YES
868 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
869 # are documented, but have no documentation for their parameters or return
870 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
871 # documentation, but not about the absence of documentation.
872 # The default value is: NO.
874 WARN_NO_PARAMDOC = NO
876 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
877 # can produce. The string should contain the $file, $line, and $text tags, which
878 # will be replaced by the file and line number from which the warning originated
879 # and the warning text. Optionally the format may contain $version, which will
880 # be replaced by the version of the file (if it could be obtained via
881 # FILE_VERSION_FILTER)
882 # The default value is: $file:$line: $text.
884 WARN_FORMAT = "$file:$line: $text"
886 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
887 # messages should be written. If left blank the output is written to standard
892 #---------------------------------------------------------------------------
893 # Configuration options related to the input files
894 #---------------------------------------------------------------------------
896 # The INPUT tag is used to specify the files and/or directories that contain
897 # documented source files. You may enter file names like myfile.cpp or
898 # directories like /usr/src/myproject. Separate the files or directories with
900 # Note: If this tag is empty the current directory is searched.
904 # This tag can be used to specify the character encoding of the source files
905 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
906 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
907 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
908 # possible encodings.
909 # The default value is: UTF-8.
911 INPUT_ENCODING = UTF-8
913 # If the value of the INPUT tag contains directories, you can use the
914 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
915 # *.h) to filter out the source-files in the directories. If left blank the
916 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
917 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
918 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
919 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
920 # *.qsf, *.as and *.js.
923 #FILE_PATTERNS = *.py
926 #FILE_PATTERNS = *.cs
928 # The RECURSIVE tag can be used to specify whether or not subdirectories should
929 # be searched for input files as well.
930 # The default value is: NO.
934 # The EXCLUDE tag can be used to specify files and/or directories that should be
935 # excluded from the INPUT source files. This way you can easily exclude a
936 # subdirectory from a directory tree whose root is specified with the INPUT tag.
938 # Note that relative paths are relative to the directory from which doxygen is
943 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
944 # directories that are symbolic links (a Unix file system feature) are excluded
946 # The default value is: NO.
948 EXCLUDE_SYMLINKS = NO
950 # If the value of the INPUT tag contains directories, you can use the
951 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
952 # certain files from those directories.
954 # Note that the wildcards are matched against the file with absolute path, so to
955 # exclude all test directories for example use the pattern */test/*
959 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
960 # (namespaces, classes, functions, etc.) that should be excluded from the
961 # output. The symbol name can be a fully qualified name, a word, or if the
962 # wildcard * is used, a substring. Examples: ANamespace, AClass,
963 # AClass::ANamespace, ANamespace::*Test
965 # Note that the wildcards are matched against the file with absolute path, so to
966 # exclude all test directories use the pattern */test/*
970 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
971 # that contain example code fragments that are included (see the \include
976 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
977 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
978 # *.h) to filter out the source-files in the directories. If left blank all
979 # files are included.
983 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
984 # searched for input files to be used with the \include or \dontinclude commands
985 # irrespective of the value of the RECURSIVE tag.
986 # The default value is: NO.
988 EXAMPLE_RECURSIVE = NO
990 # The IMAGE_PATH tag can be used to specify one or more files or directories
991 # that contain images that are to be included in the documentation (see the
996 # The INPUT_FILTER tag can be used to specify a program that doxygen should
997 # invoke to filter for each input file. Doxygen will invoke the filter program
998 # by executing (via popen()) the command:
1000 # <filter> <input-file>
1002 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1003 # name of an input file. Doxygen will then use the output that the filter
1004 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1007 # Note that the filter must not add or remove lines; it is applied before the
1008 # code is scanned, but not when the output code is generated. If lines are added
1009 # or removed, the anchors will not be placed correctly.
1013 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1014 # basis. Doxygen will compare the file name with each pattern and apply the
1015 # filter if there is a match. The filters are a list of the form: pattern=filter
1016 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1017 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1018 # patterns match the file name, INPUT_FILTER is applied.
1022 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1023 # INPUT_FILTER ) will also be used to filter the input files that are used for
1024 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1025 # The default value is: NO.
1027 FILTER_SOURCE_FILES = NO
1029 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1030 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1031 # it is also possible to disable source filtering for a specific pattern using
1032 # *.ext= (so without naming a filter).
1033 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1035 FILTER_SOURCE_PATTERNS =
1037 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1038 # is part of the input, its contents will be placed on the main page
1039 # (index.html). This can be useful if you have a project on for instance GitHub
1040 # and want to reuse the introduction page also for the doxygen output.
1042 USE_MDFILE_AS_MAINPAGE =
1044 #---------------------------------------------------------------------------
1045 # Configuration options related to source browsing
1046 #---------------------------------------------------------------------------
1048 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1049 # generated. Documented entities will be cross-referenced with these sources.
1051 # Note: To get rid of all source code in the generated output, make sure that
1052 # also VERBATIM_HEADERS is set to NO.
1053 # The default value is: NO.
1057 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1058 # classes and enums directly into the documentation.
1059 # The default value is: NO.
1063 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1064 # special comment blocks from generated source code fragments. Normal C, C++ and
1065 # Fortran comments will always remain visible.
1066 # The default value is: YES.
1068 STRIP_CODE_COMMENTS = NO
1070 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1071 # function all documented functions referencing it will be listed.
1072 # The default value is: NO.
1074 REFERENCED_BY_RELATION = NO
1076 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1077 # all documented entities called/used by that function will be listed.
1078 # The default value is: NO.
1080 REFERENCES_RELATION = NO
1082 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1083 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
1084 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1085 # link to the documentation.
1086 # The default value is: YES.
1088 REFERENCES_LINK_SOURCE = YES
1090 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1091 # source code will show a tooltip with additional information such as prototype,
1092 # brief description and links to the definition and documentation. Since this
1093 # will make the HTML file larger and loading of large files a bit slower, you
1094 # can opt to disable this feature.
1095 # The default value is: YES.
1096 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1098 SOURCE_TOOLTIPS = YES
1100 # If the USE_HTAGS tag is set to YES then the references to source code will
1101 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1102 # source browser. The htags tool is part of GNU's global source tagging system
1103 # (see http://www.gnu.org/software/global/global.html). You will need version
1106 # To use it do the following:
1107 # - Install the latest version of global
1108 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1109 # - Make sure the INPUT points to the root of the source tree
1110 # - Run doxygen as normal
1112 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1113 # tools must be available from the command line (i.e. in the search path).
1115 # The result: instead of the source browser generated by doxygen, the links to
1116 # source code will now point to the output of htags.
1117 # The default value is: NO.
1118 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1122 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1123 # verbatim copy of the header file for each class for which an include is
1124 # specified. Set to NO to disable this.
1125 # See also: Section \class.
1126 # The default value is: YES.
1128 VERBATIM_HEADERS = YES
1130 #---------------------------------------------------------------------------
1131 # Configuration options related to the alphabetical class index
1132 #---------------------------------------------------------------------------
1134 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1135 # compounds will be generated. Enable this if the project contains a lot of
1136 # classes, structs, unions or interfaces.
1137 # The default value is: YES.
1139 ALPHABETICAL_INDEX = YES
1141 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1142 # which the alphabetical index list will be split.
1143 # Minimum value: 1, maximum value: 20, default value: 5.
1144 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1146 COLS_IN_ALPHA_INDEX = 5
1148 # In case all classes in a project start with a common prefix, all classes will
1149 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1150 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1151 # while generating the index headers.
1152 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1156 #---------------------------------------------------------------------------
1157 # Configuration options related to the HTML output
1158 #---------------------------------------------------------------------------
1160 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1161 # The default value is: YES.
1165 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1166 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1168 # The default directory is: html.
1169 # This tag requires that the tag GENERATE_HTML is set to YES.
1173 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1174 # generated HTML page (for example: .htm, .php, .asp).
1175 # The default value is: .html.
1176 # This tag requires that the tag GENERATE_HTML is set to YES.
1178 HTML_FILE_EXTENSION = .html
1180 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1181 # each generated HTML page. If the tag is left blank doxygen will generate a
1184 # To get valid HTML the header file that includes any scripts and style sheets
1185 # that doxygen needs, which is dependent on the configuration options used (e.g.
1186 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1187 # default header using
1188 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1190 # and then modify the file new_header.html. See also section "Doxygen usage"
1191 # for information on how to generate the default header that doxygen normally
1193 # Note: The header is subject to change so you typically have to regenerate the
1194 # default header when upgrading to a newer version of doxygen. For a description
1195 # of the possible markers and block names see the documentation.
1196 # This tag requires that the tag GENERATE_HTML is set to YES.
1200 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1201 # generated HTML page. If the tag is left blank doxygen will generate a standard
1202 # footer. See HTML_HEADER for more information on how to generate a default
1203 # footer and what special commands can be used inside the footer. See also
1204 # section "Doxygen usage" for information on how to generate the default footer
1205 # that doxygen normally uses.
1206 # This tag requires that the tag GENERATE_HTML is set to YES.
1210 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1211 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1212 # the HTML output. If left blank doxygen will generate a default style sheet.
1213 # See also section "Doxygen usage" for information on how to generate the style
1214 # sheet that doxygen normally uses.
1215 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1216 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1218 # This tag requires that the tag GENERATE_HTML is set to YES.
1222 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1223 # defined cascading style sheet that is included after the standard style sheets
1224 # created by doxygen. Using this option one can overrule certain style aspects.
1225 # This is preferred over using HTML_STYLESHEET since it does not replace the
1226 # standard style sheet and is therefor more robust against future updates.
1227 # Doxygen will copy the style sheet file to the output directory. For an example
1228 # see the documentation.
1229 # This tag requires that the tag GENERATE_HTML is set to YES.
1231 HTML_EXTRA_STYLESHEET =
1233 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1234 # other source files which should be copied to the HTML output directory. Note
1235 # that these files will be copied to the base HTML output directory. Use the
1236 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1237 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1238 # files will be copied as-is; there are no commands or markers available.
1239 # This tag requires that the tag GENERATE_HTML is set to YES.
1243 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1244 # will adjust the colors in the stylesheet and background images according to
1245 # this color. Hue is specified as an angle on a colorwheel, see
1246 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1247 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1248 # purple, and 360 is red again.
1249 # Minimum value: 0, maximum value: 359, default value: 220.
1250 # This tag requires that the tag GENERATE_HTML is set to YES.
1252 HTML_COLORSTYLE_HUE = 220
1254 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1255 # in the HTML output. For a value of 0 the output will use grayscales only. A
1256 # value of 255 will produce the most vivid colors.
1257 # Minimum value: 0, maximum value: 255, default value: 100.
1258 # This tag requires that the tag GENERATE_HTML is set to YES.
1260 HTML_COLORSTYLE_SAT = 100
1262 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1263 # luminance component of the colors in the HTML output. Values below 100
1264 # gradually make the output lighter, whereas values above 100 make the output
1265 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1266 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1268 # Minimum value: 40, maximum value: 240, default value: 80.
1269 # This tag requires that the tag GENERATE_HTML is set to YES.
1271 HTML_COLORSTYLE_GAMMA = 80
1273 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1274 # page will contain the date and time when the page was generated. Setting this
1275 # to NO can help when comparing the output of multiple runs.
1276 # The default value is: YES.
1277 # This tag requires that the tag GENERATE_HTML is set to YES.
1279 HTML_TIMESTAMP = YES
1281 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1282 # documentation will contain sections that can be hidden and shown after the
1284 # The default value is: NO.
1285 # This tag requires that the tag GENERATE_HTML is set to YES.
1287 HTML_DYNAMIC_SECTIONS = NO
1289 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1290 # shown in the various tree structured indices initially; the user can expand
1291 # and collapse entries dynamically later on. Doxygen will expand the tree to
1292 # such a level that at most the specified number of entries are visible (unless
1293 # a fully collapsed tree already exceeds this amount). So setting the number of
1294 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1295 # representing an infinite number of entries and will result in a full expanded
1297 # Minimum value: 0, maximum value: 9999, default value: 100.
1298 # This tag requires that the tag GENERATE_HTML is set to YES.
1300 HTML_INDEX_NUM_ENTRIES = 100
1302 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1303 # generated that can be used as input for Apple's Xcode 3 integrated development
1304 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1305 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1306 # Makefile in the HTML output directory. Running make will produce the docset in
1307 # that directory and running make install will install the docset in
1308 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1309 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1310 # for more information.
1311 # The default value is: NO.
1312 # This tag requires that the tag GENERATE_HTML is set to YES.
1314 GENERATE_DOCSET = NO
1316 # This tag determines the name of the docset feed. A documentation feed provides
1317 # an umbrella under which multiple documentation sets from a single provider
1318 # (such as a company or product suite) can be grouped.
1319 # The default value is: Doxygen generated docs.
1320 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1322 DOCSET_FEEDNAME = "Doxygen generated docs"
1324 # This tag specifies a string that should uniquely identify the documentation
1325 # set bundle. This should be a reverse domain-name style string, e.g.
1326 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1327 # The default value is: org.doxygen.Project.
1328 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1330 DOCSET_BUNDLE_ID = org.doxygen.Project
1332 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1333 # the documentation publisher. This should be a reverse domain-name style
1334 # string, e.g. com.mycompany.MyDocSet.documentation.
1335 # The default value is: org.doxygen.Publisher.
1336 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1338 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1340 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1341 # The default value is: Publisher.
1342 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1344 DOCSET_PUBLISHER_NAME = Publisher
1346 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1347 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1348 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1349 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1352 # The HTML Help Workshop contains a compiler that can convert all HTML output
1353 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1354 # files are now used as the Windows 98 help format, and will replace the old
1355 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1356 # HTML files also contain an index, a table of contents, and you can search for
1357 # words in the documentation. The HTML workshop also contains a viewer for
1358 # compressed HTML files.
1359 # The default value is: NO.
1360 # This tag requires that the tag GENERATE_HTML is set to YES.
1362 GENERATE_HTMLHELP = NO
1364 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1365 # file. You can add a path in front of the file if the result should not be
1366 # written to the html output directory.
1367 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1371 # The HHC_LOCATION tag can be used to specify the location (absolute path
1372 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1373 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1374 # The file has to be specified with full path.
1375 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1379 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1380 # YES) or that it should be included in the master .chm file ( NO).
1381 # The default value is: NO.
1382 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1386 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1387 # and project file content.
1388 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1390 CHM_INDEX_ENCODING =
1392 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1393 # YES) or a normal table of contents ( NO) in the .chm file.
1394 # The default value is: NO.
1395 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1399 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1400 # the table of contents of the HTML help documentation and to the tree view.
1401 # The default value is: NO.
1402 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1406 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1407 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1408 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1409 # (.qch) of the generated HTML documentation.
1410 # The default value is: NO.
1411 # This tag requires that the tag GENERATE_HTML is set to YES.
1415 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1416 # the file name of the resulting .qch file. The path specified is relative to
1417 # the HTML output folder.
1418 # This tag requires that the tag GENERATE_QHP is set to YES.
1422 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1423 # Project output. For more information please see Qt Help Project / Namespace
1424 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1425 # The default value is: org.doxygen.Project.
1426 # This tag requires that the tag GENERATE_QHP is set to YES.
1428 QHP_NAMESPACE = org.doxygen.Project
1430 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1431 # Help Project output. For more information please see Qt Help Project / Virtual
1432 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1434 # The default value is: doc.
1435 # This tag requires that the tag GENERATE_QHP is set to YES.
1437 QHP_VIRTUAL_FOLDER = doc
1439 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1440 # filter to add. For more information please see Qt Help Project / Custom
1441 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1443 # This tag requires that the tag GENERATE_QHP is set to YES.
1445 QHP_CUST_FILTER_NAME =
1447 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1448 # custom filter to add. For more information please see Qt Help Project / Custom
1449 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1451 # This tag requires that the tag GENERATE_QHP is set to YES.
1453 QHP_CUST_FILTER_ATTRS =
1455 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1456 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1457 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1458 # This tag requires that the tag GENERATE_QHP is set to YES.
1460 QHP_SECT_FILTER_ATTRS =
1462 # The QHG_LOCATION tag can be used to specify the location of Qt's
1463 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1464 # generated .qhp file.
1465 # This tag requires that the tag GENERATE_QHP is set to YES.
1469 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1470 # generated, together with the HTML files, they form an Eclipse help plugin. To
1471 # install this plugin and make it available under the help contents menu in
1472 # Eclipse, the contents of the directory containing the HTML and XML files needs
1473 # to be copied into the plugins directory of eclipse. The name of the directory
1474 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1475 # After copying Eclipse needs to be restarted before the help appears.
1476 # The default value is: NO.
1477 # This tag requires that the tag GENERATE_HTML is set to YES.
1479 GENERATE_ECLIPSEHELP = NO
1481 # A unique identifier for the Eclipse help plugin. When installing the plugin
1482 # the directory name containing the HTML and XML files should also have this
1483 # name. Each documentation set should have its own identifier.
1484 # The default value is: org.doxygen.Project.
1485 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1487 ECLIPSE_DOC_ID = org.doxygen.Project
1489 # If you want full control over the layout of the generated HTML pages it might
1490 # be necessary to disable the index and replace it with your own. The
1491 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1492 # of each HTML page. A value of NO enables the index and the value YES disables
1493 # it. Since the tabs in the index contain the same information as the navigation
1494 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1495 # The default value is: NO.
1496 # This tag requires that the tag GENERATE_HTML is set to YES.
1500 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1501 # structure should be generated to display hierarchical information. If the tag
1502 # value is set to YES, a side panel will be generated containing a tree-like
1503 # index structure (just like the one that is generated for HTML Help). For this
1504 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1505 # (i.e. any modern browser). Windows users are probably better off using the
1506 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1507 # further fine-tune the look of the index. As an example, the default style
1508 # sheet generated by doxygen has an example that shows how to put an image at
1509 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1510 # the same information as the tab index, you could consider setting
1511 # DISABLE_INDEX to YES when enabling this option.
1512 # The default value is: NO.
1513 # This tag requires that the tag GENERATE_HTML is set to YES.
1515 GENERATE_TREEVIEW = NO
1517 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1518 # doxygen will group on one line in the generated HTML documentation.
1520 # Note that a value of 0 will completely suppress the enum values from appearing
1521 # in the overview section.
1522 # Minimum value: 0, maximum value: 20, default value: 4.
1523 # This tag requires that the tag GENERATE_HTML is set to YES.
1525 ENUM_VALUES_PER_LINE = 4
1527 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1528 # to set the initial width (in pixels) of the frame in which the tree is shown.
1529 # Minimum value: 0, maximum value: 1500, default value: 250.
1530 # This tag requires that the tag GENERATE_HTML is set to YES.
1532 TREEVIEW_WIDTH = 250
1534 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1535 # external symbols imported via tag files in a separate window.
1536 # The default value is: NO.
1537 # This tag requires that the tag GENERATE_HTML is set to YES.
1539 EXT_LINKS_IN_WINDOW = NO
1541 # Use this tag to change the font size of LaTeX formulas included as images in
1542 # the HTML documentation. When you change the font size after a successful
1543 # doxygen run you need to manually remove any form_*.png images from the HTML
1544 # output directory to force them to be regenerated.
1545 # Minimum value: 8, maximum value: 50, default value: 10.
1546 # This tag requires that the tag GENERATE_HTML is set to YES.
1548 FORMULA_FONTSIZE = 10
1550 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1551 # generated for formulas are transparent PNGs. Transparent PNGs are not
1552 # supported properly for IE 6.0, but are supported on all modern browsers.
1554 # Note that when changing this option you need to delete any form_*.png files in
1555 # the HTML output directory before the changes have effect.
1556 # The default value is: YES.
1557 # This tag requires that the tag GENERATE_HTML is set to YES.
1559 FORMULA_TRANSPARENT = YES
1561 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1562 # http://www.mathjax.org) which uses client side Javascript for the rendering
1563 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1564 # installed or if you want to formulas look prettier in the HTML output. When
1565 # enabled you may also need to install MathJax separately and configure the path
1566 # to it using the MATHJAX_RELPATH option.
1567 # The default value is: NO.
1568 # This tag requires that the tag GENERATE_HTML is set to YES.
1572 # When MathJax is enabled you can set the default output format to be used for
1573 # the MathJax output. See the MathJax site (see:
1574 # http://docs.mathjax.org/en/latest/output.html) for more details.
1575 # Possible values are: HTML-CSS (which is slower, but has the best
1576 # compatibility), NativeMML (i.e. MathML) and SVG.
1577 # The default value is: HTML-CSS.
1578 # This tag requires that the tag USE_MATHJAX is set to YES.
1580 MATHJAX_FORMAT = HTML-CSS
1582 # When MathJax is enabled you need to specify the location relative to the HTML
1583 # output directory using the MATHJAX_RELPATH option. The destination directory
1584 # should contain the MathJax.js script. For instance, if the mathjax directory
1585 # is located at the same level as the HTML output directory, then
1586 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1587 # Content Delivery Network so you can quickly see the result without installing
1588 # MathJax. However, it is strongly recommended to install a local copy of
1589 # MathJax from http://www.mathjax.org before deployment.
1590 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1591 # This tag requires that the tag USE_MATHJAX is set to YES.
1593 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1595 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1596 # extension names that should be enabled during MathJax rendering. For example
1597 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1598 # This tag requires that the tag USE_MATHJAX is set to YES.
1600 MATHJAX_EXTENSIONS =
1602 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1603 # of code that will be used on startup of the MathJax code. See the MathJax site
1604 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1605 # example see the documentation.
1606 # This tag requires that the tag USE_MATHJAX is set to YES.
1610 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1611 # the HTML output. The underlying search engine uses javascript and DHTML and
1612 # should work on any modern browser. Note that when using HTML help
1613 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1614 # there is already a search function so this one should typically be disabled.
1615 # For large projects the javascript based search engine can be slow, then
1616 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1617 # search using the keyboard; to jump to the search box use <access key> + S
1618 # (what the <access key> is depends on the OS and browser, but it is typically
1619 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1620 # key> to jump into the search results window, the results can be navigated
1621 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1622 # the search. The filter options can be selected when the cursor is inside the
1623 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1624 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1626 # The default value is: YES.
1627 # This tag requires that the tag GENERATE_HTML is set to YES.
1631 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1632 # implemented using a web server instead of a web client using Javascript. There
1633 # are two flavours of web server based searching depending on the
1634 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1635 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1636 # enabled the indexing and searching needs to be provided by external tools. See
1637 # the section "External Indexing and Searching" for details.
1638 # The default value is: NO.
1639 # This tag requires that the tag SEARCHENGINE is set to YES.
1641 SERVER_BASED_SEARCH = NO
1643 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1644 # script for searching. Instead the search results are written to an XML file
1645 # which needs to be processed by an external indexer. Doxygen will invoke an
1646 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1649 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1650 # (doxysearch.cgi) which are based on the open source search engine library
1651 # Xapian (see: http://xapian.org/).
1653 # See the section "External Indexing and Searching" for details.
1654 # The default value is: NO.
1655 # This tag requires that the tag SEARCHENGINE is set to YES.
1657 EXTERNAL_SEARCH = NO
1659 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1660 # which will return the search results when EXTERNAL_SEARCH is enabled.
1662 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1663 # (doxysearch.cgi) which are based on the open source search engine library
1664 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1665 # Searching" for details.
1666 # This tag requires that the tag SEARCHENGINE is set to YES.
1670 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1671 # search data is written to a file for indexing by an external tool. With the
1672 # SEARCHDATA_FILE tag the name of this file can be specified.
1673 # The default file is: searchdata.xml.
1674 # This tag requires that the tag SEARCHENGINE is set to YES.
1676 SEARCHDATA_FILE = searchdata.xml
1678 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1679 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1680 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1681 # projects and redirect the results back to the right project.
1682 # This tag requires that the tag SEARCHENGINE is set to YES.
1684 EXTERNAL_SEARCH_ID =
1686 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1687 # projects other than the one defined by this configuration file, but that are
1688 # all added to the same external search index. Each project needs to have a
1689 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1690 # to a relative location where the documentation can be found. The format is:
1691 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1692 # This tag requires that the tag SEARCHENGINE is set to YES.
1694 EXTRA_SEARCH_MAPPINGS =
1696 #---------------------------------------------------------------------------
1697 # Configuration options related to the LaTeX output
1698 #---------------------------------------------------------------------------
1700 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1701 # The default value is: YES.
1703 GENERATE_LATEX = YES
1705 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1706 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1708 # The default directory is: latex.
1709 # This tag requires that the tag GENERATE_LATEX is set to YES.
1711 LATEX_OUTPUT = latex
1713 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1716 # Note that when enabling USE_PDFLATEX this option is only used for generating
1717 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1718 # written to the output directory.
1719 # The default file is: latex.
1720 # This tag requires that the tag GENERATE_LATEX is set to YES.
1722 LATEX_CMD_NAME = latex
1724 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1726 # The default file is: makeindex.
1727 # This tag requires that the tag GENERATE_LATEX is set to YES.
1729 MAKEINDEX_CMD_NAME = makeindex
1731 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1732 # documents. This may be useful for small projects and may help to save some
1734 # The default value is: NO.
1735 # This tag requires that the tag GENERATE_LATEX is set to YES.
1739 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1741 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1742 # 14 inches) and executive (7.25 x 10.5 inches).
1743 # The default value is: a4.
1744 # This tag requires that the tag GENERATE_LATEX is set to YES.
1748 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1749 # that should be included in the LaTeX output. To get the times font for
1750 # instance you can specify
1751 # EXTRA_PACKAGES=times
1752 # If left blank no extra packages will be included.
1753 # This tag requires that the tag GENERATE_LATEX is set to YES.
1757 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1758 # generated LaTeX document. The header should contain everything until the first
1759 # chapter. If it is left blank doxygen will generate a standard header. See
1760 # section "Doxygen usage" for information on how to let doxygen write the
1761 # default header to a separate file.
1763 # Note: Only use a user-defined header if you know what you are doing! The
1764 # following commands have a special meaning inside the header: $title,
1765 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1766 # replace them by respectively the title of the page, the current date and time,
1767 # only the current date, the version number of doxygen, the project name (see
1768 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1769 # This tag requires that the tag GENERATE_LATEX is set to YES.
1773 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1774 # generated LaTeX document. The footer should contain everything after the last
1775 # chapter. If it is left blank doxygen will generate a standard footer.
1777 # Note: Only use a user-defined footer if you know what you are doing!
1778 # This tag requires that the tag GENERATE_LATEX is set to YES.
1782 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1783 # other source files which should be copied to the LATEX_OUTPUT output
1784 # directory. Note that the files will be copied as-is; there are no commands or
1785 # markers available.
1786 # This tag requires that the tag GENERATE_LATEX is set to YES.
1790 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1791 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1792 # contain links (just like the HTML output) instead of page references. This
1793 # makes the output suitable for online browsing using a PDF viewer.
1794 # The default value is: YES.
1795 # This tag requires that the tag GENERATE_LATEX is set to YES.
1797 PDF_HYPERLINKS = YES
1799 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1800 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1801 # higher quality PDF documentation.
1802 # The default value is: YES.
1803 # This tag requires that the tag GENERATE_LATEX is set to YES.
1807 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1808 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1809 # if errors occur, instead of asking the user for help. This option is also used
1810 # when generating formulas in HTML.
1811 # The default value is: NO.
1812 # This tag requires that the tag GENERATE_LATEX is set to YES.
1814 LATEX_BATCHMODE = NO
1816 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1817 # index chapters (such as File Index, Compound Index, etc.) in the output.
1818 # The default value is: NO.
1819 # This tag requires that the tag GENERATE_LATEX is set to YES.
1821 LATEX_HIDE_INDICES = NO
1823 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1824 # code with syntax highlighting in the LaTeX output.
1826 # Note that which sources are shown also depends on other settings such as
1828 # The default value is: NO.
1829 # This tag requires that the tag GENERATE_LATEX is set to YES.
1831 LATEX_SOURCE_CODE = NO
1833 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1834 # bibliography, e.g. plainnat, or ieeetr. See
1835 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1836 # The default value is: plain.
1837 # This tag requires that the tag GENERATE_LATEX is set to YES.
1839 LATEX_BIB_STYLE = plain
1841 #---------------------------------------------------------------------------
1842 # Configuration options related to the RTF output
1843 #---------------------------------------------------------------------------
1845 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1846 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1848 # The default value is: NO.
1852 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1853 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1855 # The default directory is: rtf.
1856 # This tag requires that the tag GENERATE_RTF is set to YES.
1860 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1861 # documents. This may be useful for small projects and may help to save some
1863 # The default value is: NO.
1864 # This tag requires that the tag GENERATE_RTF is set to YES.
1868 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1869 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1870 # output) instead of page references. This makes the output suitable for online
1871 # browsing using Word or some other Word compatible readers that support those
1874 # Note: WordPad (write) and others do not support links.
1875 # The default value is: NO.
1876 # This tag requires that the tag GENERATE_RTF is set to YES.
1880 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1881 # file, i.e. a series of assignments. You only have to provide replacements,
1882 # missing definitions are set to their default value.
1884 # See also section "Doxygen usage" for information on how to generate the
1885 # default style sheet that doxygen normally uses.
1886 # This tag requires that the tag GENERATE_RTF is set to YES.
1888 RTF_STYLESHEET_FILE =
1890 # Set optional variables used in the generation of an RTF document. Syntax is
1891 # similar to doxygen's config file. A template extensions file can be generated
1892 # using doxygen -e rtf extensionFile.
1893 # This tag requires that the tag GENERATE_RTF is set to YES.
1895 RTF_EXTENSIONS_FILE =
1897 #---------------------------------------------------------------------------
1898 # Configuration options related to the man page output
1899 #---------------------------------------------------------------------------
1901 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1902 # classes and files.
1903 # The default value is: NO.
1907 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1908 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1909 # it. A directory man3 will be created inside the directory specified by
1911 # The default directory is: man.
1912 # This tag requires that the tag GENERATE_MAN is set to YES.
1916 # The MAN_EXTENSION tag determines the extension that is added to the generated
1917 # man pages. In case the manual section does not start with a number, the number
1918 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1920 # The default value is: .3.
1921 # This tag requires that the tag GENERATE_MAN is set to YES.
1925 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1926 # will generate one additional man file for each entity documented in the real
1927 # man page(s). These additional files only source the real man page, but without
1928 # them the man command would be unable to find the correct page.
1929 # The default value is: NO.
1930 # This tag requires that the tag GENERATE_MAN is set to YES.
1934 #---------------------------------------------------------------------------
1935 # Configuration options related to the XML output
1936 #---------------------------------------------------------------------------
1938 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1939 # captures the structure of the code including all documentation.
1940 # The default value is: NO.
1944 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1945 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1947 # The default directory is: xml.
1948 # This tag requires that the tag GENERATE_XML is set to YES.
1951 XML_FILE_EXTENSION = .xml
1953 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1954 # validating XML parser to check the syntax of the XML files.
1955 # This tag requires that the tag GENERATE_XML is set to YES.
1959 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1960 # validating XML parser to check the syntax of the XML files.
1961 # This tag requires that the tag GENERATE_XML is set to YES.
1965 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1966 # listings (including syntax highlighting and cross-referencing information) to
1967 # the XML output. Note that enabling this will significantly increase the size
1968 # of the XML output.
1969 # The default value is: YES.
1970 # This tag requires that the tag GENERATE_XML is set to YES.
1972 XML_PROGRAMLISTING = YES
1974 #---------------------------------------------------------------------------
1975 # Configuration options related to the DOCBOOK output
1976 #---------------------------------------------------------------------------
1978 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1979 # that can be used to generate PDF.
1980 # The default value is: NO.
1982 GENERATE_DOCBOOK = NO
1984 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1985 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1987 # The default directory is: docbook.
1988 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1990 DOCBOOK_OUTPUT = docbook
1992 #---------------------------------------------------------------------------
1993 # Configuration options for the AutoGen Definitions output
1994 #---------------------------------------------------------------------------
1996 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1997 # Definitions (see http://autogen.sf.net) file that captures the structure of
1998 # the code including all documentation. Note that this feature is still
1999 # experimental and incomplete at the moment.
2000 # The default value is: NO.
2002 GENERATE_AUTOGEN_DEF = NO
2004 #---------------------------------------------------------------------------
2005 # Configuration options related to the Perl module output
2006 #---------------------------------------------------------------------------
2008 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
2009 # file that captures the structure of the code including all documentation.
2011 # Note that this feature is still experimental and incomplete at the moment.
2012 # The default value is: NO.
2014 GENERATE_PERLMOD = NO
2016 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
2017 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2018 # output from the Perl module output.
2019 # The default value is: NO.
2020 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2024 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
2025 # formatted so it can be parsed by a human reader. This is useful if you want to
2026 # understand what is going on. On the other hand, if this tag is set to NO the
2027 # size of the Perl module output will be much smaller and Perl will parse it
2029 # The default value is: YES.
2030 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2032 PERLMOD_PRETTY = YES
2034 # The names of the make variables in the generated doxyrules.make file are
2035 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2036 # so different doxyrules.make files included by the same Makefile don't
2037 # overwrite each other's variables.
2038 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2040 PERLMOD_MAKEVAR_PREFIX =
2042 #---------------------------------------------------------------------------
2043 # Configuration options related to the preprocessor
2044 #---------------------------------------------------------------------------
2046 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
2047 # C-preprocessor directives found in the sources and include files.
2048 # The default value is: YES.
2050 ENABLE_PREPROCESSING = YES
2052 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
2053 # in the source code. If set to NO only conditional compilation will be
2054 # performed. Macro expansion can be done in a controlled way by setting
2055 # EXPAND_ONLY_PREDEF to YES.
2056 # The default value is: NO.
2057 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2059 MACRO_EXPANSION = NO
2061 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2062 # the macro expansion is limited to the macros specified with the PREDEFINED and
2063 # EXPAND_AS_DEFINED tags.
2064 # The default value is: NO.
2065 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2067 EXPAND_ONLY_PREDEF = NO
2069 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
2070 # INCLUDE_PATH will be searched if a #include is found.
2071 # The default value is: YES.
2072 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2074 SEARCH_INCLUDES = YES
2076 # The INCLUDE_PATH tag can be used to specify one or more directories that
2077 # contain include files that are not input files but should be processed by the
2079 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2083 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2084 # patterns (like *.h and *.hpp) to filter out the header-files in the
2085 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2087 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2089 INCLUDE_FILE_PATTERNS =
2091 # The PREDEFINED tag can be used to specify one or more macro names that are
2092 # defined before the preprocessor is started (similar to the -D option of e.g.
2093 # gcc). The argument of the tag is a list of macros of the form: name or
2094 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2095 # is assumed. To prevent a macro definition from being undefined via #undef or
2096 # recursively expanded use the := operator instead of the = operator.
2097 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2101 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2102 # tag can be used to specify a list of macro names that should be expanded. The
2103 # macro definition that is found in the sources will be used. Use the PREDEFINED
2104 # tag if you want to use a different macro definition that overrules the
2105 # definition found in the source code.
2106 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2110 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2111 # remove all refrences to function-like macros that are alone on a line, have an
2112 # all uppercase name, and do not end with a semicolon. Such function macros are
2113 # typically used for boiler-plate code, and will confuse the parser if not
2115 # The default value is: YES.
2116 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2118 SKIP_FUNCTION_MACROS = YES
2120 #---------------------------------------------------------------------------
2121 # Configuration options related to external references
2122 #---------------------------------------------------------------------------
2124 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2125 # file the location of the external documentation should be added. The format of
2126 # a tag file without this location is as follows:
2127 # TAGFILES = file1 file2 ...
2128 # Adding location for the tag files is done as follows:
2129 # TAGFILES = file1=loc1 "file2 = loc2" ...
2130 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2131 # section "Linking to external documentation" for more information about the use
2133 # Note: Each tag file must have an unique name (where the name does NOT include
2134 # the path). If a tag file is not located in the directory in which doxygen is
2135 # run, you must also specify the path to the tagfile here.
2139 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2140 # tag file that is based on the input files it reads. See section "Linking to
2141 # external documentation" for more information about the usage of tag files.
2145 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2146 # class index. If set to NO only the inherited external classes will be listed.
2147 # The default value is: NO.
2151 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2152 # the modules index. If set to NO, only the current project's groups will be
2154 # The default value is: YES.
2156 EXTERNAL_GROUPS = YES
2158 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2159 # the related pages index. If set to NO, only the current project's pages will
2161 # The default value is: YES.
2163 EXTERNAL_PAGES = YES
2165 # The PERL_PATH should be the absolute path and name of the perl script
2166 # interpreter (i.e. the result of 'which perl').
2167 # The default file (with absolute path) is: /usr/bin/perl.
2169 PERL_PATH = /usr/bin/perl
2171 #---------------------------------------------------------------------------
2172 # Configuration options related to the dot tool
2173 #---------------------------------------------------------------------------
2175 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2176 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2177 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2178 # disabled, but it is recommended to install and use dot, since it yields more
2180 # The default value is: YES.
2182 CLASS_DIAGRAMS = YES
2184 # You can define message sequence charts within doxygen comments using the \msc
2185 # command. Doxygen will then run the mscgen tool (see:
2186 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2187 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2188 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2189 # default search path.
2193 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2194 # then run dia to produce the diagram and insert it in the documentation. The
2195 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2196 # If left empty dia is assumed to be found in the default search path.
2200 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2201 # and usage relations if the target is undocumented or is not a class.
2202 # The default value is: YES.
2204 HIDE_UNDOC_RELATIONS = YES
2206 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2207 # available from the path. This tool is part of Graphviz (see:
2208 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2209 # Bell Labs. The other options in this section have no effect if this option is
2211 # The default value is: NO.
2215 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2216 # to run in parallel. When set to 0 doxygen will base this on the number of
2217 # processors available in the system. You can set it explicitly to a value
2218 # larger than 0 to get control over the balance between CPU load and processing
2220 # Minimum value: 0, maximum value: 32, default value: 0.
2221 # This tag requires that the tag HAVE_DOT is set to YES.
2225 # When you want a differently looking font n the dot files that doxygen
2226 # generates you can specify the font name using DOT_FONTNAME. You need to make
2227 # sure dot is able to find the font, which can be done by putting it in a
2228 # standard location or by setting the DOTFONTPATH environment variable or by
2229 # setting DOT_FONTPATH to the directory containing the font.
2230 # The default value is: Helvetica.
2231 # This tag requires that the tag HAVE_DOT is set to YES.
2233 DOT_FONTNAME = Helvetica
2235 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2237 # Minimum value: 4, maximum value: 24, default value: 10.
2238 # This tag requires that the tag HAVE_DOT is set to YES.
2242 # By default doxygen will tell dot to use the default font as specified with
2243 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2244 # the path where dot can find it using this tag.
2245 # This tag requires that the tag HAVE_DOT is set to YES.
2249 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2250 # each documented class showing the direct and indirect inheritance relations.
2251 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2252 # The default value is: YES.
2253 # This tag requires that the tag HAVE_DOT is set to YES.
2257 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2258 # graph for each documented class showing the direct and indirect implementation
2259 # dependencies (inheritance, containment, and class references variables) of the
2260 # class with other documented classes.
2261 # The default value is: YES.
2262 # This tag requires that the tag HAVE_DOT is set to YES.
2264 COLLABORATION_GRAPH = YES
2266 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2267 # groups, showing the direct groups dependencies.
2268 # The default value is: YES.
2269 # This tag requires that the tag HAVE_DOT is set to YES.
2273 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2274 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2276 # The default value is: NO.
2277 # This tag requires that the tag HAVE_DOT is set to YES.
2281 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2282 # class node. If there are many fields or methods and many nodes the graph may
2283 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2284 # number of items for each type to make the size more manageable. Set this to 0
2285 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2286 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2287 # but if the number exceeds 15, the total amount of fields shown is limited to
2289 # Minimum value: 0, maximum value: 100, default value: 10.
2290 # This tag requires that the tag HAVE_DOT is set to YES.
2292 UML_LIMIT_NUM_FIELDS = 10
2294 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2295 # collaboration graphs will show the relations between templates and their
2297 # The default value is: NO.
2298 # This tag requires that the tag HAVE_DOT is set to YES.
2300 TEMPLATE_RELATIONS = NO
2302 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2303 # YES then doxygen will generate a graph for each documented file showing the
2304 # direct and indirect include dependencies of the file with other documented
2306 # The default value is: YES.
2307 # This tag requires that the tag HAVE_DOT is set to YES.
2311 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2312 # set to YES then doxygen will generate a graph for each documented file showing
2313 # the direct and indirect include dependencies of the file with other documented
2315 # The default value is: YES.
2316 # This tag requires that the tag HAVE_DOT is set to YES.
2318 INCLUDED_BY_GRAPH = YES
2320 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2321 # dependency graph for every global function or class method.
2323 # Note that enabling this option will significantly increase the time of a run.
2324 # So in most cases it will be better to enable call graphs for selected
2325 # functions only using the \callgraph command.
2326 # The default value is: NO.
2327 # This tag requires that the tag HAVE_DOT is set to YES.
2331 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2332 # dependency graph for every global function or class method.
2334 # Note that enabling this option will significantly increase the time of a run.
2335 # So in most cases it will be better to enable caller graphs for selected
2336 # functions only using the \callergraph command.
2337 # The default value is: NO.
2338 # This tag requires that the tag HAVE_DOT is set to YES.
2342 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2343 # hierarchy of all classes instead of a textual one.
2344 # The default value is: YES.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2347 GRAPHICAL_HIERARCHY = YES
2349 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2350 # dependencies a directory has on other directories in a graphical way. The
2351 # dependency relations are determined by the #include relations between the
2352 # files in the directories.
2353 # The default value is: YES.
2354 # This tag requires that the tag HAVE_DOT is set to YES.
2356 DIRECTORY_GRAPH = YES
2358 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2360 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2361 # to make the SVG files visible in IE 9+ (other browsers do not have this
2363 # Possible values are: png, jpg, gif and svg.
2364 # The default value is: png.
2365 # This tag requires that the tag HAVE_DOT is set to YES.
2367 DOT_IMAGE_FORMAT = png
2369 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2370 # enable generation of interactive SVG images that allow zooming and panning.
2372 # Note that this requires a modern browser other than Internet Explorer. Tested
2373 # and working are Firefox, Chrome, Safari, and Opera.
2374 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2375 # the SVG files visible. Older versions of IE do not have SVG support.
2376 # The default value is: NO.
2377 # This tag requires that the tag HAVE_DOT is set to YES.
2379 INTERACTIVE_SVG = NO
2381 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2382 # found. If left blank, it is assumed the dot tool can be found in the path.
2383 # This tag requires that the tag HAVE_DOT is set to YES.
2387 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2388 # contain dot files that are included in the documentation (see the \dotfile
2390 # This tag requires that the tag HAVE_DOT is set to YES.
2394 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2395 # contain msc files that are included in the documentation (see the \mscfile
2400 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2401 # contain dia files that are included in the documentation (see the \diafile
2406 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2407 # that will be shown in the graph. If the number of nodes in a graph becomes
2408 # larger than this value, doxygen will truncate the graph, which is visualized
2409 # by representing a node as a red box. Note that doxygen if the number of direct
2410 # children of the root node in a graph is already larger than
2411 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2412 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2413 # Minimum value: 0, maximum value: 10000, default value: 50.
2414 # This tag requires that the tag HAVE_DOT is set to YES.
2416 DOT_GRAPH_MAX_NODES = 50
2418 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2419 # generated by dot. A depth value of 3 means that only nodes reachable from the
2420 # root by following a path via at most 3 edges will be shown. Nodes that lay
2421 # further from the root node will be omitted. Note that setting this option to 1
2422 # or 2 may greatly reduce the computation time needed for large code bases. Also
2423 # note that the size of a graph can be further restricted by
2424 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2425 # Minimum value: 0, maximum value: 1000, default value: 0.
2426 # This tag requires that the tag HAVE_DOT is set to YES.
2428 MAX_DOT_GRAPH_DEPTH = 0
2430 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2431 # background. This is disabled by default, because dot on Windows does not seem
2432 # to support this out of the box.
2434 # Warning: Depending on the platform used, enabling this option may lead to
2435 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2437 # The default value is: NO.
2438 # This tag requires that the tag HAVE_DOT is set to YES.
2440 DOT_TRANSPARENT = NO
2442 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2443 # files in one run (i.e. multiple -o and -T options on the command line). This
2444 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2445 # this, this feature is disabled by default.
2446 # The default value is: NO.
2447 # This tag requires that the tag HAVE_DOT is set to YES.
2449 DOT_MULTI_TARGETS = YES
2451 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2452 # explaining the meaning of the various boxes and arrows in the dot generated
2454 # The default value is: YES.
2455 # This tag requires that the tag HAVE_DOT is set to YES.
2457 GENERATE_LEGEND = YES
2459 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2460 # files that are used to generate the various graphs.
2461 # The default value is: YES.
2462 # This tag requires that the tag HAVE_DOT is set to YES.
2466 # For Open Source DALi API Reference
2467 ALIASES += SINCE_1_0="@since 1.0"
2468 ALIASES += SINCE_1_1="@since 1.1"
2469 ALIASES += SINCE_1_2="@since 1.2"
2471 # Extra tags for Tizen 3.0
2472 ALIASES += SINCE_1_2_2="@since 1.2.2"
2473 ALIASES += SINCE_1_2_4="@since 1.2.4"
2474 ALIASES += SINCE_1_2_5="@since 1.2.5"
2476 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
2477 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
2478 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"
2480 ALIASES += PLATFORM=""
2481 ALIASES += PRIVLEVEL_PLATFORM=""
2482 ALIASES += PRIVLEVEL_PUBLIC=""
2483 ALIASES += PRIVILEGE_KEYGRAB=""
2484 ALIASES += PRIVILEGE_DISPLAY=""
2485 ALIASES += REMARK_INTERNET=""