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