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