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