[dali_1.0.17] Merge branch 'tizen'
[platform/core/uifw/dali-toolkit.git] / build / tizen / docs / dali.doxy.in
1 # Doxyfile 1.5.8
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 hash (#) is considered a comment and will be ignored
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING      = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME           = Dali
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33
34 PROJECT_NUMBER         =
35
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
40
41 OUTPUT_DIRECTORY       = @DOXYGEN_DOCS_DIR@/generated
42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49
50 CREATE_SUBDIRS         = NO
51
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
61 # Spanish, Swedish, and Ukrainian.
62
63 OUTPUT_LANGUAGE        = English
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC      = YES
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF           = YES
78
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88
89 ABBREVIATE_BRIEF       = "The $name class" \
90                          "The $name widget" \
91                          "The $name file" \
92                          is \
93                          provides \
94                          specifies \
95                          contains \
96                          represents \
97                          a \
98                          an \
99                          the
100
101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102 # Doxygen will generate a detailed section even if there is only a brief
103 # description.
104
105 ALWAYS_DETAILED_SEC    = NO
106
107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108 # inherited members of a class in the documentation of that class as if those
109 # members were ordinary class members. Constructors, destructors and assignment
110 # operators of the base classes will not be shown.
111
112 INLINE_INHERITED_MEMB  = NO
113
114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115 # path before files name in the file list and in the header files. If set
116 # to NO the shortest path that makes the file name unique will be used.
117
118 FULL_PATH_NAMES        = YES
119
120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121 # can be used to strip a user-defined part of the path. Stripping is
122 # only done if one of the specified strings matches the left-hand part of
123 # the path. The tag can be used to show relative paths in the file list.
124 # If left blank the directory from which doxygen is run is used as the
125 # path to strip.
126
127 STRIP_FROM_PATH        = .
128
129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130 # the path mentioned in the documentation of a class, which tells
131 # the reader which header file to include in order to use a class.
132 # If left blank only the name of the header file containing the class
133 # definition is used. Otherwise one should specify the include paths that
134 # are normally passed to the compiler using the -I flag.
135
136 STRIP_FROM_INC_PATH    =
137
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # (but less readable) file names. This can be useful is your file systems
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
141
142 SHORT_NAMES            = NO
143
144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145 # will interpret the first line (until the first dot) of a JavaDoc-style
146 # comment as the brief description. If set to NO, the JavaDoc
147 # comments will behave just like regular Qt-style comments
148 # (thus requiring an explicit @brief command for a brief description.)
149
150 JAVADOC_AUTOBRIEF      = YES
151
152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153 # interpret the first line (until the first dot) of a Qt-style
154 # comment as the brief description. If set to NO, the comments
155 # will behave just like regular Qt-style comments (thus requiring
156 # an explicit \brief command for a brief description.)
157
158 QT_AUTOBRIEF           = NO
159
160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
162 # comments) as a brief description. This used to be the default behaviour.
163 # The new default is to treat a multi-line C++ comment block as a detailed
164 # description. Set this tag to YES if you prefer the old behaviour instead.
165
166 MULTILINE_CPP_IS_BRIEF = NO
167
168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169 # member inherits the documentation from any documented member that it
170 # re-implements.
171
172 INHERIT_DOCS           = YES
173
174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175 # a new page for each member. If set to NO, the documentation of a member will
176 # be part of the file/class/namespace that contains it.
177
178 SEPARATE_MEMBER_PAGES  = NO
179
180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
181 # Doxygen uses this value to replace tabs by spaces in code fragments.
182
183 TAB_SIZE               = 2
184
185 # This tag can be used to specify a number of aliases that acts
186 # as commands in the documentation. An alias has the form "name=value".
187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
188 # put the command \sideeffect (or @sideeffect) in the documentation, which
189 # will result in a user-defined paragraph with heading "Side Effects:".
190 # You can put \n's in the value part of an alias to insert newlines.
191
192 ALIASES                =
193
194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195 # sources only. Doxygen will then generate output that is more tailored for C.
196 # For instance, some of the names that are used will be different. The list
197 # of all members will be omitted, etc.
198
199 OPTIMIZE_OUTPUT_FOR_C  = NO
200
201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202 # sources only. Doxygen will then generate output that is more tailored for
203 # Java. For instance, namespaces will be presented as packages, qualified
204 # scopes will look different, etc.
205
206 OPTIMIZE_OUTPUT_JAVA   = NO
207
208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209 # sources only. Doxygen will then generate output that is more tailored for
210 # Fortran.
211
212 OPTIMIZE_FOR_FORTRAN   = NO
213
214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215 # sources. Doxygen will then generate output that is tailored for
216 # VHDL.
217
218 OPTIMIZE_OUTPUT_VHDL   = NO
219
220 # Doxygen selects the parser to use depending on the extension of the files it parses.
221 # With this tag you can assign which parser to use for a given extension.
222 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
223 # The format is ext=language, where ext is a file extension, and language is one of
224 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227 # use: inc=Fortran f=C
228
229 EXTENSION_MAPPING      =
230
231 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
232 # to include (a tag file for) the STL sources as input, then you should
233 # set this tag to YES in order to let doxygen match functions declarations and
234 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
235 # func(std::string) {}). This also make the inheritance and collaboration
236 # diagrams that involve STL classes more complete and accurate.
237
238 BUILTIN_STL_SUPPORT    = YES
239
240 # If you use Microsoft's C++/CLI language, you should set this option to YES to
241 # enable parsing support.
242
243 CPP_CLI_SUPPORT        = NO
244
245 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
246 # Doxygen will parse them like normal C++ but will assume all classes use public
247 # instead of private inheritance when no explicit protection keyword is present.
248
249 SIP_SUPPORT            = NO
250
251 # For Microsoft's IDL there are propget and propput attributes to indicate getter
252 # and setter methods for a property. Setting this option to YES (the default)
253 # will make doxygen to replace the get and set methods by a property in the
254 # documentation. This will only work if the methods are indeed getting or
255 # setting a simple type. If this is not the case, or you want to show the
256 # methods anyway, you should set this option to NO.
257
258 IDL_PROPERTY_SUPPORT   = YES
259
260 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
261 # tag is set to YES, then doxygen will reuse the documentation of the first
262 # member in the group (if any) for the other members of the group. By default
263 # all members of a group must be documented explicitly.
264
265 DISTRIBUTE_GROUP_DOC   = NO
266
267 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
268 # the same type (for instance a group of public functions) to be put as a
269 # subgroup of that type (e.g. under the Public Functions section). Set it to
270 # NO to prevent subgrouping. Alternatively, this can be done per class using
271 # the \nosubgrouping command.
272
273 SUBGROUPING            = YES
274
275 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
276 # is documented as struct, union, or enum with the name of the typedef. So
277 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
278 # with name TypeT. When disabled the typedef will appear as a member of a file,
279 # namespace, or class. And the struct will be named TypeS. This can typically
280 # be useful for C code in case the coding convention dictates that all compound
281 # types are typedef'ed and only the typedef is referenced, never the tag name.
282
283 TYPEDEF_HIDES_STRUCT   = NO
284
285 #---------------------------------------------------------------------------
286 # Build related configuration options
287 #---------------------------------------------------------------------------
288
289 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
290 # documentation are documented, even if no documentation was available.
291 # Private class members and static file members will be hidden unless
292 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
293
294 EXTRACT_ALL            = YES
295
296 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
297 # will be included in the documentation.
298
299 EXTRACT_PRIVATE        = YES
300
301 # If the EXTRACT_STATIC tag is set to YES all static members of a file
302 # will be included in the documentation.
303
304 EXTRACT_STATIC         = YES
305
306 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
307 # defined locally in source files will be included in the documentation.
308 # If set to NO only classes defined in header files are included.
309
310 EXTRACT_LOCAL_CLASSES  = YES
311
312 # This flag is only useful for Objective-C code. When set to YES local
313 # methods, which are defined in the implementation section but not in
314 # the interface are included in the documentation.
315 # If set to NO (the default) only methods in the interface are included.
316
317 EXTRACT_LOCAL_METHODS  = NO
318
319 # If this flag is set to YES, the members of anonymous namespaces will be
320 # extracted and appear in the documentation as a namespace called
321 # 'anonymous_namespace{file}', where file will be replaced with the base
322 # name of the file that contains the anonymous namespace. By default
323 # anonymous namespace are hidden.
324
325 EXTRACT_ANON_NSPACES   = NO
326
327 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
328 # undocumented members of documented classes, files or namespaces.
329 # If set to NO (the default) these members will be included in the
330 # various overviews, but no documentation section is generated.
331 # This option has no effect if EXTRACT_ALL is enabled.
332
333 HIDE_UNDOC_MEMBERS     = NO
334
335 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
336 # undocumented classes that are normally visible in the class hierarchy.
337 # If set to NO (the default) these classes will be included in the various
338 # overviews. This option has no effect if EXTRACT_ALL is enabled.
339
340 HIDE_UNDOC_CLASSES     = NO
341
342 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
343 # friend (class|struct|union) declarations.
344 # If set to NO (the default) these declarations will be included in the
345 # documentation.
346
347 HIDE_FRIEND_COMPOUNDS  = NO
348
349 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
350 # documentation blocks found inside the body of a function.
351 # If set to NO (the default) these blocks will be appended to the
352 # function's detailed documentation block.
353
354 HIDE_IN_BODY_DOCS      = NO
355
356 # The INTERNAL_DOCS tag determines if documentation
357 # that is typed after a \internal command is included. If the tag is set
358 # to NO (the default) then the documentation will be excluded.
359 # Set it to YES to include the internal documentation.
360
361 INTERNAL_DOCS          = NO
362
363 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
364 # file names in lower-case letters. If set to YES upper-case letters are also
365 # allowed. This is useful if you have classes or files whose names only differ
366 # in case and if your file system supports case sensitive file names. Windows
367 # and Mac users are advised to set this option to NO.
368
369 CASE_SENSE_NAMES       = NO
370
371 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
372 # will show members with their full class and namespace scopes in the
373 # documentation. If set to YES the scope will be hidden.
374
375 HIDE_SCOPE_NAMES       = NO
376
377 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
378 # will put a list of the files that are included by a file in the documentation
379 # of that file.
380
381 SHOW_INCLUDE_FILES     = YES
382
383 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
384 # is inserted in the documentation for inline members.
385
386 INLINE_INFO            = YES
387
388 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
389 # will sort the (detailed) documentation of file and class members
390 # alphabetically by member name. If set to NO the members will appear in
391 # declaration order.
392
393 SORT_MEMBER_DOCS       = YES
394
395 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
396 # brief documentation of file, namespace and class members alphabetically
397 # by member name. If set to NO (the default) the members will appear in
398 # declaration order.
399
400 SORT_BRIEF_DOCS        = NO
401
402 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
403 # hierarchy of group names into alphabetical order. If set to NO (the default)
404 # the group names will appear in their defined order.
405
406 SORT_GROUP_NAMES       = NO
407
408 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
409 # sorted by fully-qualified names, including namespaces. If set to
410 # NO (the default), the class list will be sorted only by class name,
411 # not including the namespace part.
412 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
413 # Note: This option applies only to the class list, not to the
414 # alphabetical list.
415
416 SORT_BY_SCOPE_NAME     = NO
417
418 # The GENERATE_TODOLIST tag can be used to enable (YES) or
419 # disable (NO) the todo list. This list is created by putting \todo
420 # commands in the documentation.
421
422 GENERATE_TODOLIST      = NO
423
424 # The GENERATE_TESTLIST tag can be used to enable (YES) or
425 # disable (NO) the test list. This list is created by putting \test
426 # commands in the documentation.
427
428 GENERATE_TESTLIST      = NO
429
430 # The GENERATE_BUGLIST tag can be used to enable (YES) or
431 # disable (NO) the bug list. This list is created by putting \bug
432 # commands in the documentation.
433
434 GENERATE_BUGLIST       = NO
435
436 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
437 # disable (NO) the deprecated list. This list is created by putting
438 # \deprecated commands in the documentation.
439
440 GENERATE_DEPRECATEDLIST= YES
441
442 # The ENABLED_SECTIONS tag can be used to enable conditional
443 # documentation sections, marked by \if sectionname ... \endif.
444
445 ENABLED_SECTIONS       =
446
447 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
448 # the initial value of a variable or define consists of for it to appear in
449 # the documentation. If the initializer consists of more lines than specified
450 # here it will be hidden. Use a value of 0 to hide initializers completely.
451 # The appearance of the initializer of individual variables and defines in the
452 # documentation can be controlled using \showinitializer or \hideinitializer
453 # command in the documentation regardless of this setting.
454
455 MAX_INITIALIZER_LINES  = 30
456
457 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
458 # at the bottom of the documentation of classes and structs. If set to YES the
459 # list will mention the files that were used to generate the documentation.
460
461 SHOW_USED_FILES        = YES
462
463 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
464 # This will remove the Files entry from the Quick Index and from the
465 # Folder Tree View (if specified). The default is YES.
466
467 SHOW_FILES             = YES
468
469 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
470 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
471 # and from the Folder Tree View (if specified). The default is YES.
472
473 SHOW_NAMESPACES        = YES
474
475 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
476 # doxygen should invoke to get the current version for each file (typically from
477 # the version control system). Doxygen will invoke the program by executing (via
478 # popen()) the command <command> <input-file>, where <command> is the value of
479 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
480 # provided by doxygen. Whatever the program writes to standard output
481 # is used as the file version. See the manual for examples.
482
483 FILE_VERSION_FILTER    =
484
485 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
486 # doxygen. The layout file controls the global structure of the generated output files
487 # in an output format independent way. The create the layout file that represents
488 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
489 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
490 # of the layout file.
491
492 LAYOUT_FILE            = @DOXYGEN_DOCS_DIR@/DaliLayout.xml
493
494 #---------------------------------------------------------------------------
495 # configuration options related to warning and progress messages
496 #---------------------------------------------------------------------------
497
498 # The QUIET tag can be used to turn on/off the messages that are generated
499 # by doxygen. Possible values are YES and NO. If left blank NO is used.
500
501 QUIET                  = YES
502
503 # The WARNINGS tag can be used to turn on/off the warning messages that are
504 # generated by doxygen. Possible values are YES and NO. If left blank
505 # NO is used.
506
507 WARNINGS               = YES
508
509 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
510 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
511 # automatically be disabled.
512
513 WARN_IF_UNDOCUMENTED   = YES
514
515 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
516 # potential errors in the documentation, such as not documenting some
517 # parameters in a documented function, or documenting parameters that
518 # don't exist or using markup commands wrongly.
519
520 WARN_IF_DOC_ERROR      = YES
521
522 # This WARN_NO_PARAMDOC option can be abled to get warnings for
523 # functions that are documented, but have no documentation for their parameters
524 # or return value. If set to NO (the default) doxygen will only warn about
525 # wrong or incomplete parameter documentation, but not about the absence of
526 # documentation.
527
528 WARN_NO_PARAMDOC       = YES
529
530 # The WARN_FORMAT tag determines the format of the warning messages that
531 # doxygen can produce. The string should contain the $file, $line, and $text
532 # tags, which will be replaced by the file and line number from which the
533 # warning originated and the warning text. Optionally the format may contain
534 # $version, which will be replaced by the version of the file (if it could
535 # be obtained via FILE_VERSION_FILTER)
536
537 WARN_FORMAT            = "$file:$line: $text"
538
539 # The WARN_LOGFILE tag can be used to specify a file to which warning
540 # and error messages should be written. If left blank the output is written
541 # to stderr.
542
543 WARN_LOGFILE           =
544
545 #---------------------------------------------------------------------------
546 # configuration options related to the input files
547 #---------------------------------------------------------------------------
548
549 # The INPUT tag can be used to specify the files and/or directories that contain
550 # documented source files. You may enter file names like "myfile.cpp" or
551 # directories like "/usr/src/myproject". Separate the files or directories
552 # with spaces.
553
554 INPUT                  = @DOXYGEN_DOCS_DIR@/content \
555                          ../../../../dali-toolkit/base/dali-toolkit/public-api \
556                          ../../../../dali-toolkit/optional/dali-toolkit/public-api \
557                          ../../../automated-tests/README.md \
558                          @prefix@/include/dali
559
560 # This tag can be used to specify the character encoding of the source files
561 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
562 # also the default input encoding. Doxygen uses libiconv (or the iconv built
563 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
564 # the list of possible encodings.
565
566 INPUT_ENCODING         = UTF-8
567
568 # If the value of the INPUT tag contains directories, you can use the
569 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
570 # and *.h) to filter out the source-files in the directories. If left
571 # blank the following patterns are tested:
572 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
573 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
574
575 FILE_PATTERNS          = *.c \
576                          *.cc \
577                          *.cxx \
578                          *.cpp \
579                          *.c++ \
580                          *.d \
581                          *.java \
582                          *.ii \
583                          *.ixx \
584                          *.ipp \
585                          *.i++ \
586                          *.inl \
587                          *.h \
588                          *.hh \
589                          *.hxx \
590                          *.hpp \
591                          *.h++ \
592                          *.idl \
593                          *.odl \
594                          *.cs \
595                          *.php \
596                          *.php3 \
597                          *.inc \
598                          *.m \
599                          *.md \
600                          *.mm \
601                          *.dox \
602                          *.py \
603                          *.f90 \
604                          *.f \
605                          *.vhd \
606                          *.vhdl
607
608 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
609 # should be searched for input files as well. Possible values are YES and NO.
610 # If left blank NO is used.
611
612 RECURSIVE              = YES
613
614 # The EXCLUDE tag can be used to specify files and/or directories that should
615 # excluded from the INPUT source files. This way you can easily exclude a
616 # subdirectory from a directory tree whose root is specified with the INPUT tag.
617
618 EXCLUDE                = dali/integration-api
619
620
621 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
622 # directories that are symbolic links (a Unix filesystem feature) are excluded
623 # from the input.
624
625 EXCLUDE_SYMLINKS       = NO
626
627 # If the value of the INPUT tag contains directories, you can use the
628 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
629 # certain files from those directories. Note that the wildcards are matched
630 # against the file with absolute path, so to exclude all test directories
631 # for example use the pattern */test/*
632
633 EXCLUDE_PATTERNS       =
634
635 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
636 # (namespaces, classes, functions, etc.) that should be excluded from the
637 # output. The symbol name can be a fully qualified name, a word, or if the
638 # wildcard * is used, a substring. Examples: ANamespace, AClass,
639 # AClass::ANamespace, ANamespace::*Test
640
641 EXCLUDE_SYMBOLS        = DaliInternal \
642                          Dali::Internal \
643                          Dali::Integration \
644                          Impl \
645                          ApplicationImpl
646
647 # The EXAMPLE_PATH tag can be used to specify one or more files or
648 # directories that contain example code fragments that are included (see
649 # the \include command).
650
651 EXAMPLE_PATH           =
652
653 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
654 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
655 # and *.h) to filter out the source-files in the directories. If left
656 # blank all files are included.
657
658 EXAMPLE_PATTERNS       = *
659
660 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
661 # searched for input files to be used with the \include or \dontinclude
662 # commands irrespective of the value of the RECURSIVE tag.
663 # Possible values are YES and NO. If left blank NO is used.
664
665 EXAMPLE_RECURSIVE      = YES
666
667 # The IMAGE_PATH tag can be used to specify one or more files or
668 # directories that contain image that are included in the documentation (see
669 # the \image command).
670
671 IMAGE_PATH             = @DOXYGEN_DOCS_DIR@/content/images
672
673 # The INPUT_FILTER tag can be used to specify a program that doxygen should
674 # invoke to filter for each input file. Doxygen will invoke the filter program
675 # by executing (via popen()) the command <filter> <input-file>, where <filter>
676 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
677 # input file. Doxygen will then use the output that the filter program writes
678 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
679 # ignored.
680
681 INPUT_FILTER           =
682
683 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
684 # basis.  Doxygen will compare the file name with each pattern and apply the
685 # filter if there is a match.  The filters are a list of the form:
686 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
687 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
688 # is applied to all files.
689
690 FILTER_PATTERNS        =
691
692 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
693 # INPUT_FILTER) will be used to filter the input files when producing source
694 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
695
696 FILTER_SOURCE_FILES    = NO
697
698 #---------------------------------------------------------------------------
699 # configuration options related to source browsing
700 #---------------------------------------------------------------------------
701
702 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
703 # be generated. Documented entities will be cross-referenced with these sources.
704 # Note: To get rid of all source code in the generated output, make sure also
705 # VERBATIM_HEADERS is set to NO.
706
707 SOURCE_BROWSER         = YES
708
709 # Setting the INLINE_SOURCES tag to YES will include the body
710 # of functions and classes directly in the documentation.
711
712 INLINE_SOURCES         = NO
713
714 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
715 # doxygen to hide any special comment blocks from generated source code
716 # fragments. Normal C and C++ comments will always remain visible.
717
718 STRIP_CODE_COMMENTS    = YES
719
720 # If the REFERENCED_BY_RELATION tag is set to YES
721 # then for each documented function all documented
722 # functions referencing it will be listed.
723
724 REFERENCED_BY_RELATION = NO
725
726 # If the REFERENCES_RELATION tag is set to YES
727 # then for each documented function all documented entities
728 # called/used by that function will be listed.
729
730 REFERENCES_RELATION    = NO
731
732 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
733 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
734 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
735 # link to the source code.  Otherwise they will link to the documentation.
736
737 REFERENCES_LINK_SOURCE = YES
738
739 # If the USE_HTAGS tag is set to YES then the references to source code
740 # will point to the HTML generated by the htags(1) tool instead of doxygen
741 # built-in source browser. The htags tool is part of GNU's global source
742 # tagging system (see http://www.gnu.org/software/global/global.html). You
743 # will need version 4.8.6 or higher.
744
745 USE_HTAGS              = NO
746
747 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
748 # will generate a verbatim copy of the header file for each class for
749 # which an include is specified. Set to NO to disable this.
750
751 VERBATIM_HEADERS       = YES
752
753 #---------------------------------------------------------------------------
754 # configuration options related to the alphabetical class index
755 #---------------------------------------------------------------------------
756
757 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
758 # of all compounds will be generated. Enable this if the project
759 # contains a lot of classes, structs, unions or interfaces.
760
761 ALPHABETICAL_INDEX     = NO
762
763 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
764 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
765 # in which this list will be split (can be a number in the range [1..20])
766
767 COLS_IN_ALPHA_INDEX    = 5
768
769 # In case all classes in a project start with a common prefix, all
770 # classes will be put under the same header in the alphabetical index.
771 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
772 # should be ignored while generating the index headers.
773
774 IGNORE_PREFIX          =
775
776 #---------------------------------------------------------------------------
777 # configuration options related to the HTML output
778 #---------------------------------------------------------------------------
779
780 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
781 # generate HTML output.
782
783 GENERATE_HTML          = YES
784
785 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
786 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
787 # put in front of it. If left blank `html' will be used as the default path.
788
789 HTML_OUTPUT            = html
790
791 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
792 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
793 # doxygen will generate files with .html extension.
794
795 HTML_FILE_EXTENSION    = .html
796
797 # The HTML_HEADER tag can be used to specify a personal HTML header for
798 # each generated HTML page. If it is left blank doxygen will generate a
799 # standard header.
800
801 HTML_HEADER            =
802
803 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
804 # each generated HTML page. If it is left blank doxygen will generate a
805 # standard footer.
806
807 HTML_FOOTER            =
808
809 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
810 # style sheet that is used by each HTML page. It can be used to
811 # fine-tune the look of the HTML output. If the tag is left blank doxygen
812 # will generate a default style sheet. Note that doxygen will try to copy
813 # the style sheet file to the HTML output directory, so don't put your own
814 # stylesheet in the HTML output directory as well, or it will be erased!
815
816 HTML_STYLESHEET        =
817
818 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
819 # documentation will contain sections that can be hidden and shown after the
820 # page has loaded. For this to work a browser that supports
821 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
822 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
823
824 HTML_DYNAMIC_SECTIONS  = NO
825
826 # If the GENERATE_DOCSET tag is set to YES, additional index files
827 # will be generated that can be used as input for Apple's Xcode 3
828 # integrated development environment, introduced with OSX 10.5 (Leopard).
829 # To create a documentation set, doxygen will generate a Makefile in the
830 # HTML output directory. Running make will produce the docset in that
831 # directory and running "make install" will install the docset in
832 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
833 # it at startup.
834 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
835
836 GENERATE_DOCSET        = NO
837
838 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
839 # feed. A documentation feed provides an umbrella under which multiple
840 # documentation sets from a single provider (such as a company or product suite)
841 # can be grouped.
842
843 DOCSET_FEEDNAME        = "Doxygen generated docs"
844
845 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
846 # should uniquely identify the documentation set bundle. This should be a
847 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
848 # will append .docset to the name.
849
850 DOCSET_BUNDLE_ID       = org.doxygen.Project
851
852 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
853 # will be generated that can be used as input for tools like the
854 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
855 # of the generated HTML documentation.
856
857 GENERATE_HTMLHELP      = YES
858
859 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
860 # be used to specify the file name of the resulting .chm file. You
861 # can add a path in front of the file if the result should not be
862 # written to the html output directory.
863
864 CHM_FILE               = dali.chm
865
866 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
867 # be used to specify the location (absolute path including file name) of
868 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
869 # the HTML help compiler on the generated index.hhp.
870
871 HHC_LOCATION           =
872
873 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
874 # controls if a separate .chi index file is generated (YES) or that
875 # it should be included in the master .chm file (NO).
876
877 GENERATE_CHI           = NO
878
879 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
880 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
881 # content.
882
883 CHM_INDEX_ENCODING     =
884
885 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
886 # controls whether a binary table of contents is generated (YES) or a
887 # normal table of contents (NO) in the .chm file.
888
889 BINARY_TOC             = NO
890
891 # The TOC_EXPAND flag can be set to YES to add extra items for group members
892 # to the contents of the HTML help documentation and to the tree view.
893
894 TOC_EXPAND             = NO
895
896 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
897 # are set, an additional index file will be generated that can be used as input for
898 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
899 # HTML documentation.
900
901 GENERATE_QHP           = NO
902
903 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
904 # be used to specify the file name of the resulting .qch file.
905 # The path specified is relative to the HTML output folder.
906
907 QCH_FILE               =
908
909 # The QHP_NAMESPACE tag specifies the namespace to use when generating
910 # Qt Help Project output. For more information please see
911 # http://doc.trolltech.com/qthelpproject.html#namespace
912
913 QHP_NAMESPACE          =
914
915 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
916 # Qt Help Project output. For more information please see
917 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
918
919 QHP_VIRTUAL_FOLDER     = doc
920
921 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
922 # For more information please see
923 # http://doc.trolltech.com/qthelpproject.html#custom-filters
924
925 QHP_CUST_FILTER_NAME   =
926
927 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
928 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
929
930 QHP_CUST_FILTER_ATTRS  =
931
932 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
933 # filter section matches.
934 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
935
936 QHP_SECT_FILTER_ATTRS  =
937
938 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
939 # be used to specify the location of Qt's qhelpgenerator.
940 # If non-empty doxygen will try to run qhelpgenerator on the generated
941 # .qhp file.
942
943 QHG_LOCATION           =
944
945 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
946 # top of each HTML page. The value NO (the default) enables the index and
947 # the value YES disables it.
948
949 DISABLE_INDEX          = NO
950
951 # This tag can be used to set the number of enum values (range [1..20])
952 # that doxygen will group on one line in the generated HTML documentation.
953
954 ENUM_VALUES_PER_LINE   = 4
955
956 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
957 # structure should be generated to display hierarchical information.
958 # If the tag value is set to FRAME, a side panel will be generated
959 # containing a tree-like index structure (just like the one that
960 # is generated for HTML Help). For this to work a browser that supports
961 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
962 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
963 # probably better off using the HTML help feature. Other possible values
964 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
965 # and Class Hierarchy pages using a tree view instead of an ordered list;
966 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
967 # disables this behavior completely. For backwards compatibility with previous
968 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
969 # respectively.
970
971 GENERATE_TREEVIEW      = NONE
972
973 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
974 # used to set the initial width (in pixels) of the frame in which the tree
975 # is shown.
976
977 TREEVIEW_WIDTH         = 250
978
979 # Use this tag to change the font size of Latex formulas included
980 # as images in the HTML documentation. The default is 10. Note that
981 # when you change the font size after a successful doxygen run you need
982 # to manually remove any form_*.png images from the HTML output directory
983 # to force them to be regenerated.
984
985 FORMULA_FONTSIZE       = 10
986
987 #---------------------------------------------------------------------------
988 # configuration options related to the LaTeX output
989 #---------------------------------------------------------------------------
990
991 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
992 # generate Latex output.
993
994 GENERATE_LATEX         = NO
995
996 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
997 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
998 # put in front of it. If left blank `latex' will be used as the default path.
999
1000 LATEX_OUTPUT           = latex
1001
1002 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1003 # invoked. If left blank `latex' will be used as the default command name.
1004
1005 LATEX_CMD_NAME         = latex
1006
1007 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1008 # generate index for LaTeX. If left blank `makeindex' will be used as the
1009 # default command name.
1010
1011 MAKEINDEX_CMD_NAME     = makeindex
1012
1013 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1014 # LaTeX documents. This may be useful for small projects and may help to
1015 # save some trees in general.
1016
1017 COMPACT_LATEX          = NO
1018
1019 # The PAPER_TYPE tag can be used to set the paper type that is used
1020 # by the printer. Possible values are: a4, a4wide, letter, legal and
1021 # executive. If left blank a4wide will be used.
1022
1023 PAPER_TYPE             = a4wide
1024
1025 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1026 # packages that should be included in the LaTeX output.
1027
1028 EXTRA_PACKAGES         =
1029
1030 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1031 # the generated latex document. The header should contain everything until
1032 # the first chapter. If it is left blank doxygen will generate a
1033 # standard header. Notice: only use this tag if you know what you are doing!
1034
1035 LATEX_HEADER           =
1036
1037 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1038 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1039 # contain links (just like the HTML output) instead of page references
1040 # This makes the output suitable for online browsing using a pdf viewer.
1041
1042 PDF_HYPERLINKS         = YES
1043
1044 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1045 # plain latex in the generated Makefile. Set this option to YES to get a
1046 # higher quality PDF documentation.
1047
1048 USE_PDFLATEX           = YES
1049
1050 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1051 # command to the generated LaTeX files. This will instruct LaTeX to keep
1052 # running if errors occur, instead of asking the user for help.
1053 # This option is also used when generating formulas in HTML.
1054
1055 LATEX_BATCHMODE        = NO
1056
1057 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1058 # include the index chapters (such as File Index, Compound Index, etc.)
1059 # in the output.
1060
1061 LATEX_HIDE_INDICES     = NO
1062
1063 #---------------------------------------------------------------------------
1064 # configuration options related to the RTF output
1065 #---------------------------------------------------------------------------
1066
1067 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1068 # The RTF output is optimized for Word 97 and may not look very pretty with
1069 # other RTF readers or editors.
1070
1071 GENERATE_RTF           = NO
1072
1073 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1074 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1075 # put in front of it. If left blank `rtf' will be used as the default path.
1076
1077 RTF_OUTPUT             = rtf
1078
1079 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1080 # RTF documents. This may be useful for small projects and may help to
1081 # save some trees in general.
1082
1083 COMPACT_RTF            = NO
1084
1085 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1086 # will contain hyperlink fields. The RTF file will
1087 # contain links (just like the HTML output) instead of page references.
1088 # This makes the output suitable for online browsing using WORD or other
1089 # programs which support those fields.
1090 # Note: wordpad (write) and others do not support links.
1091
1092 RTF_HYPERLINKS         = NO
1093
1094 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1095 # config file, i.e. a series of assignments. You only have to provide
1096 # replacements, missing definitions are set to their default value.
1097
1098 RTF_STYLESHEET_FILE    =
1099
1100 # Set optional variables used in the generation of an rtf document.
1101 # Syntax is similar to doxygen's config file.
1102
1103 RTF_EXTENSIONS_FILE    =
1104
1105 #---------------------------------------------------------------------------
1106 # configuration options related to the man page output
1107 #---------------------------------------------------------------------------
1108
1109 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1110 # generate man pages
1111
1112 GENERATE_MAN           = NO
1113
1114 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1115 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1116 # put in front of it. If left blank `man' will be used as the default path.
1117
1118 MAN_OUTPUT             = man
1119
1120 # The MAN_EXTENSION tag determines the extension that is added to
1121 # the generated man pages (default is the subroutine's section .3)
1122
1123 MAN_EXTENSION          = .3
1124
1125 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1126 # then it will generate one additional man file for each entity
1127 # documented in the real man page(s). These additional files
1128 # only source the real man page, but without them the man command
1129 # would be unable to find the correct page. The default is NO.
1130
1131 MAN_LINKS              = NO
1132
1133 #---------------------------------------------------------------------------
1134 # configuration options related to the XML output
1135 #---------------------------------------------------------------------------
1136
1137 # If the GENERATE_XML tag is set to YES Doxygen will
1138 # generate an XML file that captures the structure of
1139 # the code including all documentation.
1140
1141 GENERATE_XML           = NO
1142
1143 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1144 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1145 # put in front of it. If left blank `xml' will be used as the default path.
1146
1147 XML_OUTPUT             = xml
1148
1149 # The XML_SCHEMA tag can be used to specify an XML schema,
1150 # which can be used by a validating XML parser to check the
1151 # syntax of the XML files.
1152
1153 XML_SCHEMA             =
1154
1155 # The XML_DTD tag can be used to specify an XML DTD,
1156 # which can be used by a validating XML parser to check the
1157 # syntax of the XML files.
1158
1159 XML_DTD                =
1160
1161 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1162 # dump the program listings (including syntax highlighting
1163 # and cross-referencing information) to the XML output. Note that
1164 # enabling this will significantly increase the size of the XML output.
1165
1166 XML_PROGRAMLISTING     = YES
1167
1168 #---------------------------------------------------------------------------
1169 # configuration options for the AutoGen Definitions output
1170 #---------------------------------------------------------------------------
1171
1172 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1173 # generate an AutoGen Definitions (see autogen.sf.net) file
1174 # that captures the structure of the code including all
1175 # documentation. Note that this feature is still experimental
1176 # and incomplete at the moment.
1177
1178 GENERATE_AUTOGEN_DEF   = NO
1179
1180 #---------------------------------------------------------------------------
1181 # configuration options related to the Perl module output
1182 #---------------------------------------------------------------------------
1183
1184 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1185 # generate a Perl module file that captures the structure of
1186 # the code including all documentation. Note that this
1187 # feature is still experimental and incomplete at the
1188 # moment.
1189
1190 GENERATE_PERLMOD       = NO
1191
1192 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1193 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1194 # to generate PDF and DVI output from the Perl module output.
1195
1196 PERLMOD_LATEX          = NO
1197
1198 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1199 # nicely formatted so it can be parsed by a human reader.  This is useful
1200 # if you want to understand what is going on.  On the other hand, if this
1201 # tag is set to NO the size of the Perl module output will be much smaller
1202 # and Perl will parse it just the same.
1203
1204 PERLMOD_PRETTY         = YES
1205
1206 # The names of the make variables in the generated doxyrules.make file
1207 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1208 # This is useful so different doxyrules.make files included by the same
1209 # Makefile don't overwrite each other's variables.
1210
1211 PERLMOD_MAKEVAR_PREFIX =
1212
1213 #---------------------------------------------------------------------------
1214 # Configuration options related to the preprocessor
1215 #---------------------------------------------------------------------------
1216
1217 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1218 # evaluate all C-preprocessor directives found in the sources and include
1219 # files.
1220
1221 ENABLE_PREPROCESSING   = YES
1222
1223 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1224 # names in the source code. If set to NO (the default) only conditional
1225 # compilation will be performed. Macro expansion can be done in a controlled
1226 # way by setting EXPAND_ONLY_PREDEF to YES.
1227
1228 MACRO_EXPANSION        = YES
1229
1230 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1231 # then the macro expansion is limited to the macros specified with the
1232 # PREDEFINED and EXPAND_AS_DEFINED tags.
1233
1234 EXPAND_ONLY_PREDEF     = YES
1235
1236 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1237 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1238
1239 SEARCH_INCLUDES        = YES
1240
1241 # The INCLUDE_PATH tag can be used to specify one or more directories that
1242 # contain include files that are not input files but should be processed by
1243 # the preprocessor.
1244
1245 INCLUDE_PATH           =
1246
1247 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1248 # patterns (like *.h and *.hpp) to filter out the header-files in the
1249 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1250 # be used.
1251
1252 INCLUDE_FILE_PATTERNS  =
1253
1254 # The PREDEFINED tag can be used to specify one or more macro names that
1255 # are defined before the preprocessor is started (similar to the -D option of
1256 # gcc). The argument of the tag is a list of macros of the form: name
1257 # or name=definition (no spaces). If the definition and the = are
1258 # omitted =1 is assumed. To prevent a macro definition from being
1259 # undefined via #undef or recursively expanded use the := operator
1260 # instead of the = operator.
1261
1262 PREDEFINED             = DALI_IMPORT_API DALI_INTERNAL \
1263                        __attribute__ ((visibility ("default"))) \
1264                        __attribute__ ((visibility ("hidden")))
1265
1266 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1267 # this tag can be used to specify a list of macro names that should be expanded.
1268 # The macro definition that is found in the sources will be used.
1269 # Use the PREDEFINED tag if you want to use a different macro definition.
1270
1271 EXPAND_AS_DEFINED      =
1272
1273 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1274 # doxygen's preprocessor will remove all function-like macros that are alone
1275 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1276 # function macros are typically used for boiler-plate code, and will confuse
1277 # the parser if not removed.
1278
1279 SKIP_FUNCTION_MACROS   = YES
1280
1281 #---------------------------------------------------------------------------
1282 # Configuration::additions related to external references
1283 #---------------------------------------------------------------------------
1284
1285 # The TAGFILES option can be used to specify one or more tagfiles.
1286 # Optionally an initial location of the external documentation
1287 # can be added for each tagfile. The format of a tag file without
1288 # this location is as follows:
1289 #   TAGFILES = file1 file2 ...
1290 # Adding location for the tag files is done as follows:
1291 #   TAGFILES = file1=loc1 "file2 = loc2" ...
1292 # where "loc1" and "loc2" can be relative or absolute paths or
1293 # URLs. If a location is present for each tag, the installdox tool
1294 # does not have to be run to correct the links.
1295 # Note that each tag file must have a unique name
1296 # (where the name does NOT include the path)
1297 # If a tag file is not located in the directory in which doxygen
1298 # is run, you must also specify the path to the tagfile here.
1299
1300 TAGFILES               =
1301
1302 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1303 # a tag file that is based on the input files it reads.
1304
1305 GENERATE_TAGFILE       =
1306
1307 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1308 # in the class index. If set to NO only the inherited external classes
1309 # will be listed.
1310
1311 ALLEXTERNALS           = NO
1312
1313 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1314 # in the modules index. If set to NO, only the current project's groups will
1315 # be listed.
1316
1317 EXTERNAL_GROUPS        = YES
1318
1319 # The PERL_PATH should be the absolute path and name of the perl script
1320 # interpreter (i.e. the result of `which perl').
1321
1322 PERL_PATH              = /usr/bin/perl
1323
1324 #---------------------------------------------------------------------------
1325 # Configuration options related to the dot tool
1326 #---------------------------------------------------------------------------
1327
1328 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1329 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1330 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1331 # this option is superseded by the HAVE_DOT option below. This is only a
1332 # fallback. It is recommended to install and use dot, since it yields more
1333 # powerful graphs.
1334
1335 CLASS_DIAGRAMS         = YES
1336
1337 # You can define message sequence charts within doxygen comments using the \msc
1338 # command. Doxygen will then run the mscgen tool (see
1339 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1340 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1341 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1342 # default search path.
1343
1344 MSCGEN_PATH            =
1345
1346 # If set to YES, the inheritance and collaboration graphs will hide
1347 # inheritance and usage relations if the target is undocumented
1348 # or is not a class.
1349
1350 HIDE_UNDOC_RELATIONS   = YES
1351
1352 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1353 # available from the path. This tool is part of Graphviz, a graph visualization
1354 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1355 # have no effect if this option is set to NO (the default)
1356
1357 HAVE_DOT               = NO
1358
1359 # By default doxygen will write a font called FreeSans.ttf to the output
1360 # directory and reference it in all dot files that doxygen generates. This
1361 # font does not include all possible unicode characters however, so when you need
1362 # these (or just want a differently looking font) you can specify the font name
1363 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1364 # which can be done by putting it in a standard location or by setting the
1365 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1366 # containing the font.
1367
1368 DOT_FONTNAME           =
1369
1370 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1371 # The default size is 10pt.
1372
1373 DOT_FONTSIZE           = 10
1374
1375 # By default doxygen will tell dot to use the output directory to look for the
1376 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1377 # different font using DOT_FONTNAME you can set the path where dot
1378 # can find it using this tag.
1379
1380 DOT_FONTPATH           =
1381
1382 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1383 # will generate a graph for each documented class showing the direct and
1384 # indirect inheritance relations. Setting this tag to YES will force the
1385 # the CLASS_DIAGRAMS tag to NO.
1386
1387 CLASS_GRAPH            = YES
1388
1389 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1390 # will generate a graph for each documented class showing the direct and
1391 # indirect implementation dependencies (inheritance, containment, and
1392 # class references variables) of the class with other documented classes.
1393
1394 COLLABORATION_GRAPH    = YES
1395
1396 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1397 # will generate a graph for groups, showing the direct groups dependencies
1398
1399 GROUP_GRAPHS           = YES
1400
1401 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1402 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1403 # Language.
1404
1405 UML_LOOK               = NO
1406
1407 # If set to YES, the inheritance and collaboration graphs will show the
1408 # relations between templates and their instances.
1409
1410 TEMPLATE_RELATIONS     = NO
1411
1412 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1413 # tags are set to YES then doxygen will generate a graph for each documented
1414 # file showing the direct and indirect include dependencies of the file with
1415 # other documented files.
1416
1417 INCLUDE_GRAPH          = YES
1418
1419 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1420 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1421 # documented header file showing the documented files that directly or
1422 # indirectly include this file.
1423
1424 INCLUDED_BY_GRAPH      = YES
1425
1426 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1427 # doxygen will generate a call dependency graph for every global function
1428 # or class method. Note that enabling this option will significantly increase
1429 # the time of a run. So in most cases it will be better to enable call graphs
1430 # for selected functions only using the \callgraph command.
1431
1432 CALL_GRAPH             = NO
1433
1434 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1435 # doxygen will generate a caller dependency graph for every global function
1436 # or class method. Note that enabling this option will significantly increase
1437 # the time of a run. So in most cases it will be better to enable caller
1438 # graphs for selected functions only using the \callergraph command.
1439
1440 CALLER_GRAPH           = NO
1441
1442 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1443 # will graphical hierarchy of all classes instead of a textual one.
1444
1445 GRAPHICAL_HIERARCHY    = YES
1446
1447 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1448 # then doxygen will show the dependencies a directory has on other directories
1449 # in a graphical way. The dependency relations are determined by the #include
1450 # relations between the files in the directories.
1451
1452 DIRECTORY_GRAPH        = YES
1453
1454 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1455 # generated by dot. Possible values are png, jpg, or gif
1456 # If left blank png will be used.
1457
1458 DOT_IMAGE_FORMAT       = png
1459
1460 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1461 # found. If left blank, it is assumed the dot tool can be found in the path.
1462
1463 DOT_PATH               =
1464
1465 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1466 # contain dot files that are included in the documentation (see the
1467 # \dotfile command).
1468
1469 DOTFILE_DIRS           =
1470
1471 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1472 # nodes that will be shown in the graph. If the number of nodes in a graph
1473 # becomes larger than this value, doxygen will truncate the graph, which is
1474 # visualized by representing a node as a red box. Note that doxygen if the
1475 # number of direct children of the root node in a graph is already larger than
1476 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1477 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1478
1479 DOT_GRAPH_MAX_NODES    = 50
1480
1481 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1482 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1483 # from the root by following a path via at most 3 edges will be shown. Nodes
1484 # that lay further from the root node will be omitted. Note that setting this
1485 # option to 1 or 2 may greatly reduce the computation time needed for large
1486 # code bases. Also note that the size of a graph can be further restricted by
1487 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1488
1489 MAX_DOT_GRAPH_DEPTH    = 0
1490
1491 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1492 # background. This is disabled by default, because dot on Windows does not
1493 # seem to support this out of the box. Warning: Depending on the platform used,
1494 # enabling this option may lead to badly anti-aliased labels on the edges of
1495 # a graph (i.e. they become hard to read).
1496
1497 DOT_TRANSPARENT        = NO
1498
1499 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1500 # files in one run (i.e. multiple -o and -T options on the command line). This
1501 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1502 # support this, this feature is disabled by default.
1503
1504 DOT_MULTI_TARGETS      = NO
1505
1506 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1507 # generate a legend page explaining the meaning of the various boxes and
1508 # arrows in the dot generated graphs.
1509
1510 GENERATE_LEGEND        = YES
1511
1512 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1513 # remove the intermediate dot files that are used to generate
1514 # the various graphs.
1515
1516 DOT_CLEANUP            = YES
1517
1518 #---------------------------------------------------------------------------
1519 # Options related to the search engine
1520 #---------------------------------------------------------------------------
1521
1522 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1523 # for the HTML output. The underlying search engine uses javascript
1524 # and DHTML and should work on any modern browser. Note that when using
1525 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1526 # (GENERATE_DOCSET) there is already a search function so this one should
1527 # typically be disabled. For large projects the javascript based search engine
1528 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1529
1530 SEARCHENGINE           = NO
1531
1532 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1533 # implemented using a PHP enabled web server instead of at the web client
1534 # using Javascript. Doxygen will generate the search PHP script and index
1535 # file to put on the web server. The advantage of the server
1536 # based approach is that it scales better to large projects and allows
1537 # full text search. The disadvances is that it is more difficult to setup
1538 # and does not have live searching capabilities.
1539
1540 # SERVER_BASED_SEARCH    = NO