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