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