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