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