4d281e5ff9f7b867394116048336b379d9f7f82f
[platform/core/uifw/dali-toolkit.git] / build / tizen / docs / dali.doxy.in
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.
4
5 # This file describes the settings to be used by the documentation system
6 # doxygen (www.doxygen.org) for a project.
7 #
8 # All text after a double hash (##) is considered a comment and is placed in
9 # front of the TAG it is preceding.
10 #
11 # All text after a single hash (#) is considered a comment and will be ignored.
12 # The format is:
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 (\" \").
17
18 #---------------------------------------------------------------------------
19 # Project related configuration options
20 #---------------------------------------------------------------------------
21
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.
28
29 DOXYFILE_ENCODING      = UTF-8
30
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.
36
37 PROJECT_NAME           = DALi
38
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.
42
43 PROJECT_NUMBER         =
44
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.
48
49 PROJECT_BRIEF          =
50
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.
55
56 PROJECT_LOGO           =
57
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.
62
63 OUTPUT_DIRECTORY       = @DOXYGEN_DOCS_DIR@/generated
64
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.
72
73 CREATE_SUBDIRS         = NO
74
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
78 # U+3044.
79 # The default value is: NO.
80
81 ALLOW_UNICODE_NAMES    = NO
82
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.
95
96 OUTPUT_LANGUAGE        = English
97
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.
103
104 OUTPUT_TEXT_DIRECTION = None
105
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.
110
111 BRIEF_MEMBER_DESC      = YES
112
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
115 #
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.
119
120 REPEAT_BRIEF           = YES
121
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.
130
131 ABBREVIATE_BRIEF       = "The $name class" \
132                          "The $name widget" \
133                          "The $name file" \
134                          is \
135                          provides \
136                          specifies \
137                          contains \
138                          represents \
139                          a \
140                          an \
141                          the
142
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
145 # description.
146 # The default value is: NO.
147
148 ALWAYS_DETAILED_SEC    = NO
149
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.
155
156 INLINE_INHERITED_MEMB  = NO
157
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.
162
163 FULL_PATH_NAMES        = YES
164
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
169 # strip.
170 #
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.
174
175 STRIP_FROM_PATH        = .
176
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
182 # using the -I flag.
183
184 STRIP_FROM_INC_PATH    =
185
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.
190
191 SHORT_NAMES            = NO
192
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
197 # description.)
198 # The default value is: NO.
199
200 JAVADOC_AUTOBRIEF      = YES
201
202 # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
203 # such as
204 # /***************
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.
209
210 JAVADOC_BANNER = NO
211
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.
217
218 QT_AUTOBRIEF           = NO
219
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.
225 #
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.
229
230 MULTILINE_CPP_IS_BRIEF = NO
231
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.
237
238 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ PYTHON_DOCSTRING = YES
239
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.
243
244 INHERIT_DOCS           = YES
245
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.
250
251 SEPARATE_MEMBER_PAGES  = NO
252
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.
256
257 TAB_SIZE               = 2
258
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:
261 # name=value
262 # For example adding
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 \\})
273
274 ALIASES                =
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"
279
280 # <DALi Doxygen Tagging Rule>
281 #
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.
289 #
290 # If you need a newer version number like @SINCE_1_5 or @SINCE_2_0, just add new ALIASES for it.
291 #
292 # ##################################################3
293 # # Guide for Open Source DALi API Reference
294 #
295 # ### @SINCE example:
296 #   [some-public-header.h]
297 #   /**
298 #    * ...
299 #    * @SINCE_1_0.1
300 #    */
301 #   void SomeFunction();
302 #
303 #   [generated html file]
304 #   void SomeFunction()
305 #   ...
306 #   Since:
307 #       1.0.1
308 #
309 # ### @DEPRECATED example 1:
310 #   [some-public-header.h]
311 #   /**
312 #    * @DEPRECATED_1_0.3
313 #    * ...
314 #    */
315 #   void SomeFunction();
316 #
317 #   [generated html file]
318 #   void SomeFunction()
319 #   Deprecated:
320 #       Deprecated since 1.0.3
321 #   ...
322 #
323 # ### @DEPRECATED example 2:
324 #   [some-public-header.h]
325 #   ...
326 #   /**
327 #    * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
328 #    * ...
329 #    */
330 #   void SomeFunction();
331 #
332 #   [generated html file]
333 #   void SomeFunction()
334 #   Deprecated:
335 #       Deprecated since 1.0.3. Use SomeFunction2() instead.
336 #   ...
337 #
338 # ##################################################3
339 # # Guide for Tizen Native API Reference
340 #
341 # ### @SINCE example:
342 #   [some-public-header.h]
343 #   /**
344 #    * ...
345 #    * @SINCE_1_0.1
346 #    */
347 #   void SomeFunction();
348 #
349 #   [generated html file]
350 #   void SomeFunction()
351 #   ...
352 #   Since:
353 #       2.4, DALi Version 1.0.1
354 #
355 # ### @DEPRECATED example 1:
356 #   [some-public-header.h]
357 #   /**
358 #    * @DEPRECATED_1_0.3
359 #    * ...
360 #    */
361 #   void SomeFunction();
362 #
363 #   [generated html file]
364 #   void SomeFunction()
365 #   Deprecated:
366 #       Deprecated since 3.0, DALi version 1.0.3
367 #   ...
368 #
369 # ### @DEPRECATED example 2:
370 #   [some-public-header.h]
371 #   ...
372 #   /**
373 #    * @DEPRECATED_1_0.3. Use SomeFunction2() instead.
374 #    * ...
375 #    */
376 #   void SomeFunction();
377 #
378 #   [generated html file]
379 #   void SomeFunction()
380 #   Deprecated:
381 #       Deprecated since 3.0, DALi version 1.0.3. Use SomeFunction2() instead.
382 #   ...
383
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"
395 ALIASES += SINCE_2_3="@since 2.3"
396
397 # Extra tags for Tizen 3.0
398 ALIASES += SINCE_1_2_2="@since 1.2.2"
399 ALIASES += SINCE_1_2_4="@since 1.2.4"
400 ALIASES += SINCE_1_2_5="@since 1.2.5"
401 ALIASES += SINCE_1_2_10="@since 1.2.10"
402 ALIASES += SINCE_1_2_14="@since 1.2.14"
403 ALIASES += SINCE_1_2_32="@since 1.2.32"
404
405 # Extra tags for Tizen 4.0
406 ALIASES += SINCE_1_3_4="@since 1.3.4"
407 ALIASES += SINCE_1_3_5="@since 1.3.5"
408 ALIASES += SINCE_1_3_9="@since 1.3.9"
409 ALIASES += SINCE_1_3_15="@since 1.3.15"
410
411 #Extra tags for Tizen 5.5
412 ALIASES += SINCE_1_3_31="@since 1.3.31"
413
414 ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 1.0"
415 ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 1.1"
416 ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 1.2.8"
417 ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 1.2.10"
418 ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 1.2"
419 ALIASES += DEPRECATED_1_3="@deprecated Deprecated since 1.3"
420 ALIASES += DEPRECATED_1_3_39="@deprecated Deprecated since 1.3.39"
421 ALIASES += DEPRECATED_1_3_51="@deprecated Deprecated since 1.3.51"
422 ALIASES += DEPRECATED_1_4="@deprecated Deprecated since 1.4"
423 ALIASES += DEPRECATED_2_0="@deprecated Deprecated since 2.0"
424 ALIASES += DEPRECATED_2_1="@deprecated Deprecated since 2.1"
425 ALIASES += DEPRECATED_2_2="@deprecated Deprecated since 2.2"
426 ALIASES += DEPRECATED_2_3="@deprecated Deprecated since 2.3"
427
428 ALIASES += PLATFORM=""
429 ALIASES += PRIVLEVEL_PLATFORM=""
430 ALIASES += PRIVLEVEL_PUBLIC=""
431 ALIASES += PRIVILEGE_KEYGRAB=""
432 ALIASES += PRIVILEGE_DISPLAY=""
433 ALIASES += PRIVILEGE_WINDOW_PRIORITY=""
434 ALIASES += REMARK_INTERNET=""
435 ALIASES += REMARK_STORAGE=""
436 ALIASES += REMARK_RAWVIDEO=""
437
438 ############################################
439 ## For Tizen Native API Reference
440 #ALIASES += SINCE_1_0="\par Since:\n 2.4, DALi version 1.0"
441 #ALIASES += SINCE_1_1="\par Since:\n 3.0, DALi version 1.1"
442 #ALIASES += SINCE_1_2="\par Since:\n 4.0, DALi version 1.2"
443 #ALIASES += SINCE_1_3="\par Since:\n 5.0, DALi version 1.3"
444 #ALIASES += SINCE_1_4="\par Since:\n 5.5, DALi version 1.4"
445 #ALIASES += SINCE_1_9="\par Since:\n 6.0, DALi version 1.9"
446 #ALIASES += SINCE_2_0="\par Since:\n 6.5, DALi version 2.0"
447 #ALIASES += SINCE_2_1="\par Since:\n 7.0, DALi version 2.1"
448 #ALIASES += SINCE_2_2="\par Since:\n 8.0, DALi version 2.2"
449 #ALIASES += SINCE_2_3="\par Since:\n 9.0, DALi version 2.3"
450
451 ## Extra tags for Tizen 3.0
452 #ALIASES += SINCE_1_2_2="\par Since:\n 3.0, DALi version 1.2.2"
453 #ALIASES += SINCE_1_2_4="\par Since:\n 3.0, DALi version 1.2.4"
454 #ALIASES += SINCE_1_2_5="\par Since:\n 3.0, DALi version 1.2.5"
455 #ALIASES += SINCE_1_2_10="\par Since:\n 3.0, DALi version 1.2.10"
456 #ALIASES += SINCE_1_2_14="\par Since:\n 3.0, DALi version 1.2.14"
457 #ALIASES += SINCE_1_2_32="\par Since:\n 3.0, DALi version 1.2.32"
458
459 ## Extra tags for Tizen 4.0
460 #ALIASES += SINCE_1_3_4="\par Since:\n 4.0, DALi version 1.3.4"
461 #ALIASES += SINCE_1_3_5="\par Since:\n 4.0, DALi version 1.3.5"
462 #ALIASES += SINCE_1_3_9="\par Since:\n 4.0, DALi version 1.3.9"
463 #ALIASES += SINCE_1_3_15="\par Since:\n 4.0, DALi version 1.3.15"
464
465 #Extra tags for Tizen 5.5
466 #ALIASES += SINCE_1_3_31="\par Since:\n 5.5, DALi version 1.3.31"
467
468 ## DALi has no deprecated API in Tizen 2.4 because it's DALi's first release.
469 ## Thus deprecated APIs in DALi 1.0.xx will be deprecated in Tizen 3.0.
470 #ALIASES += DEPRECATED_1_0="@deprecated Deprecated since 3.0, DALi version 1.0"
471 #ALIASES += DEPRECATED_1_1="@deprecated Deprecated since 3.0, DALi version 1.1"
472 #ALIASES += DEPRECATED_1_2_8="@deprecated Deprecated since 3.0, DALi version 1.2.8"
473 #ALIASES += DEPRECATED_1_2_10="@deprecated Deprecated since 3.0, DALi version 1.2.10"
474 #ALIASES += DEPRECATED_1_2="@deprecated Deprecated since 4.0, DALi version 1.2"
475 #ALIASES += DEPRECATED_1_3="@deprecated Deprecated since 5.0, DALi version 1.3"
476 #ALIASES += DEPRECATED_1_3_39="@deprecated Deprecated since 5.5, DALi version 1.3.39"
477 #ALIASES += DEPRECATED_1_3_51="@deprecated Deprecated since 5.5, DALi version 1.3.51"
478 #ALIASES += DEPRECATED_1_4="@deprecated Deprecated since 5.5, DALi version 1.4"
479 #ALIASES += DEPRECATED_2_0="@deprecated Deprecated since 6.5, DALi version 2.0"
480 #ALIASES += DEPRECATED_2_1="@deprecated Deprecated since 7.0, DALi version 2.1"
481 #ALIASES += DEPRECATED_2_2="@deprecated Deprecated since 8.0, DALi version 2.2"
482 #ALIASES += DEPRECATED_2_3="@deprecated Deprecated since 9.0, DALi version 2.3"
483
484 #ALIASES += PLATFORM="@platform"
485 #ALIASES += PRIVLEVEL_PLATFORM="\par Privilege Level:\n platform"
486 #ALIASES += PRIVLEVEL_PUBLIC="\par Privilege Level:\n public"
487 #ALIASES += PRIVILEGE_KEYGRAB="\par Privilege:\n http://tizen.org/privilege/keygrab"
488 #ALIASES += PRIVILEGE_DISPLAY="\par Privilege:\n http://tizen.org/privilege/display"
489 #ALIASES += PRIVILEGE_WINDOW_PRIORITY="\par Privilege:\n http://tizen.org/privilege/window.priority.set"
490 #ALIASES += REMARK_INTERNET="@remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address."
491 #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."
492 #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."
493
494 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
495 # only. Doxygen will then generate output that is more tailored for C. For
496 # instance, some of the names that are used will be different. The list of all
497 # members will be omitted, etc.
498 # The default value is: NO.
499
500 OPTIMIZE_OUTPUT_FOR_C  = NO
501
502 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
503 # Python sources only. Doxygen will then generate output that is more tailored
504 # for that language. For instance, namespaces will be presented as packages,
505 # qualified scopes will look different, etc.
506 # The default value is: NO.
507
508 OPTIMIZE_OUTPUT_JAVA   = NO
509
510 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
511 # sources. Doxygen will then generate output that is tailored for Fortran.
512 # The default value is: NO.
513
514 OPTIMIZE_FOR_FORTRAN   = NO
515
516 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
517 # sources. Doxygen will then generate output that is tailored for VHDL.
518 # The default value is: NO.
519
520 OPTIMIZE_OUTPUT_VHDL   = NO
521
522 # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
523 # sources only. Doxygen will then generate output that is more tailored for that
524 # language. For instance, namespaces will be presented as modules, types will be
525 # separated into more groups, etc.
526 # The default value is: NO.
527
528 OPTIMIZE_OUTPUT_SLICE = NO
529
530 # Doxygen selects the parser to use depending on the extension of the files it
531 # parses. With this tag you can assign which parser to use for a given
532 # extension. Doxygen has a built-in mapping, but you can override or extend it
533 # using this tag. The format is ext=language, where ext is a file extension, and
534 # language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
535 # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
536 # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
537 # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
538 # tries to guess whether the code is fixed or free formatted code, this is the
539 # default for Fortran type files). For instance to make doxygen treat .inc files
540 # as Fortran files (default is PHP), and .f files as C (default is Fortran),
541 # use: inc=Fortran f=C.
542 #
543 # Note: For files without extension you can use no_extension as a placeholder.
544 #
545 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
546 # the files are not read by doxygen. When specifying no_extension you should add
547 # * to the FILE_PATTERNS.
548 #
549 # Note see also the list of default file extension mappings.
550
551 EXTENSION_MAPPING      =
552
553 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
554 # according to the Markdown format, which allows for more readable
555 # documentation. See https://daringfireball.net/projects/markdown/ for details.
556 # The output of markdown processing is further processed by doxygen, so you can
557 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
558 # case of backward compatibilities issues.
559 # The default value is: YES.
560
561 MARKDOWN_SUPPORT       = YES
562
563 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
564 # to that level are automatically included in the table of contents, even if
565 # they do not have an id attribute.
566 # Note: This feature currently applies only to Markdown headings.
567 # Minimum value: 0, maximum value: 99, default value: 5.
568 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
569
570 TOC_INCLUDE_HEADINGS = 5
571
572 # When enabled doxygen tries to link words that correspond to documented
573 # classes, or namespaces to their corresponding documentation. Such a link can
574 # be prevented in individual cases by putting a % sign in front of the word or
575 # globally by setting AUTOLINK_SUPPORT to NO.
576 # The default value is: YES.
577
578 AUTOLINK_SUPPORT       = YES
579
580 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
581 # to include (a tag file for) the STL sources as input, then you should set this
582 # tag to YES in order to let doxygen match functions declarations and
583 # definitions whose arguments contain STL classes (e.g. func(std::string);
584 # versus func(std::string) {}). This also make the inheritance and collaboration
585 # diagrams that involve STL classes more complete and accurate.
586 # The default value is: NO.
587
588 BUILTIN_STL_SUPPORT    = YES
589
590 # If you use Microsoft's C++/CLI language, you should set this option to YES to
591 # enable parsing support.
592 # The default value is: NO.
593
594 CPP_CLI_SUPPORT        = NO
595
596 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
597 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
598 # will parse them like normal C++ but will assume all classes use public instead
599 # of private inheritance when no explicit protection keyword is present.
600 # The default value is: NO.
601
602 SIP_SUPPORT            = NO
603
604 # For Microsoft's IDL there are propget and propput attributes to indicate
605 # getter and setter methods for a property. Setting this option to YES will make
606 # doxygen to replace the get and set methods by a property in the documentation.
607 # This will only work if the methods are indeed getting or setting a simple
608 # type. If this is not the case, or you want to show the methods anyway, you
609 # should set this option to NO.
610 # The default value is: YES.
611
612 IDL_PROPERTY_SUPPORT   = YES
613
614 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
615 # tag is set to YES then doxygen will reuse the documentation of the first
616 # member in the group (if any) for the other members of the group. By default
617 # all members of a group must be documented explicitly.
618 # The default value is: NO.
619
620 DISTRIBUTE_GROUP_DOC   = NO
621
622 # If one adds a struct or class to a group and this option is enabled, then also
623 # any nested class or struct is added to the same group. By default this option
624 # is disabled and one has to add nested compounds explicitly via \ingroup.
625 # The default value is: NO.
626
627 GROUP_NESTED_COMPOUNDS = NO
628
629 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
630 # (for instance a group of public functions) to be put as a subgroup of that
631 # type (e.g. under the Public Functions section). Set it to NO to prevent
632 # subgrouping. Alternatively, this can be done per class using the
633 # \nosubgrouping command.
634 # The default value is: YES.
635
636 SUBGROUPING            = YES
637
638 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
639 # are shown inside the group in which they are included (e.g. using \ingroup)
640 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
641 # and RTF).
642 #
643 # Note that this feature does not work in combination with
644 # SEPARATE_MEMBER_PAGES.
645 # The default value is: NO.
646
647 INLINE_GROUPED_CLASSES = NO
648
649 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
650 # with only public data fields or simple typedef fields will be shown inline in
651 # the documentation of the scope in which they are defined (i.e. file,
652 # namespace, or group documentation), provided this scope is documented. If set
653 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
654 # Man pages) or section (for LaTeX and RTF).
655 # The default value is: NO.
656
657 INLINE_SIMPLE_STRUCTS  = NO
658
659 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
660 # enum is documented as struct, union, or enum with the name of the typedef. So
661 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
662 # with name TypeT. When disabled the typedef will appear as a member of a file,
663 # namespace, or class. And the struct will be named TypeS. This can typically be
664 # useful for C code in case the coding convention dictates that all compound
665 # types are typedef'ed and only the typedef is referenced, never the tag name.
666 # The default value is: NO.
667
668 TYPEDEF_HIDES_STRUCT   = NO
669
670 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
671 # cache is used to resolve symbols given their name and scope. Since this can be
672 # an expensive process and often the same symbol appears multiple times in the
673 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
674 # doxygen will become slower. If the cache is too large, memory is wasted. The
675 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
676 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
677 # symbols. At the end of a run doxygen will report the cache usage and suggest
678 # the optimal cache size from a speed point of view.
679 # Minimum value: 0, maximum value: 9, default value: 0.
680
681 LOOKUP_CACHE_SIZE      = 0
682
683 # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
684 # during processing. When set to 0 doxygen will based this on the number of
685 # cores available in the system. You can set it explicitly to a value larger
686 # than 0 to get more control over the balance between CPU load and processing
687 # speed. At this moment only the input processing can be done using multiple
688 # threads. Since this is still an experimental feature the default is set to 1,
689 # which efficively disables parallel processing. Please report any issues you
690 # encounter. Generating dot graphs in parallel is controlled by the
691 # DOT_NUM_THREADS setting.
692 # Minimum value: 0, maximum value: 32, default value: 1.
693
694 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ NUM_PROC_THREADS = 1
695
696 #---------------------------------------------------------------------------
697 # Build related configuration options
698 #---------------------------------------------------------------------------
699
700 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
701 # documentation are documented, even if no documentation was available. Private
702 # class members and static file members will be hidden unless the
703 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
704 # Note: This will also disable the warnings about undocumented members that are
705 # normally produced when WARNINGS is set to YES.
706 # The default value is: NO.
707
708 EXTRACT_ALL            = YES
709
710 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
711 # be included in the documentation.
712 # The default value is: NO.
713
714 EXTRACT_PRIVATE        = YES
715
716 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
717 # methods of a class will be included in the documentation.
718 # The default value is: NO.
719
720 EXTRACT_PRIV_VIRTUAL = NO
721
722 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
723 # scope will be included in the documentation.
724 # The default value is: NO.
725
726 EXTRACT_PACKAGE        = NO
727
728 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
729 # included in the documentation.
730 # The default value is: NO.
731
732 EXTRACT_STATIC         = YES
733
734 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
735 # locally in source files will be included in the documentation. If set to NO,
736 # only classes defined in header files are included. Does not have any effect
737 # for Java sources.
738 # The default value is: YES.
739
740 EXTRACT_LOCAL_CLASSES  = YES
741
742 # This flag is only useful for Objective-C code. If set to YES, local methods,
743 # which are defined in the implementation section but not in the interface are
744 # included in the documentation. If set to NO, only methods in the interface are
745 # included.
746 # The default value is: NO.
747
748 EXTRACT_LOCAL_METHODS  = NO
749
750 # If this flag is set to YES, the members of anonymous namespaces will be
751 # extracted and appear in the documentation as a namespace called
752 # 'anonymous_namespace{file}', where file will be replaced with the base name of
753 # the file that contains the anonymous namespace. By default anonymous namespace
754 # are hidden.
755 # The default value is: NO.
756
757 EXTRACT_ANON_NSPACES   = NO
758
759 # If this flag is set to YES, the name of an unnamed parameter in a declaration
760 # will be determined by the corresponding definition. By default unnamed
761 # parameters remain unnamed in the output.
762 # The default value is: YES.
763
764 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ RESOLVE_UNNAMED_PARAMS = YES
765
766 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
767 # undocumented members inside documented classes or files. If set to NO these
768 # members will be included in the various overviews, but no documentation
769 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
770 # The default value is: NO.
771
772 HIDE_UNDOC_MEMBERS     = NO
773
774 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
775 # undocumented classes that are normally visible in the class hierarchy. If set
776 # to NO, these classes will be included in the various overviews. This option
777 # has no effect if EXTRACT_ALL is enabled.
778 # The default value is: NO.
779
780 HIDE_UNDOC_CLASSES     = NO
781
782 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
783 # declarations. If set to NO, these declarations will be included in the
784 # documentation.
785 # The default value is: NO.
786
787 HIDE_FRIEND_COMPOUNDS  = NO
788
789 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
790 # documentation blocks found inside the body of a function. If set to NO, these
791 # blocks will be appended to the function's detailed documentation block.
792 # The default value is: NO.
793
794 HIDE_IN_BODY_DOCS      = NO
795
796 # The INTERNAL_DOCS tag determines if documentation that is typed after a
797 # \internal command is included. If the tag is set to NO then the documentation
798 # will be excluded. Set it to YES to include the internal documentation.
799 # The default value is: NO.
800
801 INTERNAL_DOCS          = NO
802
803 # With the correct setting of option CASE_SENSE_NAMES doxygen will better be
804 # able to match the capabilities of the underlying filesystem. In case the
805 # filesystem is case sensitive (i.e. it supports files in the same directory
806 # whose names only differ in casing), the option must be set to YES to properly
807 # deal with such files in case they appear in the input. For filesystems that
808 # are not case sensitive the option should be be set to NO to properly deal with
809 # output files written for symbols that only differ in casing, such as for two
810 # classes, one named CLASS and the other named Class, and to also support
811 # references to files without having to specify the exact matching casing. On
812 # Windows (including Cygwin) and MacOS, users should typically set this option
813 # to NO, whereas on Linux or other Unix flavors it should typically be set to
814 # YES.
815 # The default value is: system dependent.
816
817 CASE_SENSE_NAMES       = NO
818
819 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
820 # their full class and namespace scopes in the documentation. If set to YES, the
821 # scope will be hidden.
822 # The default value is: NO.
823
824 HIDE_SCOPE_NAMES       = NO
825
826 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
827 # append additional text to a page's title, such as Class Reference. If set to
828 # YES the compound reference will be hidden.
829 # The default value is: NO.
830
831 HIDE_COMPOUND_REFERENCE= NO
832
833 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
834 # the files that are included by a file in the documentation of that file.
835 # The default value is: YES.
836
837 SHOW_INCLUDE_FILES     = YES
838
839 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
840 # grouped member an include statement to the documentation, telling the reader
841 # which file to include in order to use the member.
842 # The default value is: NO.
843
844 SHOW_GROUPED_MEMB_INC  = NO
845
846 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
847 # files with double quotes in the documentation rather than with sharp brackets.
848 # The default value is: NO.
849
850 FORCE_LOCAL_INCLUDES   = NO
851
852 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
853 # documentation for inline members.
854 # The default value is: YES.
855
856 INLINE_INFO            = YES
857
858 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
859 # (detailed) documentation of file and class members alphabetically by member
860 # name. If set to NO, the members will appear in declaration order.
861 # The default value is: YES.
862
863 SORT_MEMBER_DOCS       = YES
864
865 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
866 # descriptions of file, namespace and class members alphabetically by member
867 # name. If set to NO, the members will appear in declaration order. Note that
868 # this will also influence the order of the classes in the class list.
869 # The default value is: NO.
870
871 SORT_BRIEF_DOCS        = NO
872
873 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
874 # (brief and detailed) documentation of class members so that constructors and
875 # destructors are listed first. If set to NO the constructors will appear in the
876 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
877 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
878 # member documentation.
879 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
880 # detailed member documentation.
881 # The default value is: NO.
882
883 SORT_MEMBERS_CTORS_1ST = NO
884
885 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
886 # of group names into alphabetical order. If set to NO the group names will
887 # appear in their defined order.
888 # The default value is: NO.
889
890 SORT_GROUP_NAMES       = NO
891
892 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
893 # fully-qualified names, including namespaces. If set to NO, the class list will
894 # be sorted only by class name, not including the namespace part.
895 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
896 # Note: This option applies only to the class list, not to the alphabetical
897 # list.
898 # The default value is: NO.
899
900 SORT_BY_SCOPE_NAME     = NO
901
902 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
903 # type resolution of all parameters of a function it will reject a match between
904 # the prototype and the implementation of a member function even if there is
905 # only one candidate or it is obvious which candidate to choose by doing a
906 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
907 # accept a match between prototype and implementation in such cases.
908 # The default value is: NO.
909
910 STRICT_PROTO_MATCHING  = NO
911
912 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
913 # list. This list is created by putting \todo commands in the documentation.
914 # The default value is: YES.
915
916 GENERATE_TODOLIST      = NO
917
918 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
919 # list. This list is created by putting \test commands in the documentation.
920 # The default value is: YES.
921
922 GENERATE_TESTLIST      = NO
923
924 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
925 # list. This list is created by putting \bug commands in the documentation.
926 # The default value is: YES.
927
928 GENERATE_BUGLIST       = NO
929
930 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
931 # the deprecated list. This list is created by putting \deprecated commands in
932 # the documentation.
933 # The default value is: YES.
934
935 GENERATE_DEPRECATEDLIST= YES
936
937 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
938 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
939 # ... \endcond blocks.
940
941 ENABLED_SECTIONS       = show_tizen_feature
942
943 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
944 # initial value of a variable or macro / define can have for it to appear in the
945 # documentation. If the initializer consists of more lines than specified here
946 # it will be hidden. Use a value of 0 to hide initializers completely. The
947 # appearance of the value of individual variables and macros / defines can be
948 # controlled using \showinitializer or \hideinitializer command in the
949 # documentation regardless of this setting.
950 # Minimum value: 0, maximum value: 10000, default value: 30.
951
952 MAX_INITIALIZER_LINES  = 30
953
954 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
955 # the bottom of the documentation of classes and structs. If set to YES, the
956 # list will mention the files that were used to generate the documentation.
957 # The default value is: YES.
958
959 SHOW_USED_FILES        = YES
960
961 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
962 # will remove the Files entry from the Quick Index and from the Folder Tree View
963 # (if specified).
964 # The default value is: YES.
965
966 SHOW_FILES             = YES
967
968 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
969 # page. This will remove the Namespaces entry from the Quick Index and from the
970 # Folder Tree View (if specified).
971 # The default value is: YES.
972
973 SHOW_NAMESPACES        = YES
974
975 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
976 # doxygen should invoke to get the current version for each file (typically from
977 # the version control system). Doxygen will invoke the program by executing (via
978 # popen()) the command command input-file, where command is the value of the
979 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
980 # by doxygen. Whatever the program writes to standard output is used as the file
981 # version. For an example see the documentation.
982
983 FILE_VERSION_FILTER    =
984
985 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
986 # by doxygen. The layout file controls the global structure of the generated
987 # output files in an output format independent way. To create the layout file
988 # that represents doxygen's defaults, run doxygen with the -l option. You can
989 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
990 # will be used as the name of the layout file.
991 #
992 # Note that if you run doxygen from a directory containing a file called
993 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
994 # tag is left empty.
995
996 LAYOUT_FILE            = @DOXYGEN_DOCS_DIR@/DaliLayout.xml
997
998 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
999 # the reference definitions. This must be a list of .bib files. The .bib
1000 # extension is automatically appended if omitted. This requires the bibtex tool
1001 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
1002 # For LaTeX the style of the bibliography can be controlled using
1003 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
1004 # search path. See also \cite for info how to create references.
1005
1006 CITE_BIB_FILES         =
1007
1008 #---------------------------------------------------------------------------
1009 # Configuration options related to warning and progress messages
1010 #---------------------------------------------------------------------------
1011
1012 # The QUIET tag can be used to turn on/off the messages that are generated to
1013 # standard output by doxygen. If QUIET is set to YES this implies that the
1014 # messages are off.
1015 # The default value is: NO.
1016
1017 QUIET                  = YES
1018
1019 # The WARNINGS tag can be used to turn on/off the warning messages that are
1020 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
1021 # this implies that the warnings are on.
1022 #
1023 # Tip: Turn warnings on while writing the documentation.
1024 # The default value is: YES.
1025
1026 WARNINGS               = YES
1027
1028 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
1029 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
1030 # will automatically be disabled.
1031 # The default value is: YES.
1032
1033 WARN_IF_UNDOCUMENTED   = YES
1034
1035 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
1036 # potential errors in the documentation, such as not documenting some parameters
1037 # in a documented function, or documenting parameters that don't exist or using
1038 # markup commands wrongly.
1039 # The default value is: YES.
1040
1041 WARN_IF_DOC_ERROR      = YES
1042
1043 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
1044 # are documented, but have no documentation for their parameters or return
1045 # value. If set to NO, doxygen will only warn about wrong or incomplete
1046 # parameter documentation, but not about the absence of documentation. If
1047 # EXTRACT_ALL is set to YES then this flag will automatically be disabled.
1048 # The default value is: NO.
1049
1050 WARN_NO_PARAMDOC       = YES
1051
1052 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
1053 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
1054 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
1055 # at the end of the doxygen process doxygen will return with a non-zero status.
1056 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
1057 # The default value is: NO.
1058
1059 WARN_AS_ERROR          = NO
1060
1061 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
1062 # can produce. The string should contain the $file, $line, and $text tags, which
1063 # will be replaced by the file and line number from which the warning originated
1064 # and the warning text. Optionally the format may contain $version, which will
1065 # be replaced by the version of the file (if it could be obtained via
1066 # FILE_VERSION_FILTER)
1067 # The default value is: $file:$line: $text.
1068
1069 WARN_FORMAT            = "$file:$line: $text"
1070
1071 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
1072 # messages should be written. If left blank the output is written to standard
1073 # error (stderr).
1074
1075 WARN_LOGFILE           = doxygen-errors.txt
1076
1077 #---------------------------------------------------------------------------
1078 # Configuration options related to the input files
1079 #---------------------------------------------------------------------------
1080
1081 # The INPUT tag is used to specify the files and/or directories that contain
1082 # documented source files. You may enter file names like myfile.cpp or
1083 # directories like /usr/src/myproject. Separate the files or directories with
1084 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
1085 # Note: If this tag is empty the current directory is searched.
1086
1087 INPUT                  = @DOXYGEN_DOCS_DIR@/content \
1088                          @prefix@/include/dali/doc/dali-core-doc.h \
1089                          @prefix@/include/dali/doc/dali-adaptor-doc.h \
1090                          ../../../doc/dali-toolkit-doc.h \
1091                          @prefix@/include/dali/public-api \
1092                          @prefix@/include/dali/devel-api \
1093                          ../../../dali-toolkit/public-api \
1094                          ../../../dali-toolkit/devel-api \
1095                          ../../../dali-scene3d/public-api \
1096                          ../../../automated-tests/README.md
1097
1098 # This tag can be used to specify the character encoding of the source files
1099 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1100 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1101 # documentation (see:
1102 # https://www.gnu.org/software/libiconv/) for the list of possible encodings.
1103 # The default value is: UTF-8.
1104
1105 INPUT_ENCODING         = UTF-8
1106
1107 # If the value of the INPUT tag contains directories, you can use the
1108 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1109 # *.h) to filter out the source-files in the directories.
1110 #
1111 # Note that for custom extensions or not directly supported extensions you also
1112 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1113 # read by doxygen.
1114 #
1115 # Note the list of default checked file patterns might differ from the list of
1116 # default file extension mappings.
1117 #
1118 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
1119 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
1120 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
1121 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
1122 # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
1123 # *.ucf, *.qsf and *.ice.
1124
1125 FILE_PATTERNS          = *.h \
1126                          *.md
1127
1128 # The RECURSIVE tag can be used to specify whether or not subdirectories should
1129 # be searched for input files as well.
1130 # The default value is: NO.
1131
1132 RECURSIVE              = YES
1133
1134 # The EXCLUDE tag can be used to specify files and/or directories that should be
1135 # excluded from the INPUT source files. This way you can easily exclude a
1136 # subdirectory from a directory tree whose root is specified with the INPUT tag.
1137 #
1138 # Note that relative paths are relative to the directory from which doxygen is
1139 # run.
1140
1141 EXCLUDE                = dali/integration-api
1142
1143 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1144 # directories that are symbolic links (a Unix file system feature) are excluded
1145 # from the input.
1146 # The default value is: NO.
1147
1148 EXCLUDE_SYMLINKS       = NO
1149
1150 # If the value of the INPUT tag contains directories, you can use the
1151 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1152 # certain files from those directories.
1153 #
1154 # Note that the wildcards are matched against the file with absolute path, so to
1155 # exclude all test directories for example use the pattern */test/*
1156
1157 EXCLUDE_PATTERNS       =
1158
1159 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1160 # (namespaces, classes, functions, etc.) that should be excluded from the
1161 # output. The symbol name can be a fully qualified name, a word, or if the
1162 # wildcard * is used, a substring. Examples: ANamespace, AClass,
1163 # AClass::ANamespace, ANamespace::*Test
1164 #
1165 # Note that the wildcards are matched against the file with absolute path, so to
1166 # exclude all test directories use the pattern */test/*
1167
1168 EXCLUDE_SYMBOLS        = DaliInternal \
1169                          Dali::Internal \
1170                          Dali::Integration \
1171                          Impl \
1172                          ApplicationImpl
1173
1174 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
1175 # that contain example code fragments that are included (see the \include
1176 # command).
1177
1178 EXAMPLE_PATH           = @DOXYGEN_DOCS_DIR@/../
1179
1180 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
1181 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1182 # *.h) to filter out the source-files in the directories. If left blank all
1183 # files are included.
1184
1185 EXAMPLE_PATTERNS       = *
1186
1187 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1188 # searched for input files to be used with the \include or \dontinclude commands
1189 # irrespective of the value of the RECURSIVE tag.
1190 # The default value is: NO.
1191
1192 EXAMPLE_RECURSIVE      = YES
1193
1194 # The IMAGE_PATH tag can be used to specify one or more files or directories
1195 # that contain images that are to be included in the documentation (see the
1196 # \image command).
1197
1198 IMAGE_PATH             = @DOXYGEN_DOCS_DIR@/content/images
1199
1200 # The INPUT_FILTER tag can be used to specify a program that doxygen should
1201 # invoke to filter for each input file. Doxygen will invoke the filter program
1202 # by executing (via popen()) the command:
1203 #
1204 # <filter> <input-file>
1205 #
1206 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1207 # name of an input file. Doxygen will then use the output that the filter
1208 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
1209 # will be ignored.
1210 #
1211 # Note that the filter must not add or remove lines; it is applied before the
1212 # code is scanned, but not when the output code is generated. If lines are added
1213 # or removed, the anchors will not be placed correctly.
1214 #
1215 # Note that for custom extensions or not directly supported extensions you also
1216 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1217 # properly processed by doxygen.
1218
1219 INPUT_FILTER           =
1220
1221 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1222 # basis. Doxygen will compare the file name with each pattern and apply the
1223 # filter if there is a match. The filters are a list of the form: pattern=filter
1224 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1225 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1226 # patterns match the file name, INPUT_FILTER is applied.
1227 #
1228 # Note that for custom extensions or not directly supported extensions you also
1229 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1230 # properly processed by doxygen.
1231
1232 FILTER_PATTERNS        =
1233
1234 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1235 # INPUT_FILTER) will also be used to filter the input files that are used for
1236 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1237 # The default value is: NO.
1238
1239 FILTER_SOURCE_FILES    = NO
1240
1241 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1242 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1243 # it is also possible to disable source filtering for a specific pattern using
1244 # *.ext= (so without naming a filter).
1245 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1246
1247 FILTER_SOURCE_PATTERNS =
1248
1249 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1250 # is part of the input, its contents will be placed on the main page
1251 # (index.html). This can be useful if you have a project on for instance GitHub
1252 # and want to reuse the introduction page also for the doxygen output.
1253
1254 USE_MDFILE_AS_MAINPAGE = main.md
1255
1256 #---------------------------------------------------------------------------
1257 # Configuration options related to source browsing
1258 #---------------------------------------------------------------------------
1259
1260 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1261 # generated. Documented entities will be cross-referenced with these sources.
1262 #
1263 # Note: To get rid of all source code in the generated output, make sure that
1264 # also VERBATIM_HEADERS is set to NO.
1265 # The default value is: NO.
1266
1267 SOURCE_BROWSER         = YES
1268
1269 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1270 # classes and enums directly into the documentation.
1271 # The default value is: NO.
1272
1273 INLINE_SOURCES         = NO
1274
1275 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1276 # special comment blocks from generated source code fragments. Normal C, C++ and
1277 # Fortran comments will always remain visible.
1278 # The default value is: YES.
1279
1280 STRIP_CODE_COMMENTS    = NO
1281
1282 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1283 # entity all documented functions referencing it will be listed.
1284 # The default value is: NO.
1285
1286 REFERENCED_BY_RELATION = NO
1287
1288 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1289 # all documented entities called/used by that function will be listed.
1290 # The default value is: NO.
1291
1292 REFERENCES_RELATION    = NO
1293
1294 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1295 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1296 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1297 # link to the documentation.
1298 # The default value is: YES.
1299
1300 REFERENCES_LINK_SOURCE = YES
1301
1302 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1303 # source code will show a tooltip with additional information such as prototype,
1304 # brief description and links to the definition and documentation. Since this
1305 # will make the HTML file larger and loading of large files a bit slower, you
1306 # can opt to disable this feature.
1307 # The default value is: YES.
1308 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1309
1310 SOURCE_TOOLTIPS        = YES
1311
1312 # If the USE_HTAGS tag is set to YES then the references to source code will
1313 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1314 # source browser. The htags tool is part of GNU's global source tagging system
1315 # (see https://www.gnu.org/software/global/global.html). You will need version
1316 # 4.8.6 or higher.
1317 #
1318 # To use it do the following:
1319 # - Install the latest version of global
1320 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1321 # - Make sure the INPUT points to the root of the source tree
1322 # - Run doxygen as normal
1323 #
1324 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1325 # tools must be available from the command line (i.e. in the search path).
1326 #
1327 # The result: instead of the source browser generated by doxygen, the links to
1328 # source code will now point to the output of htags.
1329 # The default value is: NO.
1330 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1331
1332 USE_HTAGS              = NO
1333
1334 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1335 # verbatim copy of the header file for each class for which an include is
1336 # specified. Set to NO to disable this.
1337 # See also: Section \class.
1338 # The default value is: YES.
1339
1340 VERBATIM_HEADERS       = YES
1341
1342 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1343 # clang parser (see:
1344 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1345 # performance. This can be particularly helpful with template rich C++ code for
1346 # which doxygen's built-in parser lacks the necessary type information.
1347 # Note: The availability of this option depends on whether or not doxygen was
1348 # generated with the -Duse_libclang=ON option for CMake.
1349 # The default value is: NO.
1350
1351 CLANG_ASSISTED_PARSING = NO
1352
1353 # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
1354 # YES then doxygen will add the directory of each input to the include path.
1355 # The default value is: YES.
1356
1357 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ CLANG_ADD_INC_PATHS = YES
1358
1359 # If clang assisted parsing is enabled you can provide the compiler with command
1360 # line options that you would normally use when invoking the compiler. Note that
1361 # the include paths will already be set by doxygen for the files and directories
1362 # specified with INPUT and INCLUDE_PATH.
1363 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1364
1365 CLANG_OPTIONS          =
1366
1367 # If clang assisted parsing is enabled you can provide the clang parser with the
1368 # path to the directory containing a file called compile_commands.json. This
1369 # file is the compilation database (see:
1370 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1371 # options used when the source files were built. This is equivalent to
1372 # specifying the -p option to a clang tool, such as clang-check. These options
1373 # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1374 # will be added as well.
1375 # Note: The availability of this option depends on whether or not doxygen was
1376 # generated with the -Duse_libclang=ON option for CMake.
1377
1378 CLANG_DATABASE_PATH =
1379
1380 #---------------------------------------------------------------------------
1381 # Configuration options related to the alphabetical class index
1382 #---------------------------------------------------------------------------
1383
1384 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1385 # compounds will be generated. Enable this if the project contains a lot of
1386 # classes, structs, unions or interfaces.
1387 # The default value is: YES.
1388
1389 ALPHABETICAL_INDEX     = NO
1390
1391 # In case all classes in a project start with a common prefix, all classes will
1392 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1393 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1394 # while generating the index headers.
1395 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1396
1397 IGNORE_PREFIX          =
1398
1399 #---------------------------------------------------------------------------
1400 # Configuration options related to the HTML output
1401 #---------------------------------------------------------------------------
1402
1403 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1404 # The default value is: YES.
1405
1406 GENERATE_HTML          = YES
1407
1408 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1409 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1410 # it.
1411 # The default directory is: html.
1412 # This tag requires that the tag GENERATE_HTML is set to YES.
1413
1414 HTML_OUTPUT            = html
1415
1416 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1417 # generated HTML page (for example: .htm, .php, .asp).
1418 # The default value is: .html.
1419 # This tag requires that the tag GENERATE_HTML is set to YES.
1420
1421 HTML_FILE_EXTENSION    = .html
1422
1423 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1424 # each generated HTML page. If the tag is left blank doxygen will generate a
1425 # standard header.
1426 #
1427 # To get valid HTML the header file that includes any scripts and style sheets
1428 # that doxygen needs, which is dependent on the configuration options used (e.g.
1429 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1430 # default header using
1431 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1432 # YourConfigFile
1433 # and then modify the file new_header.html. See also section "Doxygen usage"
1434 # for information on how to generate the default header that doxygen normally
1435 # uses.
1436 # Note: The header is subject to change so you typically have to regenerate the
1437 # default header when upgrading to a newer version of doxygen. For a description
1438 # of the possible markers and block names see the documentation.
1439 # This tag requires that the tag GENERATE_HTML is set to YES.
1440
1441 HTML_HEADER            =
1442
1443 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1444 # generated HTML page. If the tag is left blank doxygen will generate a standard
1445 # footer. See HTML_HEADER for more information on how to generate a default
1446 # footer and what special commands can be used inside the footer. See also
1447 # section "Doxygen usage" for information on how to generate the default footer
1448 # that doxygen normally uses.
1449 # This tag requires that the tag GENERATE_HTML is set to YES.
1450
1451 HTML_FOOTER            =
1452
1453 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1454 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1455 # the HTML output. If left blank doxygen will generate a default style sheet.
1456 # See also section "Doxygen usage" for information on how to generate the style
1457 # sheet that doxygen normally uses.
1458 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1459 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1460 # obsolete.
1461 # This tag requires that the tag GENERATE_HTML is set to YES.
1462
1463 HTML_STYLESHEET        =
1464
1465 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1466 # cascading style sheets that are included after the standard style sheets
1467 # created by doxygen. Using this option one can overrule certain style aspects.
1468 # This is preferred over using HTML_STYLESHEET since it does not replace the
1469 # standard style sheet and is therefore more robust against future updates.
1470 # Doxygen will copy the style sheet files to the output directory.
1471 # Note: The order of the extra style sheet files is of importance (e.g. the last
1472 # style sheet in the list overrules the setting of the previous ones in the
1473 # list). For an example see the documentation.
1474 # This tag requires that the tag GENERATE_HTML is set to YES.
1475
1476 HTML_EXTRA_STYLESHEET  = @DOXYGEN_DOCS_DIR@/dali_doxygen.css
1477
1478 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1479 # other source files which should be copied to the HTML output directory. Note
1480 # that these files will be copied to the base HTML output directory. Use the
1481 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1482 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1483 # files will be copied as-is; there are no commands or markers available.
1484 # This tag requires that the tag GENERATE_HTML is set to YES.
1485
1486 HTML_EXTRA_FILES       =
1487
1488 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1489 # will adjust the colors in the style sheet and background images according to
1490 # this color. Hue is specified as an angle on a colorwheel, see
1491 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1492 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1493 # purple, and 360 is red again.
1494 # Minimum value: 0, maximum value: 359, default value: 220.
1495 # This tag requires that the tag GENERATE_HTML is set to YES.
1496
1497 HTML_COLORSTYLE_HUE    = 220
1498
1499 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1500 # in the HTML output. For a value of 0 the output will use grayscales only. A
1501 # value of 255 will produce the most vivid colors.
1502 # Minimum value: 0, maximum value: 255, default value: 100.
1503 # This tag requires that the tag GENERATE_HTML is set to YES.
1504
1505 HTML_COLORSTYLE_SAT    = 100
1506
1507 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1508 # luminance component of the colors in the HTML output. Values below 100
1509 # gradually make the output lighter, whereas values above 100 make the output
1510 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1511 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1512 # change the gamma.
1513 # Minimum value: 40, maximum value: 240, default value: 80.
1514 # This tag requires that the tag GENERATE_HTML is set to YES.
1515
1516 HTML_COLORSTYLE_GAMMA  = 80
1517
1518 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1519 # page will contain the date and time when the page was generated. Setting this
1520 # to YES can help to show when doxygen was last run and thus if the
1521 # documentation is up to date.
1522 # The default value is: NO.
1523 # This tag requires that the tag GENERATE_HTML is set to YES.
1524
1525 HTML_TIMESTAMP         = YES
1526
1527 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1528 # documentation will contain a main index with vertical navigation menus that
1529 # are dynamically created via JavaScript. If disabled, the navigation index will
1530 # consists of multiple levels of tabs that are statically embedded in every HTML
1531 # page. Disable this option to support browsers that do not have JavaScript,
1532 # like the Qt help browser.
1533 # The default value is: YES.
1534 # This tag requires that the tag GENERATE_HTML is set to YES.
1535
1536 HTML_DYNAMIC_MENUS = YES
1537
1538 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1539 # documentation will contain sections that can be hidden and shown after the
1540 # page has loaded.
1541 # The default value is: NO.
1542 # This tag requires that the tag GENERATE_HTML is set to YES.
1543
1544 HTML_DYNAMIC_SECTIONS  = NO
1545
1546 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1547 # shown in the various tree structured indices initially; the user can expand
1548 # and collapse entries dynamically later on. Doxygen will expand the tree to
1549 # such a level that at most the specified number of entries are visible (unless
1550 # a fully collapsed tree already exceeds this amount). So setting the number of
1551 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1552 # representing an infinite number of entries and will result in a full expanded
1553 # tree by default.
1554 # Minimum value: 0, maximum value: 9999, default value: 100.
1555 # This tag requires that the tag GENERATE_HTML is set to YES.
1556
1557 HTML_INDEX_NUM_ENTRIES = 100
1558
1559 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1560 # generated that can be used as input for Apple's Xcode 3 integrated development
1561 # environment (see:
1562 # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1563 # create a documentation set, doxygen will generate a Makefile in the HTML
1564 # output directory. Running make will produce the docset in that directory and
1565 # running make install will install the docset in
1566 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1567 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1568 # genXcode/_index.html for more information.
1569 # The default value is: NO.
1570 # This tag requires that the tag GENERATE_HTML is set to YES.
1571
1572 GENERATE_DOCSET        = NO
1573
1574 # This tag determines the name of the docset feed. A documentation feed provides
1575 # an umbrella under which multiple documentation sets from a single provider
1576 # (such as a company or product suite) can be grouped.
1577 # The default value is: Doxygen generated docs.
1578 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1579
1580 DOCSET_FEEDNAME        = "Doxygen generated docs"
1581
1582 # This tag specifies a string that should uniquely identify the documentation
1583 # set bundle. This should be a reverse domain-name style string, e.g.
1584 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1585 # The default value is: org.doxygen.Project.
1586 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1587
1588 DOCSET_BUNDLE_ID       = org.doxygen.Project
1589
1590 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1591 # the documentation publisher. This should be a reverse domain-name style
1592 # string, e.g. com.mycompany.MyDocSet.documentation.
1593 # The default value is: org.doxygen.Publisher.
1594 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1595
1596 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1597
1598 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1599 # The default value is: Publisher.
1600 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1601
1602 DOCSET_PUBLISHER_NAME  = Publisher
1603
1604 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1605 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1606 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1607 # (see:
1608 # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1609 #
1610 # The HTML Help Workshop contains a compiler that can convert all HTML output
1611 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1612 # files are now used as the Windows 98 help format, and will replace the old
1613 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1614 # HTML files also contain an index, a table of contents, and you can search for
1615 # words in the documentation. The HTML workshop also contains a viewer for
1616 # compressed HTML files.
1617 # The default value is: NO.
1618 # This tag requires that the tag GENERATE_HTML is set to YES.
1619
1620 GENERATE_HTMLHELP      = YES
1621
1622 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1623 # file. You can add a path in front of the file if the result should not be
1624 # written to the html output directory.
1625 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1626
1627 CHM_FILE               = dali.chm
1628
1629 # The HHC_LOCATION tag can be used to specify the location (absolute path
1630 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1631 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1632 # The file has to be specified with full path.
1633 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1634
1635 HHC_LOCATION           =
1636
1637 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1638 # (YES) or that it should be included in the main .chm file (NO).
1639 # The default value is: NO.
1640 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1641
1642 GENERATE_CHI           = NO
1643
1644 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1645 # and project file content.
1646 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1647
1648 CHM_INDEX_ENCODING     =
1649
1650 # The BINARY_TOC flag controls whether a binary table of contents is generated
1651 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1652 # enables the Previous and Next buttons.
1653 # The default value is: NO.
1654 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1655
1656 BINARY_TOC             = NO
1657
1658 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1659 # the table of contents of the HTML help documentation and to the tree view.
1660 # The default value is: NO.
1661 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1662
1663 TOC_EXPAND             = NO
1664
1665 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1666 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1667 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1668 # (.qch) of the generated HTML documentation.
1669 # The default value is: NO.
1670 # This tag requires that the tag GENERATE_HTML is set to YES.
1671
1672 GENERATE_QHP           = NO
1673
1674 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1675 # the file name of the resulting .qch file. The path specified is relative to
1676 # the HTML output folder.
1677 # This tag requires that the tag GENERATE_QHP is set to YES.
1678
1679 QCH_FILE               = "Dali.qch"
1680
1681 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1682 # Project output. For more information please see Qt Help Project / Namespace
1683 # (see:
1684 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1685 # The default value is: org.doxygen.Project.
1686 # This tag requires that the tag GENERATE_QHP is set to YES.
1687
1688 QHP_NAMESPACE          = "Dali"
1689
1690 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1691 # Help Project output. For more information please see Qt Help Project / Virtual
1692 # Folders (see:
1693 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1694 # The default value is: doc.
1695 # This tag requires that the tag GENERATE_QHP is set to YES.
1696
1697 QHP_VIRTUAL_FOLDER     = doc
1698
1699 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1700 # filter to add. For more information please see Qt Help Project / Custom
1701 # Filters (see:
1702 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1703 # This tag requires that the tag GENERATE_QHP is set to YES.
1704
1705 QHP_CUST_FILTER_NAME   =
1706
1707 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1708 # custom filter to add. For more information please see Qt Help Project / Custom
1709 # Filters (see:
1710 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1711 # This tag requires that the tag GENERATE_QHP is set to YES.
1712
1713 QHP_CUST_FILTER_ATTRS  =
1714
1715 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1716 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1717 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1718 # This tag requires that the tag GENERATE_QHP is set to YES.
1719
1720 QHP_SECT_FILTER_ATTRS  =
1721
1722 # The QHG_LOCATION tag can be used to specify the location (absolute path
1723 # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1724 # run qhelpgenerator on the generated .qhp file.
1725 # This tag requires that the tag GENERATE_QHP is set to YES.
1726
1727 QHG_LOCATION           =
1728
1729 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1730 # generated, together with the HTML files, they form an Eclipse help plugin. To
1731 # install this plugin and make it available under the help contents menu in
1732 # Eclipse, the contents of the directory containing the HTML and XML files needs
1733 # to be copied into the plugins directory of eclipse. The name of the directory
1734 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1735 # After copying Eclipse needs to be restarted before the help appears.
1736 # The default value is: NO.
1737 # This tag requires that the tag GENERATE_HTML is set to YES.
1738
1739 GENERATE_ECLIPSEHELP   = NO
1740
1741 # A unique identifier for the Eclipse help plugin. When installing the plugin
1742 # the directory name containing the HTML and XML files should also have this
1743 # name. Each documentation set should have its own identifier.
1744 # The default value is: org.doxygen.Project.
1745 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1746
1747 ECLIPSE_DOC_ID         = org.doxygen.Project
1748
1749 # If you want full control over the layout of the generated HTML pages it might
1750 # be necessary to disable the index and replace it with your own. The
1751 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1752 # of each HTML page. A value of NO enables the index and the value YES disables
1753 # it. Since the tabs in the index contain the same information as the navigation
1754 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1755 # The default value is: NO.
1756 # This tag requires that the tag GENERATE_HTML is set to YES.
1757
1758 DISABLE_INDEX          = NO
1759
1760 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1761 # structure should be generated to display hierarchical information. If the tag
1762 # value is set to YES, a side panel will be generated containing a tree-like
1763 # index structure (just like the one that is generated for HTML Help). For this
1764 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1765 # (i.e. any modern browser). Windows users are probably better off using the
1766 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1767 # further fine-tune the look of the index. As an example, the default style
1768 # sheet generated by doxygen has an example that shows how to put an image at
1769 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1770 # the same information as the tab index, you could consider setting
1771 # DISABLE_INDEX to YES when enabling this option.
1772 # The default value is: NO.
1773 # This tag requires that the tag GENERATE_HTML is set to YES.
1774
1775 GENERATE_TREEVIEW      = NONE
1776
1777 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1778 # doxygen will group on one line in the generated HTML documentation.
1779 #
1780 # Note that a value of 0 will completely suppress the enum values from appearing
1781 # in the overview section.
1782 # Minimum value: 0, maximum value: 20, default value: 4.
1783 # This tag requires that the tag GENERATE_HTML is set to YES.
1784
1785 ENUM_VALUES_PER_LINE   = 4
1786
1787 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1788 # to set the initial width (in pixels) of the frame in which the tree is shown.
1789 # Minimum value: 0, maximum value: 1500, default value: 250.
1790 # This tag requires that the tag GENERATE_HTML is set to YES.
1791
1792 TREEVIEW_WIDTH         = 250
1793
1794 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1795 # external symbols imported via tag files in a separate window.
1796 # The default value is: NO.
1797 # This tag requires that the tag GENERATE_HTML is set to YES.
1798
1799 EXT_LINKS_IN_WINDOW    = NO
1800
1801 # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1802 # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1803 # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1804 # the HTML output. These images will generally look nicer at scaled resolutions.
1805 # Possible values are: png (the default) and svg (looks nicer but requires the
1806 # pdf2svg or inkscape tool).
1807 # The default value is: png.
1808 # This tag requires that the tag GENERATE_HTML is set to YES.
1809
1810 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ HTML_FORMULA_FORMAT = png
1811
1812 # Use this tag to change the font size of LaTeX formulas included as images in
1813 # the HTML documentation. When you change the font size after a successful
1814 # doxygen run you need to manually remove any form_*.png images from the HTML
1815 # output directory to force them to be regenerated.
1816 # Minimum value: 8, maximum value: 50, default value: 10.
1817 # This tag requires that the tag GENERATE_HTML is set to YES.
1818
1819 FORMULA_FONTSIZE       = 10
1820
1821 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1822 # generated for formulas are transparent PNGs. Transparent PNGs are not
1823 # supported properly for IE 6.0, but are supported on all modern browsers.
1824 #
1825 # Note that when changing this option you need to delete any form_*.png files in
1826 # the HTML output directory before the changes have effect.
1827 # The default value is: YES.
1828 # This tag requires that the tag GENERATE_HTML is set to YES.
1829
1830 FORMULA_TRANSPARENT    = YES
1831
1832 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1833 # to create new LaTeX commands to be used in formulas as building blocks. See
1834 # the section "Including formulas" for details.
1835
1836 FORMULA_MACROFILE =
1837
1838 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1839 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1840 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1841 # installed or if you want to formulas look prettier in the HTML output. When
1842 # enabled you may also need to install MathJax separately and configure the path
1843 # to it using the MATHJAX_RELPATH option.
1844 # The default value is: NO.
1845 # This tag requires that the tag GENERATE_HTML is set to YES.
1846
1847 USE_MATHJAX            = NO
1848
1849 # When MathJax is enabled you can set the default output format to be used for
1850 # the MathJax output. See the MathJax site (see:
1851 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1852 # Possible values are: HTML-CSS (which is slower, but has the best
1853 # compatibility), NativeMML (i.e. MathML) and SVG.
1854 # The default value is: HTML-CSS.
1855 # This tag requires that the tag USE_MATHJAX is set to YES.
1856
1857 MATHJAX_FORMAT         = HTML-CSS
1858
1859 # When MathJax is enabled you need to specify the location relative to the HTML
1860 # output directory using the MATHJAX_RELPATH option. The destination directory
1861 # should contain the MathJax.js script. For instance, if the mathjax directory
1862 # is located at the same level as the HTML output directory, then
1863 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1864 # Content Delivery Network so you can quickly see the result without installing
1865 # MathJax. However, it is strongly recommended to install a local copy of
1866 # MathJax from https://www.mathjax.org before deployment.
1867 # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1868 # This tag requires that the tag USE_MATHJAX is set to YES.
1869
1870 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1871
1872 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1873 # extension names that should be enabled during MathJax rendering. For example
1874 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1875 # This tag requires that the tag USE_MATHJAX is set to YES.
1876
1877 MATHJAX_EXTENSIONS     =
1878
1879 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1880 # of code that will be used on startup of the MathJax code. See the MathJax site
1881 # (see:
1882 # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1883 # example see the documentation.
1884 # This tag requires that the tag USE_MATHJAX is set to YES.
1885
1886 MATHJAX_CODEFILE       =
1887
1888 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1889 # the HTML output. The underlying search engine uses javascript and DHTML and
1890 # should work on any modern browser. Note that when using HTML help
1891 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1892 # there is already a search function so this one should typically be disabled.
1893 # For large projects the javascript based search engine can be slow, then
1894 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1895 # search using the keyboard; to jump to the search box use <access key> + S
1896 # (what the <access key> is depends on the OS and browser, but it is typically
1897 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1898 # key> to jump into the search results window, the results can be navigated
1899 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1900 # the search. The filter options can be selected when the cursor is inside the
1901 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1902 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1903 # option.
1904 # The default value is: YES.
1905 # This tag requires that the tag GENERATE_HTML is set to YES.
1906
1907 SEARCHENGINE           = NO
1908
1909 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1910 # implemented using a web server instead of a web client using JavaScript. There
1911 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1912 # setting. When disabled, doxygen will generate a PHP script for searching and
1913 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1914 # and searching needs to be provided by external tools. See the section
1915 # "External Indexing and Searching" for details.
1916 # The default value is: NO.
1917 # This tag requires that the tag SEARCHENGINE is set to YES.
1918
1919 SERVER_BASED_SEARCH    = NO
1920
1921 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1922 # script for searching. Instead the search results are written to an XML file
1923 # which needs to be processed by an external indexer. Doxygen will invoke an
1924 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1925 # search results.
1926 #
1927 # Doxygen ships with an example indexer (doxyindexer) and search engine
1928 # (doxysearch.cgi) which are based on the open source search engine library
1929 # Xapian (see:
1930 # https://xapian.org/).
1931 #
1932 # See the section "External Indexing and Searching" for details.
1933 # The default value is: NO.
1934 # This tag requires that the tag SEARCHENGINE is set to YES.
1935
1936 EXTERNAL_SEARCH        = NO
1937
1938 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1939 # which will return the search results when EXTERNAL_SEARCH is enabled.
1940 #
1941 # Doxygen ships with an example indexer (doxyindexer) and search engine
1942 # (doxysearch.cgi) which are based on the open source search engine library
1943 # Xapian (see:
1944 # https://xapian.org/). See the section "External Indexing and Searching" for
1945 # details.
1946 # This tag requires that the tag SEARCHENGINE is set to YES.
1947
1948 SEARCHENGINE_URL       =
1949
1950 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1951 # search data is written to a file for indexing by an external tool. With the
1952 # SEARCHDATA_FILE tag the name of this file can be specified.
1953 # The default file is: searchdata.xml.
1954 # This tag requires that the tag SEARCHENGINE is set to YES.
1955
1956 SEARCHDATA_FILE        = searchdata.xml
1957
1958 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1959 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1960 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1961 # projects and redirect the results back to the right project.
1962 # This tag requires that the tag SEARCHENGINE is set to YES.
1963
1964 EXTERNAL_SEARCH_ID     =
1965
1966 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1967 # projects other than the one defined by this configuration file, but that are
1968 # all added to the same external search index. Each project needs to have a
1969 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1970 # to a relative location where the documentation can be found. The format is:
1971 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1972 # This tag requires that the tag SEARCHENGINE is set to YES.
1973
1974 EXTRA_SEARCH_MAPPINGS  =
1975
1976 #---------------------------------------------------------------------------
1977 # Configuration options related to the LaTeX output
1978 #---------------------------------------------------------------------------
1979
1980 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1981 # The default value is: YES.
1982
1983 GENERATE_LATEX         = NO
1984
1985 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1986 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1987 # it.
1988 # The default directory is: latex.
1989 # This tag requires that the tag GENERATE_LATEX is set to YES.
1990
1991 LATEX_OUTPUT           = latex
1992
1993 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1994 # invoked.
1995 #
1996 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1997 # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1998 # chosen this is overwritten by pdflatex. For specific output languages the
1999 # default can have been set differently, this depends on the implementation of
2000 # the output language.
2001 # This tag requires that the tag GENERATE_LATEX is set to YES.
2002
2003 LATEX_CMD_NAME         = latex
2004
2005 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2006 # index for LaTeX.
2007 # Note: This tag is used in the Makefile / make.bat.
2008 # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
2009 # (.tex).
2010 # The default file is: makeindex.
2011 # This tag requires that the tag GENERATE_LATEX is set to YES.
2012
2013 MAKEINDEX_CMD_NAME     = makeindex
2014
2015 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2016 # generate index for LaTeX. In case there is no backslash (\) as first character
2017 # it will be automatically added in the LaTeX code.
2018 # Note: This tag is used in the generated output file (.tex).
2019 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2020 # The default value is: makeindex.
2021 # This tag requires that the tag GENERATE_LATEX is set to YES.
2022
2023 LATEX_MAKEINDEX_CMD = makeindex
2024
2025 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
2026 # documents. This may be useful for small projects and may help to save some
2027 # trees in general.
2028 # The default value is: NO.
2029 # This tag requires that the tag GENERATE_LATEX is set to YES.
2030
2031 COMPACT_LATEX          = NO
2032
2033 # The PAPER_TYPE tag can be used to set the paper type that is used by the
2034 # printer.
2035 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
2036 # 14 inches) and executive (7.25 x 10.5 inches).
2037 # The default value is: a4.
2038 # This tag requires that the tag GENERATE_LATEX is set to YES.
2039
2040 PAPER_TYPE             = a4
2041
2042 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2043 # that should be included in the LaTeX output. The package can be specified just
2044 # by its name or with the correct syntax as to be used with the LaTeX
2045 # \usepackage command. To get the times font for instance you can specify :
2046 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
2047 # To use the option intlimits with the amsmath package you can specify:
2048 # EXTRA_PACKAGES=[intlimits]{amsmath}
2049 # If left blank no extra packages will be included.
2050 # This tag requires that the tag GENERATE_LATEX is set to YES.
2051
2052 EXTRA_PACKAGES         =
2053
2054 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
2055 # generated LaTeX document. The header should contain everything until the first
2056 # chapter. If it is left blank doxygen will generate a standard header. See
2057 # section "Doxygen usage" for information on how to let doxygen write the
2058 # default header to a separate file.
2059 #
2060 # Note: Only use a user-defined header if you know what you are doing! The
2061 # following commands have a special meaning inside the header: $title,
2062 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
2063 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
2064 # string, for the replacement values of the other commands the user is referred
2065 # to HTML_HEADER.
2066 # This tag requires that the tag GENERATE_LATEX is set to YES.
2067
2068 LATEX_HEADER           =
2069
2070 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
2071 # generated LaTeX document. The footer should contain everything after the last
2072 # chapter. If it is left blank doxygen will generate a standard footer. See
2073 # LATEX_HEADER for more information on how to generate a default footer and what
2074 # special commands can be used inside the footer.
2075 #
2076 # Note: Only use a user-defined footer if you know what you are doing!
2077 # This tag requires that the tag GENERATE_LATEX is set to YES.
2078
2079 LATEX_FOOTER           =
2080
2081 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2082 # LaTeX style sheets that are included after the standard style sheets created
2083 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
2084 # will copy the style sheet files to the output directory.
2085 # Note: The order of the extra style sheet files is of importance (e.g. the last
2086 # style sheet in the list overrules the setting of the previous ones in the
2087 # list).
2088 # This tag requires that the tag GENERATE_LATEX is set to YES.
2089
2090 LATEX_EXTRA_STYLESHEET =
2091
2092 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2093 # other source files which should be copied to the LATEX_OUTPUT output
2094 # directory. Note that the files will be copied as-is; there are no commands or
2095 # markers available.
2096 # This tag requires that the tag GENERATE_LATEX is set to YES.
2097
2098 LATEX_EXTRA_FILES      =
2099
2100 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2101 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2102 # contain links (just like the HTML output) instead of page references. This
2103 # makes the output suitable for online browsing using a PDF viewer.
2104 # The default value is: YES.
2105 # This tag requires that the tag GENERATE_LATEX is set to YES.
2106
2107 PDF_HYPERLINKS         = YES
2108
2109 # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2110 # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2111 # files. Set this option to YES, to get a higher quality PDF documentation.
2112 #
2113 # See also section LATEX_CMD_NAME for selecting the engine.
2114 # The default value is: YES.
2115 # This tag requires that the tag GENERATE_LATEX is set to YES.
2116
2117 USE_PDFLATEX           = YES
2118
2119 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2120 # command to the generated LaTeX files. This will instruct LaTeX to keep running
2121 # if errors occur, instead of asking the user for help. This option is also used
2122 # when generating formulas in HTML.
2123 # The default value is: NO.
2124 # This tag requires that the tag GENERATE_LATEX is set to YES.
2125
2126 LATEX_BATCHMODE        = NO
2127
2128 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2129 # index chapters (such as File Index, Compound Index, etc.) in the output.
2130 # The default value is: NO.
2131 # This tag requires that the tag GENERATE_LATEX is set to YES.
2132
2133 LATEX_HIDE_INDICES     = NO
2134
2135 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
2136 # code with syntax highlighting in the LaTeX output.
2137 #
2138 # Note that which sources are shown also depends on other settings such as
2139 # SOURCE_BROWSER.
2140 # The default value is: NO.
2141 # This tag requires that the tag GENERATE_LATEX is set to YES.
2142
2143 LATEX_SOURCE_CODE      = NO
2144
2145 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2146 # bibliography, e.g. plainnat, or ieeetr. See
2147 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2148 # The default value is: plain.
2149 # This tag requires that the tag GENERATE_LATEX is set to YES.
2150
2151 LATEX_BIB_STYLE        = plain
2152
2153 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2154 # page will contain the date and time when the page was generated. Setting this
2155 # to NO can help when comparing the output of multiple runs.
2156 # The default value is: NO.
2157 # This tag requires that the tag GENERATE_LATEX is set to YES.
2158
2159 LATEX_TIMESTAMP        = NO
2160
2161 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2162 # path from which the emoji images will be read. If a relative path is entered,
2163 # it will be relative to the LATEX_OUTPUT directory. If left blank the
2164 # LATEX_OUTPUT directory will be used.
2165 # This tag requires that the tag GENERATE_LATEX is set to YES.
2166
2167 LATEX_EMOJI_DIRECTORY =
2168
2169 #---------------------------------------------------------------------------
2170 # Configuration options related to the RTF output
2171 #---------------------------------------------------------------------------
2172
2173 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2174 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
2175 # readers/editors.
2176 # The default value is: NO.
2177
2178 GENERATE_RTF           = NO
2179
2180 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2181 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2182 # it.
2183 # The default directory is: rtf.
2184 # This tag requires that the tag GENERATE_RTF is set to YES.
2185
2186 RTF_OUTPUT             = rtf
2187
2188 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2189 # documents. This may be useful for small projects and may help to save some
2190 # trees in general.
2191 # The default value is: NO.
2192 # This tag requires that the tag GENERATE_RTF is set to YES.
2193
2194 COMPACT_RTF            = NO
2195
2196 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2197 # contain hyperlink fields. The RTF file will contain links (just like the HTML
2198 # output) instead of page references. This makes the output suitable for online
2199 # browsing using Word or some other Word compatible readers that support those
2200 # fields.
2201 #
2202 # Note: WordPad (write) and others do not support links.
2203 # The default value is: NO.
2204 # This tag requires that the tag GENERATE_RTF is set to YES.
2205
2206 RTF_HYPERLINKS         = NO
2207
2208 # Load stylesheet definitions from file. Syntax is similar to doxygen's
2209 # configuration file, i.e. a series of assignments. You only have to provide
2210 # replacements, missing definitions are set to their default value.
2211 #
2212 # See also section "Doxygen usage" for information on how to generate the
2213 # default style sheet that doxygen normally uses.
2214 # This tag requires that the tag GENERATE_RTF is set to YES.
2215
2216 RTF_STYLESHEET_FILE    =
2217
2218 # Set optional variables used in the generation of an RTF document. Syntax is
2219 # similar to doxygen's configuration file. A template extensions file can be
2220 # generated using doxygen -e rtf extensionFile.
2221 # This tag requires that the tag GENERATE_RTF is set to YES.
2222
2223 RTF_EXTENSIONS_FILE    =
2224
2225 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
2226 # with syntax highlighting in the RTF output.
2227 #
2228 # Note that which sources are shown also depends on other settings such as
2229 # SOURCE_BROWSER.
2230 # The default value is: NO.
2231 # This tag requires that the tag GENERATE_RTF is set to YES.
2232
2233 RTF_SOURCE_CODE        = NO
2234
2235 #---------------------------------------------------------------------------
2236 # Configuration options related to the man page output
2237 #---------------------------------------------------------------------------
2238
2239 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2240 # classes and files.
2241 # The default value is: NO.
2242
2243 GENERATE_MAN           = NO
2244
2245 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2246 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2247 # it. A directory man3 will be created inside the directory specified by
2248 # MAN_OUTPUT.
2249 # The default directory is: man.
2250 # This tag requires that the tag GENERATE_MAN is set to YES.
2251
2252 MAN_OUTPUT             = man
2253
2254 # The MAN_EXTENSION tag determines the extension that is added to the generated
2255 # man pages. In case the manual section does not start with a number, the number
2256 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2257 # optional.
2258 # The default value is: .3.
2259 # This tag requires that the tag GENERATE_MAN is set to YES.
2260
2261 MAN_EXTENSION          = .3
2262
2263 # The MAN_SUBDIR tag determines the name of the directory created within
2264 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2265 # MAN_EXTENSION with the initial . removed.
2266 # This tag requires that the tag GENERATE_MAN is set to YES.
2267
2268 MAN_SUBDIR             =
2269
2270 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2271 # will generate one additional man file for each entity documented in the real
2272 # man page(s). These additional files only source the real man page, but without
2273 # them the man command would be unable to find the correct page.
2274 # The default value is: NO.
2275 # This tag requires that the tag GENERATE_MAN is set to YES.
2276
2277 MAN_LINKS              = NO
2278
2279 #---------------------------------------------------------------------------
2280 # Configuration options related to the XML output
2281 #---------------------------------------------------------------------------
2282
2283 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2284 # captures the structure of the code including all documentation.
2285 # The default value is: NO.
2286
2287 GENERATE_XML           = NO
2288
2289 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2290 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2291 # it.
2292 # The default directory is: xml.
2293 # This tag requires that the tag GENERATE_XML is set to YES.
2294
2295 XML_OUTPUT             = xml
2296
2297 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2298 # listings (including syntax highlighting and cross-referencing information) to
2299 # the XML output. Note that enabling this will significantly increase the size
2300 # of the XML output.
2301 # The default value is: YES.
2302 # This tag requires that the tag GENERATE_XML is set to YES.
2303
2304 XML_PROGRAMLISTING     = YES
2305
2306 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2307 # namespace members in file scope as well, matching the HTML output.
2308 # The default value is: NO.
2309 # This tag requires that the tag GENERATE_XML is set to YES.
2310
2311 XML_NS_MEMB_FILE_SCOPE = NO
2312
2313 #---------------------------------------------------------------------------
2314 # Configuration options related to the DOCBOOK output
2315 #---------------------------------------------------------------------------
2316
2317 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2318 # that can be used to generate PDF.
2319 # The default value is: NO.
2320
2321 GENERATE_DOCBOOK       = NO
2322
2323 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2324 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2325 # front of it.
2326 # The default directory is: docbook.
2327 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2328
2329 DOCBOOK_OUTPUT         = docbook
2330
2331 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2332 # program listings (including syntax highlighting and cross-referencing
2333 # information) to the DOCBOOK output. Note that enabling this will significantly
2334 # increase the size of the DOCBOOK output.
2335 # The default value is: NO.
2336 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2337
2338 DOCBOOK_PROGRAMLISTING = NO
2339
2340 #---------------------------------------------------------------------------
2341 # Configuration options for the AutoGen Definitions output
2342 #---------------------------------------------------------------------------
2343
2344 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2345 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2346 # the structure of the code including all documentation. Note that this feature
2347 # is still experimental and incomplete at the moment.
2348 # The default value is: NO.
2349
2350 GENERATE_AUTOGEN_DEF   = NO
2351
2352 #---------------------------------------------------------------------------
2353 # Configuration options related to the Perl module output
2354 #---------------------------------------------------------------------------
2355
2356 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2357 # file that captures the structure of the code including all documentation.
2358 #
2359 # Note that this feature is still experimental and incomplete at the moment.
2360 # The default value is: NO.
2361
2362 GENERATE_PERLMOD       = NO
2363
2364 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2365 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2366 # output from the Perl module output.
2367 # The default value is: NO.
2368 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2369
2370 PERLMOD_LATEX          = NO
2371
2372 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2373 # formatted so it can be parsed by a human reader. This is useful if you want to
2374 # understand what is going on. On the other hand, if this tag is set to NO, the
2375 # size of the Perl module output will be much smaller and Perl will parse it
2376 # just the same.
2377 # The default value is: YES.
2378 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2379
2380 PERLMOD_PRETTY         = YES
2381
2382 # The names of the make variables in the generated doxyrules.make file are
2383 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2384 # so different doxyrules.make files included by the same Makefile don't
2385 # overwrite each other's variables.
2386 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2387
2388 PERLMOD_MAKEVAR_PREFIX =
2389
2390 #---------------------------------------------------------------------------
2391 # Configuration options related to the preprocessor
2392 #---------------------------------------------------------------------------
2393
2394 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2395 # C-preprocessor directives found in the sources and include files.
2396 # The default value is: YES.
2397
2398 ENABLE_PREPROCESSING   = YES
2399
2400 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2401 # in the source code. If set to NO, only conditional compilation will be
2402 # performed. Macro expansion can be done in a controlled way by setting
2403 # EXPAND_ONLY_PREDEF to YES.
2404 # The default value is: NO.
2405 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2406
2407 MACRO_EXPANSION        = YES
2408
2409 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2410 # the macro expansion is limited to the macros specified with the PREDEFINED and
2411 # EXPAND_AS_DEFINED tags.
2412 # The default value is: NO.
2413 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2414
2415 EXPAND_ONLY_PREDEF     = YES
2416
2417 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2418 # INCLUDE_PATH will be searched if a #include is found.
2419 # The default value is: YES.
2420 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2421
2422 SEARCH_INCLUDES        = YES
2423
2424 # The INCLUDE_PATH tag can be used to specify one or more directories that
2425 # contain include files that are not input files but should be processed by the
2426 # preprocessor.
2427 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2428
2429 INCLUDE_PATH           =
2430
2431 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2432 # patterns (like *.h and *.hpp) to filter out the header-files in the
2433 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2434 # used.
2435 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2436
2437 INCLUDE_FILE_PATTERNS  =
2438
2439 # The PREDEFINED tag can be used to specify one or more macro names that are
2440 # defined before the preprocessor is started (similar to the -D option of e.g.
2441 # gcc). The argument of the tag is a list of macros of the form: name or
2442 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2443 # is assumed. To prevent a macro definition from being undefined via #undef or
2444 # recursively expanded use the := operator instead of the = operator.
2445 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2446
2447 PREDEFINED             = DALI_CORE_API \
2448                          DALI_ADAPTOR_API \
2449                          DALI_TOOLKIT_API \
2450                          DALI_SCENE3D_API \
2451                          DALI_INTERNAL \
2452
2453 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2454 # tag can be used to specify a list of macro names that should be expanded. The
2455 # macro definition that is found in the sources will be used. Use the PREDEFINED
2456 # tag if you want to use a different macro definition that overrules the
2457 # definition found in the source code.
2458 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2459
2460 EXPAND_AS_DEFINED      =
2461
2462 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2463 # remove all references to function-like macros that are alone on a line, have
2464 # an all uppercase name, and do not end with a semicolon. Such function macros
2465 # are typically used for boiler-plate code, and will confuse the parser if not
2466 # removed.
2467 # The default value is: YES.
2468 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2469
2470 SKIP_FUNCTION_MACROS   = YES
2471
2472 #---------------------------------------------------------------------------
2473 # Configuration options related to external references
2474 #---------------------------------------------------------------------------
2475
2476 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2477 # file the location of the external documentation should be added. The format of
2478 # a tag file without this location is as follows:
2479 # TAGFILES = file1 file2 ...
2480 # Adding location for the tag files is done as follows:
2481 # TAGFILES = file1=loc1 "file2 = loc2" ...
2482 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2483 # section "Linking to external documentation" for more information about the use
2484 # of tag files.
2485 # Note: Each tag file must have a unique name (where the name does NOT include
2486 # the path). If a tag file is not located in the directory in which doxygen is
2487 # run, you must also specify the path to the tagfile here.
2488
2489 TAGFILES               =
2490
2491 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2492 # tag file that is based on the input files it reads. See section "Linking to
2493 # external documentation" for more information about the usage of tag files.
2494
2495 GENERATE_TAGFILE       =
2496
2497 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2498 # the class index. If set to NO, only the inherited external classes will be
2499 # listed.
2500 # The default value is: NO.
2501
2502 ALLEXTERNALS           = NO
2503
2504 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2505 # in the modules index. If set to NO, only the current project's groups will be
2506 # listed.
2507 # The default value is: YES.
2508
2509 EXTERNAL_GROUPS        = YES
2510
2511 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2512 # the related pages index. If set to NO, only the current project's pages will
2513 # be listed.
2514 # The default value is: YES.
2515
2516 EXTERNAL_PAGES         = YES
2517
2518 #---------------------------------------------------------------------------
2519 # Configuration options related to the dot tool
2520 #---------------------------------------------------------------------------
2521
2522 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2523 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2524 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2525 # disabled, but it is recommended to install and use dot, since it yields more
2526 # powerful graphs.
2527 # The default value is: YES.
2528
2529 CLASS_DIAGRAMS         = YES
2530
2531 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2532 # then run dia to produce the diagram and insert it in the documentation. The
2533 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2534 # If left empty dia is assumed to be found in the default search path.
2535
2536 DIA_PATH               =
2537
2538 # If set to YES the inheritance and collaboration graphs will hide inheritance
2539 # and usage relations if the target is undocumented or is not a class.
2540 # The default value is: YES.
2541
2542 HIDE_UNDOC_RELATIONS   = YES
2543
2544 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2545 # available from the path. This tool is part of Graphviz (see:
2546 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2547 # Bell Labs. The other options in this section have no effect if this option is
2548 # set to NO
2549 # The default value is: YES.
2550
2551 HAVE_DOT               = NO
2552
2553 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2554 # to run in parallel. When set to 0 doxygen will base this on the number of
2555 # processors available in the system. You can set it explicitly to a value
2556 # larger than 0 to get control over the balance between CPU load and processing
2557 # speed.
2558 # Minimum value: 0, maximum value: 32, default value: 0.
2559 # This tag requires that the tag HAVE_DOT is set to YES.
2560
2561 DOT_NUM_THREADS        = 0
2562
2563 # When you want a differently looking font in the dot files that doxygen
2564 # generates you can specify the font name using DOT_FONTNAME. You need to make
2565 # sure dot is able to find the font, which can be done by putting it in a
2566 # standard location or by setting the DOTFONTPATH environment variable or by
2567 # setting DOT_FONTPATH to the directory containing the font.
2568 # The default value is: Helvetica.
2569 # This tag requires that the tag HAVE_DOT is set to YES.
2570
2571 DOT_FONTNAME           =
2572
2573 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2574 # dot graphs.
2575 # Minimum value: 4, maximum value: 24, default value: 10.
2576 # This tag requires that the tag HAVE_DOT is set to YES.
2577
2578 DOT_FONTSIZE           = 10
2579
2580 # By default doxygen will tell dot to use the default font as specified with
2581 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2582 # the path where dot can find it using this tag.
2583 # This tag requires that the tag HAVE_DOT is set to YES.
2584
2585 DOT_FONTPATH           =
2586
2587 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2588 # each documented class showing the direct and indirect inheritance relations.
2589 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2590 # The default value is: YES.
2591 # This tag requires that the tag HAVE_DOT is set to YES.
2592
2593 CLASS_GRAPH            = YES
2594
2595 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2596 # graph for each documented class showing the direct and indirect implementation
2597 # dependencies (inheritance, containment, and class references variables) of the
2598 # class with other documented classes.
2599 # The default value is: YES.
2600 # This tag requires that the tag HAVE_DOT is set to YES.
2601
2602 COLLABORATION_GRAPH    = YES
2603
2604 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2605 # groups, showing the direct groups dependencies.
2606 # The default value is: YES.
2607 # This tag requires that the tag HAVE_DOT is set to YES.
2608
2609 GROUP_GRAPHS           = YES
2610
2611 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2612 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2613 # Language.
2614 # The default value is: NO.
2615 # This tag requires that the tag HAVE_DOT is set to YES.
2616
2617 UML_LOOK               = NO
2618
2619 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2620 # class node. If there are many fields or methods and many nodes the graph may
2621 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2622 # number of items for each type to make the size more manageable. Set this to 0
2623 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2624 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2625 # but if the number exceeds 15, the total amount of fields shown is limited to
2626 # 10.
2627 # Minimum value: 0, maximum value: 100, default value: 10.
2628 # This tag requires that the tag UML_LOOK is set to YES.
2629
2630 UML_LIMIT_NUM_FIELDS = 10
2631
2632 # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2633 # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2634 # tag is set to YES, doxygen will add type and arguments for attributes and
2635 # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2636 # will not generate fields with class member information in the UML graphs. The
2637 # class diagrams will look similar to the default class diagrams but using UML
2638 # notation for the relationships.
2639 # Possible values are: NO, YES and NONE.
2640 # The default value is: NO.
2641 # This tag requires that the tag UML_LOOK is set to YES.
2642
2643 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ DOT_UML_DETAILS = NO
2644
2645 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2646 # to display on a single line. If the actual line length exceeds this threshold
2647 # significantly it will wrapped across multiple lines. Some heuristics are apply
2648 # to avoid ugly line breaks.
2649 # Minimum value: 0, maximum value: 1000, default value: 17.
2650 # This tag requires that the tag HAVE_DOT is set to YES.
2651
2652 @DOXYGEN_VERSION_LESS_1_9_1_BLOCKED@ DOT_WRAP_THRESHOLD = 17
2653
2654 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2655 # collaboration graphs will show the relations between templates and their
2656 # instances.
2657 # The default value is: NO.
2658 # This tag requires that the tag HAVE_DOT is set to YES.
2659
2660 TEMPLATE_RELATIONS     = NO
2661
2662 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2663 # YES then doxygen will generate a graph for each documented file showing the
2664 # direct and indirect include dependencies of the file with other documented
2665 # files.
2666 # The default value is: YES.
2667 # This tag requires that the tag HAVE_DOT is set to YES.
2668
2669 INCLUDE_GRAPH          = YES
2670
2671 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2672 # set to YES then doxygen will generate a graph for each documented file showing
2673 # the direct and indirect include dependencies of the file with other documented
2674 # files.
2675 # The default value is: YES.
2676 # This tag requires that the tag HAVE_DOT is set to YES.
2677
2678 INCLUDED_BY_GRAPH      = YES
2679
2680 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2681 # dependency graph for every global function or class method.
2682 #
2683 # Note that enabling this option will significantly increase the time of a run.
2684 # So in most cases it will be better to enable call graphs for selected
2685 # functions only using the \callgraph command. Disabling a call graph can be
2686 # accomplished by means of the command \hidecallgraph.
2687 # The default value is: NO.
2688 # This tag requires that the tag HAVE_DOT is set to YES.
2689
2690 CALL_GRAPH             = NO
2691
2692 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2693 # dependency graph for every global function or class method.
2694 #
2695 # Note that enabling this option will significantly increase the time of a run.
2696 # So in most cases it will be better to enable caller graphs for selected
2697 # functions only using the \callergraph command. Disabling a caller graph can be
2698 # accomplished by means of the command \hidecallergraph.
2699 # The default value is: NO.
2700 # This tag requires that the tag HAVE_DOT is set to YES.
2701
2702 CALLER_GRAPH           = NO
2703
2704 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2705 # hierarchy of all classes instead of a textual one.
2706 # The default value is: YES.
2707 # This tag requires that the tag HAVE_DOT is set to YES.
2708
2709 GRAPHICAL_HIERARCHY    = YES
2710
2711 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2712 # dependencies a directory has on other directories in a graphical way. The
2713 # dependency relations are determined by the #include relations between the
2714 # files in the directories.
2715 # The default value is: YES.
2716 # This tag requires that the tag HAVE_DOT is set to YES.
2717
2718 DIRECTORY_GRAPH        = YES
2719
2720 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2721 # generated by dot. For an explanation of the image formats see the section
2722 # output formats in the documentation of the dot tool (Graphviz (see:
2723 # http://www.graphviz.org/)).
2724 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2725 # to make the SVG files visible in IE 9+ (other browsers do not have this
2726 # requirement).
2727 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2728 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2729 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2730 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2731 # png:gdiplus:gdiplus.
2732 # The default value is: png.
2733 # This tag requires that the tag HAVE_DOT is set to YES.
2734
2735 DOT_IMAGE_FORMAT       = png
2736
2737 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2738 # enable generation of interactive SVG images that allow zooming and panning.
2739 #
2740 # Note that this requires a modern browser other than Internet Explorer. Tested
2741 # and working are Firefox, Chrome, Safari, and Opera.
2742 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2743 # the SVG files visible. Older versions of IE do not have SVG support.
2744 # The default value is: NO.
2745 # This tag requires that the tag HAVE_DOT is set to YES.
2746
2747 INTERACTIVE_SVG        = NO
2748
2749 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2750 # found. If left blank, it is assumed the dot tool can be found in the path.
2751 # This tag requires that the tag HAVE_DOT is set to YES.
2752
2753 DOT_PATH               =
2754
2755 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2756 # contain dot files that are included in the documentation (see the \dotfile
2757 # command).
2758 # This tag requires that the tag HAVE_DOT is set to YES.
2759
2760 DOTFILE_DIRS           =
2761
2762 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2763 # contain msc files that are included in the documentation (see the \mscfile
2764 # command).
2765
2766 MSCFILE_DIRS           =
2767
2768 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2769 # contain dia files that are included in the documentation (see the \diafile
2770 # command).
2771
2772 DIAFILE_DIRS           =
2773
2774 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2775 # path where java can find the plantuml.jar file. If left blank, it is assumed
2776 # PlantUML is not used or called during a preprocessing step. Doxygen will
2777 # generate a warning when it encounters a \startuml command in this case and
2778 # will not generate output for the diagram.
2779
2780 PLANTUML_JAR_PATH      =
2781
2782 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2783 # configuration file for plantuml.
2784
2785 PLANTUML_CFG_FILE =
2786
2787 # When using plantuml, the specified paths are searched for files specified by
2788 # the !include statement in a plantuml block.
2789
2790 PLANTUML_INCLUDE_PATH  =
2791
2792 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2793 # that will be shown in the graph. If the number of nodes in a graph becomes
2794 # larger than this value, doxygen will truncate the graph, which is visualized
2795 # by representing a node as a red box. Note that doxygen if the number of direct
2796 # children of the root node in a graph is already larger than
2797 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2798 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2799 # Minimum value: 0, maximum value: 10000, default value: 50.
2800 # This tag requires that the tag HAVE_DOT is set to YES.
2801
2802 DOT_GRAPH_MAX_NODES    = 50
2803
2804 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2805 # generated by dot. A depth value of 3 means that only nodes reachable from the
2806 # root by following a path via at most 3 edges will be shown. Nodes that lay
2807 # further from the root node will be omitted. Note that setting this option to 1
2808 # or 2 may greatly reduce the computation time needed for large code bases. Also
2809 # note that the size of a graph can be further restricted by
2810 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2811 # Minimum value: 0, maximum value: 1000, default value: 0.
2812 # This tag requires that the tag HAVE_DOT is set to YES.
2813
2814 MAX_DOT_GRAPH_DEPTH    = 0
2815
2816 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2817 # background. This is disabled by default, because dot on Windows does not seem
2818 # to support this out of the box.
2819 #
2820 # Warning: Depending on the platform used, enabling this option may lead to
2821 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2822 # read).
2823 # The default value is: NO.
2824 # This tag requires that the tag HAVE_DOT is set to YES.
2825
2826 DOT_TRANSPARENT        = NO
2827
2828 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2829 # files in one run (i.e. multiple -o and -T options on the command line). This
2830 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2831 # this, this feature is disabled by default.
2832 # The default value is: NO.
2833 # This tag requires that the tag HAVE_DOT is set to YES.
2834
2835 DOT_MULTI_TARGETS      = NO
2836
2837 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2838 # explaining the meaning of the various boxes and arrows in the dot generated
2839 # graphs.
2840 # The default value is: YES.
2841 # This tag requires that the tag HAVE_DOT is set to YES.
2842
2843 GENERATE_LEGEND        = YES
2844
2845 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2846 # files that are used to generate the various graphs.
2847 #
2848 # Note: This setting is not only used for dot files but also for msc and
2849 # plantuml temporary files.
2850 # The default value is: YES.
2851
2852 DOT_CLEANUP            = YES