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