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