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