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