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