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