3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project.
6
# All text after a hash (#) is considered a comment and will be ignored.
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 (" ").13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
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.
23
DOXYFILE_ENCODING = UTF-8
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
# by quotes) that should identify the project.
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.
34
PROJECT_NUMBER = @PACKAGE_VERSION@
36
# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
40
# With the PROJECT_LOGO tag one can specify an logo or icon that is
41
# included in the documentation. The maximum height of the logo should not
42
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
43
# Doxygen will copy the logo to the output directory.
47
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
48
# base path where the generated documentation will be put.
49
# If a relative path is entered, it will be relative to the location
50
# where doxygen was started. If left blank the current directory will be used.
52
OUTPUT_DIRECTORY = @top_builddir@/
54
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
55
# 4096 sub-directories (in 2 levels) under the output directory of each output
56
# format and will distribute the generated files over these directories.
57
# Enabling this option can be useful when feeding doxygen a huge amount of
58
# source files, where putting all generated files in the same directory would
59
# otherwise cause performance problems for the file system.
63
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
64
# documentation generated by doxygen is written. Doxygen will use this
65
# information to generate all constant output in the proper language.
66
# The default language is English, other supported languages are:
67
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
68
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
69
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
70
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
71
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
72
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
74
OUTPUT_LANGUAGE = English
76
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
77
# include brief member descriptions after the members that are listed in
78
# the file and class documentation (similar to JavaDoc).
79
# Set to NO to disable this.
81
BRIEF_MEMBER_DESC = YES
83
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
84
# the brief description of a member or function before the detailed description.
85
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86
# brief descriptions will be completely suppressed.
90
# This tag implements a quasi-intelligent brief description abbreviator
91
# that is used to form the text in various listings. Each string
92
# in this list, if found as the leading text of the brief description, will be
93
# stripped from the text and the result after processing the whole list, is
94
# used as the annotated text. Otherwise, the brief description is used as-is.
95
# If left blank, the following values are used ("$name" is automatically96
# replaced with the name of the entity): "The $name class" "The $name widget"
97
# "The $name file" "is" "provides" "specifies" "contains"
98
# "represents" "a" "an" "the"
102
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
103
# Doxygen will generate a detailed section even if there is only a brief
106
ALWAYS_DETAILED_SEC = NO
108
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
109
# inherited members of a class in the documentation of that class as if those
110
# members were ordinary class members. Constructors, destructors and assignment
111
# operators of the base classes will not be shown.
113
INLINE_INHERITED_MEMB = NO
115
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
116
# path before files name in the file list and in the header files. If set
117
# to NO the shortest path that makes the file name unique will be used.
121
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
122
# can be used to strip a user-defined part of the path. Stripping is
123
# only done if one of the specified strings matches the left-hand part of
124
# the path. The tag can be used to show relative paths in the file list.
125
# If left blank the directory from which doxygen is run is used as the
130
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
131
# the path mentioned in the documentation of a class, which tells
132
# the reader which header file to include in order to use a class.
133
# If left blank only the name of the header file containing the class
134
# definition is used. Otherwise one should specify the include paths that
135
# are normally passed to the compiler using the -I flag.
139
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
140
# (but less readable) file names. This can be useful if your file system
141
# doesn't support long names like on DOS, Mac, or CD-ROM.
145
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146
# will interpret the first line (until the first dot) of a JavaDoc-style
147
# comment as the brief description. If set to NO, the JavaDoc
148
# comments will behave just like regular Qt-style comments
149
# (thus requiring an explicit @brief command for a brief description.)
151
JAVADOC_AUTOBRIEF = YES
153
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154
# interpret the first line (until the first dot) of a Qt-style
155
# comment as the brief description. If set to NO, the comments
156
# will behave just like regular Qt-style comments (thus requiring
157
# an explicit \brief command for a brief description.)
161
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
163
# comments) as a brief description. This used to be the default behaviour.
164
# The new default is to treat a multi-line C++ comment block as a detailed
165
# description. Set this tag to YES if you prefer the old behaviour instead.
167
MULTILINE_CPP_IS_BRIEF = NO
169
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
170
# member inherits the documentation from any documented member that it
175
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176
# a new page for each member. If set to NO, the documentation of a member will
177
# be part of the file/class/namespace that contains it.
179
SEPARATE_MEMBER_PAGES = NO
181
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
182
# Doxygen uses this value to replace tabs by spaces in code fragments.
186
# This tag can be used to specify a number of aliases that acts
187
# as commands in the documentation. An alias has the form "name=value".
188
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
189
# put the command \sideeffect (or @sideeffect) in the documentation, which
190
# will result in a user-defined paragraph with heading "Side Effects:".
191
# You can put \n's in the value part of an alias to insert newlines.
195
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
196
# sources only. Doxygen will then generate output that is more tailored for C.
197
# For instance, some of the names that are used will be different. The list
198
# of all members will be omitted, etc.
200
OPTIMIZE_OUTPUT_FOR_C = YES
202
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
203
# sources only. Doxygen will then generate output that is more tailored for
204
# Java. For instance, namespaces will be presented as packages, qualified
205
# scopes will look different, etc.
207
OPTIMIZE_OUTPUT_JAVA = NO
209
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
210
# sources only. Doxygen will then generate output that is more tailored for
213
OPTIMIZE_FOR_FORTRAN = NO
215
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
216
# sources. Doxygen will then generate output that is tailored for
219
OPTIMIZE_OUTPUT_VHDL = NO
221
# Doxygen selects the parser to use depending on the extension of the files it
222
# parses. With this tag you can assign which parser to use for a given extension.
223
# Doxygen has a built-in mapping, but you can override or extend it using this
224
# tag. The format is ext=language, where ext is a file extension, and language
225
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
226
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
227
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
228
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
229
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
231
EXTENSION_MAPPING = x=C
233
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
234
# to include (a tag file for) the STL sources as input, then you should
235
# set this tag to YES in order to let doxygen match functions declarations and
236
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
237
# func(std::string) {}). This also makes the inheritance and collaboration238
# diagrams that involve STL classes more complete and accurate.
240
BUILTIN_STL_SUPPORT = NO
242
# If you use Microsoft's C++/CLI language, you should set this option to YES to
243
# enable parsing support.
247
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
248
# Doxygen will parse them like normal C++ but will assume all classes use public
249
# instead of private inheritance when no explicit protection keyword is present.
253
# For Microsoft's IDL there are propget and propput attributes to indicate getter
254
# and setter methods for a property. Setting this option to YES (the default)
255
# will make doxygen replace the get and set methods by a property in the
256
# documentation. This will only work if the methods are indeed getting or
257
# setting a simple type. If this is not the case, or you want to show the
258
# methods anyway, you should set this option to NO.
260
IDL_PROPERTY_SUPPORT = YES
262
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
263
# tag is set to YES, then doxygen will reuse the documentation of the first
264
# member in the group (if any) for the other members of the group. By default
265
# all members of a group must be documented explicitly.
267
DISTRIBUTE_GROUP_DOC = NO
269
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
270
# the same type (for instance a group of public functions) to be put as a
271
# subgroup of that type (e.g. under the Public Functions section). Set it to
272
# NO to prevent subgrouping. Alternatively, this can be done per class using
273
# the \nosubgrouping command.
277
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
278
# is documented as struct, union, or enum with the name of the typedef. So
279
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct280
# with name TypeT. When disabled the typedef will appear as a member of a file,
281
# namespace, or class. And the struct will be named TypeS. This can typically
282
# be useful for C code in case the coding convention dictates that all compound
283
# types are typedef'ed and only the typedef is referenced, never the tag name.
285
TYPEDEF_HIDES_STRUCT = NO
287
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
288
# determine which symbols to keep in memory and which to flush to disk.
289
# When the cache is full, less often used symbols will be written to disk.
290
# For small to medium size projects (<1000 input files) the default value is
291
# probably good enough. For larger projects a too small cache size can cause
292
# doxygen to be busy swapping symbols to and from disk most of the time
293
# causing a significant performance penalty.
294
# If the system has enough physical memory increasing the cache will improve the
295
# performance by keeping more symbols in memory. Note that the value works on
296
# a logarithmic scale so increasing the size by one will roughly double the
297
# memory usage. The cache size is given by this formula:
298
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
299
# corresponding to a cache size of 2^16 = 65536 symbols
301
# Deprecated, so removing this to prevent a warning in Doxygen.
302
# SYMBOL_CACHE_SIZE = 0
304
#---------------------------------------------------------------------------
305
# Build related configuration options
306
#---------------------------------------------------------------------------
308
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
309
# documentation are documented, even if no documentation was available.
310
# Private class members and static file members will be hidden unless
311
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
315
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
316
# will be included in the documentation.
320
# If the EXTRACT_STATIC tag is set to YES all static members of a file
321
# will be included in the documentation.
325
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
326
# defined locally in source files will be included in the documentation.
327
# If set to NO only classes defined in header files are included.
329
EXTRACT_LOCAL_CLASSES = NO
331
# This flag is only useful for Objective-C code. When set to YES local
332
# methods, which are defined in the implementation section but not in
333
# the interface are included in the documentation.
334
# If set to NO (the default) only methods in the interface are included.
336
EXTRACT_LOCAL_METHODS = NO
338
# If this flag is set to YES, the members of anonymous namespaces will be
339
# extracted and appear in the documentation as a namespace called
340
# 'anonymous_namespace{file}', where file will be replaced with the base341
# name of the file that contains the anonymous namespace. By default
342
# anonymous namespaces are hidden.
344
EXTRACT_ANON_NSPACES = NO
346
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
347
# undocumented members of documented classes, files or namespaces.
348
# If set to NO (the default) these members will be included in the
349
# various overviews, but no documentation section is generated.
350
# This option has no effect if EXTRACT_ALL is enabled.
352
HIDE_UNDOC_MEMBERS = NO
354
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
355
# undocumented classes that are normally visible in the class hierarchy.
356
# If set to NO (the default) these classes will be included in the various
357
# overviews. This option has no effect if EXTRACT_ALL is enabled.
359
HIDE_UNDOC_CLASSES = NO
361
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
362
# friend (class|struct|union) declarations.
363
# If set to NO (the default) these declarations will be included in the
366
HIDE_FRIEND_COMPOUNDS = NO
368
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
369
# documentation blocks found inside the body of a function.
370
# If set to NO (the default) these blocks will be appended to the
371
# function's detailed documentation block.
373
HIDE_IN_BODY_DOCS = NO
375
# The INTERNAL_DOCS tag determines if documentation
376
# that is typed after a \internal command is included. If the tag is set
377
# to NO (the default) then the documentation will be excluded.
378
# Set it to YES to include the internal documentation.
382
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
383
# file names in lower-case letters. If set to YES upper-case letters are also
384
# allowed. This is useful if you have classes or files whose names only differ
385
# in case and if your file system supports case sensitive file names. Windows
386
# and Mac users are advised to set this option to NO.
388
CASE_SENSE_NAMES = YES
390
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
391
# will show members with their full class and namespace scopes in the
392
# documentation. If set to YES the scope will be hidden.
396
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
397
# will put a list of the files that are included by a file in the documentation
400
SHOW_INCLUDE_FILES = NO
402
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
403
# will list include files with double quotes in the documentation
404
# rather than with sharp brackets.
406
FORCE_LOCAL_INCLUDES = NO
408
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
409
# is inserted in the documentation for inline members.
413
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
414
# will sort the (detailed) documentation of file and class members
415
# alphabetically by member name. If set to NO the members will appear in
420
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
421
# brief documentation of file, namespace and class members alphabetically
422
# by member name. If set to NO (the default) the members will appear in
427
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
428
# will sort the (brief and detailed) documentation of class members so that
429
# constructors and destructors are listed first. If set to NO (the default)
430
# the constructors will appear in the respective orders defined by
431
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
432
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
433
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
435
SORT_MEMBERS_CTORS_1ST = NO
437
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
438
# hierarchy of group names into alphabetical order. If set to NO (the default)
439
# the group names will appear in their defined order.
443
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
444
# sorted by fully-qualified names, including namespaces. If set to
445
# NO (the default), the class list will be sorted only by class name,
446
# not including the namespace part.
447
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
448
# Note: This option applies only to the class list, not to the
451
SORT_BY_SCOPE_NAME = NO
453
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
454
# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
455
# will still accept a match between prototype and implementation in such cases.
457
STRICT_PROTO_MATCHING = NO
459
# The GENERATE_TODOLIST tag can be used to enable (YES) or
460
# disable (NO) the todo list. This list is created by putting \todo
461
# commands in the documentation.
463
GENERATE_TODOLIST = NO
465
# The GENERATE_TESTLIST tag can be used to enable (YES) or
466
# disable (NO) the test list. This list is created by putting \test
467
# commands in the documentation.
469
GENERATE_TESTLIST = NO
471
# The GENERATE_BUGLIST tag can be used to enable (YES) or
472
# disable (NO) the bug list. This list is created by putting \bug
473
# commands in the documentation.
477
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
478
# disable (NO) the deprecated list. This list is created by putting
479
# \deprecated commands in the documentation.
481
GENERATE_DEPRECATEDLIST= YES
483
# The ENABLED_SECTIONS tag can be used to enable conditional
484
# documentation sections, marked by \if sectionname ... \endif.
488
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
489
# the initial value of a variable or macro consists of for it to appear in
490
# the documentation. If the initializer consists of more lines than specified
491
# here it will be hidden. Use a value of 0 to hide initializers completely.
492
# The appearance of the initializer of individual variables and macros in the
493
# documentation can be controlled using \showinitializer or \hideinitializer
494
# command in the documentation regardless of this setting.
496
MAX_INITIALIZER_LINES = 30
498
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
499
# at the bottom of the documentation of classes and structs. If set to YES the
500
# list will mention the files that were used to generate the documentation.
504
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
505
# This will remove the Files entry from the Quick Index and from the
506
# Folder Tree View (if specified). The default is YES.
510
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
512
# This will remove the Namespaces entry from the Quick Index
513
# and from the Folder Tree View (if specified). The default is YES.
517
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
518
# doxygen should invoke to get the current version for each file (typically from
519
# the version control system). Doxygen will invoke the program by executing (via
520
# popen()) the command <command> <input-file>, where <command> is the value of
521
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
522
# provided by doxygen. Whatever the program writes to standard output
523
# is used as the file version. See the manual for examples.
527
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
528
# by doxygen. The layout file controls the global structure of the generated
529
# output files in an output format independent way. The create the layout file
530
# that represents doxygen's defaults, run doxygen with the -l option.
531
# You can optionally specify a file name after the option, if omitted
532
# DoxygenLayout.xml will be used as the name of the layout file.
536
#---------------------------------------------------------------------------
537
# configuration options related to warning and progress messages
538
#---------------------------------------------------------------------------
540
# The QUIET tag can be used to turn on/off the messages that are generated
541
# by doxygen. Possible values are YES and NO. If left blank NO is used.
545
# The WARNINGS tag can be used to turn on/off the warning messages that are
546
# generated by doxygen. Possible values are YES and NO. If left blank
551
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
552
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
553
# automatically be disabled.
555
WARN_IF_UNDOCUMENTED = YES
557
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
558
# potential errors in the documentation, such as not documenting some
559
# parameters in a documented function, or documenting parameters that
560
# don't exist or using markup commands wrongly.
562
WARN_IF_DOC_ERROR = YES
564
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
565
# functions that are documented, but have no documentation for their parameters
566
# or return value. If set to NO (the default) doxygen will only warn about
567
# wrong or incomplete parameter documentation, but not about the absence of
570
WARN_NO_PARAMDOC = YES
572
# The WARN_FORMAT tag determines the format of the warning messages that
573
# doxygen can produce. The string should contain the $file, $line, and $text
574
# tags, which will be replaced by the file and line number from which the
575
# warning originated and the warning text. Optionally the format may contain
576
# $version, which will be replaced by the version of the file (if it could
577
# be obtained via FILE_VERSION_FILTER)
579
WARN_FORMAT = "$file:$line: $text"
581
# The WARN_LOGFILE tag can be used to specify a file to which warning
582
# and error messages should be written. If left blank the output is written
587
#---------------------------------------------------------------------------
588
# configuration options related to the input files
589
#---------------------------------------------------------------------------
591
# The INPUT tag can be used to specify the files and/or directories that contain
592
# documented source files. You may enter file names like "myfile.cpp" or
593
# directories like "/usr/src/myproject". Separate the files or directories
596
INPUT = @top_srcdir@/src/lib \
597
@top_builddir@/src/lib \
598
@top_builddir@/elm_intro.h \
599
@srcdir@/index_elm.dox \
601
@srcdir@/pkgconfig.dox \
602
@srcdir@/eina_examples.dox \
603
@srcdir@/ecore_examples.dox \
604
@srcdir@/eet_examples.dox \
605
@srcdir@/evas_examples.dox \
606
@srcdir@/eo_tutorial.dox \
607
@srcdir@/eio_examples.dox \
608
@srcdir@/eldbus_examples.dox \
609
@srcdir@/ephysics_examples.dox \
610
@srcdir@/edje_examples.dox \
611
@top_srcdir@/src/bin/edje/edje_cc_handlers.c \
612
@srcdir@/emotion_examples.dox \
613
@srcdir@/elementary_examples.dox
615
# This tag can be used to specify the character encoding of the source files
616
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
617
# also the default input encoding. Doxygen uses libiconv (or the iconv built
618
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
619
# the list of possible encodings.
621
INPUT_ENCODING = UTF-8
623
# If the value of the INPUT tag contains directories, you can use the
624
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
625
# and *.h) to filter out the source-files in the directories. If left
626
# blank the following patterns are tested:
627
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
628
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
629
# *.f90 *.f *.for *.vhd *.vhdl
635
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
636
# should be searched for input files as well. Possible values are YES and NO.
637
# If left blank NO is used.
641
# The EXCLUDE tag can be used to specify files and/or directories that should
642
# excluded from the INPUT source files. This way you can easily exclude a
643
# subdirectory from a directory tree whose root is specified with the INPUT tag.
645
EXCLUDE = @top_builddir@/src/lib/evas/common \
646
@top_builddir@/src/lib/evas/cache \
647
@top_builddir@/src/lib/evas/file \
648
@top_builddir@/src/lib/evas/cserve2 \
649
@top_builddir@/src/lib/evas/include \
650
@top_builddir@/src/lib/efl
653
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
654
# directories that are symbolic links (a Unix file system feature) are excluded
659
# If the value of the INPUT tag contains directories, you can use the
660
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
661
# certain files from those directories. Note that the wildcards are matched
662
# against the file with absolute path, so to exclude all test directories
663
# for example use the pattern */test/*
665
EXCLUDE_PATTERNS = *_private* \
672
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
673
# (namespaces, classes, functions, etc.) that should be excluded from the
674
# output. The symbol name can be a fully qualified name, a word, or if the
675
# wildcard * is used, a substring. Examples: ANamespace, AClass,
676
# AClass::ANamespace, ANamespace::*Test
678
EXCLUDE_SYMBOLS = eo_cxx::*
680
# The EXAMPLE_PATH tag can be used to specify one or more files or
681
# directories that contain example code fragments that are included (see
682
# the \include command).
684
EXAMPLE_PATH = @top_srcdir@/src/examples \
685
@top_srcdir@/src/tests
687
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
688
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
689
# and *.h) to filter out the source-files in the directories. If left
690
# blank all files are included.
694
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
695
# searched for input files to be used with the \include or \dontinclude
696
# commands irrespective of the value of the RECURSIVE tag.
697
# Possible values are YES and NO. If left blank NO is used.
699
EXAMPLE_RECURSIVE = NO
701
# The IMAGE_PATH tag can be used to specify one or more files or
702
# directories that contain image that are included in the documentation (see
703
# the \image command).
705
IMAGE_PATH = @top_srcdir@/doc/img \
706
@top_srcdir@/doc/benchmark
708
# The INPUT_FILTER tag can be used to specify a program that doxygen should
709
# invoke to filter for each input file. Doxygen will invoke the filter program
710
# by executing (via popen()) the command <filter> <input-file>, where <filter>
711
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
712
# input file. Doxygen will then use the output that the filter program writes
714
# If FILTER_PATTERNS is specified, this tag will be
719
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
721
# Doxygen will compare the file name with each pattern and apply the
722
# filter if there is a match.
723
# The filters are a list of the form:
724
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
725
# info on how filters are used. If FILTER_PATTERNS is empty or if
726
# non of the patterns match the file name, INPUT_FILTER is applied.
730
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
731
# INPUT_FILTER) will be used to filter the input files when producing source
732
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
734
FILTER_SOURCE_FILES = NO
736
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
737
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
738
# and it is also possible to disable source filtering for a specific pattern
739
# using *.ext= (so without naming a filter). This option only has effect when
740
# FILTER_SOURCE_FILES is enabled.
742
FILTER_SOURCE_PATTERNS =
744
#---------------------------------------------------------------------------
745
# configuration options related to source browsing
746
#---------------------------------------------------------------------------
748
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
749
# be generated. Documented entities will be cross-referenced with these sources.
750
# Note: To get rid of all source code in the generated output, make sure also
751
# VERBATIM_HEADERS is set to NO.
755
# Setting the INLINE_SOURCES tag to YES will include the body
756
# of functions and classes directly in the documentation.
760
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
761
# doxygen to hide any special comment blocks from generated source code
762
# fragments. Normal C and C++ comments will always remain visible.
764
STRIP_CODE_COMMENTS = YES
766
# If the REFERENCED_BY_RELATION tag is set to YES
767
# then for each documented function all documented
768
# functions referencing it will be listed.
770
REFERENCED_BY_RELATION = YES
772
# If the REFERENCES_RELATION tag is set to YES
773
# then for each documented function all documented entities
774
# called/used by that function will be listed.
776
REFERENCES_RELATION = YES
778
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
779
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
780
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
781
# link to the source code.
782
# Otherwise they will link to the documentation.
784
REFERENCES_LINK_SOURCE = YES
786
# If the USE_HTAGS tag is set to YES then the references to source code
787
# will point to the HTML generated by the htags(1) tool instead of doxygen
788
# built-in source browser. The htags tool is part of GNU's global source
789
# tagging system (see http://www.gnu.org/software/global/global.html). You
790
# will need version 4.8.6 or higher.
794
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
795
# will generate a verbatim copy of the header file for each class for
796
# which an include is specified. Set to NO to disable this.
800
#---------------------------------------------------------------------------
801
# configuration options related to the alphabetical class index
802
#---------------------------------------------------------------------------
804
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
805
# of all compounds will be generated. Enable this if the project
806
# contains a lot of classes, structs, unions or interfaces.
808
ALPHABETICAL_INDEX = YES
810
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
811
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
812
# in which this list will be split (can be a number in the range [1..20])
814
COLS_IN_ALPHA_INDEX = 2
816
# In case all classes in a project start with a common prefix, all
817
# classes will be put under the same header in the alphabetical index.
818
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
819
# should be ignored while generating the index headers.
821
IGNORE_PREFIX = eina_ _eina_ Eina_ _Eina_ EINA_ _EINA_ \
822
eo_ _eo_ Eo_ _Eo_ EO_ _EO_ \
823
embryo_ _embryo_ Embryo_ _Embryo_ EMBRYO_ _EMBRYO_ \
824
escape_ _escape_ Escape_ _Escape_ ESCAPE_ _ESCAPE_ \
825
evil_ _evil_ Evil_ _Evil_ EVIL_ _EVIL_ \
826
evas_ _evas_ Evas_ _Evas_ EVAS_ _EVAS_ \
827
eet_ _eet_ Eet_ _Eet_ EET_ _EET_ \
828
ecore_ _ecore_ Ecore_ _Ecore_ ECORE_ _ECORE_ \
829
eio_ _eio_ Eio_ _Eio_ EIO_ _EIO_ \
830
eldbus_ _eldbus_ Eldbus_ _Eldbus_ ELDBUS_ _ELDBUS_ \
831
efreet_ _efreet_ Efreet_ _Efreet_ EFREET_ _EFREET_ \
832
eeze_ _eeze_ Eeze_ _Eeze_ EEZE_ _EEZE_ \
833
ephysics_ _ephysics_ EPhysics_ _EPhysics_ EPHYSICS_ _EPHYSICS_ \
834
edje_ _edje_ Edje_ _Edje_ EDJE_ _EDJE_ \
835
emotion_ _emotion_ Emotion_ _Emotion_ EMOTION_ _EMOTION_
838
#---------------------------------------------------------------------------
839
# configuration options related to the HTML output
840
#---------------------------------------------------------------------------
842
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
843
# generate HTML output.
847
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
848
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
849
# put in front of it. If left blank `html' will be used as the default path.
853
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
854
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
855
# doxygen will generate files with .html extension.
857
HTML_FILE_EXTENSION = .html
859
# The HTML_HEADER tag can be used to specify a personal HTML header for
860
# each generated HTML page. If it is left blank doxygen will generate a
863
HTML_HEADER = @srcdir@/head.html
865
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
866
# each generated HTML page. If it is left blank doxygen will generate a
869
HTML_FOOTER = @srcdir@/foot.html
871
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
872
# style sheet that is used by each HTML page. It can be used to
873
# fine-tune the look of the HTML output. If the tag is left blank doxygen
874
# will generate a default style sheet. Note that doxygen will try to copy
875
# the style sheet file to the HTML output directory, so don't put your own
876
# stylesheet in the HTML output directory as well, or it will be erased!
878
HTML_STYLESHEET = @srcdir@/e.css
880
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
881
# Doxygen will adjust the colors in the stylesheet and background images
882
# according to this color. Hue is specified as an angle on a colorwheel,
883
# see http://en.wikipedia.org/wiki/Hue for more information.
884
# For instance the value 0 represents red, 60 is yellow, 120 is green,
885
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
886
# The allowed range is 0 to 359.
888
HTML_COLORSTYLE_HUE = 220
890
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
891
# the colors in the HTML output. For a value of 0 the output will use
892
# grayscales only. A value of 255 will produce the most vivid colors.
894
HTML_COLORSTYLE_SAT = 100
896
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
897
# the luminance component of the colors in the HTML output. Values below
898
# 100 gradually make the output lighter, whereas values above 100 make
899
# the output darker. The value divided by 100 is the actual gamma applied,
900
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
901
# and 100 does not change the gamma.
903
HTML_COLORSTYLE_GAMMA = 80
905
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
906
# page will contain the date and time when the page was generated. Setting
907
# this to NO can help when comparing the output of multiple runs.
911
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
912
# documentation will contain sections that can be hidden and shown after the
913
# page has loaded. For this to work a browser that supports
914
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
915
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
917
HTML_DYNAMIC_SECTIONS = YES
919
# If the GENERATE_DOCSET tag is set to YES, additional index files
920
# will be generated that can be used as input for Apple's Xcode 3
921
# integrated development environment, introduced with OSX 10.5 (Leopard).
922
# To create a documentation set, doxygen will generate a Makefile in the
923
# HTML output directory. Running make will produce the docset in that
924
# directory and running "make install" will install the docset in
925
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
927
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
928
# for more information.
932
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
933
# feed. A documentation feed provides an umbrella under which multiple
934
# documentation sets from a single provider (such as a company or product suite)
937
DOCSET_FEEDNAME = "Doxygen generated docs"
939
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
940
# should uniquely identify the documentation set bundle. This should be a
941
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
942
# will append .docset to the name.
944
DOCSET_BUNDLE_ID = org.enlightenment.Efl
946
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
947
# the documentation publisher. This should be a reverse domain-name style
948
# string, e.g. com.mycompany.MyDocSet.documentation.
950
DOCSET_PUBLISHER_ID = org.enlightenment.Efl
952
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
954
DOCSET_PUBLISHER_NAME = Enlightenment
956
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
957
# will be generated that can be used as input for tools like the
958
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
959
# of the generated HTML documentation.
961
GENERATE_HTMLHELP = YES
963
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
964
# be used to specify the file name of the resulting .chm file. You
965
# can add a path in front of the file if the result should not be
966
# written to the html output directory.
970
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
971
# be used to specify the location (absolute path including file name) of
972
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
973
# the HTML help compiler on the generated index.hhp.
977
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
978
# controls if a separate .chi index file is generated (YES) or that
979
# it should be included in the master .chm file (NO).
983
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
984
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
989
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
990
# controls whether a binary table of contents is generated (YES) or a
991
# normal table of contents (NO) in the .chm file.
995
# The TOC_EXPAND flag can be set to YES to add extra items for group members
996
# to the contents of the HTML help documentation and to the tree view.
1000
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1001
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1002
# that can be used as input for Qt's qhelpgenerator to generate a
1003
# Qt Compressed Help (.qch) of the generated HTML documentation.
1007
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1008
# be used to specify the file name of the resulting .qch file.
1009
# The path specified is relative to the HTML output folder.
1013
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1014
# Qt Help Project output. For more information please see
1015
# http://doc.trolltech.com/qthelpproject.html#namespace
1017
QHP_NAMESPACE = org.enlightenment.Efl
1019
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1020
# Qt Help Project output. For more information please see
1021
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1023
QHP_VIRTUAL_FOLDER = doc
1025
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1026
# add. For more information please see
1027
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1029
QHP_CUST_FILTER_NAME =
1031
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1032
# custom filter to add. For more information please see
1033
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1034
# Qt Help Project / Custom Filters</a>.
1036
QHP_CUST_FILTER_ATTRS =
1038
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1040
# filter section matches.
1041
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1042
# Qt Help Project / Filter Attributes</a>.
1044
QHP_SECT_FILTER_ATTRS =
1046
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1047
# be used to specify the location of Qt's qhelpgenerator.
1048
# If non-empty doxygen will try to run qhelpgenerator on the generated
1053
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1054
# will be generated, which together with the HTML files, form an Eclipse help
1055
# plugin. To install this plugin and make it available under the help contents
1056
# menu in Eclipse, the contents of the directory containing the HTML and XML
1057
# files needs to be copied into the plugins directory of eclipse. The name of
1058
# the directory within the plugins directory should be the same as
1059
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1062
GENERATE_ECLIPSEHELP = NO
1064
# A unique identifier for the eclipse help plugin. When installing the plugin
1065
# the directory name containing the HTML and XML files should also have
1068
ECLIPSE_DOC_ID = org.enlightenment.Efl
1070
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1071
# top of each HTML page. The value NO (the default) enables the index and
1072
# the value YES disables it.
1076
# This tag can be used to set the number of enum values (range [0,1..20])
1077
# that doxygen will group on one line in the generated HTML documentation.
1078
# Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
1080
ENUM_VALUES_PER_LINE = 1
1082
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1083
# structure should be generated to display hierarchical information.
1084
# If the tag value is set to YES, a side panel will be generated
1085
# containing a tree-like index structure (just like the one that
1086
# is generated for HTML Help). For this to work a browser that supports
1087
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1088
# Windows users are probably better off using the HTML help feature.
1090
GENERATE_TREEVIEW = NO
1092
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1093
# used to set the initial width (in pixels) of the frame in which the tree
1098
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1099
# links to external symbols imported via tag files in a separate window.
1101
EXT_LINKS_IN_WINDOW = NO
1103
# Use this tag to change the font size of Latex formulas included
1104
# as images in the HTML documentation. The default is 10. Note that
1105
# when you change the font size after a successful doxygen run you need
1106
# to manually remove any form_*.png images from the HTML output directory
1107
# to force them to be regenerated.
1109
FORMULA_FONTSIZE = 10
1111
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1112
# generated for formulas are transparent PNGs. Transparent PNGs are
1113
# not supported properly for IE 6.0, but are supported on all modern browsers.
1114
# Note that when changing this option you need to delete any form_*.png files
1115
# in the HTML output before the changes have effect.
1117
FORMULA_TRANSPARENT = YES
1119
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1120
# (see http://www.mathjax.org) which uses client side Javascript for the
1121
# rendering instead of using prerendered bitmaps. Use this if you do not
1122
# have LaTeX installed or if you want to formulas look prettier in the HTML
1123
# output. When enabled you also need to install MathJax separately and
1124
# configure the path to it using the MATHJAX_RELPATH option.
1128
# When MathJax is enabled you need to specify the location relative to the
1129
# HTML output directory using the MATHJAX_RELPATH option. The destination
1130
# directory should contain the MathJax.js script. For instance, if the mathjax
1131
# directory is located at the same level as the HTML output directory, then
1132
# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
1133
# MathJax, but it is strongly recommended to install a local copy of MathJax
1136
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1138
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1139
# for the HTML output. The underlying search engine uses javascript
1140
# and DHTML and should work on any modern browser. Note that when using
1141
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1142
# (GENERATE_DOCSET) there is already a search function so this one should
1143
# typically be disabled. For large projects the javascript based search engine
1144
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1148
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1149
# implemented using a PHP enabled web server instead of at the web client
1150
# using Javascript. Doxygen will generate the search PHP script and index
1151
# file to put on the web server. The advantage of the server
1152
# based approach is that it scales better to large projects and allows
1153
# full text search. The disadvantages are that it is more difficult to setup
1154
# and does not have live searching capabilities.
1156
SERVER_BASED_SEARCH = NO
1158
#---------------------------------------------------------------------------
1159
# configuration options related to the LaTeX output
1160
#---------------------------------------------------------------------------
1162
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1163
# generate Latex output.
1167
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1168
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1169
# put in front of it. If left blank `latex' will be used as the default path.
1173
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1174
# invoked. If left blank `latex' will be used as the default command name.
1175
# Note that when enabling USE_PDFLATEX this option is only used for
1176
# generating bitmaps for formulas in the HTML output, but not in the
1177
# Makefile that is written to the output directory.
1179
LATEX_CMD_NAME = latex
1181
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1182
# generate index for LaTeX. If left blank `makeindex' will be used as the
1183
# default command name.
1185
MAKEINDEX_CMD_NAME = makeindex
1187
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1188
# LaTeX documents. This may be useful for small projects and may help to
1189
# save some trees in general.
1193
# The PAPER_TYPE tag can be used to set the paper type that is used
1194
# by the printer. Possible values are: a4, letter, legal and
1195
# executive. If left blank a4wide will be used.
1199
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1200
# packages that should be included in the LaTeX output.
1204
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1205
# the generated latex document. The header should contain everything until
1206
# the first chapter. If it is left blank doxygen will generate a
1207
# standard header. Notice: only use this tag if you know what you are doing!
1211
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1212
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1213
# contain links (just like the HTML output) instead of page references
1214
# This makes the output suitable for online browsing using a pdf viewer.
1218
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1219
# plain latex in the generated Makefile. Set this option to YES to get a
1220
# higher quality PDF documentation.
1224
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1225
# command to the generated LaTeX files. This will instruct LaTeX to keep
1226
# running if errors occur, instead of asking the user for help.
1227
# This option is also used when generating formulas in HTML.
1231
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1232
# include the index chapters (such as File Index, Compound Index, etc.)
1235
LATEX_HIDE_INDICES = NO
1237
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1238
# source code with syntax highlighting in the LaTeX output.
1239
# Note that which sources are shown also depends on other settings
1240
# such as SOURCE_BROWSER.
1242
LATEX_SOURCE_CODE = NO
1244
#---------------------------------------------------------------------------
1245
# configuration options related to the RTF output
1246
#---------------------------------------------------------------------------
1248
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1249
# The RTF output is optimized for Word 97 and may not look very pretty with
1250
# other RTF readers or editors.
1254
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1255
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1256
# put in front of it. If left blank `rtf' will be used as the default path.
1260
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1261
# RTF documents. This may be useful for small projects and may help to
1262
# save some trees in general.
1266
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1267
# will contain hyperlink fields. The RTF file will
1268
# contain links (just like the HTML output) instead of page references.
1269
# This makes the output suitable for online browsing using WORD or other
1270
# programs which support those fields.
1271
# Note: wordpad (write) and others do not support links.
1275
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1276
# config file, i.e. a series of assignments. You only have to provide
1277
# replacements, missing definitions are set to their default value.
1279
RTF_STYLESHEET_FILE =
1281
# Set optional variables used in the generation of an rtf document.
1282
# Syntax is similar to doxygen's config file.
1284
RTF_EXTENSIONS_FILE =
1286
#---------------------------------------------------------------------------
1287
# configuration options related to the man page output
1288
#---------------------------------------------------------------------------
1290
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1295
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1296
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1297
# put in front of it. If left blank `man' will be used as the default path.
1301
# The MAN_EXTENSION tag determines the extension that is added to
1302
# the generated man pages (default is the subroutine's section .3)
1306
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1307
# then it will generate one additional man file for each entity
1308
# documented in the real man page(s). These additional files
1309
# only source the real man page, but without them the man command
1310
# would be unable to find the correct page. The default is NO.
1314
#---------------------------------------------------------------------------
1315
# configuration options related to the XML output
1316
#---------------------------------------------------------------------------
1318
# If the GENERATE_XML tag is set to YES Doxygen will
1319
# generate an XML file that captures the structure of
1320
# the code including all documentation.
1324
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1325
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1326
# put in front of it. If left blank `xml' will be used as the default path.
1330
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1331
# dump the program listings (including syntax highlighting
1332
# and cross-referencing information) to the XML output. Note that
1333
# enabling this will significantly increase the size of the XML output.
1335
XML_PROGRAMLISTING = YES
1337
#---------------------------------------------------------------------------
1338
# configuration options for the AutoGen Definitions output
1339
#---------------------------------------------------------------------------
1341
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1342
# generate an AutoGen Definitions (see autogen.sf.net) file
1343
# that captures the structure of the code including all
1344
# documentation. Note that this feature is still experimental
1345
# and incomplete at the moment.
1347
GENERATE_AUTOGEN_DEF = NO
1349
#---------------------------------------------------------------------------
1350
# configuration options related to the Perl module output
1351
#---------------------------------------------------------------------------
1353
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1354
# generate a Perl module file that captures the structure of
1355
# the code including all documentation. Note that this
1356
# feature is still experimental and incomplete at the
1359
GENERATE_PERLMOD = NO
1361
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1362
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1363
# to generate PDF and DVI output from the Perl module output.
1367
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1368
# nicely formatted so it can be parsed by a human reader.
1370
# if you want to understand what is going on.
1371
# On the other hand, if this
1372
# tag is set to NO the size of the Perl module output will be much smaller
1373
# and Perl will parse it just the same.
1377
# The names of the make variables in the generated doxyrules.make file
1378
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1379
# This is useful so different doxyrules.make files included by the same
1380
# Makefile don't overwrite each other's variables.
1382
PERLMOD_MAKEVAR_PREFIX =
1384
#---------------------------------------------------------------------------
1385
# Configuration options related to the preprocessor
1386
#---------------------------------------------------------------------------
1388
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1389
# evaluate all C-preprocessor directives found in the sources and include
1392
ENABLE_PREPROCESSING = YES
1394
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1395
# names in the source code. If set to NO (the default) only conditional
1396
# compilation will be performed. Macro expansion can be done in a controlled
1397
# way by setting EXPAND_ONLY_PREDEF to YES.
1399
MACRO_EXPANSION = YES
1401
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1402
# then the macro expansion is limited to the macros specified with the
1403
# PREDEFINED and EXPAND_AS_DEFINED tags.
1405
EXPAND_ONLY_PREDEF = YES
1407
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1408
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1412
# The INCLUDE_PATH tag can be used to specify one or more directories that
1413
# contain include files that are not input files but should be processed by
1418
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1419
# patterns (like *.h and *.hpp) to filter out the header-files in the
1420
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1423
INCLUDE_FILE_PATTERNS =
1425
# The PREDEFINED tag can be used to specify one or more macro names that
1426
# are defined before the preprocessor is started (similar to the -D option of
1427
# gcc). The argument of the tag is a list of macros of the form: name
1428
# or name=definition (no spaces). If the definition and the = are
1429
# omitted =1 is assumed. To prevent a macro definition from being
1430
# undefined via #undef or recursively expanded use the := operator
1431
# instead of the = operator.
1433
PREDEFINED = EINA_MAGIC_DEBUG \
1435
EINA_ARG_NONNULL()= \
1437
EINA_WARN_UNUSED_RESULT= \
1443
EFL_BETA_API_SUPPORT=1 \
1444
"EO_CXX_INHERIT(name)=::name"
1446
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1447
# this tag can be used to specify a list of macro names that should be expanded.
1448
# The macro definition that is found in the sources will be used.
1449
# Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
1451
EXPAND_AS_DEFINED = EINA_VALUE_CONVERT \
1456
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1457
# doxygen's preprocessor will remove all references to function-like macros
1458
# that are alone on a line, have an all uppercase name, and do not end with a
1459
# semicolon, because these will confuse the parser if not removed.
1461
SKIP_FUNCTION_MACROS = YES
1463
#---------------------------------------------------------------------------
1464
# Configuration::additions related to external references
1465
#---------------------------------------------------------------------------
1467
# The TAGFILES option can be used to specify one or more tagfiles.
1468
# Optionally an initial location of the external documentation
1469
# can be added for each tagfile. The format of a tag file without
1470
# this location is as follows:
1472
# TAGFILES = file1 file2 ...
1473
# Adding location for the tag files is done as follows:
1475
# TAGFILES = file1=loc1 "file2 = loc2" ...
1476
# where "loc1" and "loc2" can be relative or absolute paths or
1477
# URLs. If a location is present for each tag, the installdox tool
1478
# does not have to be run to correct the links.
1479
# Note that each tag file must have a unique name
1480
# (where the name does NOT include the path)
1481
# If a tag file is not located in the directory in which doxygen
1482
# is run, you must also specify the path to the tagfile here.
1486
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1487
# a tag file that is based on the input files it reads.
1491
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1492
# in the class index. If set to NO only the inherited external classes
1497
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1498
# in the modules index. If set to NO, only the current project's groups will
1501
EXTERNAL_GROUPS = YES
1503
# The PERL_PATH should be the absolute path and name of the perl script
1504
# interpreter (i.e. the result of `which perl').
1506
PERL_PATH = /usr/bin/perl
1508
#---------------------------------------------------------------------------
1509
# Configuration options related to the dot tool
1510
#---------------------------------------------------------------------------
1512
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1513
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1514
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1515
# this option also works with HAVE_DOT disabled, but it is recommended to
1516
# install and use dot, since it yields more powerful graphs.
1520
# You can define message sequence charts within doxygen comments using the \msc
1521
# command. Doxygen will then run the mscgen tool (see
1522
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1523
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1524
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1525
# default search path.
1529
# If set to YES, the inheritance and collaboration graphs will hide
1530
# inheritance and usage relations if the target is undocumented
1533
HIDE_UNDOC_RELATIONS = YES
1535
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1536
# available from the path. This tool is part of Graphviz, a graph visualization
1537
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1538
# have no effect if this option is set to NO (the default)
1542
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1543
# allowed to run in parallel. When set to 0 (the default) doxygen will
1544
# base this on the number of processors available in the system. You can set it
1545
# explicitly to a value larger than 0 to get control over the balance
1546
# between CPU load and processing speed.
1550
# By default doxygen will write a font called Helvetica to the output
1551
# directory and reference it in all dot files that doxygen generates.
1552
# When you want a differently looking font you can specify the font name
1553
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
1554
# which can be done by putting it in a standard location or by setting the
1555
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1556
# containing the font.
1558
DOT_FONTNAME = Helvetica
1560
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1561
# The default size is 10pt.
1565
# By default doxygen will tell dot to use the output directory to look for the
1566
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1567
# different font using DOT_FONTNAME you can set the path where dot
1568
# can find it using this tag.
1572
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1573
# will generate a graph for each documented class showing the direct and
1574
# indirect inheritance relations. Setting this tag to YES will force the
1575
# the CLASS_DIAGRAMS tag to NO.
1579
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1580
# will generate a graph for each documented class showing the direct and
1581
# indirect implementation dependencies (inheritance, containment, and
1582
# class references variables) of the class with other documented classes.
1584
COLLABORATION_GRAPH = NO
1586
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1587
# will generate a graph for groups, showing the direct groups dependencies
1591
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1592
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1597
# If set to YES, the inheritance and collaboration graphs will show the
1598
# relations between templates and their instances.
1600
TEMPLATE_RELATIONS = NO
1602
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1603
# tags are set to YES then doxygen will generate a graph for each documented
1604
# file showing the direct and indirect include dependencies of the file with
1605
# other documented files.
1609
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1610
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1611
# documented header file showing the documented files that directly or
1612
# indirectly include this file.
1614
INCLUDED_BY_GRAPH = NO
1616
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1617
# doxygen will generate a call dependency graph for every global function
1618
# or class method. Note that enabling this option will significantly increase
1619
# the time of a run. So in most cases it will be better to enable call graphs
1620
# for selected functions only using the \callgraph command.
1624
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1625
# doxygen will generate a caller dependency graph for every global function
1626
# or class method. Note that enabling this option will significantly increase
1627
# the time of a run. So in most cases it will be better to enable caller
1628
# graphs for selected functions only using the \callergraph command.
1632
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1633
# will generate a graphical hierarchy of all classes instead of a textual one.
1635
GRAPHICAL_HIERARCHY = NO
1637
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1638
# then doxygen will show the dependencies a directory has on other directories
1639
# in a graphical way. The dependency relations are determined by the #include
1640
# relations between the files in the directories.
1642
DIRECTORY_GRAPH = YES
1644
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1645
# generated by dot. Possible values are png, svg, gif or svg.
1646
# If left blank png will be used.
1648
DOT_IMAGE_FORMAT = png
1650
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1651
# found. If left blank, it is assumed the dot tool can be found in the path.
1655
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1656
# contain dot files that are included in the documentation (see the
1661
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1662
# contain msc files that are included in the documentation (see the
1667
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1668
# nodes that will be shown in the graph. If the number of nodes in a graph
1669
# becomes larger than this value, doxygen will truncate the graph, which is
1670
# visualized by representing a node as a red box. Note that doxygen if the
1671
# number of direct children of the root node in a graph is already larger than
1672
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1673
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1675
DOT_GRAPH_MAX_NODES = 50
1677
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1678
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1679
# from the root by following a path via at most 3 edges will be shown. Nodes
1680
# that lay further from the root node will be omitted. Note that setting this
1681
# option to 1 or 2 may greatly reduce the computation time needed for large
1682
# code bases. Also note that the size of a graph can be further restricted by
1683
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1685
MAX_DOT_GRAPH_DEPTH = 0
1687
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1688
# background. This is disabled by default, because dot on Windows does not
1689
# seem to support this out of the box. Warning: Depending on the platform used,
1690
# enabling this option may lead to badly anti-aliased labels on the edges of
1691
# a graph (i.e. they become hard to read).
1693
DOT_TRANSPARENT = YES
1695
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1696
# files in one run (i.e. multiple -o and -T options on the command line). This
1697
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1698
# support this, this feature is disabled by default.
1700
DOT_MULTI_TARGETS = NO
1702
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1703
# generate a legend page explaining the meaning of the various boxes and
1704
# arrows in the dot generated graphs.
1706
GENERATE_LEGEND = YES
1708
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1709
# remove the intermediate dot files that are used to generate
1710
# the various graphs.
1714
# Aliases used by edcref
1716
ALIASES = block="<tr><td class=\"block\"><b>"
1717
ALIASES += context="</b></td><td class=\"context\" colspan=2>\code"
1718
ALIASES += description="\endcode</td></tr><tr><td> </td><td class=\"description\" colspan=2>"
1719
ALIASES += endblock="</td></tr>"
1720
ALIASES += property="<tr><td> </td><td><table class=\"edcref_prop\" border=\"0\"><tr><td class=\"property\"><tt>"
1721
ALIASES += parameters="</tt></td><td class=\"parameters\"><tt>"
1722
ALIASES += effect="</tt></td></tr><tr><td> </td><td class=\"effect\">"
1723
ALIASES += endproperty="</td></tr></table></td></tr>"
1724
ALIASES += edcsection{2}="</table><table class=\"edcref\"><tr class=\"section\"><td class=\"section\" colspan=\"2\">\anchor sec_\1 \ref sec_quickaccess \"\2\"</td></tr>"1725
ALIASES += edcsubsection{2}="<tr class=\"subsection\"><td class=\"subsection\" colspan=\"2\">\anchor sec_\1 \ref sec_quickaccess \"\2\"</td></tr>"1727
# Aliases used by luaref
1728
ALIASES += luaclass{2}="\anchor \1 \n<div class=\"luaclass\">\2</div>"1729
ALIASES += attributes="<div class=\"luaattrib\">Attributes:</div>"
1730
ALIASES += methods="<div class=\"luaattrib\">Methods:</div>"
1731
ALIASES += events="<div class=\"luaattrib\">Events:</div>"
1732
ALIASES += setters="<div class=\"luaattrib\">Setters:</div>"
1733
ALIASES += seealso{2}="<b>See also:</b> <a href='\2'>\1</a>\n"1734
ALIASES += seealso{1}="<b>See also:</b> \1\n"