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.
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.
61 OUTPUT_DIRECTORY = @DOXYGEN_DOCS_DIR@/generated
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.
113 ABBREVIATE_BRIEF = "The $name class" \
125 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
126 # doxygen will generate a detailed section even if there is only a brief
128 # The default value is: NO.
130 ALWAYS_DETAILED_SEC = NO
132 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
133 # inherited members of a class in the documentation of that class as if those
134 # members were ordinary class members. Constructors, destructors and assignment
135 # operators of the base classes will not be shown.
136 # The default value is: NO.
138 INLINE_INHERITED_MEMB = NO
140 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
141 # before files name in the file list and in the header files. If set to NO the
142 # shortest path that makes the file name unique will be used
143 # The default value is: YES.
145 FULL_PATH_NAMES = YES
147 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
148 # Stripping is only done if one of the specified strings matches the left-hand
149 # part of the path. The tag can be used to show relative paths in the file list.
150 # If left blank the directory from which doxygen is run is used as the path to
153 # Note that you can specify absolute paths here, but also relative paths, which
154 # will be relative from the directory where doxygen is started.
155 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
159 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
160 # path mentioned in the documentation of a class, which tells the reader which
161 # header file to include in order to use a class. If left blank only the name of
162 # the header file containing the class definition is used. Otherwise one should
163 # specify the list of include paths that are normally passed to the compiler
166 STRIP_FROM_INC_PATH =
168 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
169 # less readable) file names. This can be useful is your file systems doesn't
170 # support long names like on DOS, Mac, or CD-ROM.
171 # The default value is: NO.
175 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
176 # first line (until the first dot) of a Javadoc-style comment as the brief
177 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
178 # style comments (thus requiring an explicit @brief command for a brief
180 # The default value is: NO.
182 JAVADOC_AUTOBRIEF = YES
184 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
185 # line (until the first dot) of a Qt-style comment as the brief description. If
186 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
187 # requiring an explicit \brief command for a brief description.)
188 # The default value is: NO.
192 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
193 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
194 # a brief description. This used to be the default behavior. The new default is
195 # to treat a multi-line C++ comment block as a detailed description. Set this
196 # tag to YES if you prefer the old behavior instead.
198 # Note that setting this tag to YES also means that rational rose comments are
199 # not recognized any more.
200 # The default value is: NO.
202 MULTILINE_CPP_IS_BRIEF = NO
204 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
205 # documentation from any documented member that it re-implements.
206 # The default value is: YES.
210 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
211 # new page for each member. If set to NO, the documentation of a member will be
212 # part of the file/class/namespace that contains it.
213 # The default value is: NO.
215 SEPARATE_MEMBER_PAGES = NO
217 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
218 # uses this value to replace tabs by spaces in code fragments.
219 # Minimum value: 1, maximum value: 16, default value: 4.
223 # This tag can be used to specify a number of aliases that act as commands in
224 # the documentation. An alias has the form:
227 # "sideeffect=@par Side Effects:\n"
228 # will allow you to put the command \sideeffect (or @sideeffect) in the
229 # documentation, which will result in a user-defined paragraph with heading
230 # "Side Effects:". You can put \n's in the value part of an alias to insert
234 # Clip alias inserts the specified file between two text markers.
235 # EG: @clip{"button.h",public,private}
236 # Shows all lines between public and private *inclusive*.
237 ALIASES += clip{3}="\dontinclude \1 \n \skip \2 \n \until \3"
239 # This tag can be used to specify a number of word-keyword mappings (TCL only).
240 # A mapping has the form "name=value". For example adding "class=itcl::class"
241 # will allow you to use the command class in the itcl::class meaning.
245 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
246 # only. Doxygen will then generate output that is more tailored for C. For
247 # instance, some of the names that are used will be different. The list of all
248 # members will be omitted, etc.
249 # The default value is: NO.
251 OPTIMIZE_OUTPUT_FOR_C = NO
253 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
254 # Python sources only. Doxygen will then generate output that is more tailored
255 # for that language. For instance, namespaces will be presented as packages,
256 # qualified scopes will look different, etc.
257 # The default value is: NO.
259 OPTIMIZE_OUTPUT_JAVA = NO
261 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
262 # sources. Doxygen will then generate output that is tailored for Fortran.
263 # The default value is: NO.
265 OPTIMIZE_FOR_FORTRAN = NO
267 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
268 # sources. Doxygen will then generate output that is tailored for VHDL.
269 # The default value is: NO.
271 OPTIMIZE_OUTPUT_VHDL = NO
273 # Doxygen selects the parser to use depending on the extension of the files it
274 # parses. With this tag you can assign which parser to use for a given
275 # extension. Doxygen has a built-in mapping, but you can override or extend it
276 # using this tag. The format is ext=language, where ext is a file extension, and
277 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
278 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
279 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
280 # (default is Fortran), use: inc=Fortran f=C.
282 # Note For files without extension you can use no_extension as a placeholder.
284 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
285 # the files are not read by doxygen.
289 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
290 # according to the Markdown format, which allows for more readable
291 # documentation. See http://daringfireball.net/projects/markdown/ for details.
292 # The output of markdown processing is further processed by doxygen, so you can
293 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
294 # case of backward compatibilities issues.
295 # The default value is: YES.
297 MARKDOWN_SUPPORT = YES
299 # When enabled doxygen tries to link words that correspond to documented
300 # classes, or namespaces to their corresponding documentation. Such a link can
301 # be prevented in individual cases by by putting a % sign in front of the word
302 # or globally by setting AUTOLINK_SUPPORT to NO.
303 # The default value is: YES.
305 AUTOLINK_SUPPORT = YES
307 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
308 # to include (a tag file for) the STL sources as input, then you should set this
309 # tag to YES in order to let doxygen match functions declarations and
310 # definitions whose arguments contain STL classes (e.g. func(std::string);
311 # versus func(std::string) {}). This also make the inheritance and collaboration
312 # diagrams that involve STL classes more complete and accurate.
313 # The default value is: NO.
315 BUILTIN_STL_SUPPORT = YES
317 # If you use Microsoft's C++/CLI language, you should set this option to YES to
318 # enable parsing support.
319 # The default value is: NO.
323 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
324 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
325 # will parse them like normal C++ but will assume all classes use public instead
326 # of private inheritance when no explicit protection keyword is present.
327 # The default value is: NO.
331 # For Microsoft's IDL there are propget and propput attributes to indicate
332 # getter and setter methods for a property. Setting this option to YES will make
333 # doxygen to replace the get and set methods by a property in the documentation.
334 # This will only work if the methods are indeed getting or setting a simple
335 # type. If this is not the case, or you want to show the methods anyway, you
336 # should set this option to NO.
337 # The default value is: YES.
339 IDL_PROPERTY_SUPPORT = YES
341 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
342 # tag is set to YES, then doxygen will reuse the documentation of the first
343 # member in the group (if any) for the other members of the group. By default
344 # all members of a group must be documented explicitly.
345 # The default value is: NO.
347 DISTRIBUTE_GROUP_DOC = NO
349 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
350 # (for instance a group of public functions) to be put as a subgroup of that
351 # type (e.g. under the Public Functions section). Set it to NO to prevent
352 # subgrouping. Alternatively, this can be done per class using the
353 # \nosubgrouping command.
354 # The default value is: YES.
358 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
359 # are shown inside the group in which they are included (e.g. using \ingroup)
360 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
363 # Note that this feature does not work in combination with
364 # SEPARATE_MEMBER_PAGES.
365 # The default value is: NO.
367 INLINE_GROUPED_CLASSES = NO
369 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
370 # with only public data fields or simple typedef fields will be shown inline in
371 # the documentation of the scope in which they are defined (i.e. file,
372 # namespace, or group documentation), provided this scope is documented. If set
373 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
374 # Man pages) or section (for LaTeX and RTF).
375 # The default value is: NO.
377 INLINE_SIMPLE_STRUCTS = NO
379 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
380 # enum is documented as struct, union, or enum with the name of the typedef. So
381 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
382 # with name TypeT. When disabled the typedef will appear as a member of a file,
383 # namespace, or class. And the struct will be named TypeS. This can typically be
384 # useful for C code in case the coding convention dictates that all compound
385 # types are typedef'ed and only the typedef is referenced, never the tag name.
386 # The default value is: NO.
388 TYPEDEF_HIDES_STRUCT = NO
390 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
391 # cache is used to resolve symbols given their name and scope. Since this can be
392 # an expensive process and often the same symbol appears multiple times in the
393 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
394 # doxygen will become slower. If the cache is too large, memory is wasted. The
395 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
396 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
397 # symbols. At the end of a run doxygen will report the cache usage and suggest
398 # the optimal cache size from a speed point of view.
399 # Minimum value: 0, maximum value: 9, default value: 0.
401 LOOKUP_CACHE_SIZE = 0
403 #---------------------------------------------------------------------------
404 # Build related configuration options
405 #---------------------------------------------------------------------------
407 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
408 # documentation are documented, even if no documentation was available. Private
409 # class members and static file members will be hidden unless the
410 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
411 # Note: This will also disable the warnings about undocumented members that are
412 # normally produced when WARNINGS is set to YES.
413 # The default value is: NO.
417 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
418 # be included in the documentation.
419 # The default value is: NO.
421 EXTRACT_PRIVATE = YES
423 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
424 # scope will be included in the documentation.
425 # The default value is: NO.
429 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
430 # included in the documentation.
431 # The default value is: NO.
435 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
436 # locally in source files will be included in the documentation. If set to NO
437 # only classes defined in header files are included. Does not have any effect
439 # The default value is: YES.
441 EXTRACT_LOCAL_CLASSES = YES
443 # This flag is only useful for Objective-C code. When set to YES local methods,
444 # which are defined in the implementation section but not in the interface are
445 # included in the documentation. If set to NO only methods in the interface are
447 # The default value is: NO.
449 EXTRACT_LOCAL_METHODS = NO
451 # If this flag is set to YES, the members of anonymous namespaces will be
452 # extracted and appear in the documentation as a namespace called
453 # 'anonymous_namespace{file}', where file will be replaced with the base name of
454 # the file that contains the anonymous namespace. By default anonymous namespace
456 # The default value is: NO.
458 EXTRACT_ANON_NSPACES = NO
460 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
461 # undocumented members inside documented classes or files. If set to NO these
462 # members will be included in the various overviews, but no documentation
463 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
464 # The default value is: NO.
466 HIDE_UNDOC_MEMBERS = NO
468 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
469 # undocumented classes that are normally visible in the class hierarchy. If set
470 # to NO these classes will be included in the various overviews. This option has
471 # no effect if EXTRACT_ALL is enabled.
472 # The default value is: NO.
474 HIDE_UNDOC_CLASSES = NO
476 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
477 # (class|struct|union) declarations. If set to NO these declarations will be
478 # included in the documentation.
479 # The default value is: NO.
481 HIDE_FRIEND_COMPOUNDS = NO
483 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
484 # documentation blocks found inside the body of a function. If set to NO these
485 # blocks will be appended to the function's detailed documentation block.
486 # The default value is: NO.
488 HIDE_IN_BODY_DOCS = NO
490 # The INTERNAL_DOCS tag determines if documentation that is typed after a
491 # \internal command is included. If the tag is set to NO then the documentation
492 # will be excluded. Set it to YES to include the internal documentation.
493 # The default value is: NO.
497 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
498 # names in lower-case letters. If set to YES upper-case letters are also
499 # allowed. This is useful if you have classes or files whose names only differ
500 # in case and if your file system supports case sensitive file names. Windows
501 # and Mac users are advised to set this option to NO.
502 # The default value is: system dependent.
504 CASE_SENSE_NAMES = NO
506 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
507 # their full class and namespace scopes in the documentation. If set to YES the
508 # scope will be hidden.
509 # The default value is: NO.
511 HIDE_SCOPE_NAMES = NO
513 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
514 # the files that are included by a file in the documentation of that file.
515 # The default value is: YES.
517 SHOW_INCLUDE_FILES = YES
519 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
520 # grouped member an include statement to the documentation, telling the reader
521 # which file to include in order to use the member.
522 # The default value is: NO.
524 SHOW_GROUPED_MEMB_INC = NO
526 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
527 # files with double quotes in the documentation rather than with sharp brackets.
528 # The default value is: NO.
530 FORCE_LOCAL_INCLUDES = NO
532 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
533 # documentation for inline members.
534 # The default value is: YES.
538 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
539 # (detailed) documentation of file and class members alphabetically by member
540 # name. If set to NO the members will appear in declaration order.
541 # The default value is: YES.
543 SORT_MEMBER_DOCS = YES
545 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
546 # descriptions of file, namespace and class members alphabetically by member
547 # name. If set to NO the members will appear in declaration order. Note that
548 # this will also influence the order of the classes in the class list.
549 # The default value is: NO.
553 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
554 # (brief and detailed) documentation of class members so that constructors and
555 # destructors are listed first. If set to NO the constructors will appear in the
556 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
557 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
558 # member documentation.
559 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
560 # detailed member documentation.
561 # The default value is: NO.
563 SORT_MEMBERS_CTORS_1ST = NO
565 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
566 # of group names into alphabetical order. If set to NO the group names will
567 # appear in their defined order.
568 # The default value is: NO.
570 SORT_GROUP_NAMES = NO
572 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
573 # fully-qualified names, including namespaces. If set to NO, the class list will
574 # be sorted only by class name, not including the namespace part.
575 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
576 # Note: This option applies only to the class list, not to the alphabetical
578 # The default value is: NO.
580 SORT_BY_SCOPE_NAME = NO
582 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
583 # type resolution of all parameters of a function it will reject a match between
584 # the prototype and the implementation of a member function even if there is
585 # only one candidate or it is obvious which candidate to choose by doing a
586 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
587 # accept a match between prototype and implementation in such cases.
588 # The default value is: NO.
590 STRICT_PROTO_MATCHING = NO
592 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
593 # todo list. This list is created by putting \todo commands in the
595 # The default value is: YES.
597 GENERATE_TODOLIST = NO
599 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
600 # test list. This list is created by putting \test commands in the
602 # The default value is: YES.
604 GENERATE_TESTLIST = NO
606 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
607 # list. This list is created by putting \bug commands in the documentation.
608 # The default value is: YES.
610 GENERATE_BUGLIST = NO
612 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
613 # the deprecated list. This list is created by putting \deprecated commands in
615 # The default value is: YES.
617 GENERATE_DEPRECATEDLIST= YES
619 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
620 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
621 # ... \endcond blocks.
625 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
626 # initial value of a variable or macro / define can have for it to appear in the
627 # documentation. If the initializer consists of more lines than specified here
628 # it will be hidden. Use a value of 0 to hide initializers completely. The
629 # appearance of the value of individual variables and macros / defines can be
630 # controlled using \showinitializer or \hideinitializer command in the
631 # documentation regardless of this setting.
632 # Minimum value: 0, maximum value: 10000, default value: 30.
634 MAX_INITIALIZER_LINES = 30
636 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
637 # the bottom of the documentation of classes and structs. If set to YES the list
638 # will mention the files that were used to generate the documentation.
639 # The default value is: YES.
641 SHOW_USED_FILES = YES
643 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
644 # will remove the Files entry from the Quick Index and from the Folder Tree View
646 # The default value is: YES.
650 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
651 # page. This will remove the Namespaces entry from the Quick Index and from the
652 # Folder Tree View (if specified).
653 # The default value is: YES.
655 SHOW_NAMESPACES = YES
657 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
658 # doxygen should invoke to get the current version for each file (typically from
659 # the version control system). Doxygen will invoke the program by executing (via
660 # popen()) the command command input-file, where command is the value of the
661 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
662 # by doxygen. Whatever the program writes to standard output is used as the file
663 # version. For an example see the documentation.
665 FILE_VERSION_FILTER =
667 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
668 # by doxygen. The layout file controls the global structure of the generated
669 # output files in an output format independent way. To create the layout file
670 # that represents doxygen's defaults, run doxygen with the -l option. You can
671 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
672 # will be used as the name of the layout file.
674 # Note that if you run doxygen from a directory containing a file called
675 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
678 LAYOUT_FILE = @DOXYGEN_DOCS_DIR@/DaliLayout.xml
680 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
681 # the reference definitions. This must be a list of .bib files. The .bib
682 # extension is automatically appended if omitted. This requires the bibtex tool
683 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
684 # For LaTeX the style of the bibliography can be controlled using
685 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
686 # search path. Do not use file names with spaces, bibtex cannot handle them. See
687 # also \cite for info how to create references.
691 #---------------------------------------------------------------------------
692 # Configuration options related to warning and progress messages
693 #---------------------------------------------------------------------------
695 # The QUIET tag can be used to turn on/off the messages that are generated to
696 # standard output by doxygen. If QUIET is set to YES this implies that the
698 # The default value is: NO.
702 # The WARNINGS tag can be used to turn on/off the warning messages that are
703 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
704 # this implies that the warnings are on.
706 # Tip: Turn warnings on while writing the documentation.
707 # The default value is: YES.
711 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
712 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
713 # will automatically be disabled.
714 # The default value is: YES.
716 WARN_IF_UNDOCUMENTED = YES
718 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
719 # potential errors in the documentation, such as not documenting some parameters
720 # in a documented function, or documenting parameters that don't exist or using
721 # markup commands wrongly.
722 # The default value is: YES.
724 WARN_IF_DOC_ERROR = YES
726 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
727 # are documented, but have no documentation for their parameters or return
728 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
729 # documentation, but not about the absence of documentation.
730 # The default value is: NO.
732 WARN_NO_PARAMDOC = YES
734 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
735 # can produce. The string should contain the $file, $line, and $text tags, which
736 # will be replaced by the file and line number from which the warning originated
737 # and the warning text. Optionally the format may contain $version, which will
738 # be replaced by the version of the file (if it could be obtained via
739 # FILE_VERSION_FILTER)
740 # The default value is: $file:$line: $text.
742 WARN_FORMAT = "$file:$line: $text"
744 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
745 # messages should be written. If left blank the output is written to standard
750 #---------------------------------------------------------------------------
751 # Configuration options related to the input files
752 #---------------------------------------------------------------------------
754 # The INPUT tag is used to specify the files and/or directories that contain
755 # documented source files. You may enter file names like myfile.cpp or
756 # directories like /usr/src/myproject. Separate the files or directories with
758 # Note: If this tag is empty the current directory is searched.
760 INPUT = @DOXYGEN_DOCS_DIR@/content \
761 ../../../../dali-toolkit/dali-toolkit/public-api \
762 ../../../automated-tests/README.md \
763 @prefix@/include/dali
765 # This tag can be used to specify the character encoding of the source files
766 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
767 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
768 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
769 # possible encodings.
770 # The default value is: UTF-8.
772 INPUT_ENCODING = UTF-8
774 # If the value of the INPUT tag contains directories, you can use the
775 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
776 # *.h) to filter out the source-files in the directories. If left blank the
777 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
778 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
779 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
780 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
781 # *.qsf, *.as and *.js.
783 FILE_PATTERNS = *.c \
816 # The RECURSIVE tag can be used to specify whether or not subdirectories should
817 # be searched for input files as well.
818 # The default value is: NO.
822 # The EXCLUDE tag can be used to specify files and/or directories that should be
823 # excluded from the INPUT source files. This way you can easily exclude a
824 # subdirectory from a directory tree whose root is specified with the INPUT tag.
826 # Note that relative paths are relative to the directory from which doxygen is
829 EXCLUDE = dali/integration-api
831 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
832 # directories that are symbolic links (a Unix file system feature) are excluded
834 # The default value is: NO.
836 EXCLUDE_SYMLINKS = NO
838 # If the value of the INPUT tag contains directories, you can use the
839 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
840 # certain files from those directories.
842 # Note that the wildcards are matched against the file with absolute path, so to
843 # exclude all test directories for example use the pattern */test/*
847 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
848 # (namespaces, classes, functions, etc.) that should be excluded from the
849 # output. The symbol name can be a fully qualified name, a word, or if the
850 # wildcard * is used, a substring. Examples: ANamespace, AClass,
851 # AClass::ANamespace, ANamespace::*Test
853 # Note that the wildcards are matched against the file with absolute path, so to
854 # exclude all test directories use the pattern */test/*
856 EXCLUDE_SYMBOLS = DaliInternal \
862 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
863 # that contain example code fragments that are included (see the \include
866 EXAMPLE_PATH = @DOXYGEN_DOCS_DIR@/../
868 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
869 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
870 # *.h) to filter out the source-files in the directories. If left blank all
871 # files are included.
875 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
876 # searched for input files to be used with the \include or \dontinclude commands
877 # irrespective of the value of the RECURSIVE tag.
878 # The default value is: NO.
880 EXAMPLE_RECURSIVE = YES
882 # The IMAGE_PATH tag can be used to specify one or more files or directories
883 # that contain images that are to be included in the documentation (see the
886 IMAGE_PATH = @DOXYGEN_DOCS_DIR@/content/images
888 # The INPUT_FILTER tag can be used to specify a program that doxygen should
889 # invoke to filter for each input file. Doxygen will invoke the filter program
890 # by executing (via popen()) the command:
892 # <filter> <input-file>
894 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
895 # name of an input file. Doxygen will then use the output that the filter
896 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
899 # Note that the filter must not add or remove lines; it is applied before the
900 # code is scanned, but not when the output code is generated. If lines are added
901 # or removed, the anchors will not be placed correctly.
905 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
906 # basis. Doxygen will compare the file name with each pattern and apply the
907 # filter if there is a match. The filters are a list of the form: pattern=filter
908 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
909 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
910 # patterns match the file name, INPUT_FILTER is applied.
914 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
915 # INPUT_FILTER ) will also be used to filter the input files that are used for
916 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
917 # The default value is: NO.
919 FILTER_SOURCE_FILES = NO
921 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
922 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
923 # it is also possible to disable source filtering for a specific pattern using
924 # *.ext= (so without naming a filter).
925 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
927 FILTER_SOURCE_PATTERNS =
929 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
930 # is part of the input, its contents will be placed on the main page
931 # (index.html). This can be useful if you have a project on for instance GitHub
932 # and want to reuse the introduction page also for the doxygen output.
934 USE_MDFILE_AS_MAINPAGE =
936 #---------------------------------------------------------------------------
937 # Configuration options related to source browsing
938 #---------------------------------------------------------------------------
940 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
941 # generated. Documented entities will be cross-referenced with these sources.
943 # Note: To get rid of all source code in the generated output, make sure that
944 # also VERBATIM_HEADERS is set to NO.
945 # The default value is: NO.
949 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
950 # classes and enums directly into the documentation.
951 # The default value is: NO.
955 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
956 # special comment blocks from generated source code fragments. Normal C, C++ and
957 # Fortran comments will always remain visible.
958 # The default value is: YES.
960 STRIP_CODE_COMMENTS = NO
962 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
963 # function all documented functions referencing it will be listed.
964 # The default value is: NO.
966 REFERENCED_BY_RELATION = NO
968 # If the REFERENCES_RELATION tag is set to YES then for each documented function
969 # all documented entities called/used by that function will be listed.
970 # The default value is: NO.
972 REFERENCES_RELATION = NO
974 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
975 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
976 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
977 # link to the documentation.
978 # The default value is: YES.
980 REFERENCES_LINK_SOURCE = YES
982 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
983 # source code will show a tooltip with additional information such as prototype,
984 # brief description and links to the definition and documentation. Since this
985 # will make the HTML file larger and loading of large files a bit slower, you
986 # can opt to disable this feature.
987 # The default value is: YES.
988 # This tag requires that the tag SOURCE_BROWSER is set to YES.
990 SOURCE_TOOLTIPS = YES
992 # If the USE_HTAGS tag is set to YES then the references to source code will
993 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
994 # source browser. The htags tool is part of GNU's global source tagging system
995 # (see http://www.gnu.org/software/global/global.html). You will need version
998 # To use it do the following:
999 # - Install the latest version of global
1000 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1001 # - Make sure the INPUT points to the root of the source tree
1002 # - Run doxygen as normal
1004 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1005 # tools must be available from the command line (i.e. in the search path).
1007 # The result: instead of the source browser generated by doxygen, the links to
1008 # source code will now point to the output of htags.
1009 # The default value is: NO.
1010 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1014 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1015 # verbatim copy of the header file for each class for which an include is
1016 # specified. Set to NO to disable this.
1017 # See also: Section \class.
1018 # The default value is: YES.
1020 VERBATIM_HEADERS = YES
1022 #---------------------------------------------------------------------------
1023 # Configuration options related to the alphabetical class index
1024 #---------------------------------------------------------------------------
1026 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1027 # compounds will be generated. Enable this if the project contains a lot of
1028 # classes, structs, unions or interfaces.
1029 # The default value is: YES.
1031 ALPHABETICAL_INDEX = NO
1033 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1034 # which the alphabetical index list will be split.
1035 # Minimum value: 1, maximum value: 20, default value: 5.
1036 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1038 COLS_IN_ALPHA_INDEX = 5
1040 # In case all classes in a project start with a common prefix, all classes will
1041 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1042 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1043 # while generating the index headers.
1044 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1048 #---------------------------------------------------------------------------
1049 # Configuration options related to the HTML output
1050 #---------------------------------------------------------------------------
1052 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1053 # The default value is: YES.
1057 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1058 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1060 # The default directory is: html.
1061 # This tag requires that the tag GENERATE_HTML is set to YES.
1065 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1066 # generated HTML page (for example: .htm, .php, .asp).
1067 # The default value is: .html.
1068 # This tag requires that the tag GENERATE_HTML is set to YES.
1070 HTML_FILE_EXTENSION = .html
1072 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1073 # each generated HTML page. If the tag is left blank doxygen will generate a
1076 # To get valid HTML the header file that includes any scripts and style sheets
1077 # that doxygen needs, which is dependent on the configuration options used (e.g.
1078 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1079 # default header using
1080 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1082 # and then modify the file new_header.html. See also section "Doxygen usage"
1083 # for information on how to generate the default header that doxygen normally
1085 # Note: The header is subject to change so you typically have to regenerate the
1086 # default header when upgrading to a newer version of doxygen. For a description
1087 # of the possible markers and block names see the documentation.
1088 # This tag requires that the tag GENERATE_HTML is set to YES.
1092 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1093 # generated HTML page. If the tag is left blank doxygen will generate a standard
1094 # footer. See HTML_HEADER for more information on how to generate a default
1095 # footer and what special commands can be used inside the footer. See also
1096 # section "Doxygen usage" for information on how to generate the default footer
1097 # that doxygen normally uses.
1098 # This tag requires that the tag GENERATE_HTML is set to YES.
1102 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1103 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1104 # the HTML output. If left blank doxygen will generate a default style sheet.
1105 # See also section "Doxygen usage" for information on how to generate the style
1106 # sheet that doxygen normally uses.
1107 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1108 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1110 # This tag requires that the tag GENERATE_HTML is set to YES.
1114 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1115 # defined cascading style sheet that is included after the standard style sheets
1116 # created by doxygen. Using this option one can overrule certain style aspects.
1117 # This is preferred over using HTML_STYLESHEET since it does not replace the
1118 # standard style sheet and is therefor more robust against future updates.
1119 # Doxygen will copy the style sheet file to the output directory. For an example
1120 # see the documentation.
1121 # This tag requires that the tag GENERATE_HTML is set to YES.
1123 HTML_EXTRA_STYLESHEET =
1125 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1126 # other source files which should be copied to the HTML output directory. Note
1127 # that these files will be copied to the base HTML output directory. Use the
1128 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1129 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1130 # files will be copied as-is; there are no commands or markers available.
1131 # This tag requires that the tag GENERATE_HTML is set to YES.
1135 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1136 # will adjust the colors in the stylesheet and background images according to
1137 # this color. Hue is specified as an angle on a colorwheel, see
1138 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1139 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1140 # purple, and 360 is red again.
1141 # Minimum value: 0, maximum value: 359, default value: 220.
1142 # This tag requires that the tag GENERATE_HTML is set to YES.
1144 HTML_COLORSTYLE_HUE = 220
1146 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1147 # in the HTML output. For a value of 0 the output will use grayscales only. A
1148 # value of 255 will produce the most vivid colors.
1149 # Minimum value: 0, maximum value: 255, default value: 100.
1150 # This tag requires that the tag GENERATE_HTML is set to YES.
1152 HTML_COLORSTYLE_SAT = 100
1154 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1155 # luminance component of the colors in the HTML output. Values below 100
1156 # gradually make the output lighter, whereas values above 100 make the output
1157 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1158 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1160 # Minimum value: 40, maximum value: 240, default value: 80.
1161 # This tag requires that the tag GENERATE_HTML is set to YES.
1163 HTML_COLORSTYLE_GAMMA = 80
1165 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1166 # page will contain the date and time when the page was generated. Setting this
1167 # to NO can help when comparing the output of multiple runs.
1168 # The default value is: YES.
1169 # This tag requires that the tag GENERATE_HTML is set to YES.
1171 HTML_TIMESTAMP = YES
1173 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1174 # documentation will contain sections that can be hidden and shown after the
1176 # The default value is: NO.
1177 # This tag requires that the tag GENERATE_HTML is set to YES.
1179 HTML_DYNAMIC_SECTIONS = NO
1181 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1182 # shown in the various tree structured indices initially; the user can expand
1183 # and collapse entries dynamically later on. Doxygen will expand the tree to
1184 # such a level that at most the specified number of entries are visible (unless
1185 # a fully collapsed tree already exceeds this amount). So setting the number of
1186 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1187 # representing an infinite number of entries and will result in a full expanded
1189 # Minimum value: 0, maximum value: 9999, default value: 100.
1190 # This tag requires that the tag GENERATE_HTML is set to YES.
1192 HTML_INDEX_NUM_ENTRIES = 100
1194 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1195 # generated that can be used as input for Apple's Xcode 3 integrated development
1196 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1197 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1198 # Makefile in the HTML output directory. Running make will produce the docset in
1199 # that directory and running make install will install the docset in
1200 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1201 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1202 # for more information.
1203 # The default value is: NO.
1204 # This tag requires that the tag GENERATE_HTML is set to YES.
1206 GENERATE_DOCSET = NO
1208 # This tag determines the name of the docset feed. A documentation feed provides
1209 # an umbrella under which multiple documentation sets from a single provider
1210 # (such as a company or product suite) can be grouped.
1211 # The default value is: Doxygen generated docs.
1212 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1214 DOCSET_FEEDNAME = "Doxygen generated docs"
1216 # This tag specifies a string that should uniquely identify the documentation
1217 # set bundle. This should be a reverse domain-name style string, e.g.
1218 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1219 # The default value is: org.doxygen.Project.
1220 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1222 DOCSET_BUNDLE_ID = org.doxygen.Project
1224 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1225 # the documentation publisher. This should be a reverse domain-name style
1226 # string, e.g. com.mycompany.MyDocSet.documentation.
1227 # The default value is: org.doxygen.Publisher.
1228 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1230 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1232 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1233 # The default value is: Publisher.
1234 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1236 DOCSET_PUBLISHER_NAME = Publisher
1238 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1239 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1240 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1241 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1244 # The HTML Help Workshop contains a compiler that can convert all HTML output
1245 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1246 # files are now used as the Windows 98 help format, and will replace the old
1247 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1248 # HTML files also contain an index, a table of contents, and you can search for
1249 # words in the documentation. The HTML workshop also contains a viewer for
1250 # compressed HTML files.
1251 # The default value is: NO.
1252 # This tag requires that the tag GENERATE_HTML is set to YES.
1254 GENERATE_HTMLHELP = YES
1256 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1257 # file. You can add a path in front of the file if the result should not be
1258 # written to the html output directory.
1259 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1263 # The HHC_LOCATION tag can be used to specify the location (absolute path
1264 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1265 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1266 # The file has to be specified with full path.
1267 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1272 # YES) or that it should be included in the master .chm file ( NO).
1273 # The default value is: NO.
1274 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1278 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1279 # and project file content.
1280 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1282 CHM_INDEX_ENCODING =
1284 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1285 # YES) or a normal table of contents ( NO) in the .chm file.
1286 # The default value is: NO.
1287 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1291 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1292 # the table of contents of the HTML help documentation and to the tree view.
1293 # The default value is: NO.
1294 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1298 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1299 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1300 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1301 # (.qch) of the generated HTML documentation.
1302 # The default value is: NO.
1303 # This tag requires that the tag GENERATE_HTML is set to YES.
1307 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1308 # the file name of the resulting .qch file. The path specified is relative to
1309 # the HTML output folder.
1310 # This tag requires that the tag GENERATE_QHP is set to YES.
1314 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1315 # Project output. For more information please see Qt Help Project / Namespace
1316 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1317 # The default value is: org.doxygen.Project.
1318 # This tag requires that the tag GENERATE_QHP is set to YES.
1322 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1323 # Help Project output. For more information please see Qt Help Project / Virtual
1324 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1326 # The default value is: doc.
1327 # This tag requires that the tag GENERATE_QHP is set to YES.
1329 QHP_VIRTUAL_FOLDER = doc
1331 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1332 # filter to add. For more information please see Qt Help Project / Custom
1333 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1335 # This tag requires that the tag GENERATE_QHP is set to YES.
1337 QHP_CUST_FILTER_NAME =
1339 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1340 # custom filter to add. For more information please see Qt Help Project / Custom
1341 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1343 # This tag requires that the tag GENERATE_QHP is set to YES.
1345 QHP_CUST_FILTER_ATTRS =
1347 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1348 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1349 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1350 # This tag requires that the tag GENERATE_QHP is set to YES.
1352 QHP_SECT_FILTER_ATTRS =
1354 # The QHG_LOCATION tag can be used to specify the location of Qt's
1355 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1356 # generated .qhp file.
1357 # This tag requires that the tag GENERATE_QHP is set to YES.
1361 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1362 # generated, together with the HTML files, they form an Eclipse help plugin. To
1363 # install this plugin and make it available under the help contents menu in
1364 # Eclipse, the contents of the directory containing the HTML and XML files needs
1365 # to be copied into the plugins directory of eclipse. The name of the directory
1366 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1367 # After copying Eclipse needs to be restarted before the help appears.
1368 # The default value is: NO.
1369 # This tag requires that the tag GENERATE_HTML is set to YES.
1371 GENERATE_ECLIPSEHELP = NO
1373 # A unique identifier for the Eclipse help plugin. When installing the plugin
1374 # the directory name containing the HTML and XML files should also have this
1375 # name. Each documentation set should have its own identifier.
1376 # The default value is: org.doxygen.Project.
1377 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1379 ECLIPSE_DOC_ID = org.doxygen.Project
1381 # If you want full control over the layout of the generated HTML pages it might
1382 # be necessary to disable the index and replace it with your own. The
1383 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1384 # of each HTML page. A value of NO enables the index and the value YES disables
1385 # it. Since the tabs in the index contain the same information as the navigation
1386 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1387 # The default value is: NO.
1388 # This tag requires that the tag GENERATE_HTML is set to YES.
1392 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1393 # structure should be generated to display hierarchical information. If the tag
1394 # value is set to YES, a side panel will be generated containing a tree-like
1395 # index structure (just like the one that is generated for HTML Help). For this
1396 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1397 # (i.e. any modern browser). Windows users are probably better off using the
1398 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1399 # further fine-tune the look of the index. As an example, the default style
1400 # sheet generated by doxygen has an example that shows how to put an image at
1401 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1402 # the same information as the tab index, you could consider setting
1403 # DISABLE_INDEX to YES when enabling this option.
1404 # The default value is: NO.
1405 # This tag requires that the tag GENERATE_HTML is set to YES.
1407 GENERATE_TREEVIEW = NONE
1409 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1410 # doxygen will group on one line in the generated HTML documentation.
1412 # Note that a value of 0 will completely suppress the enum values from appearing
1413 # in the overview section.
1414 # Minimum value: 0, maximum value: 20, default value: 4.
1415 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 ENUM_VALUES_PER_LINE = 4
1419 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1420 # to set the initial width (in pixels) of the frame in which the tree is shown.
1421 # Minimum value: 0, maximum value: 1500, default value: 250.
1422 # This tag requires that the tag GENERATE_HTML is set to YES.
1424 TREEVIEW_WIDTH = 250
1426 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1427 # external symbols imported via tag files in a separate window.
1428 # The default value is: NO.
1429 # This tag requires that the tag GENERATE_HTML is set to YES.
1431 EXT_LINKS_IN_WINDOW = NO
1433 # Use this tag to change the font size of LaTeX formulas included as images in
1434 # the HTML documentation. When you change the font size after a successful
1435 # doxygen run you need to manually remove any form_*.png images from the HTML
1436 # output directory to force them to be regenerated.
1437 # Minimum value: 8, maximum value: 50, default value: 10.
1438 # This tag requires that the tag GENERATE_HTML is set to YES.
1440 FORMULA_FONTSIZE = 10
1442 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1443 # generated for formulas are transparent PNGs. Transparent PNGs are not
1444 # supported properly for IE 6.0, but are supported on all modern browsers.
1446 # Note that when changing this option you need to delete any form_*.png files in
1447 # the HTML output directory before the changes have effect.
1448 # The default value is: YES.
1449 # This tag requires that the tag GENERATE_HTML is set to YES.
1451 FORMULA_TRANSPARENT = YES
1453 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1454 # http://www.mathjax.org) which uses client side Javascript for the rendering
1455 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1456 # installed or if you want to formulas look prettier in the HTML output. When
1457 # enabled you may also need to install MathJax separately and configure the path
1458 # to it using the MATHJAX_RELPATH option.
1459 # The default value is: NO.
1460 # This tag requires that the tag GENERATE_HTML is set to YES.
1464 # When MathJax is enabled you can set the default output format to be used for
1465 # the MathJax output. See the MathJax site (see:
1466 # http://docs.mathjax.org/en/latest/output.html) for more details.
1467 # Possible values are: HTML-CSS (which is slower, but has the best
1468 # compatibility), NativeMML (i.e. MathML) and SVG.
1469 # The default value is: HTML-CSS.
1470 # This tag requires that the tag USE_MATHJAX is set to YES.
1472 MATHJAX_FORMAT = HTML-CSS
1474 # When MathJax is enabled you need to specify the location relative to the HTML
1475 # output directory using the MATHJAX_RELPATH option. The destination directory
1476 # should contain the MathJax.js script. For instance, if the mathjax directory
1477 # is located at the same level as the HTML output directory, then
1478 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1479 # Content Delivery Network so you can quickly see the result without installing
1480 # MathJax. However, it is strongly recommended to install a local copy of
1481 # MathJax from http://www.mathjax.org before deployment.
1482 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1483 # This tag requires that the tag USE_MATHJAX is set to YES.
1485 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1487 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1488 # extension names that should be enabled during MathJax rendering. For example
1489 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1490 # This tag requires that the tag USE_MATHJAX is set to YES.
1492 MATHJAX_EXTENSIONS =
1494 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1495 # of code that will be used on startup of the MathJax code. See the MathJax site
1496 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1497 # example see the documentation.
1498 # This tag requires that the tag USE_MATHJAX is set to YES.
1502 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1503 # the HTML output. The underlying search engine uses javascript and DHTML and
1504 # should work on any modern browser. Note that when using HTML help
1505 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1506 # there is already a search function so this one should typically be disabled.
1507 # For large projects the javascript based search engine can be slow, then
1508 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1509 # search using the keyboard; to jump to the search box use <access key> + S
1510 # (what the <access key> is depends on the OS and browser, but it is typically
1511 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1512 # key> to jump into the search results window, the results can be navigated
1513 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1514 # the search. The filter options can be selected when the cursor is inside the
1515 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1516 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1518 # The default value is: YES.
1519 # This tag requires that the tag GENERATE_HTML is set to YES.
1523 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1524 # implemented using a web server instead of a web client using Javascript. There
1525 # are two flavours of web server based searching depending on the
1526 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1527 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1528 # enabled the indexing and searching needs to be provided by external tools. See
1529 # the section "External Indexing and Searching" for details.
1530 # The default value is: NO.
1531 # This tag requires that the tag SEARCHENGINE is set to YES.
1533 SERVER_BASED_SEARCH = NO
1535 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1536 # script for searching. Instead the search results are written to an XML file
1537 # which needs to be processed by an external indexer. Doxygen will invoke an
1538 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1541 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1542 # (doxysearch.cgi) which are based on the open source search engine library
1543 # Xapian (see: http://xapian.org/).
1545 # See the section "External Indexing and Searching" for details.
1546 # The default value is: NO.
1547 # This tag requires that the tag SEARCHENGINE is set to YES.
1549 EXTERNAL_SEARCH = NO
1551 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1552 # which will return the search results when EXTERNAL_SEARCH is enabled.
1554 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1555 # (doxysearch.cgi) which are based on the open source search engine library
1556 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1557 # Searching" for details.
1558 # This tag requires that the tag SEARCHENGINE is set to YES.
1562 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1563 # search data is written to a file for indexing by an external tool. With the
1564 # SEARCHDATA_FILE tag the name of this file can be specified.
1565 # The default file is: searchdata.xml.
1566 # This tag requires that the tag SEARCHENGINE is set to YES.
1568 SEARCHDATA_FILE = searchdata.xml
1570 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1571 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1572 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1573 # projects and redirect the results back to the right project.
1574 # This tag requires that the tag SEARCHENGINE is set to YES.
1576 EXTERNAL_SEARCH_ID =
1578 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1579 # projects other than the one defined by this configuration file, but that are
1580 # all added to the same external search index. Each project needs to have a
1581 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1582 # to a relative location where the documentation can be found. The format is:
1583 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1584 # This tag requires that the tag SEARCHENGINE is set to YES.
1586 EXTRA_SEARCH_MAPPINGS =
1588 #---------------------------------------------------------------------------
1589 # Configuration options related to the LaTeX output
1590 #---------------------------------------------------------------------------
1592 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1593 # The default value is: YES.
1597 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1598 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1600 # The default directory is: latex.
1601 # This tag requires that the tag GENERATE_LATEX is set to YES.
1603 LATEX_OUTPUT = latex
1605 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1608 # Note that when enabling USE_PDFLATEX this option is only used for generating
1609 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1610 # written to the output directory.
1611 # The default file is: latex.
1612 # This tag requires that the tag GENERATE_LATEX is set to YES.
1614 LATEX_CMD_NAME = latex
1616 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1618 # The default file is: makeindex.
1619 # This tag requires that the tag GENERATE_LATEX is set to YES.
1621 MAKEINDEX_CMD_NAME = makeindex
1623 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1624 # documents. This may be useful for small projects and may help to save some
1626 # The default value is: NO.
1627 # This tag requires that the tag GENERATE_LATEX is set to YES.
1631 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1633 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1634 # 14 inches) and executive (7.25 x 10.5 inches).
1635 # The default value is: a4.
1636 # This tag requires that the tag GENERATE_LATEX is set to YES.
1640 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1641 # that should be included in the LaTeX output. To get the times font for
1642 # instance you can specify
1643 # EXTRA_PACKAGES=times
1644 # If left blank no extra packages will be included.
1645 # This tag requires that the tag GENERATE_LATEX is set to YES.
1649 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1650 # generated LaTeX document. The header should contain everything until the first
1651 # chapter. If it is left blank doxygen will generate a standard header. See
1652 # section "Doxygen usage" for information on how to let doxygen write the
1653 # default header to a separate file.
1655 # Note: Only use a user-defined header if you know what you are doing! The
1656 # following commands have a special meaning inside the header: $title,
1657 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1658 # replace them by respectively the title of the page, the current date and time,
1659 # only the current date, the version number of doxygen, the project name (see
1660 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1661 # This tag requires that the tag GENERATE_LATEX is set to YES.
1665 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1666 # generated LaTeX document. The footer should contain everything after the last
1667 # chapter. If it is left blank doxygen will generate a standard footer.
1669 # Note: Only use a user-defined footer if you know what you are doing!
1670 # This tag requires that the tag GENERATE_LATEX is set to YES.
1674 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1675 # other source files which should be copied to the LATEX_OUTPUT output
1676 # directory. Note that the files will be copied as-is; there are no commands or
1677 # markers available.
1678 # This tag requires that the tag GENERATE_LATEX is set to YES.
1682 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1683 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1684 # contain links (just like the HTML output) instead of page references. This
1685 # makes the output suitable for online browsing using a PDF viewer.
1686 # The default value is: YES.
1687 # This tag requires that the tag GENERATE_LATEX is set to YES.
1689 PDF_HYPERLINKS = YES
1691 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1692 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1693 # higher quality PDF documentation.
1694 # The default value is: YES.
1695 # This tag requires that the tag GENERATE_LATEX is set to YES.
1699 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1700 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1701 # if errors occur, instead of asking the user for help. This option is also used
1702 # when generating formulas in HTML.
1703 # The default value is: NO.
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1706 LATEX_BATCHMODE = NO
1708 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1709 # index chapters (such as File Index, Compound Index, etc.) in the output.
1710 # The default value is: NO.
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1713 LATEX_HIDE_INDICES = NO
1715 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1716 # code with syntax highlighting in the LaTeX output.
1718 # Note that which sources are shown also depends on other settings such as
1720 # The default value is: NO.
1721 # This tag requires that the tag GENERATE_LATEX is set to YES.
1723 LATEX_SOURCE_CODE = NO
1725 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1726 # bibliography, e.g. plainnat, or ieeetr. See
1727 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1728 # The default value is: plain.
1729 # This tag requires that the tag GENERATE_LATEX is set to YES.
1731 LATEX_BIB_STYLE = plain
1733 #---------------------------------------------------------------------------
1734 # Configuration options related to the RTF output
1735 #---------------------------------------------------------------------------
1737 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1738 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1740 # The default value is: NO.
1744 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1745 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1747 # The default directory is: rtf.
1748 # This tag requires that the tag GENERATE_RTF is set to YES.
1752 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1753 # documents. This may be useful for small projects and may help to save some
1755 # The default value is: NO.
1756 # This tag requires that the tag GENERATE_RTF is set to YES.
1760 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1761 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1762 # output) instead of page references. This makes the output suitable for online
1763 # browsing using Word or some other Word compatible readers that support those
1766 # Note: WordPad (write) and others do not support links.
1767 # The default value is: NO.
1768 # This tag requires that the tag GENERATE_RTF is set to YES.
1772 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1773 # file, i.e. a series of assignments. You only have to provide replacements,
1774 # missing definitions are set to their default value.
1776 # See also section "Doxygen usage" for information on how to generate the
1777 # default style sheet that doxygen normally uses.
1778 # This tag requires that the tag GENERATE_RTF is set to YES.
1780 RTF_STYLESHEET_FILE =
1782 # Set optional variables used in the generation of an RTF document. Syntax is
1783 # similar to doxygen's config file. A template extensions file can be generated
1784 # using doxygen -e rtf extensionFile.
1785 # This tag requires that the tag GENERATE_RTF is set to YES.
1787 RTF_EXTENSIONS_FILE =
1789 #---------------------------------------------------------------------------
1790 # Configuration options related to the man page output
1791 #---------------------------------------------------------------------------
1793 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1794 # classes and files.
1795 # The default value is: NO.
1799 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1800 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1801 # it. A directory man3 will be created inside the directory specified by
1803 # The default directory is: man.
1804 # This tag requires that the tag GENERATE_MAN is set to YES.
1808 # The MAN_EXTENSION tag determines the extension that is added to the generated
1809 # man pages. In case the manual section does not start with a number, the number
1810 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1812 # The default value is: .3.
1813 # This tag requires that the tag GENERATE_MAN is set to YES.
1817 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1818 # will generate one additional man file for each entity documented in the real
1819 # man page(s). These additional files only source the real man page, but without
1820 # them the man command would be unable to find the correct page.
1821 # The default value is: NO.
1822 # This tag requires that the tag GENERATE_MAN is set to YES.
1826 #---------------------------------------------------------------------------
1827 # Configuration options related to the XML output
1828 #---------------------------------------------------------------------------
1830 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1831 # captures the structure of the code including all documentation.
1832 # The default value is: NO.
1836 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1837 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1839 # The default directory is: xml.
1840 # This tag requires that the tag GENERATE_XML is set to YES.
1844 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1845 # validating XML parser to check the syntax of the XML files.
1846 # This tag requires that the tag GENERATE_XML is set to YES.
1850 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1851 # validating XML parser to check the syntax of the XML files.
1852 # This tag requires that the tag GENERATE_XML is set to YES.
1856 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1857 # listings (including syntax highlighting and cross-referencing information) to
1858 # the XML output. Note that enabling this will significantly increase the size
1859 # of the XML output.
1860 # The default value is: YES.
1861 # This tag requires that the tag GENERATE_XML is set to YES.
1863 XML_PROGRAMLISTING = YES
1865 #---------------------------------------------------------------------------
1866 # Configuration options related to the DOCBOOK output
1867 #---------------------------------------------------------------------------
1869 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1870 # that can be used to generate PDF.
1871 # The default value is: NO.
1873 GENERATE_DOCBOOK = NO
1875 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1876 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1878 # The default directory is: docbook.
1879 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1881 DOCBOOK_OUTPUT = docbook
1883 #---------------------------------------------------------------------------
1884 # Configuration options for the AutoGen Definitions output
1885 #---------------------------------------------------------------------------
1887 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1888 # Definitions (see http://autogen.sf.net) file that captures the structure of
1889 # the code including all documentation. Note that this feature is still
1890 # experimental and incomplete at the moment.
1891 # The default value is: NO.
1893 GENERATE_AUTOGEN_DEF = NO
1895 #---------------------------------------------------------------------------
1896 # Configuration options related to the Perl module output
1897 #---------------------------------------------------------------------------
1899 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1900 # file that captures the structure of the code including all documentation.
1902 # Note that this feature is still experimental and incomplete at the moment.
1903 # The default value is: NO.
1905 GENERATE_PERLMOD = NO
1907 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1908 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1909 # output from the Perl module output.
1910 # The default value is: NO.
1911 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1915 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1916 # formatted so it can be parsed by a human reader. This is useful if you want to
1917 # understand what is going on. On the other hand, if this tag is set to NO the
1918 # size of the Perl module output will be much smaller and Perl will parse it
1920 # The default value is: YES.
1921 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1923 PERLMOD_PRETTY = YES
1925 # The names of the make variables in the generated doxyrules.make file are
1926 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1927 # so different doxyrules.make files included by the same Makefile don't
1928 # overwrite each other's variables.
1929 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1931 PERLMOD_MAKEVAR_PREFIX =
1933 #---------------------------------------------------------------------------
1934 # Configuration options related to the preprocessor
1935 #---------------------------------------------------------------------------
1937 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1938 # C-preprocessor directives found in the sources and include files.
1939 # The default value is: YES.
1941 ENABLE_PREPROCESSING = YES
1943 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1944 # in the source code. If set to NO only conditional compilation will be
1945 # performed. Macro expansion can be done in a controlled way by setting
1946 # EXPAND_ONLY_PREDEF to YES.
1947 # The default value is: NO.
1948 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1950 MACRO_EXPANSION = YES
1952 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1953 # the macro expansion is limited to the macros specified with the PREDEFINED and
1954 # EXPAND_AS_DEFINED tags.
1955 # The default value is: NO.
1956 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1958 EXPAND_ONLY_PREDEF = YES
1960 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1961 # INCLUDE_PATH will be searched if a #include is found.
1962 # The default value is: YES.
1963 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1965 SEARCH_INCLUDES = YES
1967 # The INCLUDE_PATH tag can be used to specify one or more directories that
1968 # contain include files that are not input files but should be processed by the
1970 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1974 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1975 # patterns (like *.h and *.hpp) to filter out the header-files in the
1976 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1978 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1980 INCLUDE_FILE_PATTERNS =
1982 # The PREDEFINED tag can be used to specify one or more macro names that are
1983 # defined before the preprocessor is started (similar to the -D option of e.g.
1984 # gcc). The argument of the tag is a list of macros of the form: name or
1985 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1986 # is assumed. To prevent a macro definition from being undefined via #undef or
1987 # recursively expanded use the := operator instead of the = operator.
1988 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1990 PREDEFINED = DALI_IMPORT_API \
1999 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2000 # tag can be used to specify a list of macro names that should be expanded. The
2001 # macro definition that is found in the sources will be used. Use the PREDEFINED
2002 # tag if you want to use a different macro definition that overrules the
2003 # definition found in the source code.
2004 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2008 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2009 # remove all refrences to function-like macros that are alone on a line, have an
2010 # all uppercase name, and do not end with a semicolon. Such function macros are
2011 # typically used for boiler-plate code, and will confuse the parser if not
2013 # The default value is: YES.
2014 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2016 SKIP_FUNCTION_MACROS = YES
2018 #---------------------------------------------------------------------------
2019 # Configuration options related to external references
2020 #---------------------------------------------------------------------------
2022 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2023 # file the location of the external documentation should be added. The format of
2024 # a tag file without this location is as follows:
2025 # TAGFILES = file1 file2 ...
2026 # Adding location for the tag files is done as follows:
2027 # TAGFILES = file1=loc1 "file2 = loc2" ...
2028 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2029 # section "Linking to external documentation" for more information about the use
2031 # Note: Each tag file must have an unique name (where the name does NOT include
2032 # the path). If a tag file is not located in the directory in which doxygen is
2033 # run, you must also specify the path to the tagfile here.
2037 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2038 # tag file that is based on the input files it reads. See section "Linking to
2039 # external documentation" for more information about the usage of tag files.
2043 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2044 # class index. If set to NO only the inherited external classes will be listed.
2045 # The default value is: NO.
2049 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2050 # the modules index. If set to NO, only the current project's groups will be
2052 # The default value is: YES.
2054 EXTERNAL_GROUPS = YES
2056 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2057 # the related pages index. If set to NO, only the current project's pages will
2059 # The default value is: YES.
2061 EXTERNAL_PAGES = YES
2063 # The PERL_PATH should be the absolute path and name of the perl script
2064 # interpreter (i.e. the result of 'which perl').
2065 # The default file (with absolute path) is: /usr/bin/perl.
2067 PERL_PATH = /usr/bin/perl
2069 #---------------------------------------------------------------------------
2070 # Configuration options related to the dot tool
2071 #---------------------------------------------------------------------------
2073 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2074 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2075 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2076 # disabled, but it is recommended to install and use dot, since it yields more
2078 # The default value is: YES.
2080 CLASS_DIAGRAMS = YES
2082 # You can define message sequence charts within doxygen comments using the \msc
2083 # command. Doxygen will then run the mscgen tool (see:
2084 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2085 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2086 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2087 # default search path.
2091 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2092 # then run dia to produce the diagram and insert it in the documentation. The
2093 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2094 # If left empty dia is assumed to be found in the default search path.
2098 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2099 # and usage relations if the target is undocumented or is not a class.
2100 # The default value is: YES.
2102 HIDE_UNDOC_RELATIONS = YES
2104 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2105 # available from the path. This tool is part of Graphviz (see:
2106 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2107 # Bell Labs. The other options in this section have no effect if this option is
2109 # The default value is: NO.
2113 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2114 # to run in parallel. When set to 0 doxygen will base this on the number of
2115 # processors available in the system. You can set it explicitly to a value
2116 # larger than 0 to get control over the balance between CPU load and processing
2118 # Minimum value: 0, maximum value: 32, default value: 0.
2119 # This tag requires that the tag HAVE_DOT is set to YES.
2123 # When you want a differently looking font n the dot files that doxygen
2124 # generates you can specify the font name using DOT_FONTNAME. You need to make
2125 # sure dot is able to find the font, which can be done by putting it in a
2126 # standard location or by setting the DOTFONTPATH environment variable or by
2127 # setting DOT_FONTPATH to the directory containing the font.
2128 # The default value is: Helvetica.
2129 # This tag requires that the tag HAVE_DOT is set to YES.
2133 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2135 # Minimum value: 4, maximum value: 24, default value: 10.
2136 # This tag requires that the tag HAVE_DOT is set to YES.
2140 # By default doxygen will tell dot to use the default font as specified with
2141 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2142 # the path where dot can find it using this tag.
2143 # This tag requires that the tag HAVE_DOT is set to YES.
2147 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2148 # each documented class showing the direct and indirect inheritance relations.
2149 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2150 # The default value is: YES.
2151 # This tag requires that the tag HAVE_DOT is set to YES.
2155 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2156 # graph for each documented class showing the direct and indirect implementation
2157 # dependencies (inheritance, containment, and class references variables) of the
2158 # class with other documented classes.
2159 # The default value is: YES.
2160 # This tag requires that the tag HAVE_DOT is set to YES.
2162 COLLABORATION_GRAPH = YES
2164 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2165 # groups, showing the direct groups dependencies.
2166 # The default value is: YES.
2167 # This tag requires that the tag HAVE_DOT is set to YES.
2171 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2172 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2174 # The default value is: NO.
2175 # This tag requires that the tag HAVE_DOT is set to YES.
2179 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2180 # class node. If there are many fields or methods and many nodes the graph may
2181 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2182 # number of items for each type to make the size more manageable. Set this to 0
2183 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2184 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2185 # but if the number exceeds 15, the total amount of fields shown is limited to
2187 # Minimum value: 0, maximum value: 100, default value: 10.
2188 # This tag requires that the tag HAVE_DOT is set to YES.
2190 UML_LIMIT_NUM_FIELDS = 10
2192 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2193 # collaboration graphs will show the relations between templates and their
2195 # The default value is: NO.
2196 # This tag requires that the tag HAVE_DOT is set to YES.
2198 TEMPLATE_RELATIONS = NO
2200 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2201 # YES then doxygen will generate a graph for each documented file showing the
2202 # direct and indirect include dependencies of the file with other documented
2204 # The default value is: YES.
2205 # This tag requires that the tag HAVE_DOT is set to YES.
2209 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2210 # set to YES then doxygen will generate a graph for each documented file showing
2211 # the direct and indirect include dependencies of the file with other documented
2213 # The default value is: YES.
2214 # This tag requires that the tag HAVE_DOT is set to YES.
2216 INCLUDED_BY_GRAPH = YES
2218 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2219 # dependency graph for every global function or class method.
2221 # Note that enabling this option will significantly increase the time of a run.
2222 # So in most cases it will be better to enable call graphs for selected
2223 # functions only using the \callgraph command.
2224 # The default value is: NO.
2225 # This tag requires that the tag HAVE_DOT is set to YES.
2229 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2230 # dependency graph for every global function or class method.
2232 # Note that enabling this option will significantly increase the time of a run.
2233 # So in most cases it will be better to enable caller graphs for selected
2234 # functions only using the \callergraph command.
2235 # The default value is: NO.
2236 # This tag requires that the tag HAVE_DOT is set to YES.
2240 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2241 # hierarchy of all classes instead of a textual one.
2242 # The default value is: YES.
2243 # This tag requires that the tag HAVE_DOT is set to YES.
2245 GRAPHICAL_HIERARCHY = YES
2247 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2248 # dependencies a directory has on other directories in a graphical way. The
2249 # dependency relations are determined by the #include relations between the
2250 # files in the directories.
2251 # The default value is: YES.
2252 # This tag requires that the tag HAVE_DOT is set to YES.
2254 DIRECTORY_GRAPH = YES
2256 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2258 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2259 # to make the SVG files visible in IE 9+ (other browsers do not have this
2261 # Possible values are: png, jpg, gif and svg.
2262 # The default value is: png.
2263 # This tag requires that the tag HAVE_DOT is set to YES.
2265 DOT_IMAGE_FORMAT = png
2267 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2268 # enable generation of interactive SVG images that allow zooming and panning.
2270 # Note that this requires a modern browser other than Internet Explorer. Tested
2271 # and working are Firefox, Chrome, Safari, and Opera.
2272 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2273 # the SVG files visible. Older versions of IE do not have SVG support.
2274 # The default value is: NO.
2275 # This tag requires that the tag HAVE_DOT is set to YES.
2277 INTERACTIVE_SVG = NO
2279 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2280 # found. If left blank, it is assumed the dot tool can be found in the path.
2281 # This tag requires that the tag HAVE_DOT is set to YES.
2285 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2286 # contain dot files that are included in the documentation (see the \dotfile
2288 # This tag requires that the tag HAVE_DOT is set to YES.
2292 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2293 # contain msc files that are included in the documentation (see the \mscfile
2298 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2299 # contain dia files that are included in the documentation (see the \diafile
2304 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2305 # that will be shown in the graph. If the number of nodes in a graph becomes
2306 # larger than this value, doxygen will truncate the graph, which is visualized
2307 # by representing a node as a red box. Note that doxygen if the number of direct
2308 # children of the root node in a graph is already larger than
2309 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2310 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2311 # Minimum value: 0, maximum value: 10000, default value: 50.
2312 # This tag requires that the tag HAVE_DOT is set to YES.
2314 DOT_GRAPH_MAX_NODES = 50
2316 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2317 # generated by dot. A depth value of 3 means that only nodes reachable from the
2318 # root by following a path via at most 3 edges will be shown. Nodes that lay
2319 # further from the root node will be omitted. Note that setting this option to 1
2320 # or 2 may greatly reduce the computation time needed for large code bases. Also
2321 # note that the size of a graph can be further restricted by
2322 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2323 # Minimum value: 0, maximum value: 1000, default value: 0.
2324 # This tag requires that the tag HAVE_DOT is set to YES.
2326 MAX_DOT_GRAPH_DEPTH = 0
2328 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2329 # background. This is disabled by default, because dot on Windows does not seem
2330 # to support this out of the box.
2332 # Warning: Depending on the platform used, enabling this option may lead to
2333 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2335 # The default value is: NO.
2336 # This tag requires that the tag HAVE_DOT is set to YES.
2338 DOT_TRANSPARENT = NO
2340 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2341 # files in one run (i.e. multiple -o and -T options on the command line). This
2342 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2343 # this, this feature is disabled by default.
2344 # The default value is: NO.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2347 DOT_MULTI_TARGETS = NO
2349 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2350 # explaining the meaning of the various boxes and arrows in the dot generated
2352 # The default value is: YES.
2353 # This tag requires that the tag HAVE_DOT is set to YES.
2355 GENERATE_LEGEND = YES
2357 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2358 # files that are used to generate the various graphs.
2359 # The default value is: YES.
2360 # This tag requires that the tag HAVE_DOT is set to YES.