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