1 # Doxyfile @DOXYGEN_VERSION@
2 # Note : Some option need to be blocked if version is lower than 1.9.1.
3 # See how "DOXYGEN_VERSION_LESS_1_9_1_BLOCKED" defined in CMakeList.txt.
5 # This file describes the settings to be used by the documentation system
6 # doxygen (www.doxygen.org) for a project.
8 # All text after a double hash (##) is considered a comment and is placed in
9 # front of the TAG it is preceding.
11 # All text after a single hash (#) is considered a comment and will be ignored.
13 # TAG = value [value, ...]
14 # For lists, items can also be appended using:
15 # TAG += value [value, ...]
16 # Values that contain spaces should be placed between quotes (\" \").
18 #---------------------------------------------------------------------------
19 # Project related configuration options
20 #---------------------------------------------------------------------------
22 # This tag specifies the encoding used for all characters in the configuration
23 # file that follow. The default is UTF-8 which is also the encoding used for all
24 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
25 # iconv built into libc) for the transcoding. See
26 # https://www.gnu.org/software/libiconv/ for the list of possible encodings.
27 # The default value is: UTF-8.
29 DOXYFILE_ENCODING = UTF-8
31 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
32 # double-quotes, unless you are using Doxywizard) that should identify the
33 # project for which the documentation is generated. This name is used in the
34 # title of most generated pages and in a few other places.
35 # The default value is: My Project.
39 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
40 # could be handy for archiving the generated documentation or if some version
41 # control system is used.
45 # Using the PROJECT_BRIEF tag one can provide an optional one line description
46 # for a project that appears at the top of each page and should give viewer a
47 # quick idea about the purpose of the project. Keep the description short.
51 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
52 # in the documentation. The maximum height of the logo should not exceed 55
53 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
54 # the logo to the output directory.
58 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
59 # into which the generated documentation will be written. If a relative path is
60 # entered, it will be relative to the location where doxygen was started. If
61 # left blank the current directory will be used.
63 OUTPUT_DIRECTORY = @DOXYGEN_DOCS_DIR@/generated
65 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
66 # directories (in 2 levels) under the output directory of each output format and
67 # will distribute the generated files over these directories. Enabling this
68 # option can be useful when feeding doxygen a huge amount of source files, where
69 # putting all generated files in the same directory would otherwise causes
70 # performance problems for the file system.
71 # The default value is: NO.
75 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
76 # characters to appear in the names of generated files. If set to NO, non-ASCII
77 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
79 # The default value is: NO.
81 ALLOW_UNICODE_NAMES = NO
83 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
84 # documentation generated by doxygen is written. Doxygen will use this
85 # information to generate all constant output in the proper language.
86 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
87 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
88 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
89 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
90 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
91 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
92 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
93 # Ukrainian and Vietnamese.
94 # The default value is: English.
96 OUTPUT_LANGUAGE = English
98 # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
99 # documentation generated by doxygen is written. Doxygen will use this
100 # information to generate all generated output in the proper direction.
101 # Possible values are: None, LTR, RTL and Context.
102 # The default value is: None.
104 OUTPUT_TEXT_DIRECTION = None
106 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
107 # descriptions after the members that are listed in the file and class
108 # documentation (similar to Javadoc). Set to NO to disable this.
109 # The default value is: YES.
111 BRIEF_MEMBER_DESC = YES
113 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
114 # description of a member or function before the detailed description
116 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
117 # brief descriptions will be completely suppressed.
118 # The default value is: YES.
122 # This tag implements a quasi-intelligent brief description abbreviator that is
123 # used to form the text in various listings. Each string in this list, if found
124 # as the leading text of the brief description, will be stripped from the text
125 # and the result, after processing the whole list, is used as the annotated
126 # text. Otherwise, the brief description is used as-is. If left blank, the
127 # following values are used ($name is automatically replaced with the name of
128 # the entity):The $name class, The $name widget, The $name file, is, provides,
129 # specifies, contains, represents, a, an and the.
131 ABBREVIATE_BRIEF = "The $name class" \
143 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
144 # doxygen will generate a detailed section even if there is only a brief
146 # The default value is: NO.
148 ALWAYS_DETAILED_SEC = NO
150 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
151 # inherited members of a class in the documentation of that class as if those
152 # members were ordinary class members. Constructors, destructors and assignment
153 # operators of the base classes will not be shown.
154 # The default value is: NO.
156 INLINE_INHERITED_MEMB = NO
158 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
159 # before files name in the file list and in the header files. If set to NO the
160 # shortest path that makes the file name unique will be used
161 # The default value is: YES.
163 FULL_PATH_NAMES = YES
165 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
166 # Stripping is only done if one of the specified strings matches the left-hand
167 # part of the path. The tag can be used to show relative paths in the file list.
168 # If left blank the directory from which doxygen is run is used as the path to
171 # Note that you can specify absolute paths here, but also relative paths, which
172 # will be relative from the directory where doxygen is started.
173 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
177 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
178 # path mentioned in the documentation of a class, which tells the reader which
179 # header file to include in order to use a class. If left blank only the name of
180 # the header file containing the class definition is used. Otherwise one should
181 # specify the list of include paths that are normally passed to the compiler
184 STRIP_FROM_INC_PATH =
186 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
187 # less readable) file names. This can be useful is your file systems doesn't
188 # support long names like on DOS, Mac, or CD-ROM.
189 # The default value is: NO.
193 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
194 # first line (until the first dot) of a Javadoc-style comment as the brief
195 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
196 # style comments (thus requiring an explicit @brief command for a brief
198 # The default value is: NO.
200 JAVADOC_AUTOBRIEF = YES
202 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
205 # as being the beginning of a Javadoc-style comment "banner". If set to NO, the
206 # Javadoc-style will behave just like regular comments and it will not be
207 # interpreted by doxygen.
208 # The default value is: NO.
212 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
213 # line (until the first dot) of a Qt-style comment as the brief description. If
214 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
215 # requiring an explicit \brief command for a brief description.)
216 # The default value is: NO.
220 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
221 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
222 # a brief description. This used to be the default behavior. The new default is
223 # to treat a multi-line C++ comment block as a detailed description. Set this
224 # tag to YES if you prefer the old behavior instead.
226 # Note that setting this tag to YES also means that rational rose comments are
227 # not recognized any more.
228 # The default value is: NO.
230 MULTILINE_CPP_IS_BRIEF = NO
232 # By default Python docstrings are displayed as preformatted text and doxygen's
233 # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
234 # doxygen's special commands can be used and the contents of the docstring
235 # documentation blocks is shown as doxygen documentation.
236 # The default value is: YES.
238 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ PYTHON_DOCSTRING = YES
240 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
241 # documentation from any documented member that it re-implements.
242 # The default value is: YES.
246 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
247 # page for each member. If set to NO, the documentation of a member will be part
248 # of the file/class/namespace that contains it.
249 # The default value is: NO.
251 SEPARATE_MEMBER_PAGES = NO
253 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
254 # uses this value to replace tabs by spaces in code fragments.
255 # Minimum value: 1, maximum value: 16, default value: 4.
259 # This tag can be used to specify a number of aliases that act as commands in
260 # the documentation. An alias has the form:
263 # "sideeffect=@par Side Effects:\n"
264 # will allow you to put the command \sideeffect (or @sideeffect) in the
265 # documentation, which will result in a user-defined paragraph with heading
266 # "Side Effects:". You can put \n's in the value part of an alias to insert
267 # newlines (in the resulting output). You can put ^^ in the value part of an
268 # alias to insert a newline as if a physical newline was in the original file.
269 # When you need a literal { or } or , in the value part of an alias you have to
270 # escape them by means of a backslash (\), this can lead to conflicts with the
271 # commands \{ and \} for these it is advised to use the version @{ and @} or use
272 # a double escape (\\{ and \\})
275 # Clip alias inserts the specified file between two text markers.
276 # EG: @clip{"button.h",public,private}
277 # Shows all lines between public and private *inclusive*.
278 ALIASES += clip{3}="\dontinclude \1 \n \skip \2 \n \until \3"
280 # <DALi Doxygen Tagging Rule>
282 # Use @SINCE_1_0, @SINCE_1_1, ... instead of @since,
283 # and use @DEPRECATED_1_0, @DEPRECATED_1_1, ... instead of @deprecated.
284 # It enables integrated management of version tagging between
285 # the open source DALi API reference and Tizen API reference.
286 # Using those tags with different ALIASES settings in each doxygen config file allows us
287 # to generate two versions of "Since" and "Deprecated" generated output
288 # from one set of public header files.
290 # If you need a newer version number like @SINCE_1_5 or @SINCE_2_0, just add new ALIASES for it.
292 # ##################################################3
293 # # Guide for Open Source DALi API Reference
295 # ### @SINCE example:
296 # [some-public-header.h]
301 # void SomeFunction();
303 # [generated html file]
304 # void SomeFunction()
309 # ### @DEPRECATED example 1:
310 # [some-public-header.h]
312 # * @DEPRECATED_1_0.3
315 # void SomeFunction();
317 # [generated html file]
318 # void SomeFunction()
320 # Deprecated since 1.0.3
323 # ### @DEPRECATED example 2:
324 # [some-public-header.h]
327 # * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
330 # void SomeFunction();
332 # [generated html file]
333 # void SomeFunction()
335 # Deprecated since 1.0.3. Use SomeFunction2() instead.
338 # ##################################################3
339 # # Guide for Tizen Native API Reference
341 # ### @SINCE example:
342 # [some-public-header.h]
347 # void SomeFunction();
349 # [generated html file]
350 # void SomeFunction()
353 # 2.4, DALi Version 1.0.1
355 # ### @DEPRECATED example 1:
356 # [some-public-header.h]
358 # * @DEPRECATED_1_0.3
361 # void SomeFunction();
363 # [generated html file]
364 # void SomeFunction()
366 # Deprecated since 3.0, DALi version 1.0.3
369 # ### @DEPRECATED example 2:
370 # [some-public-header.h]
373 # * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
376 # void SomeFunction();
378 # [generated html file]
379 # void SomeFunction()
381 # Deprecated since 3.0, DALi version 1.0.3. Use SomeFunction2() instead.
384 ###########################################
385 # For Open Source DALi API Reference
386 ALIASES += SINCE_1_0="@since 1.0"
387 ALIASES += SINCE_1_1="@since 1.1"
388 ALIASES += SINCE_1_2="@since 1.2"
389 ALIASES += SINCE_1_3="@since 1.3"
390 ALIASES += SINCE_1_4="@since 1.4"
391 ALIASES += SINCE_1_9="@since 1.9"
392 ALIASES += SINCE_2_0="@since 2.0"
393 ALIASES += SINCE_2_1="@since 2.1"
394 ALIASES += SINCE_2_2="@since 2.2"
396 # Extra tags for Tizen 3.0
397 ALIASES += SINCE_1_2_2="@since 1.2.2"
398 ALIASES += SINCE_1_2_4="@since 1.2.4"
399 ALIASES += SINCE_1_2_5="@since 1.2.5"
400 ALIASES += SINCE_1_2_10="@since 1.2.10"
401 ALIASES += SINCE_1_2_14="@since 1.2.14"
402 ALIASES += SINCE_1_2_32="@since 1.2.32"
404 # Extra tags for Tizen 4.0
405 ALIASES += SINCE_1_3_4="@since 1.3.4"
406 ALIASES += SINCE_1_3_5="@since 1.3.5"
407 ALIASES += SINCE_1_3_9="@since 1.3.9"
408 ALIASES += SINCE_1_3_15="@since 1.3.15"
410 #Extra tags for Tizen 5.5
411 ALIASES += SINCE_1_3_31="@since 1.3.31"
413 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
414 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
415 ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 1.2.8"
416 ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 1.2.10"
417 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"
418 ALIASES += DEPRECATED_1_3="@deprecated Deprecated since 1.3"
419 ALIASES += DEPRECATED_1_3_39="@deprecated Deprecated since 1.3.39"
420 ALIASES += DEPRECATED_1_3_51="@deprecated Deprecated since 1.3.51"
421 ALIASES += DEPRECATED_1_4="@deprecated Deprecated since 1.4"
422 ALIASES += DEPRECATED_2_0="@deprecated Deprecated since 2.0"
423 ALIASES += DEPRECATED_2_1="@deprecated Deprecated since 2.1"
424 ALIASES += DEPRECATED_2_2="@deprecated Deprecated since 2.2"
426 ALIASES += PLATFORM=""
427 ALIASES += PRIVLEVEL_PLATFORM=""
428 ALIASES += PRIVLEVEL_PUBLIC=""
429 ALIASES += PRIVILEGE_KEYGRAB=""
430 ALIASES += PRIVILEGE_DISPLAY=""
431 ALIASES += PRIVILEGE_WINDOW_PRIORITY=""
432 ALIASES += REMARK_INTERNET=""
433 ALIASES += REMARK_STORAGE=""
434 ALIASES += REMARK_RAWVIDEO=""
436 ############################################
437 ## For Tizen Native API Reference
438 #ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0"
439 #ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1"
440 #ALIASES += SINCE_1_2="\par Since:\n 4.0, DALi version 1.2"
441 #ALIASES += SINCE_1_3="\par Since:\n 5.0, DALi version 1.3"
442 #ALIASES += SINCE_1_4="\par Since:\n 5.5, DALi version 1.4"
443 #ALIASES += SINCE_1_9="\par Since:\n 6.0, DALi version 1.9"
444 #ALIASES += SINCE_2_0="\par Since:\n 6.5, DALi version 2.0"
445 #ALIASES += SINCE_2_1="\par Since:\n 7.0, DALi version 2.1"
446 #ALIASES += SINCE_2_2="\par Since:\n 7.5, DALi version 2.2"
448 ## Extra tags for Tizen 3.0
449 #ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2"
450 #ALIASES += SINCE_1_2_4="\par Since:\n 3.0, DALi version 1.2.4"
451 #ALIASES += SINCE_1_2_5="\par Since:\n 3.0, DALi version 1.2.5"
452 #ALIASES += SINCE_1_2_10="\par Since:\n 3.0, DALi version 1.2.10"
453 #ALIASES += SINCE_1_2_14="\par Since:\n 3.0, DALi version 1.2.14"
454 #ALIASES += SINCE_1_2_32="\par Since:\n 3.0, DALi version 1.2.32"
456 ## Extra tags for Tizen 4.0
457 #ALIASES += SINCE_1_3_4="\par Since:\n 4.0, DALi version 1.3.4"
458 #ALIASES += SINCE_1_3_5="\par Since:\n 4.0, DALi version 1.3.5"
459 #ALIASES += SINCE_1_3_9="\par Since:\n 4.0, DALi version 1.3.9"
460 #ALIASES += SINCE_1_3_15="\par Since:\n 4.0, DALi version 1.3.15"
462 #Extra tags for Tizen 5.5
463 #ALIASES += SINCE_1_3_31="\par Since:\n 5.5, DALi version 1.3.31"
465 ## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release.
466 ## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0.
467 #ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0"
468 #ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1"
469 #ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 3.0, DALi version 1.2.8"
470 #ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 3.0, DALi version 1.2.10"
471 #ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 4.0, DALi version 1.2"
472 #ALIASES += DEPRECATED_1_3="@deprecated Deprecated since 5.0, DALi version 1.3"
473 #ALIASES += DEPRECATED_1_3_39="@deprecated Deprecated since 5.5, DALi version 1.3.39"
474 #ALIASES += DEPRECATED_1_3_51="@deprecated Deprecated since 5.5, DALi version 1.3.51"
475 #ALIASES += DEPRECATED_1_4="@deprecated Deprecated since 5.5, DALi version 1.4"
476 #ALIASES += DEPRECATED_2_0="@deprecated Deprecated since 6.5, DALi version 2.0"
477 #ALIASES += DEPRECATED_2_1="@deprecated Deprecated since 7.0, DALi version 2.1"
478 #ALIASES += DEPRECATED_2_2="@deprecated Deprecated since 7.5, DALi version 2.2"
480 #ALIASES += PLATFORM="@platform"
481 #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform"
482 #ALIASES += PRIVLEVEL_PUBLIC="\par Privilege Level:\n public"
483 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
484 #ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
485 #ALIASES += PRIVILEGE_WINDOW_PRIORITY="\par Privilege:\n http://tizen.org/privilege/window.priority.set"
486 #ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."
487 #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."
488 #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."
490 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
491 # only. Doxygen will then generate output that is more tailored for C. For
492 # instance, some of the names that are used will be different. The list of all
493 # members will be omitted, etc.
494 # The default value is: NO.
496 OPTIMIZE_OUTPUT_FOR_C = NO
498 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
499 # Python sources only. Doxygen will then generate output that is more tailored
500 # for that language. For instance, namespaces will be presented as packages,
501 # qualified scopes will look different, etc.
502 # The default value is: NO.
504 OPTIMIZE_OUTPUT_JAVA = NO
506 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
507 # sources. Doxygen will then generate output that is tailored for Fortran.
508 # The default value is: NO.
510 OPTIMIZE_FOR_FORTRAN = NO
512 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
513 # sources. Doxygen will then generate output that is tailored for VHDL.
514 # The default value is: NO.
516 OPTIMIZE_OUTPUT_VHDL = NO
518 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
519 # sources only. Doxygen will then generate output that is more tailored for that
520 # language. For instance, namespaces will be presented as modules, types will be
521 # separated into more groups, etc.
522 # The default value is: NO.
524 OPTIMIZE_OUTPUT_SLICE = NO
526 # Doxygen selects the parser to use depending on the extension of the files it
527 # parses. With this tag you can assign which parser to use for a given
528 # extension. Doxygen has a built-in mapping, but you can override or extend it
529 # using this tag. The format is ext=language, where ext is a file extension, and
530 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
531 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
532 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
533 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
534 # tries to guess whether the code is fixed or free formatted code, this is the
535 # default for Fortran type files). For instance to make doxygen treat .inc files
536 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
537 # use: inc=Fortran f=C.
539 # Note: For files without extension you can use no_extension as a placeholder.
541 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
542 # the files are not read by doxygen. When specifying no_extension you should add
543 # * to the FILE_PATTERNS.
545 # Note see also the list of default file extension mappings.
549 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
550 # according to the Markdown format, which allows for more readable
551 # documentation. See https://daringfireball.net/projects/markdown/ for details.
552 # The output of markdown processing is further processed by doxygen, so you can
553 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
554 # case of backward compatibilities issues.
555 # The default value is: YES.
557 MARKDOWN_SUPPORT = YES
559 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
560 # to that level are automatically included in the table of contents, even if
561 # they do not have an id attribute.
562 # Note: This feature currently applies only to Markdown headings.
563 # Minimum value: 0, maximum value: 99, default value: 5.
564 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
566 TOC_INCLUDE_HEADINGS = 5
568 # When enabled doxygen tries to link words that correspond to documented
569 # classes, or namespaces to their corresponding documentation. Such a link can
570 # be prevented in individual cases by putting a % sign in front of the word or
571 # globally by setting AUTOLINK_SUPPORT to NO.
572 # The default value is: YES.
574 AUTOLINK_SUPPORT = YES
576 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
577 # to include (a tag file for) the STL sources as input, then you should set this
578 # tag to YES in order to let doxygen match functions declarations and
579 # definitions whose arguments contain STL classes (e.g. func(std::string);
580 # versus func(std::string) {}). This also make the inheritance and collaboration
581 # diagrams that involve STL classes more complete and accurate.
582 # The default value is: NO.
584 BUILTIN_STL_SUPPORT = YES
586 # If you use Microsoft's C++/CLI language, you should set this option to YES to
587 # enable parsing support.
588 # The default value is: NO.
592 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
593 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
594 # will parse them like normal C++ but will assume all classes use public instead
595 # of private inheritance when no explicit protection keyword is present.
596 # The default value is: NO.
600 # For Microsoft's IDL there are propget and propput attributes to indicate
601 # getter and setter methods for a property. Setting this option to YES will make
602 # doxygen to replace the get and set methods by a property in the documentation.
603 # This will only work if the methods are indeed getting or setting a simple
604 # type. If this is not the case, or you want to show the methods anyway, you
605 # should set this option to NO.
606 # The default value is: YES.
608 IDL_PROPERTY_SUPPORT = YES
610 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
611 # tag is set to YES then doxygen will reuse the documentation of the first
612 # member in the group (if any) for the other members of the group. By default
613 # all members of a group must be documented explicitly.
614 # The default value is: NO.
616 DISTRIBUTE_GROUP_DOC = NO
618 # If one adds a struct or class to a group and this option is enabled, then also
619 # any nested class or struct is added to the same group. By default this option
620 # is disabled and one has to add nested compounds explicitly via \ingroup.
621 # The default value is: NO.
623 GROUP_NESTED_COMPOUNDS = NO
625 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
626 # (for instance a group of public functions) to be put as a subgroup of that
627 # type (e.g. under the Public Functions section). Set it to NO to prevent
628 # subgrouping. Alternatively, this can be done per class using the
629 # \nosubgrouping command.
630 # The default value is: YES.
634 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
635 # are shown inside the group in which they are included (e.g. using \ingroup)
636 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
639 # Note that this feature does not work in combination with
640 # SEPARATE_MEMBER_PAGES.
641 # The default value is: NO.
643 INLINE_GROUPED_CLASSES = NO
645 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
646 # with only public data fields or simple typedef fields will be shown inline in
647 # the documentation of the scope in which they are defined (i.e. file,
648 # namespace, or group documentation), provided this scope is documented. If set
649 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
650 # Man pages) or section (for LaTeX and RTF).
651 # The default value is: NO.
653 INLINE_SIMPLE_STRUCTS = NO
655 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
656 # enum is documented as struct, union, or enum with the name of the typedef. So
657 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
658 # with name TypeT. When disabled the typedef will appear as a member of a file,
659 # namespace, or class. And the struct will be named TypeS. This can typically be
660 # useful for C code in case the coding convention dictates that all compound
661 # types are typedef'ed and only the typedef is referenced, never the tag name.
662 # The default value is: NO.
664 TYPEDEF_HIDES_STRUCT = NO
666 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
667 # cache is used to resolve symbols given their name and scope. Since this can be
668 # an expensive process and often the same symbol appears multiple times in the
669 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
670 # doxygen will become slower. If the cache is too large, memory is wasted. The
671 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
672 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
673 # symbols. At the end of a run doxygen will report the cache usage and suggest
674 # the optimal cache size from a speed point of view.
675 # Minimum value: 0, maximum value: 9, default value: 0.
677 LOOKUP_CACHE_SIZE = 0
679 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
680 # during processing. When set to 0 doxygen will based this on the number of
681 # cores available in the system. You can set it explicitly to a value larger
682 # than 0 to get more control over the balance between CPU load and processing
683 # speed. At this moment only the input processing can be done using multiple
684 # threads. Since this is still an experimental feature the default is set to 1,
685 # which efficively disables parallel processing. Please report any issues you
686 # encounter. Generating dot graphs in parallel is controlled by the
687 # DOT_NUM_THREADS setting.
688 # Minimum value: 0, maximum value: 32, default value: 1.
690 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ NUM_PROC_THREADS = 1
692 #---------------------------------------------------------------------------
693 # Build related configuration options
694 #---------------------------------------------------------------------------
696 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
697 # documentation are documented, even if no documentation was available. Private
698 # class members and static file members will be hidden unless the
699 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
700 # Note: This will also disable the warnings about undocumented members that are
701 # normally produced when WARNINGS is set to YES.
702 # The default value is: NO.
706 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
707 # be included in the documentation.
708 # The default value is: NO.
710 EXTRACT_PRIVATE = YES
712 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
713 # methods of a class will be included in the documentation.
714 # The default value is: NO.
716 EXTRACT_PRIV_VIRTUAL = NO
718 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
719 # scope will be included in the documentation.
720 # The default value is: NO.
724 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
725 # included in the documentation.
726 # The default value is: NO.
730 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
731 # locally in source files will be included in the documentation. If set to NO,
732 # only classes defined in header files are included. Does not have any effect
734 # The default value is: YES.
736 EXTRACT_LOCAL_CLASSES = YES
738 # This flag is only useful for Objective-C code. If set to YES, local methods,
739 # which are defined in the implementation section but not in the interface are
740 # included in the documentation. If set to NO, only methods in the interface are
742 # The default value is: NO.
744 EXTRACT_LOCAL_METHODS = NO
746 # If this flag is set to YES, the members of anonymous namespaces will be
747 # extracted and appear in the documentation as a namespace called
748 # 'anonymous_namespace{file}', where file will be replaced with the base name of
749 # the file that contains the anonymous namespace. By default anonymous namespace
751 # The default value is: NO.
753 EXTRACT_ANON_NSPACES = NO
755 # If this flag is set to YES, the name of an unnamed parameter in a declaration
756 # will be determined by the corresponding definition. By default unnamed
757 # parameters remain unnamed in the output.
758 # The default value is: YES.
760 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ RESOLVE_UNNAMED_PARAMS = YES
762 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
763 # undocumented members inside documented classes or files. If set to NO these
764 # members will be included in the various overviews, but no documentation
765 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
766 # The default value is: NO.
768 HIDE_UNDOC_MEMBERS = NO
770 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
771 # undocumented classes that are normally visible in the class hierarchy. If set
772 # to NO, these classes will be included in the various overviews. This option
773 # has no effect if EXTRACT_ALL is enabled.
774 # The default value is: NO.
776 HIDE_UNDOC_CLASSES = NO
778 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
779 # declarations. If set to NO, these declarations will be included in the
781 # The default value is: NO.
783 HIDE_FRIEND_COMPOUNDS = NO
785 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
786 # documentation blocks found inside the body of a function. If set to NO, these
787 # blocks will be appended to the function's detailed documentation block.
788 # The default value is: NO.
790 HIDE_IN_BODY_DOCS = NO
792 # The INTERNAL_DOCS tag determines if documentation that is typed after a
793 # \internal command is included. If the tag is set to NO then the documentation
794 # will be excluded. Set it to YES to include the internal documentation.
795 # The default value is: NO.
799 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
800 # able to match the capabilities of the underlying filesystem. In case the
801 # filesystem is case sensitive (i.e. it supports files in the same directory
802 # whose names only differ in casing), the option must be set to YES to properly
803 # deal with such files in case they appear in the input. For filesystems that
804 # are not case sensitive the option should be be set to NO to properly deal with
805 # output files written for symbols that only differ in casing, such as for two
806 # classes, one named CLASS and the other named Class, and to also support
807 # references to files without having to specify the exact matching casing. On
808 # Windows (including Cygwin) and MacOS, users should typically set this option
809 # to NO, whereas on Linux or other Unix flavors it should typically be set to
811 # The default value is: system dependent.
813 CASE_SENSE_NAMES = NO
815 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
816 # their full class and namespace scopes in the documentation. If set to YES, the
817 # scope will be hidden.
818 # The default value is: NO.
820 HIDE_SCOPE_NAMES = NO
822 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
823 # append additional text to a page's title, such as Class Reference. If set to
824 # YES the compound reference will be hidden.
825 # The default value is: NO.
827 HIDE_COMPOUND_REFERENCE= NO
829 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
830 # the files that are included by a file in the documentation of that file.
831 # The default value is: YES.
833 SHOW_INCLUDE_FILES = YES
835 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
836 # grouped member an include statement to the documentation, telling the reader
837 # which file to include in order to use the member.
838 # The default value is: NO.
840 SHOW_GROUPED_MEMB_INC = NO
842 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
843 # files with double quotes in the documentation rather than with sharp brackets.
844 # The default value is: NO.
846 FORCE_LOCAL_INCLUDES = NO
848 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
849 # documentation for inline members.
850 # The default value is: YES.
854 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
855 # (detailed) documentation of file and class members alphabetically by member
856 # name. If set to NO, the members will appear in declaration order.
857 # The default value is: YES.
859 SORT_MEMBER_DOCS = YES
861 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
862 # descriptions of file, namespace and class members alphabetically by member
863 # name. If set to NO, the members will appear in declaration order. Note that
864 # this will also influence the order of the classes in the class list.
865 # The default value is: NO.
869 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
870 # (brief and detailed) documentation of class members so that constructors and
871 # destructors are listed first. If set to NO the constructors will appear in the
872 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
873 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
874 # member documentation.
875 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
876 # detailed member documentation.
877 # The default value is: NO.
879 SORT_MEMBERS_CTORS_1ST = NO
881 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
882 # of group names into alphabetical order. If set to NO the group names will
883 # appear in their defined order.
884 # The default value is: NO.
886 SORT_GROUP_NAMES = NO
888 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
889 # fully-qualified names, including namespaces. If set to NO, the class list will
890 # be sorted only by class name, not including the namespace part.
891 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
892 # Note: This option applies only to the class list, not to the alphabetical
894 # The default value is: NO.
896 SORT_BY_SCOPE_NAME = NO
898 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
899 # type resolution of all parameters of a function it will reject a match between
900 # the prototype and the implementation of a member function even if there is
901 # only one candidate or it is obvious which candidate to choose by doing a
902 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
903 # accept a match between prototype and implementation in such cases.
904 # The default value is: NO.
906 STRICT_PROTO_MATCHING = NO
908 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
909 # list. This list is created by putting \todo commands in the documentation.
910 # The default value is: YES.
912 GENERATE_TODOLIST = NO
914 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
915 # list. This list is created by putting \test commands in the documentation.
916 # The default value is: YES.
918 GENERATE_TESTLIST = NO
920 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
921 # list. This list is created by putting \bug commands in the documentation.
922 # The default value is: YES.
924 GENERATE_BUGLIST = NO
926 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
927 # the deprecated list. This list is created by putting \deprecated commands in
929 # The default value is: YES.
931 GENERATE_DEPRECATEDLIST= YES
933 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
934 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
935 # ... \endcond blocks.
937 ENABLED_SECTIONS = show_tizen_feature
939 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
940 # initial value of a variable or macro / define can have for it to appear in the
941 # documentation. If the initializer consists of more lines than specified here
942 # it will be hidden. Use a value of 0 to hide initializers completely. The
943 # appearance of the value of individual variables and macros / defines can be
944 # controlled using \showinitializer or \hideinitializer command in the
945 # documentation regardless of this setting.
946 # Minimum value: 0, maximum value: 10000, default value: 30.
948 MAX_INITIALIZER_LINES = 30
950 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
951 # the bottom of the documentation of classes and structs. If set to YES, the
952 # list will mention the files that were used to generate the documentation.
953 # The default value is: YES.
955 SHOW_USED_FILES = YES
957 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
958 # will remove the Files entry from the Quick Index and from the Folder Tree View
960 # The default value is: YES.
964 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
965 # page. This will remove the Namespaces entry from the Quick Index and from the
966 # Folder Tree View (if specified).
967 # The default value is: YES.
969 SHOW_NAMESPACES = YES
971 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
972 # doxygen should invoke to get the current version for each file (typically from
973 # the version control system). Doxygen will invoke the program by executing (via
974 # popen()) the command command input-file, where command is the value of the
975 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
976 # by doxygen. Whatever the program writes to standard output is used as the file
977 # version. For an example see the documentation.
979 FILE_VERSION_FILTER =
981 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
982 # by doxygen. The layout file controls the global structure of the generated
983 # output files in an output format independent way. To create the layout file
984 # that represents doxygen's defaults, run doxygen with the -l option. You can
985 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
986 # will be used as the name of the layout file.
988 # Note that if you run doxygen from a directory containing a file called
989 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
992 LAYOUT_FILE = @DOXYGEN_DOCS_DIR@/DaliLayout.xml
994 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
995 # the reference definitions. This must be a list of .bib files. The .bib
996 # extension is automatically appended if omitted. This requires the bibtex tool
997 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
998 # For LaTeX the style of the bibliography can be controlled using
999 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
1000 # search path. See also \cite for info how to create references.
1004 #---------------------------------------------------------------------------
1005 # Configuration options related to warning and progress messages
1006 #---------------------------------------------------------------------------
1008 # The QUIET tag can be used to turn on/off the messages that are generated to
1009 # standard output by doxygen. If QUIET is set to YES this implies that the
1011 # The default value is: NO.
1015 # The WARNINGS tag can be used to turn on/off the warning messages that are
1016 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
1017 # this implies that the warnings are on.
1019 # Tip: Turn warnings on while writing the documentation.
1020 # The default value is: YES.
1024 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
1025 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
1026 # will automatically be disabled.
1027 # The default value is: YES.
1029 WARN_IF_UNDOCUMENTED = YES
1031 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
1032 # potential errors in the documentation, such as not documenting some parameters
1033 # in a documented function, or documenting parameters that don't exist or using
1034 # markup commands wrongly.
1035 # The default value is: YES.
1037 WARN_IF_DOC_ERROR = YES
1039 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
1040 # are documented, but have no documentation for their parameters or return
1041 # value. If set to NO, doxygen will only warn about wrong or incomplete
1042 # parameter documentation, but not about the absence of documentation. If
1043 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
1044 # The default value is: NO.
1046 WARN_NO_PARAMDOC = YES
1048 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
1049 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
1050 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
1051 # at the end of the doxygen process doxygen will return with a non-zero status.
1052 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
1053 # The default value is: NO.
1057 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
1058 # can produce. The string should contain the $file, $line, and $text tags, which
1059 # will be replaced by the file and line number from which the warning originated
1060 # and the warning text. Optionally the format may contain $version, which will
1061 # be replaced by the version of the file (if it could be obtained via
1062 # FILE_VERSION_FILTER)
1063 # The default value is: $file:$line: $text.
1065 WARN_FORMAT = "$file:$line: $text"
1067 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
1068 # messages should be written. If left blank the output is written to standard
1071 WARN_LOGFILE = doxygen-errors.txt
1073 #---------------------------------------------------------------------------
1074 # Configuration options related to the input files
1075 #---------------------------------------------------------------------------
1077 # The INPUT tag is used to specify the files and/or directories that contain
1078 # documented source files. You may enter file names like myfile.cpp or
1079 # directories like /usr/src/myproject. Separate the files or directories with
1080 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
1081 # Note: If this tag is empty the current directory is searched.
1083 INPUT = @DOXYGEN_DOCS_DIR@/content \
1084 @prefix@/include/dali/doc/dali-core-doc.h \
1085 @prefix@/include/dali/doc/dali-adaptor-doc.h \
1086 ../../../doc/dali-toolkit-doc.h \
1087 @prefix@/include/dali/public-api \
1088 @prefix@/include/dali/devel-api \
1089 ../../../dali-toolkit/public-api \
1090 ../../../dali-toolkit/devel-api \
1091 ../../../dali-scene3d/public-api \
1092 ../../../automated-tests/README.md
1094 # This tag can be used to specify the character encoding of the source files
1095 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1096 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1097 # documentation (see:
1098 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
1099 # The default value is: UTF-8.
1101 INPUT_ENCODING = UTF-8
1103 # If the value of the INPUT tag contains directories, you can use the
1104 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1105 # *.h) to filter out the source-files in the directories.
1107 # Note that for custom extensions or not directly supported extensions you also
1108 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1111 # Note the list of default checked file patterns might differ from the list of
1112 # default file extension mappings.
1114 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
1115 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
1116 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
1117 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
1118 # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
1119 # *.ucf, *.qsf and *.ice.
1121 FILE_PATTERNS = *.h \
1124 # The RECURSIVE tag can be used to specify whether or not subdirectories should
1125 # be searched for input files as well.
1126 # The default value is: NO.
1130 # The EXCLUDE tag can be used to specify files and/or directories that should be
1131 # excluded from the INPUT source files. This way you can easily exclude a
1132 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1134 # Note that relative paths are relative to the directory from which doxygen is
1137 EXCLUDE = dali/integration-api
1139 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1140 # directories that are symbolic links (a Unix file system feature) are excluded
1142 # The default value is: NO.
1144 EXCLUDE_SYMLINKS = NO
1146 # If the value of the INPUT tag contains directories, you can use the
1147 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1148 # certain files from those directories.
1150 # Note that the wildcards are matched against the file with absolute path, so to
1151 # exclude all test directories for example use the pattern */test/*
1155 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1156 # (namespaces, classes, functions, etc.) that should be excluded from the
1157 # output. The symbol name can be a fully qualified name, a word, or if the
1158 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1159 # AClass::ANamespace, ANamespace::*Test
1161 # Note that the wildcards are matched against the file with absolute path, so to
1162 # exclude all test directories use the pattern */test/*
1164 EXCLUDE_SYMBOLS = DaliInternal \
1170 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1171 # that contain example code fragments that are included (see the \include
1174 EXAMPLE_PATH = @DOXYGEN_DOCS_DIR@/../
1176 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1177 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1178 # *.h) to filter out the source-files in the directories. If left blank all
1179 # files are included.
1181 EXAMPLE_PATTERNS = *
1183 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1184 # searched for input files to be used with the \include or \dontinclude commands
1185 # irrespective of the value of the RECURSIVE tag.
1186 # The default value is: NO.
1188 EXAMPLE_RECURSIVE = YES
1190 # The IMAGE_PATH tag can be used to specify one or more files or directories
1191 # that contain images that are to be included in the documentation (see the
1194 IMAGE_PATH = @DOXYGEN_DOCS_DIR@/content/images
1196 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1197 # invoke to filter for each input file. Doxygen will invoke the filter program
1198 # by executing (via popen()) the command:
1200 # <filter> <input-file>
1202 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1203 # name of an input file. Doxygen will then use the output that the filter
1204 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1207 # Note that the filter must not add or remove lines; it is applied before the
1208 # code is scanned, but not when the output code is generated. If lines are added
1209 # or removed, the anchors will not be placed correctly.
1211 # Note that for custom extensions or not directly supported extensions you also
1212 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1213 # properly processed by doxygen.
1217 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1218 # basis. Doxygen will compare the file name with each pattern and apply the
1219 # filter if there is a match. The filters are a list of the form: pattern=filter
1220 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1221 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1222 # patterns match the file name, INPUT_FILTER is applied.
1224 # Note that for custom extensions or not directly supported extensions you also
1225 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1226 # properly processed by doxygen.
1230 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1231 # INPUT_FILTER) will also be used to filter the input files that are used for
1232 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1233 # The default value is: NO.
1235 FILTER_SOURCE_FILES = NO
1237 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1238 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1239 # it is also possible to disable source filtering for a specific pattern using
1240 # *.ext= (so without naming a filter).
1241 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1243 FILTER_SOURCE_PATTERNS =
1245 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1246 # is part of the input, its contents will be placed on the main page
1247 # (index.html). This can be useful if you have a project on for instance GitHub
1248 # and want to reuse the introduction page also for the doxygen output.
1250 USE_MDFILE_AS_MAINPAGE = main.md
1252 #---------------------------------------------------------------------------
1253 # Configuration options related to source browsing
1254 #---------------------------------------------------------------------------
1256 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1257 # generated. Documented entities will be cross-referenced with these sources.
1259 # Note: To get rid of all source code in the generated output, make sure that
1260 # also VERBATIM_HEADERS is set to NO.
1261 # The default value is: NO.
1263 SOURCE_BROWSER = YES
1265 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1266 # classes and enums directly into the documentation.
1267 # The default value is: NO.
1271 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1272 # special comment blocks from generated source code fragments. Normal C, C++ and
1273 # Fortran comments will always remain visible.
1274 # The default value is: YES.
1276 STRIP_CODE_COMMENTS = NO
1278 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1279 # entity all documented functions referencing it will be listed.
1280 # The default value is: NO.
1282 REFERENCED_BY_RELATION = NO
1284 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1285 # all documented entities called/used by that function will be listed.
1286 # The default value is: NO.
1288 REFERENCES_RELATION = NO
1290 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1291 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1292 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1293 # link to the documentation.
1294 # The default value is: YES.
1296 REFERENCES_LINK_SOURCE = YES
1298 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1299 # source code will show a tooltip with additional information such as prototype,
1300 # brief description and links to the definition and documentation. Since this
1301 # will make the HTML file larger and loading of large files a bit slower, you
1302 # can opt to disable this feature.
1303 # The default value is: YES.
1304 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1306 SOURCE_TOOLTIPS = YES
1308 # If the USE_HTAGS tag is set to YES then the references to source code will
1309 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1310 # source browser. The htags tool is part of GNU's global source tagging system
1311 # (see https://www.gnu.org/software/global/global.html). You will need version
1314 # To use it do the following:
1315 # - Install the latest version of global
1316 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1317 # - Make sure the INPUT points to the root of the source tree
1318 # - Run doxygen as normal
1320 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1321 # tools must be available from the command line (i.e. in the search path).
1323 # The result: instead of the source browser generated by doxygen, the links to
1324 # source code will now point to the output of htags.
1325 # The default value is: NO.
1326 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1330 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1331 # verbatim copy of the header file for each class for which an include is
1332 # specified. Set to NO to disable this.
1333 # See also: Section \class.
1334 # The default value is: YES.
1336 VERBATIM_HEADERS = YES
1338 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1339 # clang parser (see:
1340 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1341 # performance. This can be particularly helpful with template rich C++ code for
1342 # which doxygen's built-in parser lacks the necessary type information.
1343 # Note: The availability of this option depends on whether or not doxygen was
1344 # generated with the -Duse_libclang=ON option for CMake.
1345 # The default value is: NO.
1347 CLANG_ASSISTED_PARSING = NO
1349 # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
1350 # YES then doxygen will add the directory of each input to the include path.
1351 # The default value is: YES.
1353 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ CLANG_ADD_INC_PATHS = YES
1355 # If clang assisted parsing is enabled you can provide the compiler with command
1356 # line options that you would normally use when invoking the compiler. Note that
1357 # the include paths will already be set by doxygen for the files and directories
1358 # specified with INPUT and INCLUDE_PATH.
1359 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1363 # If clang assisted parsing is enabled you can provide the clang parser with the
1364 # path to the directory containing a file called compile_commands.json. This
1365 # file is the compilation database (see:
1366 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1367 # options used when the source files were built. This is equivalent to
1368 # specifying the -p option to a clang tool, such as clang-check. These options
1369 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1370 # will be added as well.
1371 # Note: The availability of this option depends on whether or not doxygen was
1372 # generated with the -Duse_libclang=ON option for CMake.
1374 CLANG_DATABASE_PATH =
1376 #---------------------------------------------------------------------------
1377 # Configuration options related to the alphabetical class index
1378 #---------------------------------------------------------------------------
1380 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1381 # compounds will be generated. Enable this if the project contains a lot of
1382 # classes, structs, unions or interfaces.
1383 # The default value is: YES.
1385 ALPHABETICAL_INDEX = NO
1387 # In case all classes in a project start with a common prefix, all classes will
1388 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1389 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1390 # while generating the index headers.
1391 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1395 #---------------------------------------------------------------------------
1396 # Configuration options related to the HTML output
1397 #---------------------------------------------------------------------------
1399 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1400 # The default value is: YES.
1404 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1405 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1407 # The default directory is: html.
1408 # This tag requires that the tag GENERATE_HTML is set to YES.
1412 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1413 # generated HTML page (for example: .htm, .php, .asp).
1414 # The default value is: .html.
1415 # This tag requires that the tag GENERATE_HTML is set to YES.
1417 HTML_FILE_EXTENSION = .html
1419 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1420 # each generated HTML page. If the tag is left blank doxygen will generate a
1423 # To get valid HTML the header file that includes any scripts and style sheets
1424 # that doxygen needs, which is dependent on the configuration options used (e.g.
1425 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1426 # default header using
1427 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1429 # and then modify the file new_header.html. See also section "Doxygen usage"
1430 # for information on how to generate the default header that doxygen normally
1432 # Note: The header is subject to change so you typically have to regenerate the
1433 # default header when upgrading to a newer version of doxygen. For a description
1434 # of the possible markers and block names see the documentation.
1435 # This tag requires that the tag GENERATE_HTML is set to YES.
1439 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1440 # generated HTML page. If the tag is left blank doxygen will generate a standard
1441 # footer. See HTML_HEADER for more information on how to generate a default
1442 # footer and what special commands can be used inside the footer. See also
1443 # section "Doxygen usage" for information on how to generate the default footer
1444 # that doxygen normally uses.
1445 # This tag requires that the tag GENERATE_HTML is set to YES.
1449 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1450 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1451 # the HTML output. If left blank doxygen will generate a default style sheet.
1452 # See also section "Doxygen usage" for information on how to generate the style
1453 # sheet that doxygen normally uses.
1454 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1455 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1457 # This tag requires that the tag GENERATE_HTML is set to YES.
1461 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1462 # cascading style sheets that are included after the standard style sheets
1463 # created by doxygen. Using this option one can overrule certain style aspects.
1464 # This is preferred over using HTML_STYLESHEET since it does not replace the
1465 # standard style sheet and is therefore more robust against future updates.
1466 # Doxygen will copy the style sheet files to the output directory.
1467 # Note: The order of the extra style sheet files is of importance (e.g. the last
1468 # style sheet in the list overrules the setting of the previous ones in the
1469 # list). For an example see the documentation.
1470 # This tag requires that the tag GENERATE_HTML is set to YES.
1472 HTML_EXTRA_STYLESHEET = @DOXYGEN_DOCS_DIR@/dali_doxygen.css
1474 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1475 # other source files which should be copied to the HTML output directory. Note
1476 # that these files will be copied to the base HTML output directory. Use the
1477 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1478 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1479 # files will be copied as-is; there are no commands or markers available.
1480 # This tag requires that the tag GENERATE_HTML is set to YES.
1484 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1485 # will adjust the colors in the style sheet and background images according to
1486 # this color. Hue is specified as an angle on a colorwheel, see
1487 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1488 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1489 # purple, and 360 is red again.
1490 # Minimum value: 0, maximum value: 359, default value: 220.
1491 # This tag requires that the tag GENERATE_HTML is set to YES.
1493 HTML_COLORSTYLE_HUE = 220
1495 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1496 # in the HTML output. For a value of 0 the output will use grayscales only. A
1497 # value of 255 will produce the most vivid colors.
1498 # Minimum value: 0, maximum value: 255, default value: 100.
1499 # This tag requires that the tag GENERATE_HTML is set to YES.
1501 HTML_COLORSTYLE_SAT = 100
1503 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1504 # luminance component of the colors in the HTML output. Values below 100
1505 # gradually make the output lighter, whereas values above 100 make the output
1506 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1507 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1509 # Minimum value: 40, maximum value: 240, default value: 80.
1510 # This tag requires that the tag GENERATE_HTML is set to YES.
1512 HTML_COLORSTYLE_GAMMA = 80
1514 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1515 # page will contain the date and time when the page was generated. Setting this
1516 # to YES can help to show when doxygen was last run and thus if the
1517 # documentation is up to date.
1518 # The default value is: NO.
1519 # This tag requires that the tag GENERATE_HTML is set to YES.
1521 HTML_TIMESTAMP = YES
1523 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1524 # documentation will contain a main index with vertical navigation menus that
1525 # are dynamically created via JavaScript. If disabled, the navigation index will
1526 # consists of multiple levels of tabs that are statically embedded in every HTML
1527 # page. Disable this option to support browsers that do not have JavaScript,
1528 # like the Qt help browser.
1529 # The default value is: YES.
1530 # This tag requires that the tag GENERATE_HTML is set to YES.
1532 HTML_DYNAMIC_MENUS = YES
1534 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1535 # documentation will contain sections that can be hidden and shown after the
1537 # The default value is: NO.
1538 # This tag requires that the tag GENERATE_HTML is set to YES.
1540 HTML_DYNAMIC_SECTIONS = NO
1542 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1543 # shown in the various tree structured indices initially; the user can expand
1544 # and collapse entries dynamically later on. Doxygen will expand the tree to
1545 # such a level that at most the specified number of entries are visible (unless
1546 # a fully collapsed tree already exceeds this amount). So setting the number of
1547 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1548 # representing an infinite number of entries and will result in a full expanded
1550 # Minimum value: 0, maximum value: 9999, default value: 100.
1551 # This tag requires that the tag GENERATE_HTML is set to YES.
1553 HTML_INDEX_NUM_ENTRIES = 100
1555 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1556 # generated that can be used as input for Apple's Xcode 3 integrated development
1558 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1559 # create a documentation set, doxygen will generate a Makefile in the HTML
1560 # output directory. Running make will produce the docset in that directory and
1561 # running make install will install the docset in
1562 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1563 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1564 # genXcode/_index.html for more information.
1565 # The default value is: NO.
1566 # This tag requires that the tag GENERATE_HTML is set to YES.
1568 GENERATE_DOCSET = NO
1570 # This tag determines the name of the docset feed. A documentation feed provides
1571 # an umbrella under which multiple documentation sets from a single provider
1572 # (such as a company or product suite) can be grouped.
1573 # The default value is: Doxygen generated docs.
1574 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1576 DOCSET_FEEDNAME = "Doxygen generated docs"
1578 # This tag specifies a string that should uniquely identify the documentation
1579 # set bundle. This should be a reverse domain-name style string, e.g.
1580 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1581 # The default value is: org.doxygen.Project.
1582 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1584 DOCSET_BUNDLE_ID = org.doxygen.Project
1586 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1587 # the documentation publisher. This should be a reverse domain-name style
1588 # string, e.g. com.mycompany.MyDocSet.documentation.
1589 # The default value is: org.doxygen.Publisher.
1590 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1592 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1594 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1595 # The default value is: Publisher.
1596 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1598 DOCSET_PUBLISHER_NAME = Publisher
1600 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1601 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1602 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1604 # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1606 # The HTML Help Workshop contains a compiler that can convert all HTML output
1607 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1608 # files are now used as the Windows 98 help format, and will replace the old
1609 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1610 # HTML files also contain an index, a table of contents, and you can search for
1611 # words in the documentation. The HTML workshop also contains a viewer for
1612 # compressed HTML files.
1613 # The default value is: NO.
1614 # This tag requires that the tag GENERATE_HTML is set to YES.
1616 GENERATE_HTMLHELP = YES
1618 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1619 # file. You can add a path in front of the file if the result should not be
1620 # written to the html output directory.
1621 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1625 # The HHC_LOCATION tag can be used to specify the location (absolute path
1626 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1627 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1628 # The file has to be specified with full path.
1629 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1633 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1634 # (YES) or that it should be included in the main .chm file (NO).
1635 # The default value is: NO.
1636 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1640 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1641 # and project file content.
1642 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1644 CHM_INDEX_ENCODING =
1646 # The BINARY_TOC flag controls whether a binary table of contents is generated
1647 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1648 # enables the Previous and Next buttons.
1649 # The default value is: NO.
1650 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1654 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1655 # the table of contents of the HTML help documentation and to the tree view.
1656 # The default value is: NO.
1657 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1661 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1662 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1663 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1664 # (.qch) of the generated HTML documentation.
1665 # The default value is: NO.
1666 # This tag requires that the tag GENERATE_HTML is set to YES.
1670 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1671 # the file name of the resulting .qch file. The path specified is relative to
1672 # the HTML output folder.
1673 # This tag requires that the tag GENERATE_QHP is set to YES.
1675 QCH_FILE = "Dali.qch"
1677 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1678 # Project output. For more information please see Qt Help Project / Namespace
1680 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1681 # The default value is: org.doxygen.Project.
1682 # This tag requires that the tag GENERATE_QHP is set to YES.
1684 QHP_NAMESPACE = "Dali"
1686 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1687 # Help Project output. For more information please see Qt Help Project / Virtual
1689 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1690 # The default value is: doc.
1691 # This tag requires that the tag GENERATE_QHP is set to YES.
1693 QHP_VIRTUAL_FOLDER = doc
1695 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1696 # filter to add. For more information please see Qt Help Project / Custom
1698 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1699 # This tag requires that the tag GENERATE_QHP is set to YES.
1701 QHP_CUST_FILTER_NAME =
1703 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1704 # custom filter to add. For more information please see Qt Help Project / Custom
1706 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1707 # This tag requires that the tag GENERATE_QHP is set to YES.
1709 QHP_CUST_FILTER_ATTRS =
1711 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1712 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1713 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1714 # This tag requires that the tag GENERATE_QHP is set to YES.
1716 QHP_SECT_FILTER_ATTRS =
1718 # The QHG_LOCATION tag can be used to specify the location (absolute path
1719 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1720 # run qhelpgenerator on the generated .qhp file.
1721 # This tag requires that the tag GENERATE_QHP is set to YES.
1725 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1726 # generated, together with the HTML files, they form an Eclipse help plugin. To
1727 # install this plugin and make it available under the help contents menu in
1728 # Eclipse, the contents of the directory containing the HTML and XML files needs
1729 # to be copied into the plugins directory of eclipse. The name of the directory
1730 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1731 # After copying Eclipse needs to be restarted before the help appears.
1732 # The default value is: NO.
1733 # This tag requires that the tag GENERATE_HTML is set to YES.
1735 GENERATE_ECLIPSEHELP = NO
1737 # A unique identifier for the Eclipse help plugin. When installing the plugin
1738 # the directory name containing the HTML and XML files should also have this
1739 # name. Each documentation set should have its own identifier.
1740 # The default value is: org.doxygen.Project.
1741 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1743 ECLIPSE_DOC_ID = org.doxygen.Project
1745 # If you want full control over the layout of the generated HTML pages it might
1746 # be necessary to disable the index and replace it with your own. The
1747 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1748 # of each HTML page. A value of NO enables the index and the value YES disables
1749 # it. Since the tabs in the index contain the same information as the navigation
1750 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1751 # The default value is: NO.
1752 # This tag requires that the tag GENERATE_HTML is set to YES.
1756 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1757 # structure should be generated to display hierarchical information. If the tag
1758 # value is set to YES, a side panel will be generated containing a tree-like
1759 # index structure (just like the one that is generated for HTML Help). For this
1760 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1761 # (i.e. any modern browser). Windows users are probably better off using the
1762 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1763 # further fine-tune the look of the index. As an example, the default style
1764 # sheet generated by doxygen has an example that shows how to put an image at
1765 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1766 # the same information as the tab index, you could consider setting
1767 # DISABLE_INDEX to YES when enabling this option.
1768 # The default value is: NO.
1769 # This tag requires that the tag GENERATE_HTML is set to YES.
1771 GENERATE_TREEVIEW = NONE
1773 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1774 # doxygen will group on one line in the generated HTML documentation.
1776 # Note that a value of 0 will completely suppress the enum values from appearing
1777 # in the overview section.
1778 # Minimum value: 0, maximum value: 20, default value: 4.
1779 # This tag requires that the tag GENERATE_HTML is set to YES.
1781 ENUM_VALUES_PER_LINE = 4
1783 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1784 # to set the initial width (in pixels) of the frame in which the tree is shown.
1785 # Minimum value: 0, maximum value: 1500, default value: 250.
1786 # This tag requires that the tag GENERATE_HTML is set to YES.
1788 TREEVIEW_WIDTH = 250
1790 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1791 # external symbols imported via tag files in a separate window.
1792 # The default value is: NO.
1793 # This tag requires that the tag GENERATE_HTML is set to YES.
1795 EXT_LINKS_IN_WINDOW = NO
1797 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1798 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1799 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1800 # the HTML output. These images will generally look nicer at scaled resolutions.
1801 # Possible values are: png (the default) and svg (looks nicer but requires the
1802 # pdf2svg or inkscape tool).
1803 # The default value is: png.
1804 # This tag requires that the tag GENERATE_HTML is set to YES.
1806 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ HTML_FORMULA_FORMAT = png
1808 # Use this tag to change the font size of LaTeX formulas included as images in
1809 # the HTML documentation. When you change the font size after a successful
1810 # doxygen run you need to manually remove any form_*.png images from the HTML
1811 # output directory to force them to be regenerated.
1812 # Minimum value: 8, maximum value: 50, default value: 10.
1813 # This tag requires that the tag GENERATE_HTML is set to YES.
1815 FORMULA_FONTSIZE = 10
1817 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1818 # generated for formulas are transparent PNGs. Transparent PNGs are not
1819 # supported properly for IE 6.0, but are supported on all modern browsers.
1821 # Note that when changing this option you need to delete any form_*.png files in
1822 # the HTML output directory before the changes have effect.
1823 # The default value is: YES.
1824 # This tag requires that the tag GENERATE_HTML is set to YES.
1826 FORMULA_TRANSPARENT = YES
1828 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1829 # to create new LaTeX commands to be used in formulas as building blocks. See
1830 # the section "Including formulas" for details.
1834 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1835 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1836 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1837 # installed or if you want to formulas look prettier in the HTML output. When
1838 # enabled you may also need to install MathJax separately and configure the path
1839 # to it using the MATHJAX_RELPATH option.
1840 # The default value is: NO.
1841 # This tag requires that the tag GENERATE_HTML is set to YES.
1845 # When MathJax is enabled you can set the default output format to be used for
1846 # the MathJax output. See the MathJax site (see:
1847 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1848 # Possible values are: HTML-CSS (which is slower, but has the best
1849 # compatibility), NativeMML (i.e. MathML) and SVG.
1850 # The default value is: HTML-CSS.
1851 # This tag requires that the tag USE_MATHJAX is set to YES.
1853 MATHJAX_FORMAT = HTML-CSS
1855 # When MathJax is enabled you need to specify the location relative to the HTML
1856 # output directory using the MATHJAX_RELPATH option. The destination directory
1857 # should contain the MathJax.js script. For instance, if the mathjax directory
1858 # is located at the same level as the HTML output directory, then
1859 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1860 # Content Delivery Network so you can quickly see the result without installing
1861 # MathJax. However, it is strongly recommended to install a local copy of
1862 # MathJax from https://www.mathjax.org before deployment.
1863 # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1864 # This tag requires that the tag USE_MATHJAX is set to YES.
1866 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1868 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1869 # extension names that should be enabled during MathJax rendering. For example
1870 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1871 # This tag requires that the tag USE_MATHJAX is set to YES.
1873 MATHJAX_EXTENSIONS =
1875 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1876 # of code that will be used on startup of the MathJax code. See the MathJax site
1878 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1879 # example see the documentation.
1880 # This tag requires that the tag USE_MATHJAX is set to YES.
1884 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1885 # the HTML output. The underlying search engine uses javascript and DHTML and
1886 # should work on any modern browser. Note that when using HTML help
1887 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1888 # there is already a search function so this one should typically be disabled.
1889 # For large projects the javascript based search engine can be slow, then
1890 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1891 # search using the keyboard; to jump to the search box use <access key> + S
1892 # (what the <access key> is depends on the OS and browser, but it is typically
1893 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1894 # key> to jump into the search results window, the results can be navigated
1895 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1896 # the search. The filter options can be selected when the cursor is inside the
1897 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1898 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1900 # The default value is: YES.
1901 # This tag requires that the tag GENERATE_HTML is set to YES.
1905 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1906 # implemented using a web server instead of a web client using JavaScript. There
1907 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1908 # setting. When disabled, doxygen will generate a PHP script for searching and
1909 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1910 # and searching needs to be provided by external tools. See the section
1911 # "External Indexing and Searching" for details.
1912 # The default value is: NO.
1913 # This tag requires that the tag SEARCHENGINE is set to YES.
1915 SERVER_BASED_SEARCH = NO
1917 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1918 # script for searching. Instead the search results are written to an XML file
1919 # which needs to be processed by an external indexer. Doxygen will invoke an
1920 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1923 # Doxygen ships with an example indexer (doxyindexer) and search engine
1924 # (doxysearch.cgi) which are based on the open source search engine library
1926 # https://xapian.org/).
1928 # See the section "External Indexing and Searching" for details.
1929 # The default value is: NO.
1930 # This tag requires that the tag SEARCHENGINE is set to YES.
1932 EXTERNAL_SEARCH = NO
1934 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1935 # which will return the search results when EXTERNAL_SEARCH is enabled.
1937 # Doxygen ships with an example indexer (doxyindexer) and search engine
1938 # (doxysearch.cgi) which are based on the open source search engine library
1940 # https://xapian.org/). See the section "External Indexing and Searching" for
1942 # This tag requires that the tag SEARCHENGINE is set to YES.
1946 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1947 # search data is written to a file for indexing by an external tool. With the
1948 # SEARCHDATA_FILE tag the name of this file can be specified.
1949 # The default file is: searchdata.xml.
1950 # This tag requires that the tag SEARCHENGINE is set to YES.
1952 SEARCHDATA_FILE = searchdata.xml
1954 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1955 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1956 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1957 # projects and redirect the results back to the right project.
1958 # This tag requires that the tag SEARCHENGINE is set to YES.
1960 EXTERNAL_SEARCH_ID =
1962 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1963 # projects other than the one defined by this configuration file, but that are
1964 # all added to the same external search index. Each project needs to have a
1965 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1966 # to a relative location where the documentation can be found. The format is:
1967 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1968 # This tag requires that the tag SEARCHENGINE is set to YES.
1970 EXTRA_SEARCH_MAPPINGS =
1972 #---------------------------------------------------------------------------
1973 # Configuration options related to the LaTeX output
1974 #---------------------------------------------------------------------------
1976 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1977 # The default value is: YES.
1981 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1982 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1984 # The default directory is: latex.
1985 # This tag requires that the tag GENERATE_LATEX is set to YES.
1987 LATEX_OUTPUT = latex
1989 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1992 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1993 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1994 # chosen this is overwritten by pdflatex. For specific output languages the
1995 # default can have been set differently, this depends on the implementation of
1996 # the output language.
1997 # This tag requires that the tag GENERATE_LATEX is set to YES.
1999 LATEX_CMD_NAME = latex
2001 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2003 # Note: This tag is used in the Makefile / make.bat.
2004 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
2006 # The default file is: makeindex.
2007 # This tag requires that the tag GENERATE_LATEX is set to YES.
2009 MAKEINDEX_CMD_NAME = makeindex
2011 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2012 # generate index for LaTeX. In case there is no backslash (\) as first character
2013 # it will be automatically added in the LaTeX code.
2014 # Note: This tag is used in the generated output file (.tex).
2015 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2016 # The default value is: makeindex.
2017 # This tag requires that the tag GENERATE_LATEX is set to YES.
2019 LATEX_MAKEINDEX_CMD = makeindex
2021 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
2022 # documents. This may be useful for small projects and may help to save some
2024 # The default value is: NO.
2025 # This tag requires that the tag GENERATE_LATEX is set to YES.
2029 # The PAPER_TYPE tag can be used to set the paper type that is used by the
2031 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
2032 # 14 inches) and executive (7.25 x 10.5 inches).
2033 # The default value is: a4.
2034 # This tag requires that the tag GENERATE_LATEX is set to YES.
2038 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2039 # that should be included in the LaTeX output. The package can be specified just
2040 # by its name or with the correct syntax as to be used with the LaTeX
2041 # \usepackage command. To get the times font for instance you can specify :
2042 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
2043 # To use the option intlimits with the amsmath package you can specify:
2044 # EXTRA_PACKAGES=[intlimits]{amsmath}
2045 # If left blank no extra packages will be included.
2046 # This tag requires that the tag GENERATE_LATEX is set to YES.
2050 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
2051 # generated LaTeX document. The header should contain everything until the first
2052 # chapter. If it is left blank doxygen will generate a standard header. See
2053 # section "Doxygen usage" for information on how to let doxygen write the
2054 # default header to a separate file.
2056 # Note: Only use a user-defined header if you know what you are doing! The
2057 # following commands have a special meaning inside the header: $title,
2058 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
2059 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
2060 # string, for the replacement values of the other commands the user is referred
2062 # This tag requires that the tag GENERATE_LATEX is set to YES.
2066 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
2067 # generated LaTeX document. The footer should contain everything after the last
2068 # chapter. If it is left blank doxygen will generate a standard footer. See
2069 # LATEX_HEADER for more information on how to generate a default footer and what
2070 # special commands can be used inside the footer.
2072 # Note: Only use a user-defined footer if you know what you are doing!
2073 # This tag requires that the tag GENERATE_LATEX is set to YES.
2077 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2078 # LaTeX style sheets that are included after the standard style sheets created
2079 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
2080 # will copy the style sheet files to the output directory.
2081 # Note: The order of the extra style sheet files is of importance (e.g. the last
2082 # style sheet in the list overrules the setting of the previous ones in the
2084 # This tag requires that the tag GENERATE_LATEX is set to YES.
2086 LATEX_EXTRA_STYLESHEET =
2088 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2089 # other source files which should be copied to the LATEX_OUTPUT output
2090 # directory. Note that the files will be copied as-is; there are no commands or
2091 # markers available.
2092 # This tag requires that the tag GENERATE_LATEX is set to YES.
2096 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2097 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2098 # contain links (just like the HTML output) instead of page references. This
2099 # makes the output suitable for online browsing using a PDF viewer.
2100 # The default value is: YES.
2101 # This tag requires that the tag GENERATE_LATEX is set to YES.
2103 PDF_HYPERLINKS = YES
2105 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2106 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2107 # files. Set this option to YES, to get a higher quality PDF documentation.
2109 # See also section LATEX_CMD_NAME for selecting the engine.
2110 # The default value is: YES.
2111 # This tag requires that the tag GENERATE_LATEX is set to YES.
2115 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2116 # command to the generated LaTeX files. This will instruct LaTeX to keep running
2117 # if errors occur, instead of asking the user for help. This option is also used
2118 # when generating formulas in HTML.
2119 # The default value is: NO.
2120 # This tag requires that the tag GENERATE_LATEX is set to YES.
2122 LATEX_BATCHMODE = NO
2124 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2125 # index chapters (such as File Index, Compound Index, etc.) in the output.
2126 # The default value is: NO.
2127 # This tag requires that the tag GENERATE_LATEX is set to YES.
2129 LATEX_HIDE_INDICES = NO
2131 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
2132 # code with syntax highlighting in the LaTeX output.
2134 # Note that which sources are shown also depends on other settings such as
2136 # The default value is: NO.
2137 # This tag requires that the tag GENERATE_LATEX is set to YES.
2139 LATEX_SOURCE_CODE = NO
2141 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2142 # bibliography, e.g. plainnat, or ieeetr. See
2143 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2144 # The default value is: plain.
2145 # This tag requires that the tag GENERATE_LATEX is set to YES.
2147 LATEX_BIB_STYLE = plain
2149 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2150 # page will contain the date and time when the page was generated. Setting this
2151 # to NO can help when comparing the output of multiple runs.
2152 # The default value is: NO.
2153 # This tag requires that the tag GENERATE_LATEX is set to YES.
2155 LATEX_TIMESTAMP = NO
2157 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2158 # path from which the emoji images will be read. If a relative path is entered,
2159 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2160 # LATEX_OUTPUT directory will be used.
2161 # This tag requires that the tag GENERATE_LATEX is set to YES.
2163 LATEX_EMOJI_DIRECTORY =
2165 #---------------------------------------------------------------------------
2166 # Configuration options related to the RTF output
2167 #---------------------------------------------------------------------------
2169 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2170 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2172 # The default value is: NO.
2176 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2177 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2179 # The default directory is: rtf.
2180 # This tag requires that the tag GENERATE_RTF is set to YES.
2184 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2185 # documents. This may be useful for small projects and may help to save some
2187 # The default value is: NO.
2188 # This tag requires that the tag GENERATE_RTF is set to YES.
2192 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2193 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2194 # output) instead of page references. This makes the output suitable for online
2195 # browsing using Word or some other Word compatible readers that support those
2198 # Note: WordPad (write) and others do not support links.
2199 # The default value is: NO.
2200 # This tag requires that the tag GENERATE_RTF is set to YES.
2204 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2205 # configuration file, i.e. a series of assignments. You only have to provide
2206 # replacements, missing definitions are set to their default value.
2208 # See also section "Doxygen usage" for information on how to generate the
2209 # default style sheet that doxygen normally uses.
2210 # This tag requires that the tag GENERATE_RTF is set to YES.
2212 RTF_STYLESHEET_FILE =
2214 # Set optional variables used in the generation of an RTF document. Syntax is
2215 # similar to doxygen's configuration file. A template extensions file can be
2216 # generated using doxygen -e rtf extensionFile.
2217 # This tag requires that the tag GENERATE_RTF is set to YES.
2219 RTF_EXTENSIONS_FILE =
2221 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
2222 # with syntax highlighting in the RTF output.
2224 # Note that which sources are shown also depends on other settings such as
2226 # The default value is: NO.
2227 # This tag requires that the tag GENERATE_RTF is set to YES.
2229 RTF_SOURCE_CODE = NO
2231 #---------------------------------------------------------------------------
2232 # Configuration options related to the man page output
2233 #---------------------------------------------------------------------------
2235 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2236 # classes and files.
2237 # The default value is: NO.
2241 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2242 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2243 # it. A directory man3 will be created inside the directory specified by
2245 # The default directory is: man.
2246 # This tag requires that the tag GENERATE_MAN is set to YES.
2250 # The MAN_EXTENSION tag determines the extension that is added to the generated
2251 # man pages. In case the manual section does not start with a number, the number
2252 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2254 # The default value is: .3.
2255 # This tag requires that the tag GENERATE_MAN is set to YES.
2259 # The MAN_SUBDIR tag determines the name of the directory created within
2260 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2261 # MAN_EXTENSION with the initial . removed.
2262 # This tag requires that the tag GENERATE_MAN is set to YES.
2266 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2267 # will generate one additional man file for each entity documented in the real
2268 # man page(s). These additional files only source the real man page, but without
2269 # them the man command would be unable to find the correct page.
2270 # The default value is: NO.
2271 # This tag requires that the tag GENERATE_MAN is set to YES.
2275 #---------------------------------------------------------------------------
2276 # Configuration options related to the XML output
2277 #---------------------------------------------------------------------------
2279 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2280 # captures the structure of the code including all documentation.
2281 # The default value is: NO.
2285 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2286 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2288 # The default directory is: xml.
2289 # This tag requires that the tag GENERATE_XML is set to YES.
2293 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2294 # listings (including syntax highlighting and cross-referencing information) to
2295 # the XML output. Note that enabling this will significantly increase the size
2296 # of the XML output.
2297 # The default value is: YES.
2298 # This tag requires that the tag GENERATE_XML is set to YES.
2300 XML_PROGRAMLISTING = YES
2302 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2303 # namespace members in file scope as well, matching the HTML output.
2304 # The default value is: NO.
2305 # This tag requires that the tag GENERATE_XML is set to YES.
2307 XML_NS_MEMB_FILE_SCOPE = NO
2309 #---------------------------------------------------------------------------
2310 # Configuration options related to the DOCBOOK output
2311 #---------------------------------------------------------------------------
2313 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2314 # that can be used to generate PDF.
2315 # The default value is: NO.
2317 GENERATE_DOCBOOK = NO
2319 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2320 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2322 # The default directory is: docbook.
2323 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2325 DOCBOOK_OUTPUT = docbook
2327 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2328 # program listings (including syntax highlighting and cross-referencing
2329 # information) to the DOCBOOK output. Note that enabling this will significantly
2330 # increase the size of the DOCBOOK output.
2331 # The default value is: NO.
2332 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2334 DOCBOOK_PROGRAMLISTING = NO
2336 #---------------------------------------------------------------------------
2337 # Configuration options for the AutoGen Definitions output
2338 #---------------------------------------------------------------------------
2340 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2341 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2342 # the structure of the code including all documentation. Note that this feature
2343 # is still experimental and incomplete at the moment.
2344 # The default value is: NO.
2346 GENERATE_AUTOGEN_DEF = NO
2348 #---------------------------------------------------------------------------
2349 # Configuration options related to the Perl module output
2350 #---------------------------------------------------------------------------
2352 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2353 # file that captures the structure of the code including all documentation.
2355 # Note that this feature is still experimental and incomplete at the moment.
2356 # The default value is: NO.
2358 GENERATE_PERLMOD = NO
2360 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2361 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2362 # output from the Perl module output.
2363 # The default value is: NO.
2364 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2368 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2369 # formatted so it can be parsed by a human reader. This is useful if you want to
2370 # understand what is going on. On the other hand, if this tag is set to NO, the
2371 # size of the Perl module output will be much smaller and Perl will parse it
2373 # The default value is: YES.
2374 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2376 PERLMOD_PRETTY = YES
2378 # The names of the make variables in the generated doxyrules.make file are
2379 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2380 # so different doxyrules.make files included by the same Makefile don't
2381 # overwrite each other's variables.
2382 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2384 PERLMOD_MAKEVAR_PREFIX =
2386 #---------------------------------------------------------------------------
2387 # Configuration options related to the preprocessor
2388 #---------------------------------------------------------------------------
2390 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2391 # C-preprocessor directives found in the sources and include files.
2392 # The default value is: YES.
2394 ENABLE_PREPROCESSING = YES
2396 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2397 # in the source code. If set to NO, only conditional compilation will be
2398 # performed. Macro expansion can be done in a controlled way by setting
2399 # EXPAND_ONLY_PREDEF to YES.
2400 # The default value is: NO.
2401 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2403 MACRO_EXPANSION = YES
2405 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2406 # the macro expansion is limited to the macros specified with the PREDEFINED and
2407 # EXPAND_AS_DEFINED tags.
2408 # The default value is: NO.
2409 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2411 EXPAND_ONLY_PREDEF = YES
2413 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2414 # INCLUDE_PATH will be searched if a #include is found.
2415 # The default value is: YES.
2416 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2418 SEARCH_INCLUDES = YES
2420 # The INCLUDE_PATH tag can be used to specify one or more directories that
2421 # contain include files that are not input files but should be processed by the
2423 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2427 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2428 # patterns (like *.h and *.hpp) to filter out the header-files in the
2429 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2431 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2433 INCLUDE_FILE_PATTERNS =
2435 # The PREDEFINED tag can be used to specify one or more macro names that are
2436 # defined before the preprocessor is started (similar to the -D option of e.g.
2437 # gcc). The argument of the tag is a list of macros of the form: name or
2438 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2439 # is assumed. To prevent a macro definition from being undefined via #undef or
2440 # recursively expanded use the := operator instead of the = operator.
2441 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2443 PREDEFINED = DALI_CORE_API \
2449 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2450 # tag can be used to specify a list of macro names that should be expanded. The
2451 # macro definition that is found in the sources will be used. Use the PREDEFINED
2452 # tag if you want to use a different macro definition that overrules the
2453 # definition found in the source code.
2454 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2458 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2459 # remove all references to function-like macros that are alone on a line, have
2460 # an all uppercase name, and do not end with a semicolon. Such function macros
2461 # are typically used for boiler-plate code, and will confuse the parser if not
2463 # The default value is: YES.
2464 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2466 SKIP_FUNCTION_MACROS = YES
2468 #---------------------------------------------------------------------------
2469 # Configuration options related to external references
2470 #---------------------------------------------------------------------------
2472 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2473 # file the location of the external documentation should be added. The format of
2474 # a tag file without this location is as follows:
2475 # TAGFILES = file1 file2 ...
2476 # Adding location for the tag files is done as follows:
2477 # TAGFILES = file1=loc1 "file2 = loc2" ...
2478 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2479 # section "Linking to external documentation" for more information about the use
2481 # Note: Each tag file must have a unique name (where the name does NOT include
2482 # the path). If a tag file is not located in the directory in which doxygen is
2483 # run, you must also specify the path to the tagfile here.
2487 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2488 # tag file that is based on the input files it reads. See section "Linking to
2489 # external documentation" for more information about the usage of tag files.
2493 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2494 # the class index. If set to NO, only the inherited external classes will be
2496 # The default value is: NO.
2500 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2501 # in the modules index. If set to NO, only the current project's groups will be
2503 # The default value is: YES.
2505 EXTERNAL_GROUPS = YES
2507 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2508 # the related pages index. If set to NO, only the current project's pages will
2510 # The default value is: YES.
2512 EXTERNAL_PAGES = YES
2514 #---------------------------------------------------------------------------
2515 # Configuration options related to the dot tool
2516 #---------------------------------------------------------------------------
2518 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2519 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2520 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2521 # disabled, but it is recommended to install and use dot, since it yields more
2523 # The default value is: YES.
2525 CLASS_DIAGRAMS = YES
2527 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2528 # then run dia to produce the diagram and insert it in the documentation. The
2529 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2530 # If left empty dia is assumed to be found in the default search path.
2534 # If set to YES the inheritance and collaboration graphs will hide inheritance
2535 # and usage relations if the target is undocumented or is not a class.
2536 # The default value is: YES.
2538 HIDE_UNDOC_RELATIONS = YES
2540 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2541 # available from the path. This tool is part of Graphviz (see:
2542 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2543 # Bell Labs. The other options in this section have no effect if this option is
2545 # The default value is: YES.
2549 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2550 # to run in parallel. When set to 0 doxygen will base this on the number of
2551 # processors available in the system. You can set it explicitly to a value
2552 # larger than 0 to get control over the balance between CPU load and processing
2554 # Minimum value: 0, maximum value: 32, default value: 0.
2555 # This tag requires that the tag HAVE_DOT is set to YES.
2559 # When you want a differently looking font in the dot files that doxygen
2560 # generates you can specify the font name using DOT_FONTNAME. You need to make
2561 # sure dot is able to find the font, which can be done by putting it in a
2562 # standard location or by setting the DOTFONTPATH environment variable or by
2563 # setting DOT_FONTPATH to the directory containing the font.
2564 # The default value is: Helvetica.
2565 # This tag requires that the tag HAVE_DOT is set to YES.
2569 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2571 # Minimum value: 4, maximum value: 24, default value: 10.
2572 # This tag requires that the tag HAVE_DOT is set to YES.
2576 # By default doxygen will tell dot to use the default font as specified with
2577 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2578 # the path where dot can find it using this tag.
2579 # This tag requires that the tag HAVE_DOT is set to YES.
2583 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2584 # each documented class showing the direct and indirect inheritance relations.
2585 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2586 # The default value is: YES.
2587 # This tag requires that the tag HAVE_DOT is set to YES.
2591 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2592 # graph for each documented class showing the direct and indirect implementation
2593 # dependencies (inheritance, containment, and class references variables) of the
2594 # class with other documented classes.
2595 # The default value is: YES.
2596 # This tag requires that the tag HAVE_DOT is set to YES.
2598 COLLABORATION_GRAPH = YES
2600 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2601 # groups, showing the direct groups dependencies.
2602 # The default value is: YES.
2603 # This tag requires that the tag HAVE_DOT is set to YES.
2607 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2608 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2610 # The default value is: NO.
2611 # This tag requires that the tag HAVE_DOT is set to YES.
2615 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2616 # class node. If there are many fields or methods and many nodes the graph may
2617 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2618 # number of items for each type to make the size more manageable. Set this to 0
2619 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2620 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2621 # but if the number exceeds 15, the total amount of fields shown is limited to
2623 # Minimum value: 0, maximum value: 100, default value: 10.
2624 # This tag requires that the tag UML_LOOK is set to YES.
2626 UML_LIMIT_NUM_FIELDS = 10
2628 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2629 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2630 # tag is set to YES, doxygen will add type and arguments for attributes and
2631 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2632 # will not generate fields with class member information in the UML graphs. The
2633 # class diagrams will look similar to the default class diagrams but using UML
2634 # notation for the relationships.
2635 # Possible values are: NO, YES and NONE.
2636 # The default value is: NO.
2637 # This tag requires that the tag UML_LOOK is set to YES.
2639 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ DOT_UML_DETAILS = NO
2641 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2642 # to display on a single line. If the actual line length exceeds this threshold
2643 # significantly it will wrapped across multiple lines. Some heuristics are apply
2644 # to avoid ugly line breaks.
2645 # Minimum value: 0, maximum value: 1000, default value: 17.
2646 # This tag requires that the tag HAVE_DOT is set to YES.
2648 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ DOT_WRAP_THRESHOLD = 17
2650 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2651 # collaboration graphs will show the relations between templates and their
2653 # The default value is: NO.
2654 # This tag requires that the tag HAVE_DOT is set to YES.
2656 TEMPLATE_RELATIONS = NO
2658 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2659 # YES then doxygen will generate a graph for each documented file showing the
2660 # direct and indirect include dependencies of the file with other documented
2662 # The default value is: YES.
2663 # This tag requires that the tag HAVE_DOT is set to YES.
2667 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2668 # set to YES then doxygen will generate a graph for each documented file showing
2669 # the direct and indirect include dependencies of the file with other documented
2671 # The default value is: YES.
2672 # This tag requires that the tag HAVE_DOT is set to YES.
2674 INCLUDED_BY_GRAPH = YES
2676 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2677 # dependency graph for every global function or class method.
2679 # Note that enabling this option will significantly increase the time of a run.
2680 # So in most cases it will be better to enable call graphs for selected
2681 # functions only using the \callgraph command. Disabling a call graph can be
2682 # accomplished by means of the command \hidecallgraph.
2683 # The default value is: NO.
2684 # This tag requires that the tag HAVE_DOT is set to YES.
2688 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2689 # dependency graph for every global function or class method.
2691 # Note that enabling this option will significantly increase the time of a run.
2692 # So in most cases it will be better to enable caller graphs for selected
2693 # functions only using the \callergraph command. Disabling a caller graph can be
2694 # accomplished by means of the command \hidecallergraph.
2695 # The default value is: NO.
2696 # This tag requires that the tag HAVE_DOT is set to YES.
2700 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2701 # hierarchy of all classes instead of a textual one.
2702 # The default value is: YES.
2703 # This tag requires that the tag HAVE_DOT is set to YES.
2705 GRAPHICAL_HIERARCHY = YES
2707 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2708 # dependencies a directory has on other directories in a graphical way. The
2709 # dependency relations are determined by the #include relations between the
2710 # files in the directories.
2711 # The default value is: YES.
2712 # This tag requires that the tag HAVE_DOT is set to YES.
2714 DIRECTORY_GRAPH = YES
2716 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2717 # generated by dot. For an explanation of the image formats see the section
2718 # output formats in the documentation of the dot tool (Graphviz (see:
2719 # http://www.graphviz.org/)).
2720 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2721 # to make the SVG files visible in IE 9+ (other browsers do not have this
2723 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2724 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2725 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2726 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2727 # png:gdiplus:gdiplus.
2728 # The default value is: png.
2729 # This tag requires that the tag HAVE_DOT is set to YES.
2731 DOT_IMAGE_FORMAT = png
2733 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2734 # enable generation of interactive SVG images that allow zooming and panning.
2736 # Note that this requires a modern browser other than Internet Explorer. Tested
2737 # and working are Firefox, Chrome, Safari, and Opera.
2738 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2739 # the SVG files visible. Older versions of IE do not have SVG support.
2740 # The default value is: NO.
2741 # This tag requires that the tag HAVE_DOT is set to YES.
2743 INTERACTIVE_SVG = NO
2745 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2746 # found. If left blank, it is assumed the dot tool can be found in the path.
2747 # This tag requires that the tag HAVE_DOT is set to YES.
2751 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2752 # contain dot files that are included in the documentation (see the \dotfile
2754 # This tag requires that the tag HAVE_DOT is set to YES.
2758 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2759 # contain msc files that are included in the documentation (see the \mscfile
2764 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2765 # contain dia files that are included in the documentation (see the \diafile
2770 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2771 # path where java can find the plantuml.jar file. If left blank, it is assumed
2772 # PlantUML is not used or called during a preprocessing step. Doxygen will
2773 # generate a warning when it encounters a \startuml command in this case and
2774 # will not generate output for the diagram.
2778 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2779 # configuration file for plantuml.
2783 # When using plantuml, the specified paths are searched for files specified by
2784 # the !include statement in a plantuml block.
2786 PLANTUML_INCLUDE_PATH =
2788 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2789 # that will be shown in the graph. If the number of nodes in a graph becomes
2790 # larger than this value, doxygen will truncate the graph, which is visualized
2791 # by representing a node as a red box. Note that doxygen if the number of direct
2792 # children of the root node in a graph is already larger than
2793 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2794 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2795 # Minimum value: 0, maximum value: 10000, default value: 50.
2796 # This tag requires that the tag HAVE_DOT is set to YES.
2798 DOT_GRAPH_MAX_NODES = 50
2800 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2801 # generated by dot. A depth value of 3 means that only nodes reachable from the
2802 # root by following a path via at most 3 edges will be shown. Nodes that lay
2803 # further from the root node will be omitted. Note that setting this option to 1
2804 # or 2 may greatly reduce the computation time needed for large code bases. Also
2805 # note that the size of a graph can be further restricted by
2806 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2807 # Minimum value: 0, maximum value: 1000, default value: 0.
2808 # This tag requires that the tag HAVE_DOT is set to YES.
2810 MAX_DOT_GRAPH_DEPTH = 0
2812 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2813 # background. This is disabled by default, because dot on Windows does not seem
2814 # to support this out of the box.
2816 # Warning: Depending on the platform used, enabling this option may lead to
2817 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2819 # The default value is: NO.
2820 # This tag requires that the tag HAVE_DOT is set to YES.
2822 DOT_TRANSPARENT = NO
2824 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2825 # files in one run (i.e. multiple -o and -T options on the command line). This
2826 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2827 # this, this feature is disabled by default.
2828 # The default value is: NO.
2829 # This tag requires that the tag HAVE_DOT is set to YES.
2831 DOT_MULTI_TARGETS = NO
2833 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2834 # explaining the meaning of the various boxes and arrows in the dot generated
2836 # The default value is: YES.
2837 # This tag requires that the tag HAVE_DOT is set to YES.
2839 GENERATE_LEGEND = YES
2841 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2842 # files that are used to generate the various graphs.
2844 # Note: This setting is not only used for dot files but also for msc and
2845 # plantuml temporary files.
2846 # The default value is: YES.