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