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