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 # <DALi Doxygen Tagging Rule>
241 # Use @SINCE_1_0, @SINCE_1_1, ... instead of @since,
242 # and use @DEPRECATED_1_0, @DEPRECATED_1_1, ... instead of @deprecated.
243 # It enables integrated management of version tagging between
244 # the open source DALi API reference and Tizen API reference.
245 # Using those tags with different ALIASES settings in each doxygen config file allows us
246 # to generate two versions of "Since" and "Deprecated" generated output
247 # from one set of public header files.
249 # If you need a newer version number like @SINCE_1_5 or @SINCE_2_0, just add new ALIASES for it.
251 # ##################################################3
252 # # Guide for Open Source DALi API Reference
254 # ### @SINCE example:
255 # [some-public-header.h]
260 # void SomeFunction();
262 # [generated html file]
263 # void SomeFunction()
268 # ### @DEPRECATED example 1:
269 # [some-public-header.h]
271 # * @DEPRECATED_1_0.3
274 # void SomeFunction();
276 # [generated html file]
277 # void SomeFunction()
279 # Deprecated since 1.0.3
282 # ### @DEPRECATED example 2:
283 # [some-public-header.h]
286 # * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
289 # void SomeFunction();
291 # [generated html file]
292 # void SomeFunction()
294 # Deprecated since 1.0.3. Use SomeFunction2() instead.
297 # ##################################################3
298 # # Guide for Tizen Native API Reference
300 # ### @SINCE example:
301 # [some-public-header.h]
306 # void SomeFunction();
308 # [generated html file]
309 # void SomeFunction()
312 # 2.4, DALi Version 1.0.1
314 # ### @DEPRECATED example 1:
315 # [some-public-header.h]
317 # * @DEPRECATED_1_0.3
320 # void SomeFunction();
322 # [generated html file]
323 # void SomeFunction()
325 # Deprecated since 3.0, DALi version 1.0.3
328 # ### @DEPRECATED example 2:
329 # [some-public-header.h]
332 # * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
335 # void SomeFunction();
337 # [generated html file]
338 # void SomeFunction()
340 # Deprecated since 3.0, DALi version 1.0.3. Use SomeFunction2() instead.
343 ###########################################
344 # For Open Source DALi API Reference
345 ALIASES += SINCE_1_0="@since 1.0"
346 ALIASES += SINCE_1_1="@since 1.1"
347 ALIASES += SINCE_1_2="@since 1.2"
349 # Extra tags for Tizen 3.0
350 ALIASES += SINCE_1_2_2="@since 1.2.2"
351 ALIASES += SINCE_1_2_4="@since 1.2.4"
352 ALIASES += SINCE_1_2_5="@since 1.2.5"
353 ALIASES += SINCE_1_2_10="@since 1.2.10"
354 ALIASES += SINCE_1_2_14="@since 1.2.14"
355 ALIASES += SINCE_1_2_32="@since 1.2.32"
357 # Extra tags for Tizen 4.0
358 ALIASES += SINCE_1_3_4="@since 1.3.4"
360 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
361 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
362 ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 1.2.8"
363 ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 1.2.10"
364 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"
366 ALIASES += PLATFORM=""
367 ALIASES += PRIVLEVEL_PLATFORM=""
368 ALIASES += PRIVLEVEL_PUBLIC=""
369 ALIASES += PRIVILEGE_KEYGRAB=""
370 ALIASES += PRIVILEGE_DISPLAY=""
371 ALIASES += PRIVILEGE_WINDOW_PRIORITY=""
372 ALIASES += REMARK_INTERNET=""
373 ALIASES += REMARK_STORAGE=""
374 ALIASES += REMARK_RAWVIDEO=""
376 ############################################
377 ## For Tizen Native API Reference
378 #ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0"
379 #ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1"
380 #ALIASES += SINCE_1_2="\par Since:\n 4.0, DALi version 1.2"
382 ## Extra tags for Tizen 3.0
383 #ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2"
384 #ALIASES += SINCE_1_2_4="\par Since:\n 3.0, DALi version 1.2.4"
385 #ALIASES += SINCE_1_2_5="\par Since:\n 3.0, DALi version 1.2.5"
386 #ALIASES += SINCE_1_2_10="\par Since:\n 3.0, DALi version 1.2.10"
387 #ALIASES += SINCE_1_2_14="\par Since:\n 3.0, DALi version 1.2.14"
388 #ALIASES += SINCE_1_2_32="\par Since:\n 3.0, DALi version 1.2.32"
390 ## Extra tags for Tizen 4.0
391 #ALIASES += SINCE_1_3_4="\par Since:\n 4.0, DALi version 1.3.4"
393 ## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release.
394 ## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0.
395 #ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0"
396 #ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1"
397 #ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 3.0, DALi version 1.2.8"
398 #ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 3.0, DALi version 1.2.10"
399 #ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 4.0, DALi version 1.2"
401 #ALIASES += PLATFORM="@platform"
402 #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform"
403 #ALIASES += PRIVLEVEL_PUBLIC="\par Privilege Level:\n public"
404 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
405 #ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
406 #ALIASES += PRIVILEGE_WINDOW_PRIORITY="\par Privilege:\n http://tizen.org/privilege/window.priority.set"
407 #ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."
408 #ALIASES += REMARK_STORAGE="@remarks %http://tizen.org/privilege/mediastorage is needed if @a url is relevant to media storage. @remarks %http://tizen.org/privilege/externalstorage is needed if @a url is relevant to external storage."
409 #ALIASES += REMARK_RAWVIDEO="@remarks %http://tizen.org/feature/multimedia.raw_video is needed if UNDERLAY is false. If the feature isn't supported, UNDERLAY is always true."
411 # This tag can be used to specify a number of word-keyword mappings (TCL only).
412 # A mapping has the form "name=value". For example adding "class=itcl::class"
413 # will allow you to use the command class in the itcl::class meaning.
417 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
418 # only. Doxygen will then generate output that is more tailored for C. For
419 # instance, some of the names that are used will be different. The list of all
420 # members will be omitted, etc.
421 # The default value is: NO.
423 OPTIMIZE_OUTPUT_FOR_C = NO
425 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
426 # Python sources only. Doxygen will then generate output that is more tailored
427 # for that language. For instance, namespaces will be presented as packages,
428 # qualified scopes will look different, etc.
429 # The default value is: NO.
431 OPTIMIZE_OUTPUT_JAVA = NO
433 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
434 # sources. Doxygen will then generate output that is tailored for Fortran.
435 # The default value is: NO.
437 OPTIMIZE_FOR_FORTRAN = NO
439 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
440 # sources. Doxygen will then generate output that is tailored for VHDL.
441 # The default value is: NO.
443 OPTIMIZE_OUTPUT_VHDL = NO
445 # Doxygen selects the parser to use depending on the extension of the files it
446 # parses. With this tag you can assign which parser to use for a given
447 # extension. Doxygen has a built-in mapping, but you can override or extend it
448 # using this tag. The format is ext=language, where ext is a file extension, and
449 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
450 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
451 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
452 # (default is Fortran), use: inc=Fortran f=C.
454 # Note For files without extension you can use no_extension as a placeholder.
456 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
457 # the files are not read by doxygen.
461 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
462 # according to the Markdown format, which allows for more readable
463 # documentation. See http://daringfireball.net/projects/markdown/ for details.
464 # The output of markdown processing is further processed by doxygen, so you can
465 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
466 # case of backward compatibilities issues.
467 # The default value is: YES.
469 MARKDOWN_SUPPORT = YES
471 # When enabled doxygen tries to link words that correspond to documented
472 # classes, or namespaces to their corresponding documentation. Such a link can
473 # be prevented in individual cases by by putting a % sign in front of the word
474 # or globally by setting AUTOLINK_SUPPORT to NO.
475 # The default value is: YES.
477 AUTOLINK_SUPPORT = YES
479 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
480 # to include (a tag file for) the STL sources as input, then you should set this
481 # tag to YES in order to let doxygen match functions declarations and
482 # definitions whose arguments contain STL classes (e.g. func(std::string);
483 # versus func(std::string) {}). This also make the inheritance and collaboration
484 # diagrams that involve STL classes more complete and accurate.
485 # The default value is: NO.
487 BUILTIN_STL_SUPPORT = YES
489 # If you use Microsoft's C++/CLI language, you should set this option to YES to
490 # enable parsing support.
491 # The default value is: NO.
495 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
496 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
497 # will parse them like normal C++ but will assume all classes use public instead
498 # of private inheritance when no explicit protection keyword is present.
499 # The default value is: NO.
503 # For Microsoft's IDL there are propget and propput attributes to indicate
504 # getter and setter methods for a property. Setting this option to YES will make
505 # doxygen to replace the get and set methods by a property in the documentation.
506 # This will only work if the methods are indeed getting or setting a simple
507 # type. If this is not the case, or you want to show the methods anyway, you
508 # should set this option to NO.
509 # The default value is: YES.
511 IDL_PROPERTY_SUPPORT = YES
513 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
514 # tag is set to YES, then doxygen will reuse the documentation of the first
515 # member in the group (if any) for the other members of the group. By default
516 # all members of a group must be documented explicitly.
517 # The default value is: NO.
519 DISTRIBUTE_GROUP_DOC = NO
521 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
522 # (for instance a group of public functions) to be put as a subgroup of that
523 # type (e.g. under the Public Functions section). Set it to NO to prevent
524 # subgrouping. Alternatively, this can be done per class using the
525 # \nosubgrouping command.
526 # The default value is: YES.
530 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
531 # are shown inside the group in which they are included (e.g. using \ingroup)
532 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
535 # Note that this feature does not work in combination with
536 # SEPARATE_MEMBER_PAGES.
537 # The default value is: NO.
539 INLINE_GROUPED_CLASSES = NO
541 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
542 # with only public data fields or simple typedef fields will be shown inline in
543 # the documentation of the scope in which they are defined (i.e. file,
544 # namespace, or group documentation), provided this scope is documented. If set
545 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
546 # Man pages) or section (for LaTeX and RTF).
547 # The default value is: NO.
549 INLINE_SIMPLE_STRUCTS = NO
551 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
552 # enum is documented as struct, union, or enum with the name of the typedef. So
553 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
554 # with name TypeT. When disabled the typedef will appear as a member of a file,
555 # namespace, or class. And the struct will be named TypeS. This can typically be
556 # useful for C code in case the coding convention dictates that all compound
557 # types are typedef'ed and only the typedef is referenced, never the tag name.
558 # The default value is: NO.
560 TYPEDEF_HIDES_STRUCT = NO
562 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
563 # cache is used to resolve symbols given their name and scope. Since this can be
564 # an expensive process and often the same symbol appears multiple times in the
565 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
566 # doxygen will become slower. If the cache is too large, memory is wasted. The
567 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
568 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
569 # symbols. At the end of a run doxygen will report the cache usage and suggest
570 # the optimal cache size from a speed point of view.
571 # Minimum value: 0, maximum value: 9, default value: 0.
573 LOOKUP_CACHE_SIZE = 0
575 #---------------------------------------------------------------------------
576 # Build related configuration options
577 #---------------------------------------------------------------------------
579 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
580 # documentation are documented, even if no documentation was available. Private
581 # class members and static file members will be hidden unless the
582 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
583 # Note: This will also disable the warnings about undocumented members that are
584 # normally produced when WARNINGS is set to YES.
585 # The default value is: NO.
589 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
590 # be included in the documentation.
591 # The default value is: NO.
593 EXTRACT_PRIVATE = YES
595 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
596 # scope will be included in the documentation.
597 # The default value is: NO.
601 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
602 # included in the documentation.
603 # The default value is: NO.
607 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
608 # locally in source files will be included in the documentation. If set to NO
609 # only classes defined in header files are included. Does not have any effect
611 # The default value is: YES.
613 EXTRACT_LOCAL_CLASSES = YES
615 # This flag is only useful for Objective-C code. When set to YES local methods,
616 # which are defined in the implementation section but not in the interface are
617 # included in the documentation. If set to NO only methods in the interface are
619 # The default value is: NO.
621 EXTRACT_LOCAL_METHODS = NO
623 # If this flag is set to YES, the members of anonymous namespaces will be
624 # extracted and appear in the documentation as a namespace called
625 # 'anonymous_namespace{file}', where file will be replaced with the base name of
626 # the file that contains the anonymous namespace. By default anonymous namespace
628 # The default value is: NO.
630 EXTRACT_ANON_NSPACES = NO
632 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
633 # undocumented members inside documented classes or files. If set to NO these
634 # members will be included in the various overviews, but no documentation
635 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
636 # The default value is: NO.
638 HIDE_UNDOC_MEMBERS = NO
640 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
641 # undocumented classes that are normally visible in the class hierarchy. If set
642 # to NO these classes will be included in the various overviews. This option has
643 # no effect if EXTRACT_ALL is enabled.
644 # The default value is: NO.
646 HIDE_UNDOC_CLASSES = NO
648 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
649 # (class|struct|union) declarations. If set to NO these declarations will be
650 # included in the documentation.
651 # The default value is: NO.
653 HIDE_FRIEND_COMPOUNDS = NO
655 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
656 # documentation blocks found inside the body of a function. If set to NO these
657 # blocks will be appended to the function's detailed documentation block.
658 # The default value is: NO.
660 HIDE_IN_BODY_DOCS = NO
662 # The INTERNAL_DOCS tag determines if documentation that is typed after a
663 # \internal command is included. If the tag is set to NO then the documentation
664 # will be excluded. Set it to YES to include the internal documentation.
665 # The default value is: NO.
669 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
670 # names in lower-case letters. If set to YES upper-case letters are also
671 # allowed. This is useful if you have classes or files whose names only differ
672 # in case and if your file system supports case sensitive file names. Windows
673 # and Mac users are advised to set this option to NO.
674 # The default value is: system dependent.
676 CASE_SENSE_NAMES = NO
678 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
679 # their full class and namespace scopes in the documentation. If set to YES the
680 # scope will be hidden.
681 # The default value is: NO.
683 HIDE_SCOPE_NAMES = NO
685 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
686 # the files that are included by a file in the documentation of that file.
687 # The default value is: YES.
689 SHOW_INCLUDE_FILES = YES
691 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
692 # grouped member an include statement to the documentation, telling the reader
693 # which file to include in order to use the member.
694 # The default value is: NO.
696 SHOW_GROUPED_MEMB_INC = NO
698 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
699 # files with double quotes in the documentation rather than with sharp brackets.
700 # The default value is: NO.
702 FORCE_LOCAL_INCLUDES = NO
704 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
705 # documentation for inline members.
706 # The default value is: YES.
710 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
711 # (detailed) documentation of file and class members alphabetically by member
712 # name. If set to NO the members will appear in declaration order.
713 # The default value is: YES.
715 SORT_MEMBER_DOCS = YES
717 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
718 # descriptions of file, namespace and class members alphabetically by member
719 # name. If set to NO the members will appear in declaration order. Note that
720 # this will also influence the order of the classes in the class list.
721 # The default value is: NO.
725 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
726 # (brief and detailed) documentation of class members so that constructors and
727 # destructors are listed first. If set to NO the constructors will appear in the
728 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
729 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
730 # member documentation.
731 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
732 # detailed member documentation.
733 # The default value is: NO.
735 SORT_MEMBERS_CTORS_1ST = NO
737 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
738 # of group names into alphabetical order. If set to NO the group names will
739 # appear in their defined order.
740 # The default value is: NO.
742 SORT_GROUP_NAMES = NO
744 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
745 # fully-qualified names, including namespaces. If set to NO, the class list will
746 # be sorted only by class name, not including the namespace part.
747 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
748 # Note: This option applies only to the class list, not to the alphabetical
750 # The default value is: NO.
752 SORT_BY_SCOPE_NAME = NO
754 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
755 # type resolution of all parameters of a function it will reject a match between
756 # the prototype and the implementation of a member function even if there is
757 # only one candidate or it is obvious which candidate to choose by doing a
758 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
759 # accept a match between prototype and implementation in such cases.
760 # The default value is: NO.
762 STRICT_PROTO_MATCHING = NO
764 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
765 # todo list. This list is created by putting \todo commands in the
767 # The default value is: YES.
769 GENERATE_TODOLIST = NO
771 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
772 # test list. This list is created by putting \test commands in the
774 # The default value is: YES.
776 GENERATE_TESTLIST = NO
778 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
779 # list. This list is created by putting \bug commands in the documentation.
780 # The default value is: YES.
782 GENERATE_BUGLIST = NO
784 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
785 # the deprecated list. This list is created by putting \deprecated commands in
787 # The default value is: YES.
789 GENERATE_DEPRECATEDLIST= YES
791 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
792 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
793 # ... \endcond blocks.
795 ENABLED_SECTIONS = show_tizen_feature
797 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
798 # initial value of a variable or macro / define can have for it to appear in the
799 # documentation. If the initializer consists of more lines than specified here
800 # it will be hidden. Use a value of 0 to hide initializers completely. The
801 # appearance of the value of individual variables and macros / defines can be
802 # controlled using \showinitializer or \hideinitializer command in the
803 # documentation regardless of this setting.
804 # Minimum value: 0, maximum value: 10000, default value: 30.
806 MAX_INITIALIZER_LINES = 30
808 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
809 # the bottom of the documentation of classes and structs. If set to YES the list
810 # will mention the files that were used to generate the documentation.
811 # The default value is: YES.
813 SHOW_USED_FILES = YES
815 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
816 # will remove the Files entry from the Quick Index and from the Folder Tree View
818 # The default value is: YES.
822 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
823 # page. This will remove the Namespaces entry from the Quick Index and from the
824 # Folder Tree View (if specified).
825 # The default value is: YES.
827 SHOW_NAMESPACES = YES
829 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
830 # doxygen should invoke to get the current version for each file (typically from
831 # the version control system). Doxygen will invoke the program by executing (via
832 # popen()) the command command input-file, where command is the value of the
833 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
834 # by doxygen. Whatever the program writes to standard output is used as the file
835 # version. For an example see the documentation.
837 FILE_VERSION_FILTER =
839 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
840 # by doxygen. The layout file controls the global structure of the generated
841 # output files in an output format independent way. To create the layout file
842 # that represents doxygen's defaults, run doxygen with the -l option. You can
843 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
844 # will be used as the name of the layout file.
846 # Note that if you run doxygen from a directory containing a file called
847 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
850 LAYOUT_FILE = @DOXYGEN_DOCS_DIR@/DaliLayout.xml
852 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
853 # the reference definitions. This must be a list of .bib files. The .bib
854 # extension is automatically appended if omitted. This requires the bibtex tool
855 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
856 # For LaTeX the style of the bibliography can be controlled using
857 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
858 # search path. Do not use file names with spaces, bibtex cannot handle them. See
859 # also \cite for info how to create references.
863 #---------------------------------------------------------------------------
864 # Configuration options related to warning and progress messages
865 #---------------------------------------------------------------------------
867 # The QUIET tag can be used to turn on/off the messages that are generated to
868 # standard output by doxygen. If QUIET is set to YES this implies that the
870 # The default value is: NO.
874 # The WARNINGS tag can be used to turn on/off the warning messages that are
875 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
876 # this implies that the warnings are on.
878 # Tip: Turn warnings on while writing the documentation.
879 # The default value is: YES.
883 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
884 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
885 # will automatically be disabled.
886 # The default value is: YES.
888 WARN_IF_UNDOCUMENTED = YES
890 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
891 # potential errors in the documentation, such as not documenting some parameters
892 # in a documented function, or documenting parameters that don't exist or using
893 # markup commands wrongly.
894 # The default value is: YES.
896 WARN_IF_DOC_ERROR = YES
898 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
899 # are documented, but have no documentation for their parameters or return
900 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
901 # documentation, but not about the absence of documentation.
902 # The default value is: NO.
904 WARN_NO_PARAMDOC = YES
906 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
907 # can produce. The string should contain the $file, $line, and $text tags, which
908 # will be replaced by the file and line number from which the warning originated
909 # and the warning text. Optionally the format may contain $version, which will
910 # be replaced by the version of the file (if it could be obtained via
911 # FILE_VERSION_FILTER)
912 # The default value is: $file:$line: $text.
914 WARN_FORMAT = "$file:$line: $text"
916 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
917 # messages should be written. If left blank the output is written to standard
922 #---------------------------------------------------------------------------
923 # Configuration options related to the input files
924 #---------------------------------------------------------------------------
926 # The INPUT tag is used to specify the files and/or directories that contain
927 # documented source files. You may enter file names like myfile.cpp or
928 # directories like /usr/src/myproject. Separate the files or directories with
930 # Note: If this tag is empty the current directory is searched.
932 INPUT = @DOXYGEN_DOCS_DIR@/content \
933 @prefix@/include/dali/doc/dali-core-doc.h \
934 @prefix@/include/dali/doc/dali-adaptor-doc.h \
935 ../../../doc/dali-toolkit-doc.h \
936 @prefix@/include/dali/public-api \
937 @prefix@/include/dali/devel-api \
938 ../../../dali-toolkit/public-api \
939 ../../../dali-toolkit/devel-api \
940 ../../../automated-tests/README.md
942 # This tag can be used to specify the character encoding of the source files
943 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
944 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
945 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
946 # possible encodings.
947 # The default value is: UTF-8.
949 INPUT_ENCODING = UTF-8
951 # If the value of the INPUT tag contains directories, you can use the
952 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
953 # *.h) to filter out the source-files in the directories. If left blank the
954 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
955 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
956 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
957 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
958 # *.qsf, *.as and *.js.
964 # The RECURSIVE tag can be used to specify whether or not subdirectories should
965 # be searched for input files as well.
966 # The default value is: NO.
970 # The EXCLUDE tag can be used to specify files and/or directories that should be
971 # excluded from the INPUT source files. This way you can easily exclude a
972 # subdirectory from a directory tree whose root is specified with the INPUT tag.
974 # Note that relative paths are relative to the directory from which doxygen is
977 EXCLUDE = dali/integration-api
979 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
980 # directories that are symbolic links (a Unix file system feature) are excluded
982 # The default value is: NO.
984 EXCLUDE_SYMLINKS = NO
986 # If the value of the INPUT tag contains directories, you can use the
987 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
988 # certain files from those directories.
990 # Note that the wildcards are matched against the file with absolute path, so to
991 # exclude all test directories for example use the pattern */test/*
995 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
996 # (namespaces, classes, functions, etc.) that should be excluded from the
997 # output. The symbol name can be a fully qualified name, a word, or if the
998 # wildcard * is used, a substring. Examples: ANamespace, AClass,
999 # AClass::ANamespace, ANamespace::*Test
1001 # Note that the wildcards are matched against the file with absolute path, so to
1002 # exclude all test directories use the pattern */test/*
1004 EXCLUDE_SYMBOLS = DaliInternal \
1010 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1011 # that contain example code fragments that are included (see the \include
1014 EXAMPLE_PATH = @DOXYGEN_DOCS_DIR@/../
1016 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1017 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1018 # *.h) to filter out the source-files in the directories. If left blank all
1019 # files are included.
1021 EXAMPLE_PATTERNS = *
1023 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1024 # searched for input files to be used with the \include or \dontinclude commands
1025 # irrespective of the value of the RECURSIVE tag.
1026 # The default value is: NO.
1028 EXAMPLE_RECURSIVE = YES
1030 # The IMAGE_PATH tag can be used to specify one or more files or directories
1031 # that contain images that are to be included in the documentation (see the
1034 IMAGE_PATH = @DOXYGEN_DOCS_DIR@/content/images
1036 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1037 # invoke to filter for each input file. Doxygen will invoke the filter program
1038 # by executing (via popen()) the command:
1040 # <filter> <input-file>
1042 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1043 # name of an input file. Doxygen will then use the output that the filter
1044 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1047 # Note that the filter must not add or remove lines; it is applied before the
1048 # code is scanned, but not when the output code is generated. If lines are added
1049 # or removed, the anchors will not be placed correctly.
1053 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1054 # basis. Doxygen will compare the file name with each pattern and apply the
1055 # filter if there is a match. The filters are a list of the form: pattern=filter
1056 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1057 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1058 # patterns match the file name, INPUT_FILTER is applied.
1062 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1063 # INPUT_FILTER ) will also be used to filter the input files that are used for
1064 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1065 # The default value is: NO.
1067 FILTER_SOURCE_FILES = NO
1069 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1070 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1071 # it is also possible to disable source filtering for a specific pattern using
1072 # *.ext= (so without naming a filter).
1073 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1075 FILTER_SOURCE_PATTERNS =
1077 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1078 # is part of the input, its contents will be placed on the main page
1079 # (index.html). This can be useful if you have a project on for instance GitHub
1080 # and want to reuse the introduction page also for the doxygen output.
1082 USE_MDFILE_AS_MAINPAGE = main.md
1084 #---------------------------------------------------------------------------
1085 # Configuration options related to source browsing
1086 #---------------------------------------------------------------------------
1088 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1089 # generated. Documented entities will be cross-referenced with these sources.
1091 # Note: To get rid of all source code in the generated output, make sure that
1092 # also VERBATIM_HEADERS is set to NO.
1093 # The default value is: NO.
1095 SOURCE_BROWSER = YES
1097 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1098 # classes and enums directly into the documentation.
1099 # The default value is: NO.
1103 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1104 # special comment blocks from generated source code fragments. Normal C, C++ and
1105 # Fortran comments will always remain visible.
1106 # The default value is: YES.
1108 STRIP_CODE_COMMENTS = NO
1110 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1111 # function all documented functions referencing it will be listed.
1112 # The default value is: NO.
1114 REFERENCED_BY_RELATION = NO
1116 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1117 # all documented entities called/used by that function will be listed.
1118 # The default value is: NO.
1120 REFERENCES_RELATION = NO
1122 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1123 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
1124 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1125 # link to the documentation.
1126 # The default value is: YES.
1128 REFERENCES_LINK_SOURCE = YES
1130 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1131 # source code will show a tooltip with additional information such as prototype,
1132 # brief description and links to the definition and documentation. Since this
1133 # will make the HTML file larger and loading of large files a bit slower, you
1134 # can opt to disable this feature.
1135 # The default value is: YES.
1136 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1138 SOURCE_TOOLTIPS = YES
1140 # If the USE_HTAGS tag is set to YES then the references to source code will
1141 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1142 # source browser. The htags tool is part of GNU's global source tagging system
1143 # (see http://www.gnu.org/software/global/global.html). You will need version
1146 # To use it do the following:
1147 # - Install the latest version of global
1148 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1149 # - Make sure the INPUT points to the root of the source tree
1150 # - Run doxygen as normal
1152 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1153 # tools must be available from the command line (i.e. in the search path).
1155 # The result: instead of the source browser generated by doxygen, the links to
1156 # source code will now point to the output of htags.
1157 # The default value is: NO.
1158 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1162 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1163 # verbatim copy of the header file for each class for which an include is
1164 # specified. Set to NO to disable this.
1165 # See also: Section \class.
1166 # The default value is: YES.
1168 VERBATIM_HEADERS = YES
1170 #---------------------------------------------------------------------------
1171 # Configuration options related to the alphabetical class index
1172 #---------------------------------------------------------------------------
1174 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1175 # compounds will be generated. Enable this if the project contains a lot of
1176 # classes, structs, unions or interfaces.
1177 # The default value is: YES.
1179 ALPHABETICAL_INDEX = NO
1181 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1182 # which the alphabetical index list will be split.
1183 # Minimum value: 1, maximum value: 20, default value: 5.
1184 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1186 COLS_IN_ALPHA_INDEX = 5
1188 # In case all classes in a project start with a common prefix, all classes will
1189 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1190 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1191 # while generating the index headers.
1192 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1196 #---------------------------------------------------------------------------
1197 # Configuration options related to the HTML output
1198 #---------------------------------------------------------------------------
1200 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1201 # The default value is: YES.
1205 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1206 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1208 # The default directory is: html.
1209 # This tag requires that the tag GENERATE_HTML is set to YES.
1213 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1214 # generated HTML page (for example: .htm, .php, .asp).
1215 # The default value is: .html.
1216 # This tag requires that the tag GENERATE_HTML is set to YES.
1218 HTML_FILE_EXTENSION = .html
1220 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1221 # each generated HTML page. If the tag is left blank doxygen will generate a
1224 # To get valid HTML the header file that includes any scripts and style sheets
1225 # that doxygen needs, which is dependent on the configuration options used (e.g.
1226 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1227 # default header using
1228 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1230 # and then modify the file new_header.html. See also section "Doxygen usage"
1231 # for information on how to generate the default header that doxygen normally
1233 # Note: The header is subject to change so you typically have to regenerate the
1234 # default header when upgrading to a newer version of doxygen. For a description
1235 # of the possible markers and block names see the documentation.
1236 # This tag requires that the tag GENERATE_HTML is set to YES.
1240 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1241 # generated HTML page. If the tag is left blank doxygen will generate a standard
1242 # footer. See HTML_HEADER for more information on how to generate a default
1243 # footer and what special commands can be used inside the footer. See also
1244 # section "Doxygen usage" for information on how to generate the default footer
1245 # that doxygen normally uses.
1246 # This tag requires that the tag GENERATE_HTML is set to YES.
1250 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1251 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1252 # the HTML output. If left blank doxygen will generate a default style sheet.
1253 # See also section "Doxygen usage" for information on how to generate the style
1254 # sheet that doxygen normally uses.
1255 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1256 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1258 # This tag requires that the tag GENERATE_HTML is set to YES.
1262 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1263 # defined cascading style sheet that is included after the standard style sheets
1264 # created by doxygen. Using this option one can overrule certain style aspects.
1265 # This is preferred over using HTML_STYLESHEET since it does not replace the
1266 # standard style sheet and is therefor more robust against future updates.
1267 # Doxygen will copy the style sheet file to the output directory. For an example
1268 # see the documentation.
1269 # This tag requires that the tag GENERATE_HTML is set to YES.
1271 HTML_EXTRA_STYLESHEET = dali_doxygen.css
1273 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1274 # other source files which should be copied to the HTML output directory. Note
1275 # that these files will be copied to the base HTML output directory. Use the
1276 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1277 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1278 # files will be copied as-is; there are no commands or markers available.
1279 # This tag requires that the tag GENERATE_HTML is set to YES.
1283 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1284 # will adjust the colors in the stylesheet and background images according to
1285 # this color. Hue is specified as an angle on a colorwheel, see
1286 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1287 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1288 # purple, and 360 is red again.
1289 # Minimum value: 0, maximum value: 359, default value: 220.
1290 # This tag requires that the tag GENERATE_HTML is set to YES.
1292 HTML_COLORSTYLE_HUE = 220
1294 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1295 # in the HTML output. For a value of 0 the output will use grayscales only. A
1296 # value of 255 will produce the most vivid colors.
1297 # Minimum value: 0, maximum value: 255, default value: 100.
1298 # This tag requires that the tag GENERATE_HTML is set to YES.
1300 HTML_COLORSTYLE_SAT = 100
1302 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1303 # luminance component of the colors in the HTML output. Values below 100
1304 # gradually make the output lighter, whereas values above 100 make the output
1305 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1306 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1308 # Minimum value: 40, maximum value: 240, default value: 80.
1309 # This tag requires that the tag GENERATE_HTML is set to YES.
1311 HTML_COLORSTYLE_GAMMA = 80
1313 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1314 # page will contain the date and time when the page was generated. Setting this
1315 # to NO can help when comparing the output of multiple runs.
1316 # The default value is: YES.
1317 # This tag requires that the tag GENERATE_HTML is set to YES.
1319 HTML_TIMESTAMP = YES
1321 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1322 # documentation will contain sections that can be hidden and shown after the
1324 # The default value is: NO.
1325 # This tag requires that the tag GENERATE_HTML is set to YES.
1327 HTML_DYNAMIC_SECTIONS = NO
1329 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1330 # shown in the various tree structured indices initially; the user can expand
1331 # and collapse entries dynamically later on. Doxygen will expand the tree to
1332 # such a level that at most the specified number of entries are visible (unless
1333 # a fully collapsed tree already exceeds this amount). So setting the number of
1334 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1335 # representing an infinite number of entries and will result in a full expanded
1337 # Minimum value: 0, maximum value: 9999, default value: 100.
1338 # This tag requires that the tag GENERATE_HTML is set to YES.
1340 HTML_INDEX_NUM_ENTRIES = 100
1342 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1343 # generated that can be used as input for Apple's Xcode 3 integrated development
1344 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1345 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1346 # Makefile in the HTML output directory. Running make will produce the docset in
1347 # that directory and running make install will install the docset in
1348 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1349 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1350 # for more information.
1351 # The default value is: NO.
1352 # This tag requires that the tag GENERATE_HTML is set to YES.
1354 GENERATE_DOCSET = NO
1356 # This tag determines the name of the docset feed. A documentation feed provides
1357 # an umbrella under which multiple documentation sets from a single provider
1358 # (such as a company or product suite) can be grouped.
1359 # The default value is: Doxygen generated docs.
1360 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1362 DOCSET_FEEDNAME = "Doxygen generated docs"
1364 # This tag specifies a string that should uniquely identify the documentation
1365 # set bundle. This should be a reverse domain-name style string, e.g.
1366 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1367 # The default value is: org.doxygen.Project.
1368 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1370 DOCSET_BUNDLE_ID = org.doxygen.Project
1372 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1373 # the documentation publisher. This should be a reverse domain-name style
1374 # string, e.g. com.mycompany.MyDocSet.documentation.
1375 # The default value is: org.doxygen.Publisher.
1376 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1378 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1380 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1381 # The default value is: Publisher.
1382 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1384 DOCSET_PUBLISHER_NAME = Publisher
1386 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1387 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1388 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1389 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1392 # The HTML Help Workshop contains a compiler that can convert all HTML output
1393 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1394 # files are now used as the Windows 98 help format, and will replace the old
1395 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1396 # HTML files also contain an index, a table of contents, and you can search for
1397 # words in the documentation. The HTML workshop also contains a viewer for
1398 # compressed HTML files.
1399 # The default value is: NO.
1400 # This tag requires that the tag GENERATE_HTML is set to YES.
1402 GENERATE_HTMLHELP = YES
1404 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1405 # file. You can add a path in front of the file if the result should not be
1406 # written to the html output directory.
1407 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1411 # The HHC_LOCATION tag can be used to specify the location (absolute path
1412 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1413 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1414 # The file has to be specified with full path.
1415 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1419 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1420 # YES) or that it should be included in the master .chm file ( NO).
1421 # The default value is: NO.
1422 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1426 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1427 # and project file content.
1428 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1430 CHM_INDEX_ENCODING =
1432 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1433 # YES) or a normal table of contents ( NO) in the .chm file.
1434 # The default value is: NO.
1435 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1439 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1440 # the table of contents of the HTML help documentation and to the tree view.
1441 # The default value is: NO.
1442 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1446 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1447 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1448 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1449 # (.qch) of the generated HTML documentation.
1450 # The default value is: NO.
1451 # This tag requires that the tag GENERATE_HTML is set to YES.
1455 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1456 # the file name of the resulting .qch file. The path specified is relative to
1457 # the HTML output folder.
1458 # This tag requires that the tag GENERATE_QHP is set to YES.
1460 QCH_FILE = "Dali.qch"
1462 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1463 # Project output. For more information please see Qt Help Project / Namespace
1464 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1465 # The default value is: org.doxygen.Project.
1466 # This tag requires that the tag GENERATE_QHP is set to YES.
1468 QHP_NAMESPACE = "Dali"
1470 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1471 # Help Project output. For more information please see Qt Help Project / Virtual
1472 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1474 # The default value is: doc.
1475 # This tag requires that the tag GENERATE_QHP is set to YES.
1477 QHP_VIRTUAL_FOLDER = doc
1479 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1480 # filter to add. For more information please see Qt Help Project / Custom
1481 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1483 # This tag requires that the tag GENERATE_QHP is set to YES.
1485 QHP_CUST_FILTER_NAME =
1487 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1488 # custom filter to add. For more information please see Qt Help Project / Custom
1489 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1491 # This tag requires that the tag GENERATE_QHP is set to YES.
1493 QHP_CUST_FILTER_ATTRS =
1495 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1496 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1497 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1498 # This tag requires that the tag GENERATE_QHP is set to YES.
1500 QHP_SECT_FILTER_ATTRS =
1502 # The QHG_LOCATION tag can be used to specify the location of Qt's
1503 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1504 # generated .qhp file.
1505 # This tag requires that the tag GENERATE_QHP is set to YES.
1507 # Don't set this - there is a broken section tag in the resultant index.qhp
1508 # that needs manually editing before running qhelpgenerator.
1511 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1512 # generated, together with the HTML files, they form an Eclipse help plugin. To
1513 # install this plugin and make it available under the help contents menu in
1514 # Eclipse, the contents of the directory containing the HTML and XML files needs
1515 # to be copied into the plugins directory of eclipse. The name of the directory
1516 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1517 # After copying Eclipse needs to be restarted before the help appears.
1518 # The default value is: NO.
1519 # This tag requires that the tag GENERATE_HTML is set to YES.
1521 GENERATE_ECLIPSEHELP = NO
1523 # A unique identifier for the Eclipse help plugin. When installing the plugin
1524 # the directory name containing the HTML and XML files should also have this
1525 # name. Each documentation set should have its own identifier.
1526 # The default value is: org.doxygen.Project.
1527 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1529 ECLIPSE_DOC_ID = org.doxygen.Project
1531 # If you want full control over the layout of the generated HTML pages it might
1532 # be necessary to disable the index and replace it with your own. The
1533 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1534 # of each HTML page. A value of NO enables the index and the value YES disables
1535 # it. Since the tabs in the index contain the same information as the navigation
1536 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1537 # The default value is: NO.
1538 # This tag requires that the tag GENERATE_HTML is set to YES.
1542 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1543 # structure should be generated to display hierarchical information. If the tag
1544 # value is set to YES, a side panel will be generated containing a tree-like
1545 # index structure (just like the one that is generated for HTML Help). For this
1546 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1547 # (i.e. any modern browser). Windows users are probably better off using the
1548 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1549 # further fine-tune the look of the index. As an example, the default style
1550 # sheet generated by doxygen has an example that shows how to put an image at
1551 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1552 # the same information as the tab index, you could consider setting
1553 # DISABLE_INDEX to YES when enabling this option.
1554 # The default value is: NO.
1555 # This tag requires that the tag GENERATE_HTML is set to YES.
1557 GENERATE_TREEVIEW = NONE
1559 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1560 # doxygen will group on one line in the generated HTML documentation.
1562 # Note that a value of 0 will completely suppress the enum values from appearing
1563 # in the overview section.
1564 # Minimum value: 0, maximum value: 20, default value: 4.
1565 # This tag requires that the tag GENERATE_HTML is set to YES.
1567 ENUM_VALUES_PER_LINE = 4
1569 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1570 # to set the initial width (in pixels) of the frame in which the tree is shown.
1571 # Minimum value: 0, maximum value: 1500, default value: 250.
1572 # This tag requires that the tag GENERATE_HTML is set to YES.
1574 TREEVIEW_WIDTH = 250
1576 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1577 # external symbols imported via tag files in a separate window.
1578 # The default value is: NO.
1579 # This tag requires that the tag GENERATE_HTML is set to YES.
1581 EXT_LINKS_IN_WINDOW = NO
1583 # Use this tag to change the font size of LaTeX formulas included as images in
1584 # the HTML documentation. When you change the font size after a successful
1585 # doxygen run you need to manually remove any form_*.png images from the HTML
1586 # output directory to force them to be regenerated.
1587 # Minimum value: 8, maximum value: 50, default value: 10.
1588 # This tag requires that the tag GENERATE_HTML is set to YES.
1590 FORMULA_FONTSIZE = 10
1592 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1593 # generated for formulas are transparent PNGs. Transparent PNGs are not
1594 # supported properly for IE 6.0, but are supported on all modern browsers.
1596 # Note that when changing this option you need to delete any form_*.png files in
1597 # the HTML output directory before the changes have effect.
1598 # The default value is: YES.
1599 # This tag requires that the tag GENERATE_HTML is set to YES.
1601 FORMULA_TRANSPARENT = YES
1603 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1604 # http://www.mathjax.org) which uses client side Javascript for the rendering
1605 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1606 # installed or if you want to formulas look prettier in the HTML output. When
1607 # enabled you may also need to install MathJax separately and configure the path
1608 # to it using the MATHJAX_RELPATH option.
1609 # The default value is: NO.
1610 # This tag requires that the tag GENERATE_HTML is set to YES.
1614 # When MathJax is enabled you can set the default output format to be used for
1615 # the MathJax output. See the MathJax site (see:
1616 # http://docs.mathjax.org/en/latest/output.html) for more details.
1617 # Possible values are: HTML-CSS (which is slower, but has the best
1618 # compatibility), NativeMML (i.e. MathML) and SVG.
1619 # The default value is: HTML-CSS.
1620 # This tag requires that the tag USE_MATHJAX is set to YES.
1622 MATHJAX_FORMAT = HTML-CSS
1624 # When MathJax is enabled you need to specify the location relative to the HTML
1625 # output directory using the MATHJAX_RELPATH option. The destination directory
1626 # should contain the MathJax.js script. For instance, if the mathjax directory
1627 # is located at the same level as the HTML output directory, then
1628 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1629 # Content Delivery Network so you can quickly see the result without installing
1630 # MathJax. However, it is strongly recommended to install a local copy of
1631 # MathJax from http://www.mathjax.org before deployment.
1632 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1633 # This tag requires that the tag USE_MATHJAX is set to YES.
1635 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1637 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1638 # extension names that should be enabled during MathJax rendering. For example
1639 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1640 # This tag requires that the tag USE_MATHJAX is set to YES.
1642 MATHJAX_EXTENSIONS =
1644 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1645 # of code that will be used on startup of the MathJax code. See the MathJax site
1646 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1647 # example see the documentation.
1648 # This tag requires that the tag USE_MATHJAX is set to YES.
1652 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1653 # the HTML output. The underlying search engine uses javascript and DHTML and
1654 # should work on any modern browser. Note that when using HTML help
1655 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1656 # there is already a search function so this one should typically be disabled.
1657 # For large projects the javascript based search engine can be slow, then
1658 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1659 # search using the keyboard; to jump to the search box use <access key> + S
1660 # (what the <access key> is depends on the OS and browser, but it is typically
1661 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1662 # key> to jump into the search results window, the results can be navigated
1663 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1664 # the search. The filter options can be selected when the cursor is inside the
1665 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1666 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1668 # The default value is: YES.
1669 # This tag requires that the tag GENERATE_HTML is set to YES.
1673 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1674 # implemented using a web server instead of a web client using Javascript. There
1675 # are two flavours of web server based searching depending on the
1676 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1677 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1678 # enabled the indexing and searching needs to be provided by external tools. See
1679 # the section "External Indexing and Searching" for details.
1680 # The default value is: NO.
1681 # This tag requires that the tag SEARCHENGINE is set to YES.
1683 SERVER_BASED_SEARCH = NO
1685 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1686 # script for searching. Instead the search results are written to an XML file
1687 # which needs to be processed by an external indexer. Doxygen will invoke an
1688 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1691 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1692 # (doxysearch.cgi) which are based on the open source search engine library
1693 # Xapian (see: http://xapian.org/).
1695 # See the section "External Indexing and Searching" for details.
1696 # The default value is: NO.
1697 # This tag requires that the tag SEARCHENGINE is set to YES.
1699 EXTERNAL_SEARCH = NO
1701 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1702 # which will return the search results when EXTERNAL_SEARCH is enabled.
1704 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1705 # (doxysearch.cgi) which are based on the open source search engine library
1706 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1707 # Searching" for details.
1708 # This tag requires that the tag SEARCHENGINE is set to YES.
1712 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1713 # search data is written to a file for indexing by an external tool. With the
1714 # SEARCHDATA_FILE tag the name of this file can be specified.
1715 # The default file is: searchdata.xml.
1716 # This tag requires that the tag SEARCHENGINE is set to YES.
1718 SEARCHDATA_FILE = searchdata.xml
1720 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1721 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1722 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1723 # projects and redirect the results back to the right project.
1724 # This tag requires that the tag SEARCHENGINE is set to YES.
1726 EXTERNAL_SEARCH_ID =
1728 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1729 # projects other than the one defined by this configuration file, but that are
1730 # all added to the same external search index. Each project needs to have a
1731 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1732 # to a relative location where the documentation can be found. The format is:
1733 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1734 # This tag requires that the tag SEARCHENGINE is set to YES.
1736 EXTRA_SEARCH_MAPPINGS =
1738 #---------------------------------------------------------------------------
1739 # Configuration options related to the LaTeX output
1740 #---------------------------------------------------------------------------
1742 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1743 # The default value is: YES.
1747 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1748 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1750 # The default directory is: latex.
1751 # This tag requires that the tag GENERATE_LATEX is set to YES.
1753 LATEX_OUTPUT = latex
1755 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1758 # Note that when enabling USE_PDFLATEX this option is only used for generating
1759 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1760 # written to the output directory.
1761 # The default file is: latex.
1762 # This tag requires that the tag GENERATE_LATEX is set to YES.
1764 LATEX_CMD_NAME = latex
1766 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1768 # The default file is: makeindex.
1769 # This tag requires that the tag GENERATE_LATEX is set to YES.
1771 MAKEINDEX_CMD_NAME = makeindex
1773 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1774 # documents. This may be useful for small projects and may help to save some
1776 # The default value is: NO.
1777 # This tag requires that the tag GENERATE_LATEX is set to YES.
1781 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1783 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1784 # 14 inches) and executive (7.25 x 10.5 inches).
1785 # The default value is: a4.
1786 # This tag requires that the tag GENERATE_LATEX is set to YES.
1790 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1791 # that should be included in the LaTeX output. To get the times font for
1792 # instance you can specify
1793 # EXTRA_PACKAGES=times
1794 # If left blank no extra packages will be included.
1795 # This tag requires that the tag GENERATE_LATEX is set to YES.
1799 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1800 # generated LaTeX document. The header should contain everything until the first
1801 # chapter. If it is left blank doxygen will generate a standard header. See
1802 # section "Doxygen usage" for information on how to let doxygen write the
1803 # default header to a separate file.
1805 # Note: Only use a user-defined header if you know what you are doing! The
1806 # following commands have a special meaning inside the header: $title,
1807 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1808 # replace them by respectively the title of the page, the current date and time,
1809 # only the current date, the version number of doxygen, the project name (see
1810 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1811 # This tag requires that the tag GENERATE_LATEX is set to YES.
1815 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1816 # generated LaTeX document. The footer should contain everything after the last
1817 # chapter. If it is left blank doxygen will generate a standard footer.
1819 # Note: Only use a user-defined footer if you know what you are doing!
1820 # This tag requires that the tag GENERATE_LATEX is set to YES.
1824 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1825 # other source files which should be copied to the LATEX_OUTPUT output
1826 # directory. Note that the files will be copied as-is; there are no commands or
1827 # markers available.
1828 # This tag requires that the tag GENERATE_LATEX is set to YES.
1832 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1833 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1834 # contain links (just like the HTML output) instead of page references. This
1835 # makes the output suitable for online browsing using a PDF viewer.
1836 # The default value is: YES.
1837 # This tag requires that the tag GENERATE_LATEX is set to YES.
1839 PDF_HYPERLINKS = YES
1841 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1842 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1843 # higher quality PDF documentation.
1844 # The default value is: YES.
1845 # This tag requires that the tag GENERATE_LATEX is set to YES.
1849 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1850 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1851 # if errors occur, instead of asking the user for help. This option is also used
1852 # when generating formulas in HTML.
1853 # The default value is: NO.
1854 # This tag requires that the tag GENERATE_LATEX is set to YES.
1856 LATEX_BATCHMODE = NO
1858 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1859 # index chapters (such as File Index, Compound Index, etc.) in the output.
1860 # The default value is: NO.
1861 # This tag requires that the tag GENERATE_LATEX is set to YES.
1863 LATEX_HIDE_INDICES = NO
1865 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1866 # code with syntax highlighting in the LaTeX output.
1868 # Note that which sources are shown also depends on other settings such as
1870 # The default value is: NO.
1871 # This tag requires that the tag GENERATE_LATEX is set to YES.
1873 LATEX_SOURCE_CODE = NO
1875 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1876 # bibliography, e.g. plainnat, or ieeetr. See
1877 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1878 # The default value is: plain.
1879 # This tag requires that the tag GENERATE_LATEX is set to YES.
1881 LATEX_BIB_STYLE = plain
1883 #---------------------------------------------------------------------------
1884 # Configuration options related to the RTF output
1885 #---------------------------------------------------------------------------
1887 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1888 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1890 # The default value is: NO.
1894 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1895 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1897 # The default directory is: rtf.
1898 # This tag requires that the tag GENERATE_RTF is set to YES.
1902 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1903 # documents. This may be useful for small projects and may help to save some
1905 # The default value is: NO.
1906 # This tag requires that the tag GENERATE_RTF is set to YES.
1910 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1911 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1912 # output) instead of page references. This makes the output suitable for online
1913 # browsing using Word or some other Word compatible readers that support those
1916 # Note: WordPad (write) and others do not support links.
1917 # The default value is: NO.
1918 # This tag requires that the tag GENERATE_RTF is set to YES.
1922 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1923 # file, i.e. a series of assignments. You only have to provide replacements,
1924 # missing definitions are set to their default value.
1926 # See also section "Doxygen usage" for information on how to generate the
1927 # default style sheet that doxygen normally uses.
1928 # This tag requires that the tag GENERATE_RTF is set to YES.
1930 RTF_STYLESHEET_FILE =
1932 # Set optional variables used in the generation of an RTF document. Syntax is
1933 # similar to doxygen's config file. A template extensions file can be generated
1934 # using doxygen -e rtf extensionFile.
1935 # This tag requires that the tag GENERATE_RTF is set to YES.
1937 RTF_EXTENSIONS_FILE =
1939 #---------------------------------------------------------------------------
1940 # Configuration options related to the man page output
1941 #---------------------------------------------------------------------------
1943 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1944 # classes and files.
1945 # The default value is: NO.
1949 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1950 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1951 # it. A directory man3 will be created inside the directory specified by
1953 # The default directory is: man.
1954 # This tag requires that the tag GENERATE_MAN is set to YES.
1958 # The MAN_EXTENSION tag determines the extension that is added to the generated
1959 # man pages. In case the manual section does not start with a number, the number
1960 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1962 # The default value is: .3.
1963 # This tag requires that the tag GENERATE_MAN is set to YES.
1967 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1968 # will generate one additional man file for each entity documented in the real
1969 # man page(s). These additional files only source the real man page, but without
1970 # them the man command would be unable to find the correct page.
1971 # The default value is: NO.
1972 # This tag requires that the tag GENERATE_MAN is set to YES.
1976 #---------------------------------------------------------------------------
1977 # Configuration options related to the XML output
1978 #---------------------------------------------------------------------------
1980 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1981 # captures the structure of the code including all documentation.
1982 # The default value is: NO.
1986 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1987 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1989 # The default directory is: xml.
1990 # This tag requires that the tag GENERATE_XML is set to YES.
1994 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1995 # validating XML parser to check the syntax of the XML files.
1996 # This tag requires that the tag GENERATE_XML is set to YES.
2000 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
2001 # validating XML parser to check the syntax of the XML files.
2002 # This tag requires that the tag GENERATE_XML is set to YES.
2006 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
2007 # listings (including syntax highlighting and cross-referencing information) to
2008 # the XML output. Note that enabling this will significantly increase the size
2009 # of the XML output.
2010 # The default value is: YES.
2011 # This tag requires that the tag GENERATE_XML is set to YES.
2013 XML_PROGRAMLISTING = YES
2015 #---------------------------------------------------------------------------
2016 # Configuration options related to the DOCBOOK output
2017 #---------------------------------------------------------------------------
2019 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
2020 # that can be used to generate PDF.
2021 # The default value is: NO.
2023 GENERATE_DOCBOOK = NO
2025 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2026 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2028 # The default directory is: docbook.
2029 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2031 DOCBOOK_OUTPUT = docbook
2033 #---------------------------------------------------------------------------
2034 # Configuration options for the AutoGen Definitions output
2035 #---------------------------------------------------------------------------
2037 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
2038 # Definitions (see http://autogen.sf.net) file that captures the structure of
2039 # the code including all documentation. Note that this feature is still
2040 # experimental and incomplete at the moment.
2041 # The default value is: NO.
2043 GENERATE_AUTOGEN_DEF = NO
2045 #---------------------------------------------------------------------------
2046 # Configuration options related to the Perl module output
2047 #---------------------------------------------------------------------------
2049 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
2050 # file that captures the structure of the code including all documentation.
2052 # Note that this feature is still experimental and incomplete at the moment.
2053 # The default value is: NO.
2055 GENERATE_PERLMOD = NO
2057 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
2058 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2059 # output from the Perl module output.
2060 # The default value is: NO.
2061 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2065 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
2066 # formatted so it can be parsed by a human reader. This is useful if you want to
2067 # understand what is going on. On the other hand, if this tag is set to NO the
2068 # size of the Perl module output will be much smaller and Perl will parse it
2070 # The default value is: YES.
2071 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2073 PERLMOD_PRETTY = YES
2075 # The names of the make variables in the generated doxyrules.make file are
2076 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2077 # so different doxyrules.make files included by the same Makefile don't
2078 # overwrite each other's variables.
2079 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2081 PERLMOD_MAKEVAR_PREFIX =
2083 #---------------------------------------------------------------------------
2084 # Configuration options related to the preprocessor
2085 #---------------------------------------------------------------------------
2087 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
2088 # C-preprocessor directives found in the sources and include files.
2089 # The default value is: YES.
2091 ENABLE_PREPROCESSING = YES
2093 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
2094 # in the source code. If set to NO only conditional compilation will be
2095 # performed. Macro expansion can be done in a controlled way by setting
2096 # EXPAND_ONLY_PREDEF to YES.
2097 # The default value is: NO.
2098 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2100 MACRO_EXPANSION = YES
2102 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2103 # the macro expansion is limited to the macros specified with the PREDEFINED and
2104 # EXPAND_AS_DEFINED tags.
2105 # The default value is: NO.
2106 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2108 EXPAND_ONLY_PREDEF = YES
2110 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
2111 # INCLUDE_PATH will be searched if a #include is found.
2112 # The default value is: YES.
2113 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2115 SEARCH_INCLUDES = YES
2117 # The INCLUDE_PATH tag can be used to specify one or more directories that
2118 # contain include files that are not input files but should be processed by the
2120 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2124 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2125 # patterns (like *.h and *.hpp) to filter out the header-files in the
2126 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2128 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2130 INCLUDE_FILE_PATTERNS =
2132 # The PREDEFINED tag can be used to specify one or more macro names that are
2133 # defined before the preprocessor is started (similar to the -D option of e.g.
2134 # gcc). The argument of the tag is a list of macros of the form: name or
2135 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2136 # is assumed. To prevent a macro definition from being undefined via #undef or
2137 # recursively expanded use the := operator instead of the = operator.
2138 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2140 PREDEFINED = DALI_IMPORT_API \
2149 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2150 # tag can be used to specify a list of macro names that should be expanded. The
2151 # macro definition that is found in the sources will be used. Use the PREDEFINED
2152 # tag if you want to use a different macro definition that overrules the
2153 # definition found in the source code.
2154 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2158 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2159 # remove all refrences to function-like macros that are alone on a line, have an
2160 # all uppercase name, and do not end with a semicolon. Such function macros are
2161 # typically used for boiler-plate code, and will confuse the parser if not
2163 # The default value is: YES.
2164 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2166 SKIP_FUNCTION_MACROS = YES
2168 #---------------------------------------------------------------------------
2169 # Configuration options related to external references
2170 #---------------------------------------------------------------------------
2172 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2173 # file the location of the external documentation should be added. The format of
2174 # a tag file without this location is as follows:
2175 # TAGFILES = file1 file2 ...
2176 # Adding location for the tag files is done as follows:
2177 # TAGFILES = file1=loc1 "file2 = loc2" ...
2178 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2179 # section "Linking to external documentation" for more information about the use
2181 # Note: Each tag file must have an unique name (where the name does NOT include
2182 # the path). If a tag file is not located in the directory in which doxygen is
2183 # run, you must also specify the path to the tagfile here.
2187 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2188 # tag file that is based on the input files it reads. See section "Linking to
2189 # external documentation" for more information about the usage of tag files.
2193 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2194 # class index. If set to NO only the inherited external classes will be listed.
2195 # The default value is: NO.
2199 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2200 # the modules index. If set to NO, only the current project's groups will be
2202 # The default value is: YES.
2204 EXTERNAL_GROUPS = YES
2206 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2207 # the related pages index. If set to NO, only the current project's pages will
2209 # The default value is: YES.
2211 EXTERNAL_PAGES = YES
2213 # The PERL_PATH should be the absolute path and name of the perl script
2214 # interpreter (i.e. the result of 'which perl').
2215 # The default file (with absolute path) is: /usr/bin/perl.
2217 PERL_PATH = /usr/bin/perl
2219 #---------------------------------------------------------------------------
2220 # Configuration options related to the dot tool
2221 #---------------------------------------------------------------------------
2223 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2224 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2225 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2226 # disabled, but it is recommended to install and use dot, since it yields more
2228 # The default value is: YES.
2230 CLASS_DIAGRAMS = YES
2232 # You can define message sequence charts within doxygen comments using the \msc
2233 # command. Doxygen will then run the mscgen tool (see:
2234 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2235 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2236 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2237 # default search path.
2241 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2242 # then run dia to produce the diagram and insert it in the documentation. The
2243 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2244 # If left empty dia is assumed to be found in the default search path.
2248 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2249 # and usage relations if the target is undocumented or is not a class.
2250 # The default value is: YES.
2252 HIDE_UNDOC_RELATIONS = YES
2254 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2255 # available from the path. This tool is part of Graphviz (see:
2256 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2257 # Bell Labs. The other options in this section have no effect if this option is
2259 # The default value is: NO.
2263 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2264 # to run in parallel. When set to 0 doxygen will base this on the number of
2265 # processors available in the system. You can set it explicitly to a value
2266 # larger than 0 to get control over the balance between CPU load and processing
2268 # Minimum value: 0, maximum value: 32, default value: 0.
2269 # This tag requires that the tag HAVE_DOT is set to YES.
2273 # When you want a differently looking font n the dot files that doxygen
2274 # generates you can specify the font name using DOT_FONTNAME. You need to make
2275 # sure dot is able to find the font, which can be done by putting it in a
2276 # standard location or by setting the DOTFONTPATH environment variable or by
2277 # setting DOT_FONTPATH to the directory containing the font.
2278 # The default value is: Helvetica.
2279 # This tag requires that the tag HAVE_DOT is set to YES.
2283 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2285 # Minimum value: 4, maximum value: 24, default value: 10.
2286 # This tag requires that the tag HAVE_DOT is set to YES.
2290 # By default doxygen will tell dot to use the default font as specified with
2291 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2292 # the path where dot can find it using this tag.
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2297 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2298 # each documented class showing the direct and indirect inheritance relations.
2299 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2300 # The default value is: YES.
2301 # This tag requires that the tag HAVE_DOT is set to YES.
2305 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2306 # graph for each documented class showing the direct and indirect implementation
2307 # dependencies (inheritance, containment, and class references variables) of the
2308 # class with other documented classes.
2309 # The default value is: YES.
2310 # This tag requires that the tag HAVE_DOT is set to YES.
2312 COLLABORATION_GRAPH = YES
2314 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2315 # groups, showing the direct groups dependencies.
2316 # The default value is: YES.
2317 # This tag requires that the tag HAVE_DOT is set to YES.
2321 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2322 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2324 # The default value is: NO.
2325 # This tag requires that the tag HAVE_DOT is set to YES.
2329 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2330 # class node. If there are many fields or methods and many nodes the graph may
2331 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2332 # number of items for each type to make the size more manageable. Set this to 0
2333 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2334 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2335 # but if the number exceeds 15, the total amount of fields shown is limited to
2337 # Minimum value: 0, maximum value: 100, default value: 10.
2338 # This tag requires that the tag HAVE_DOT is set to YES.
2340 UML_LIMIT_NUM_FIELDS = 10
2342 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2343 # collaboration graphs will show the relations between templates and their
2345 # The default value is: NO.
2346 # This tag requires that the tag HAVE_DOT is set to YES.
2348 TEMPLATE_RELATIONS = NO
2350 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2351 # YES then doxygen will generate a graph for each documented file showing the
2352 # direct and indirect include dependencies of the file with other documented
2354 # The default value is: YES.
2355 # This tag requires that the tag HAVE_DOT is set to YES.
2359 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2360 # set to YES then doxygen will generate a graph for each documented file showing
2361 # the direct and indirect include dependencies of the file with other documented
2363 # The default value is: YES.
2364 # This tag requires that the tag HAVE_DOT is set to YES.
2366 INCLUDED_BY_GRAPH = YES
2368 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2369 # dependency graph for every global function or class method.
2371 # Note that enabling this option will significantly increase the time of a run.
2372 # So in most cases it will be better to enable call graphs for selected
2373 # functions only using the \callgraph command.
2374 # The default value is: NO.
2375 # This tag requires that the tag HAVE_DOT is set to YES.
2379 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2380 # dependency graph for every global function or class method.
2382 # Note that enabling this option will significantly increase the time of a run.
2383 # So in most cases it will be better to enable caller graphs for selected
2384 # functions only using the \callergraph command.
2385 # The default value is: NO.
2386 # This tag requires that the tag HAVE_DOT is set to YES.
2390 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2391 # hierarchy of all classes instead of a textual one.
2392 # The default value is: YES.
2393 # This tag requires that the tag HAVE_DOT is set to YES.
2395 GRAPHICAL_HIERARCHY = YES
2397 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2398 # dependencies a directory has on other directories in a graphical way. The
2399 # dependency relations are determined by the #include relations between the
2400 # files in the directories.
2401 # The default value is: YES.
2402 # This tag requires that the tag HAVE_DOT is set to YES.
2404 DIRECTORY_GRAPH = YES
2406 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2408 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2409 # to make the SVG files visible in IE 9+ (other browsers do not have this
2411 # Possible values are: png, jpg, gif and svg.
2412 # The default value is: png.
2413 # This tag requires that the tag HAVE_DOT is set to YES.
2415 DOT_IMAGE_FORMAT = png
2417 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2418 # enable generation of interactive SVG images that allow zooming and panning.
2420 # Note that this requires a modern browser other than Internet Explorer. Tested
2421 # and working are Firefox, Chrome, Safari, and Opera.
2422 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2423 # the SVG files visible. Older versions of IE do not have SVG support.
2424 # The default value is: NO.
2425 # This tag requires that the tag HAVE_DOT is set to YES.
2427 INTERACTIVE_SVG = NO
2429 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2430 # found. If left blank, it is assumed the dot tool can be found in the path.
2431 # This tag requires that the tag HAVE_DOT is set to YES.
2435 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2436 # contain dot files that are included in the documentation (see the \dotfile
2438 # This tag requires that the tag HAVE_DOT is set to YES.
2442 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2443 # contain msc files that are included in the documentation (see the \mscfile
2448 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2449 # contain dia files that are included in the documentation (see the \diafile
2454 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2455 # that will be shown in the graph. If the number of nodes in a graph becomes
2456 # larger than this value, doxygen will truncate the graph, which is visualized
2457 # by representing a node as a red box. Note that doxygen if the number of direct
2458 # children of the root node in a graph is already larger than
2459 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2460 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2461 # Minimum value: 0, maximum value: 10000, default value: 50.
2462 # This tag requires that the tag HAVE_DOT is set to YES.
2464 DOT_GRAPH_MAX_NODES = 50
2466 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2467 # generated by dot. A depth value of 3 means that only nodes reachable from the
2468 # root by following a path via at most 3 edges will be shown. Nodes that lay
2469 # further from the root node will be omitted. Note that setting this option to 1
2470 # or 2 may greatly reduce the computation time needed for large code bases. Also
2471 # note that the size of a graph can be further restricted by
2472 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2473 # Minimum value: 0, maximum value: 1000, default value: 0.
2474 # This tag requires that the tag HAVE_DOT is set to YES.
2476 MAX_DOT_GRAPH_DEPTH = 0
2478 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2479 # background. This is disabled by default, because dot on Windows does not seem
2480 # to support this out of the box.
2482 # Warning: Depending on the platform used, enabling this option may lead to
2483 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2485 # The default value is: NO.
2486 # This tag requires that the tag HAVE_DOT is set to YES.
2488 DOT_TRANSPARENT = NO
2490 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2491 # files in one run (i.e. multiple -o and -T options on the command line). This
2492 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2493 # this, this feature is disabled by default.
2494 # The default value is: NO.
2495 # This tag requires that the tag HAVE_DOT is set to YES.
2497 DOT_MULTI_TARGETS = NO
2499 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2500 # explaining the meaning of the various boxes and arrows in the dot generated
2502 # The default value is: YES.
2503 # This tag requires that the tag HAVE_DOT is set to YES.
2505 GENERATE_LEGEND = YES
2507 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2508 # files that are used to generate the various graphs.
2509 # The default value is: YES.
2510 # This tag requires that the tag HAVE_DOT is set to YES.