diff options
author | David Walter Seikel | 2012-01-23 23:30:42 +1000 |
---|---|---|
committer | David Walter Seikel | 2012-01-23 23:30:42 +1000 |
commit | 825a3d837a33f226c879cd02ad15c3fba57e8b2c (patch) | |
tree | 75f57bd9c4253508d338dc79ba8e57a7abc42255 /libraries/eet/doc/Doxyfile | |
parent | Add ability to disable the test harness, or the Lua compile test. (diff) | |
download | SledjHamr-825a3d837a33f226c879cd02ad15c3fba57e8b2c.zip SledjHamr-825a3d837a33f226c879cd02ad15c3fba57e8b2c.tar.gz SledjHamr-825a3d837a33f226c879cd02ad15c3fba57e8b2c.tar.bz2 SledjHamr-825a3d837a33f226c879cd02ad15c3fba57e8b2c.tar.xz |
Update the EFL to what I'm actually using, coz I'm using some stuff not yet released.
Diffstat (limited to 'libraries/eet/doc/Doxyfile')
-rw-r--r-- | libraries/eet/doc/Doxyfile | 1689 |
1 files changed, 1622 insertions, 67 deletions
diff --git a/libraries/eet/doc/Doxyfile b/libraries/eet/doc/Doxyfile index bf2352b..f6e3026 100644 --- a/libraries/eet/doc/Doxyfile +++ b/libraries/eet/doc/Doxyfile | |||
@@ -1,139 +1,1694 @@ | |||
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 | |||
1 | PROJECT_NAME = Eet | 28 | PROJECT_NAME = Eet |
2 | PROJECT_NUMBER = 1.5.0 | 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 = 1.5.99.67344 | ||
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 | |||
3 | OUTPUT_DIRECTORY = . | 52 | OUTPUT_DIRECTORY = . |
4 | INPUT = ./eet.dox ./examples.dox ../src/lib | 53 | |
5 | IMAGE_PATH = img | 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 | |||
6 | OUTPUT_LANGUAGE = English | 74 | OUTPUT_LANGUAGE = English |
7 | GENERATE_HTML = YES | 75 | |
8 | HTML_OUTPUT = html | 76 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
9 | HTML_FILE_EXTENSION = .html | 77 | # include brief member descriptions after the members that are listed in |
10 | HTML_HEADER = ./head.html | 78 | # the file and class documentation (similar to JavaDoc). |
11 | HTML_FOOTER = ./foot.html | 79 | # Set to NO to disable this. |
12 | HTML_STYLESHEET = ./e.css | 80 | |
13 | HTML_ALIGN_MEMBERS = YES | ||
14 | ENUM_VALUES_PER_LINE = 1 | ||
15 | GENERATE_HTMLHELP = NO | ||
16 | CHM_FILE = | ||
17 | HHC_LOCATION = | ||
18 | GENERATE_CHI = NO | ||
19 | BINARY_TOC = NO | ||
20 | TOC_EXPAND = NO | ||
21 | DISABLE_INDEX = YES | ||
22 | EXTRACT_ALL = NO | ||
23 | EXTRACT_PRIVATE = NO | ||
24 | EXTRACT_STATIC = NO | ||
25 | EXTRACT_LOCAL_CLASSES = NO | ||
26 | HIDE_UNDOC_MEMBERS = YES | ||
27 | HIDE_UNDOC_CLASSES = YES | ||
28 | HIDE_FRIEND_COMPOUNDS = YES | ||
29 | BRIEF_MEMBER_DESC = YES | 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 | |||
30 | REPEAT_BRIEF = YES | 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 | |||
31 | ALWAYS_DETAILED_SEC = NO | 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 | |||
32 | INLINE_INHERITED_MEMB = NO | 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 | |||
33 | FULL_PATH_NAMES = NO | 119 | FULL_PATH_NAMES = NO |
34 | STRIP_FROM_PATH = | 120 | |
35 | INTERNAL_DOCS = NO | 121 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
36 | STRIP_CODE_COMMENTS = NO | 122 | # can be used to strip a user-defined part of the path. Stripping is |
37 | CASE_SENSE_NAMES = YES | 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 | |||
38 | SHORT_NAMES = NO | 143 | SHORT_NAMES = NO |
39 | HIDE_SCOPE_NAMES = NO | 144 | |
40 | VERBATIM_HEADERS = NO | 145 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
41 | SHOW_INCLUDE_FILES = NO | 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 | |||
42 | JAVADOC_AUTOBRIEF = YES | 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 | |||
43 | MULTILINE_CPP_IS_BRIEF = NO | 167 | MULTILINE_CPP_IS_BRIEF = NO |
44 | DETAILS_AT_TOP = 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 | |||
45 | INHERIT_DOCS = YES | 173 | INHERIT_DOCS = YES |
46 | INLINE_INFO = YES | 174 | |
47 | SORT_MEMBER_DOCS = YES | 175 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
48 | DISTRIBUTE_GROUP_DOC = NO | 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 | |||
49 | TAB_SIZE = 8 | 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 = NO | ||
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 | |||
50 | GENERATE_TODOLIST = YES | 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 | |||
51 | GENERATE_TESTLIST = YES | 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 | |||
52 | GENERATE_BUGLIST = YES | 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 | |||
53 | GENERATE_DEPRECATEDLIST= YES | 480 | GENERATE_DEPRECATEDLIST= YES |
54 | ALIASES = | 481 | |
55 | ENABLED_SECTIONS = | 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 | |||
56 | MAX_INITIALIZER_LINES = 30 | 495 | MAX_INITIALIZER_LINES = 30 |
57 | OPTIMIZE_OUTPUT_FOR_C = YES | 496 | |
58 | OPTIMIZE_OUTPUT_JAVA = NO | 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 | |||
59 | SHOW_USED_FILES = NO | 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 | |||
60 | QUIET = NO | 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 | |||
61 | WARNINGS = YES | 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 | |||
62 | WARN_IF_UNDOCUMENTED = YES | 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 | |||
63 | WARN_FORMAT = "$file:$line: $text" | 584 | WARN_FORMAT = "$file:$line: $text" |
64 | WARN_LOGFILE = | 585 | |
65 | FILE_PATTERNS = | 586 | # The WARN_LOGFILE tag can be used to specify a file to which warning |
66 | RECURSIVE = NO | 587 | # and error messages should be written. If left blank the output is written |
67 | EXCLUDE = | 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 = ./eet.dox \ | ||
602 | ./examples.dox \ | ||
603 | ../src/lib | ||
604 | |||
605 | # This tag can be used to specify the character encoding of the source files | ||
606 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | ||
607 | # also the default input encoding. Doxygen uses libiconv (or the iconv built | ||
608 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | ||
609 | # the list of possible encodings. | ||
610 | |||
611 | INPUT_ENCODING = UTF-8 | ||
612 | |||
613 | # If the value of the INPUT tag contains directories, you can use the | ||
614 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
615 | # and *.h) to filter out the source-files in the directories. If left | ||
616 | # blank the following patterns are tested: | ||
617 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh | ||
618 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py | ||
619 | # *.f90 *.f *.for *.vhd *.vhdl | ||
620 | |||
621 | FILE_PATTERNS = *.c \ | ||
622 | *.h | ||
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 = ../src/lib/eet_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 | |||
68 | EXCLUDE_SYMLINKS = NO | 640 | EXCLUDE_SYMLINKS = NO |
69 | EXCLUDE_PATTERNS = | 641 | |
70 | EXAMPLE_PATH = ../src/examples/ | 642 | # If the value of the INPUT tag contains directories, you can use the |
71 | EXAMPLE_PATTERNS = | 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 = ../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 | |||
72 | EXAMPLE_RECURSIVE = NO | 676 | EXAMPLE_RECURSIVE = NO |
73 | INPUT_FILTER = | 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 = ../doc/img | ||
683 | |||
684 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | ||
685 | # invoke to filter for each input file. Doxygen will invoke the filter program | ||
686 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | ||
687 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | ||
688 | # input file. Doxygen will then use the output that the filter program writes | ||
689 | # to standard output. | ||
690 | # If FILTER_PATTERNS is specified, this tag will be | ||
691 | # ignored. | ||
692 | |||
693 | INPUT_FILTER = | ||
694 | |||
695 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | ||
696 | # basis. | ||
697 | # Doxygen will compare the file name with each pattern and apply the | ||
698 | # filter if there is a match. | ||
699 | # The filters are a list of the form: | ||
700 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | ||
701 | # info on how filters are used. If FILTER_PATTERNS is empty or if | ||
702 | # non of the patterns match the file name, INPUT_FILTER is applied. | ||
703 | |||
704 | FILTER_PATTERNS = | ||
705 | |||
706 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | ||
707 | # INPUT_FILTER) will be used to filter the input files when producing source | ||
708 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). | ||
709 | |||
74 | FILTER_SOURCE_FILES = NO | 710 | FILTER_SOURCE_FILES = NO |
711 | |||
712 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file | ||
713 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) | ||
714 | # and it is also possible to disable source filtering for a specific pattern | ||
715 | # using *.ext= (so without naming a filter). This option only has effect when | ||
716 | # FILTER_SOURCE_FILES is enabled. | ||
717 | |||
718 | FILTER_SOURCE_PATTERNS = | ||
719 | |||
720 | #--------------------------------------------------------------------------- | ||
721 | # configuration options related to source browsing | ||
722 | #--------------------------------------------------------------------------- | ||
723 | |||
724 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | ||
725 | # be generated. Documented entities will be cross-referenced with these sources. | ||
726 | # Note: To get rid of all source code in the generated output, make sure also | ||
727 | # VERBATIM_HEADERS is set to NO. | ||
728 | |||
75 | SOURCE_BROWSER = NO | 729 | SOURCE_BROWSER = NO |
730 | |||
731 | # Setting the INLINE_SOURCES tag to YES will include the body | ||
732 | # of functions and classes directly in the documentation. | ||
733 | |||
76 | INLINE_SOURCES = NO | 734 | INLINE_SOURCES = NO |
735 | |||
736 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | ||
737 | # doxygen to hide any special comment blocks from generated source code | ||
738 | # fragments. Normal C and C++ comments will always remain visible. | ||
739 | |||
740 | STRIP_CODE_COMMENTS = YES | ||
741 | |||
742 | # If the REFERENCED_BY_RELATION tag is set to YES | ||
743 | # then for each documented function all documented | ||
744 | # functions referencing it will be listed. | ||
745 | |||
77 | REFERENCED_BY_RELATION = YES | 746 | REFERENCED_BY_RELATION = YES |
747 | |||
748 | # If the REFERENCES_RELATION tag is set to YES | ||
749 | # then for each documented function all documented entities | ||
750 | # called/used by that function will be listed. | ||
751 | |||
78 | REFERENCES_RELATION = YES | 752 | REFERENCES_RELATION = YES |
753 | |||
754 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | ||
755 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | ||
756 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | ||
757 | # link to the source code. | ||
758 | # Otherwise they will link to the documentation. | ||
759 | |||
760 | REFERENCES_LINK_SOURCE = YES | ||
761 | |||
762 | # If the USE_HTAGS tag is set to YES then the references to source code | ||
763 | # will point to the HTML generated by the htags(1) tool instead of doxygen | ||
764 | # built-in source browser. The htags tool is part of GNU's global source | ||
765 | # tagging system (see http://www.gnu.org/software/global/global.html). You | ||
766 | # will need version 4.8.6 or higher. | ||
767 | |||
768 | USE_HTAGS = NO | ||
769 | |||
770 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | ||
771 | # will generate a verbatim copy of the header file for each class for | ||
772 | # which an include is specified. Set to NO to disable this. | ||
773 | |||
774 | VERBATIM_HEADERS = NO | ||
775 | |||
776 | #--------------------------------------------------------------------------- | ||
777 | # configuration options related to the alphabetical class index | ||
778 | #--------------------------------------------------------------------------- | ||
779 | |||
780 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | ||
781 | # of all compounds will be generated. Enable this if the project | ||
782 | # contains a lot of classes, structs, unions or interfaces. | ||
783 | |||
79 | ALPHABETICAL_INDEX = YES | 784 | ALPHABETICAL_INDEX = YES |
785 | |||
786 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | ||
787 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | ||
788 | # in which this list will be split (can be a number in the range [1..20]) | ||
789 | |||
80 | COLS_IN_ALPHA_INDEX = 2 | 790 | COLS_IN_ALPHA_INDEX = 2 |
81 | IGNORE_PREFIX = eet_ _eet_ Eet_ _Eet_ EET_ _EET_ | 791 | |
792 | # In case all classes in a project start with a common prefix, all | ||
793 | # classes will be put under the same header in the alphabetical index. | ||
794 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | ||
795 | # should be ignored while generating the index headers. | ||
796 | |||
797 | IGNORE_PREFIX = eet_ \ | ||
798 | _eet_ \ | ||
799 | Eet_ \ | ||
800 | _Eet_ \ | ||
801 | EET_ \ | ||
802 | _EET_ | ||
803 | |||
804 | #--------------------------------------------------------------------------- | ||
805 | # configuration options related to the HTML output | ||
806 | #--------------------------------------------------------------------------- | ||
807 | |||
808 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | ||
809 | # generate HTML output. | ||
810 | |||
811 | GENERATE_HTML = YES | ||
812 | |||
813 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | ||
814 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
815 | # put in front of it. If left blank `html' will be used as the default path. | ||
816 | |||
817 | HTML_OUTPUT = html | ||
818 | |||
819 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | ||
820 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | ||
821 | # doxygen will generate files with .html extension. | ||
822 | |||
823 | HTML_FILE_EXTENSION = .html | ||
824 | |||
825 | # The HTML_HEADER tag can be used to specify a personal HTML header for | ||
826 | # each generated HTML page. If it is left blank doxygen will generate a | ||
827 | # standard header. | ||
828 | |||
829 | HTML_HEADER = ./head.html | ||
830 | |||
831 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | ||
832 | # each generated HTML page. If it is left blank doxygen will generate a | ||
833 | # standard footer. | ||
834 | |||
835 | HTML_FOOTER = ./foot.html | ||
836 | |||
837 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | ||
838 | # style sheet that is used by each HTML page. It can be used to | ||
839 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | ||
840 | # will generate a default style sheet. Note that doxygen will try to copy | ||
841 | # the style sheet file to the HTML output directory, so don't put your own | ||
842 | # stylesheet in the HTML output directory as well, or it will be erased! | ||
843 | |||
844 | HTML_STYLESHEET = ./e.css | ||
845 | |||
846 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. | ||
847 | # Doxygen will adjust the colors in the stylesheet and background images | ||
848 | # according to this color. Hue is specified as an angle on a colorwheel, | ||
849 | # see http://en.wikipedia.org/wiki/Hue for more information. | ||
850 | # For instance the value 0 represents red, 60 is yellow, 120 is green, | ||
851 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. | ||
852 | # The allowed range is 0 to 359. | ||
853 | |||
854 | HTML_COLORSTYLE_HUE = 220 | ||
855 | |||
856 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of | ||
857 | # the colors in the HTML output. For a value of 0 the output will use | ||
858 | # grayscales only. A value of 255 will produce the most vivid colors. | ||
859 | |||
860 | HTML_COLORSTYLE_SAT = 100 | ||
861 | |||
862 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to | ||
863 | # the luminance component of the colors in the HTML output. Values below | ||
864 | # 100 gradually make the output lighter, whereas values above 100 make | ||
865 | # the output darker. The value divided by 100 is the actual gamma applied, | ||
866 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, | ||
867 | # and 100 does not change the gamma. | ||
868 | |||
869 | HTML_COLORSTYLE_GAMMA = 80 | ||
870 | |||
871 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML | ||
872 | # page will contain the date and time when the page was generated. Setting | ||
873 | # this to NO can help when comparing the output of multiple runs. | ||
874 | |||
875 | HTML_TIMESTAMP = YES | ||
876 | |||
877 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | ||
878 | # files or namespaces will be aligned in HTML using tables. If set to | ||
879 | # NO a bullet list will be used. | ||
880 | |||
881 | HTML_ALIGN_MEMBERS = YES | ||
882 | |||
883 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | ||
884 | # documentation will contain sections that can be hidden and shown after the | ||
885 | # page has loaded. For this to work a browser that supports | ||
886 | # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | ||
887 | # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | ||
888 | |||
889 | HTML_DYNAMIC_SECTIONS = YES | ||
890 | |||
891 | # If the GENERATE_DOCSET tag is set to YES, additional index files | ||
892 | # will be generated that can be used as input for Apple's Xcode 3 | ||
893 | # integrated development environment, introduced with OSX 10.5 (Leopard). | ||
894 | # To create a documentation set, doxygen will generate a Makefile in the | ||
895 | # HTML output directory. Running make will produce the docset in that | ||
896 | # directory and running "make install" will install the docset in | ||
897 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | ||
898 | # it at startup. | ||
899 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html | ||
900 | # for more information. | ||
901 | |||
902 | GENERATE_DOCSET = YES | ||
903 | |||
904 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | ||
905 | # feed. A documentation feed provides an umbrella under which multiple | ||
906 | # documentation sets from a single provider (such as a company or product suite) | ||
907 | # can be grouped. | ||
908 | |||
909 | DOCSET_FEEDNAME = "Doxygen generated docs" | ||
910 | |||
911 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | ||
912 | # should uniquely identify the documentation set bundle. This should be a | ||
913 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | ||
914 | # will append .docset to the name. | ||
915 | |||
916 | DOCSET_BUNDLE_ID = org.enlightenment.Eet | ||
917 | |||
918 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify | ||
919 | # the documentation publisher. This should be a reverse domain-name style | ||
920 | # string, e.g. com.mycompany.MyDocSet.documentation. | ||
921 | |||
922 | DOCSET_PUBLISHER_ID = org.enlightenment.Eet | ||
923 | |||
924 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. | ||
925 | |||
926 | DOCSET_PUBLISHER_NAME = Enlightenment | ||
927 | |||
928 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | ||
929 | # will be generated that can be used as input for tools like the | ||
930 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) | ||
931 | # of the generated HTML documentation. | ||
932 | |||
933 | GENERATE_HTMLHELP = YES | ||
934 | |||
935 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | ||
936 | # be used to specify the file name of the resulting .chm file. You | ||
937 | # can add a path in front of the file if the result should not be | ||
938 | # written to the html output directory. | ||
939 | |||
940 | CHM_FILE = | ||
941 | |||
942 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | ||
943 | # be used to specify the location (absolute path including file name) of | ||
944 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | ||
945 | # the HTML help compiler on the generated index.hhp. | ||
946 | |||
947 | HHC_LOCATION = | ||
948 | |||
949 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | ||
950 | # controls if a separate .chi index file is generated (YES) or that | ||
951 | # it should be included in the master .chm file (NO). | ||
952 | |||
953 | GENERATE_CHI = NO | ||
954 | |||
955 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | ||
956 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file | ||
957 | # content. | ||
958 | |||
959 | CHM_INDEX_ENCODING = | ||
960 | |||
961 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | ||
962 | # controls whether a binary table of contents is generated (YES) or a | ||
963 | # normal table of contents (NO) in the .chm file. | ||
964 | |||
965 | BINARY_TOC = NO | ||
966 | |||
967 | # The TOC_EXPAND flag can be set to YES to add extra items for group members | ||
968 | # to the contents of the HTML help documentation and to the tree view. | ||
969 | |||
970 | TOC_EXPAND = NO | ||
971 | |||
972 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and | ||
973 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated | ||
974 | # that can be used as input for Qt's qhelpgenerator to generate a | ||
975 | # Qt Compressed Help (.qch) of the generated HTML documentation. | ||
976 | |||
977 | GENERATE_QHP = NO | ||
978 | |||
979 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can | ||
980 | # be used to specify the file name of the resulting .qch file. | ||
981 | # The path specified is relative to the HTML output folder. | ||
982 | |||
983 | QCH_FILE = | ||
984 | |||
985 | # The QHP_NAMESPACE tag specifies the namespace to use when generating | ||
986 | # Qt Help Project output. For more information please see | ||
987 | # http://doc.trolltech.com/qthelpproject.html#namespace | ||
988 | |||
989 | QHP_NAMESPACE = org.enlightenment.Eet | ||
990 | |||
991 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating | ||
992 | # Qt Help Project output. For more information please see | ||
993 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders | ||
994 | |||
995 | QHP_VIRTUAL_FOLDER = doc | ||
996 | |||
997 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to | ||
998 | # add. For more information please see | ||
999 | # http://doc.trolltech.com/qthelpproject.html#custom-filters | ||
1000 | |||
1001 | QHP_CUST_FILTER_NAME = | ||
1002 | |||
1003 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the | ||
1004 | # custom filter to add. For more information please see | ||
1005 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> | ||
1006 | # Qt Help Project / Custom Filters</a>. | ||
1007 | |||
1008 | QHP_CUST_FILTER_ATTRS = | ||
1009 | |||
1010 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this | ||
1011 | # project's | ||
1012 | # filter section matches. | ||
1013 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> | ||
1014 | # Qt Help Project / Filter Attributes</a>. | ||
1015 | |||
1016 | QHP_SECT_FILTER_ATTRS = | ||
1017 | |||
1018 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can | ||
1019 | # be used to specify the location of Qt's qhelpgenerator. | ||
1020 | # If non-empty doxygen will try to run qhelpgenerator on the generated | ||
1021 | # .qhp file. | ||
1022 | |||
1023 | QHG_LOCATION = | ||
1024 | |||
1025 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files | ||
1026 | # will be generated, which together with the HTML files, form an Eclipse help | ||
1027 | # plugin. To install this plugin and make it available under the help contents | ||
1028 | # menu in Eclipse, the contents of the directory containing the HTML and XML | ||
1029 | # files needs to be copied into the plugins directory of eclipse. The name of | ||
1030 | # the directory within the plugins directory should be the same as | ||
1031 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before | ||
1032 | # the help appears. | ||
1033 | |||
1034 | GENERATE_ECLIPSEHELP = NO | ||
1035 | |||
1036 | # A unique identifier for the eclipse help plugin. When installing the plugin | ||
1037 | # the directory name containing the HTML and XML files should also have | ||
1038 | # this name. | ||
1039 | |||
1040 | ECLIPSE_DOC_ID = org.enlightenment.Eet | ||
1041 | |||
1042 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | ||
1043 | # top of each HTML page. The value NO (the default) enables the index and | ||
1044 | # the value YES disables it. | ||
1045 | |||
1046 | DISABLE_INDEX = YES | ||
1047 | |||
1048 | # This tag can be used to set the number of enum values (range [0,1..20]) | ||
1049 | # that doxygen will group on one line in the generated HTML documentation. | ||
1050 | # Note that a value of 0 will completely suppress the enum values from appearing in the overview section. | ||
1051 | |||
1052 | ENUM_VALUES_PER_LINE = 1 | ||
1053 | |||
1054 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index | ||
1055 | # structure should be generated to display hierarchical information. | ||
1056 | # If the tag value is set to YES, a side panel will be generated | ||
1057 | # containing a tree-like index structure (just like the one that | ||
1058 | # is generated for HTML Help). For this to work a browser that supports | ||
1059 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). | ||
1060 | # Windows users are probably better off using the HTML help feature. | ||
1061 | |||
82 | GENERATE_TREEVIEW = NO | 1062 | GENERATE_TREEVIEW = NO |
1063 | |||
1064 | # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, | ||
1065 | # and Class Hierarchy pages using a tree view instead of an ordered list. | ||
1066 | |||
1067 | USE_INLINE_TREES = NO | ||
1068 | |||
1069 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | ||
1070 | # used to set the initial width (in pixels) of the frame in which the tree | ||
1071 | # is shown. | ||
1072 | |||
83 | TREEVIEW_WIDTH = 250 | 1073 | TREEVIEW_WIDTH = 250 |
1074 | |||
1075 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open | ||
1076 | # links to external symbols imported via tag files in a separate window. | ||
1077 | |||
1078 | EXT_LINKS_IN_WINDOW = NO | ||
1079 | |||
1080 | # Use this tag to change the font size of Latex formulas included | ||
1081 | # as images in the HTML documentation. The default is 10. Note that | ||
1082 | # when you change the font size after a successful doxygen run you need | ||
1083 | # to manually remove any form_*.png images from the HTML output directory | ||
1084 | # to force them to be regenerated. | ||
1085 | |||
1086 | FORMULA_FONTSIZE = 10 | ||
1087 | |||
1088 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images | ||
1089 | # generated for formulas are transparent PNGs. Transparent PNGs are | ||
1090 | # not supported properly for IE 6.0, but are supported on all modern browsers. | ||
1091 | # Note that when changing this option you need to delete any form_*.png files | ||
1092 | # in the HTML output before the changes have effect. | ||
1093 | |||
1094 | FORMULA_TRANSPARENT = YES | ||
1095 | |||
1096 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax | ||
1097 | # (see http://www.mathjax.org) which uses client side Javascript for the | ||
1098 | # rendering instead of using prerendered bitmaps. Use this if you do not | ||
1099 | # have LaTeX installed or if you want to formulas look prettier in the HTML | ||
1100 | # output. When enabled you also need to install MathJax separately and | ||
1101 | # configure the path to it using the MATHJAX_RELPATH option. | ||
1102 | |||
1103 | USE_MATHJAX = NO | ||
1104 | |||
1105 | # When MathJax is enabled you need to specify the location relative to the | ||
1106 | # HTML output directory using the MATHJAX_RELPATH option. The destination | ||
1107 | # directory should contain the MathJax.js script. For instance, if the mathjax | ||
1108 | # directory is located at the same level as the HTML output directory, then | ||
1109 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing | ||
1110 | # MathJax, but it is strongly recommended to install a local copy of MathJax | ||
1111 | # before deployment. | ||
1112 | |||
1113 | MATHJAX_RELPATH = http://www.mathjax.org/mathjax | ||
1114 | |||
1115 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box | ||
1116 | # for the HTML output. The underlying search engine uses javascript | ||
1117 | # and DHTML and should work on any modern browser. Note that when using | ||
1118 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets | ||
1119 | # (GENERATE_DOCSET) there is already a search function so this one should | ||
1120 | # typically be disabled. For large projects the javascript based search engine | ||
1121 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. | ||
1122 | |||
1123 | SEARCHENGINE = NO | ||
1124 | |||
1125 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be | ||
1126 | # implemented using a PHP enabled web server instead of at the web client | ||
1127 | # using Javascript. Doxygen will generate the search PHP script and index | ||
1128 | # file to put on the web server. The advantage of the server | ||
1129 | # based approach is that it scales better to large projects and allows | ||
1130 | # full text search. The disadvantages are that it is more difficult to setup | ||
1131 | # and does not have live searching capabilities. | ||
1132 | |||
1133 | SERVER_BASED_SEARCH = NO | ||
1134 | |||
1135 | #--------------------------------------------------------------------------- | ||
1136 | # configuration options related to the LaTeX output | ||
1137 | #--------------------------------------------------------------------------- | ||
1138 | |||
1139 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | ||
1140 | # generate Latex output. | ||
1141 | |||
84 | GENERATE_LATEX = YES | 1142 | GENERATE_LATEX = YES |
1143 | |||
1144 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | ||
1145 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1146 | # put in front of it. If left blank `latex' will be used as the default path. | ||
1147 | |||
85 | LATEX_OUTPUT = latex | 1148 | LATEX_OUTPUT = latex |
1149 | |||
1150 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | ||
1151 | # invoked. If left blank `latex' will be used as the default command name. | ||
1152 | # Note that when enabling USE_PDFLATEX this option is only used for | ||
1153 | # generating bitmaps for formulas in the HTML output, but not in the | ||
1154 | # Makefile that is written to the output directory. | ||
1155 | |||
86 | LATEX_CMD_NAME = latex | 1156 | LATEX_CMD_NAME = latex |
1157 | |||
1158 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | ||
1159 | # generate index for LaTeX. If left blank `makeindex' will be used as the | ||
1160 | # default command name. | ||
1161 | |||
87 | MAKEINDEX_CMD_NAME = makeindex | 1162 | MAKEINDEX_CMD_NAME = makeindex |
1163 | |||
1164 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | ||
1165 | # LaTeX documents. This may be useful for small projects and may help to | ||
1166 | # save some trees in general. | ||
1167 | |||
88 | COMPACT_LATEX = NO | 1168 | COMPACT_LATEX = NO |
1169 | |||
1170 | # The PAPER_TYPE tag can be used to set the paper type that is used | ||
1171 | # by the printer. Possible values are: a4, letter, legal and | ||
1172 | # executive. If left blank a4wide will be used. | ||
1173 | |||
89 | PAPER_TYPE = a4wide | 1174 | PAPER_TYPE = a4wide |
90 | EXTRA_PACKAGES = | 1175 | |
91 | LATEX_HEADER = | 1176 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
1177 | # packages that should be included in the LaTeX output. | ||
1178 | |||
1179 | EXTRA_PACKAGES = | ||
1180 | |||
1181 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | ||
1182 | # the generated latex document. The header should contain everything until | ||
1183 | # the first chapter. If it is left blank doxygen will generate a | ||
1184 | # standard header. Notice: only use this tag if you know what you are doing! | ||
1185 | |||
1186 | LATEX_HEADER = | ||
1187 | |||
1188 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | ||
1189 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | ||
1190 | # contain links (just like the HTML output) instead of page references | ||
1191 | # This makes the output suitable for online browsing using a pdf viewer. | ||
1192 | |||
92 | PDF_HYPERLINKS = YES | 1193 | PDF_HYPERLINKS = YES |
1194 | |||
1195 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | ||
1196 | # plain latex in the generated Makefile. Set this option to YES to get a | ||
1197 | # higher quality PDF documentation. | ||
1198 | |||
93 | USE_PDFLATEX = YES | 1199 | USE_PDFLATEX = YES |
1200 | |||
1201 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | ||
1202 | # command to the generated LaTeX files. This will instruct LaTeX to keep | ||
1203 | # running if errors occur, instead of asking the user for help. | ||
1204 | # This option is also used when generating formulas in HTML. | ||
1205 | |||
94 | LATEX_BATCHMODE = NO | 1206 | LATEX_BATCHMODE = NO |
1207 | |||
1208 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not | ||
1209 | # include the index chapters (such as File Index, Compound Index, etc.) | ||
1210 | # in the output. | ||
1211 | |||
1212 | LATEX_HIDE_INDICES = NO | ||
1213 | |||
1214 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include | ||
1215 | # source code with syntax highlighting in the LaTeX output. | ||
1216 | # Note that which sources are shown also depends on other settings | ||
1217 | # such as SOURCE_BROWSER. | ||
1218 | |||
1219 | LATEX_SOURCE_CODE = NO | ||
1220 | |||
1221 | #--------------------------------------------------------------------------- | ||
1222 | # configuration options related to the RTF output | ||
1223 | #--------------------------------------------------------------------------- | ||
1224 | |||
1225 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | ||
1226 | # The RTF output is optimized for Word 97 and may not look very pretty with | ||
1227 | # other RTF readers or editors. | ||
1228 | |||
95 | GENERATE_RTF = NO | 1229 | GENERATE_RTF = NO |
1230 | |||
1231 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | ||
1232 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1233 | # put in front of it. If left blank `rtf' will be used as the default path. | ||
1234 | |||
96 | RTF_OUTPUT = rtf | 1235 | RTF_OUTPUT = rtf |
1236 | |||
1237 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | ||
1238 | # RTF documents. This may be useful for small projects and may help to | ||
1239 | # save some trees in general. | ||
1240 | |||
97 | COMPACT_RTF = NO | 1241 | COMPACT_RTF = NO |
1242 | |||
1243 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | ||
1244 | # will contain hyperlink fields. The RTF file will | ||
1245 | # contain links (just like the HTML output) instead of page references. | ||
1246 | # This makes the output suitable for online browsing using WORD or other | ||
1247 | # programs which support those fields. | ||
1248 | # Note: wordpad (write) and others do not support links. | ||
1249 | |||
98 | RTF_HYPERLINKS = NO | 1250 | RTF_HYPERLINKS = NO |
99 | RTF_STYLESHEET_FILE = | 1251 | |
100 | RTF_EXTENSIONS_FILE = | 1252 | # Load stylesheet definitions from file. Syntax is similar to doxygen's |
1253 | # config file, i.e. a series of assignments. You only have to provide | ||
1254 | # replacements, missing definitions are set to their default value. | ||
1255 | |||
1256 | RTF_STYLESHEET_FILE = | ||
1257 | |||
1258 | # Set optional variables used in the generation of an rtf document. | ||
1259 | # Syntax is similar to doxygen's config file. | ||
1260 | |||
1261 | RTF_EXTENSIONS_FILE = | ||
1262 | |||
1263 | #--------------------------------------------------------------------------- | ||
1264 | # configuration options related to the man page output | ||
1265 | #--------------------------------------------------------------------------- | ||
1266 | |||
1267 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | ||
1268 | # generate man pages | ||
1269 | |||
101 | GENERATE_MAN = YES | 1270 | GENERATE_MAN = YES |
1271 | |||
1272 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | ||
1273 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1274 | # put in front of it. If left blank `man' will be used as the default path. | ||
1275 | |||
102 | MAN_OUTPUT = man | 1276 | MAN_OUTPUT = man |
1277 | |||
1278 | # The MAN_EXTENSION tag determines the extension that is added to | ||
1279 | # the generated man pages (default is the subroutine's section .3) | ||
1280 | |||
103 | MAN_EXTENSION = .3 | 1281 | MAN_EXTENSION = .3 |
1282 | |||
1283 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | ||
1284 | # then it will generate one additional man file for each entity | ||
1285 | # documented in the real man page(s). These additional files | ||
1286 | # only source the real man page, but without them the man command | ||
1287 | # would be unable to find the correct page. The default is NO. | ||
1288 | |||
104 | MAN_LINKS = YES | 1289 | MAN_LINKS = YES |
1290 | |||
1291 | #--------------------------------------------------------------------------- | ||
1292 | # configuration options related to the XML output | ||
1293 | #--------------------------------------------------------------------------- | ||
1294 | |||
1295 | # If the GENERATE_XML tag is set to YES Doxygen will | ||
1296 | # generate an XML file that captures the structure of | ||
1297 | # the code including all documentation. | ||
1298 | |||
105 | GENERATE_XML = NO | 1299 | GENERATE_XML = NO |
106 | XML_SCHEMA = | 1300 | |
107 | XML_DTD = | 1301 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
1302 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
1303 | # put in front of it. If left blank `xml' will be used as the default path. | ||
1304 | |||
1305 | XML_OUTPUT = xml | ||
1306 | |||
1307 | # The XML_SCHEMA tag can be used to specify an XML schema, | ||
1308 | # which can be used by a validating XML parser to check the | ||
1309 | # syntax of the XML files. | ||
1310 | |||
1311 | XML_SCHEMA = | ||
1312 | |||
1313 | # The XML_DTD tag can be used to specify an XML DTD, | ||
1314 | # which can be used by a validating XML parser to check the | ||
1315 | # syntax of the XML files. | ||
1316 | |||
1317 | XML_DTD = | ||
1318 | |||
1319 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will | ||
1320 | # dump the program listings (including syntax highlighting | ||
1321 | # and cross-referencing information) to the XML output. Note that | ||
1322 | # enabling this will significantly increase the size of the XML output. | ||
1323 | |||
1324 | XML_PROGRAMLISTING = YES | ||
1325 | |||
1326 | #--------------------------------------------------------------------------- | ||
1327 | # configuration options for the AutoGen Definitions output | ||
1328 | #--------------------------------------------------------------------------- | ||
1329 | |||
1330 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | ||
1331 | # generate an AutoGen Definitions (see autogen.sf.net) file | ||
1332 | # that captures the structure of the code including all | ||
1333 | # documentation. Note that this feature is still experimental | ||
1334 | # and incomplete at the moment. | ||
1335 | |||
108 | GENERATE_AUTOGEN_DEF = NO | 1336 | GENERATE_AUTOGEN_DEF = NO |
1337 | |||
1338 | #--------------------------------------------------------------------------- | ||
1339 | # configuration options related to the Perl module output | ||
1340 | #--------------------------------------------------------------------------- | ||
1341 | |||
1342 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will | ||
1343 | # generate a Perl module file that captures the structure of | ||
1344 | # the code including all documentation. Note that this | ||
1345 | # feature is still experimental and incomplete at the | ||
1346 | # moment. | ||
1347 | |||
1348 | GENERATE_PERLMOD = NO | ||
1349 | |||
1350 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | ||
1351 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able | ||
1352 | # to generate PDF and DVI output from the Perl module output. | ||
1353 | |||
1354 | PERLMOD_LATEX = NO | ||
1355 | |||
1356 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | ||
1357 | # nicely formatted so it can be parsed by a human reader. | ||
1358 | # This is useful | ||
1359 | # if you want to understand what is going on. | ||
1360 | # On the other hand, if this | ||
1361 | # tag is set to NO the size of the Perl module output will be much smaller | ||
1362 | # and Perl will parse it just the same. | ||
1363 | |||
1364 | PERLMOD_PRETTY = YES | ||
1365 | |||
1366 | # The names of the make variables in the generated doxyrules.make file | ||
1367 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | ||
1368 | # This is useful so different doxyrules.make files included by the same | ||
1369 | # Makefile don't overwrite each other's variables. | ||
1370 | |||
1371 | PERLMOD_MAKEVAR_PREFIX = | ||
1372 | |||
1373 | #--------------------------------------------------------------------------- | ||
1374 | # Configuration options related to the preprocessor | ||
1375 | #--------------------------------------------------------------------------- | ||
1376 | |||
1377 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | ||
1378 | # evaluate all C-preprocessor directives found in the sources and include | ||
1379 | # files. | ||
1380 | |||
109 | ENABLE_PREPROCESSING = YES | 1381 | ENABLE_PREPROCESSING = YES |
110 | MACRO_EXPANSION = NO | 1382 | |
111 | EXPAND_ONLY_PREDEF = NO | 1383 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1384 | # names in the source code. If set to NO (the default) only conditional | ||
1385 | # compilation will be performed. Macro expansion can be done in a controlled | ||
1386 | # way by setting EXPAND_ONLY_PREDEF to YES. | ||
1387 | |||
1388 | MACRO_EXPANSION = YES | ||
1389 | |||
1390 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | ||
1391 | # then the macro expansion is limited to the macros specified with the | ||
1392 | # PREDEFINED and EXPAND_AS_DEFINED tags. | ||
1393 | |||
1394 | EXPAND_ONLY_PREDEF = YES | ||
1395 | |||
1396 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | ||
1397 | # in the INCLUDE_PATH (see below) will be search if a #include is found. | ||
1398 | |||
112 | SEARCH_INCLUDES = NO | 1399 | SEARCH_INCLUDES = NO |
1400 | |||
1401 | # The INCLUDE_PATH tag can be used to specify one or more directories that | ||
1402 | # contain include files that are not input files but should be processed by | ||
1403 | # the preprocessor. | ||
1404 | |||
113 | INCLUDE_PATH = | 1405 | INCLUDE_PATH = |
114 | INCLUDE_FILE_PATTERNS = | 1406 | |
115 | PREDEFINED = | 1407 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
116 | EXPAND_AS_DEFINED = | 1408 | # patterns (like *.h and *.hpp) to filter out the header-files in the |
1409 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | ||
1410 | # be used. | ||
1411 | |||
1412 | INCLUDE_FILE_PATTERNS = | ||
1413 | |||
1414 | # The PREDEFINED tag can be used to specify one or more macro names that | ||
1415 | # are defined before the preprocessor is started (similar to the -D option of | ||
1416 | # gcc). The argument of the tag is a list of macros of the form: name | ||
1417 | # or name=definition (no spaces). If the definition and the = are | ||
1418 | # omitted =1 is assumed. To prevent a macro definition from being | ||
1419 | # undefined via #undef or recursively expanded use the := operator | ||
1420 | # instead of the = operator. | ||
1421 | |||
1422 | PREDEFINED = EINA_MAGIC_DEBUG \ | ||
1423 | __UNUSED__= \ | ||
1424 | EINA_ARG_NONNULL()= \ | ||
1425 | EINA_MALLOC= \ | ||
1426 | EINA_WARN_UNUSED_RESULT= \ | ||
1427 | EAPI= \ | ||
1428 | EINA_PURE= \ | ||
1429 | EINA_CONST= | ||
1430 | |||
1431 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | ||
1432 | # this tag can be used to specify a list of macro names that should be expanded. | ||
1433 | # The macro definition that is found in the sources will be used. | ||
1434 | # Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code. | ||
1435 | |||
1436 | EXPAND_AS_DEFINED = | ||
1437 | |||
1438 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | ||
1439 | # doxygen's preprocessor will remove all references to function-like macros | ||
1440 | # that are alone on a line, have an all uppercase name, and do not end with a | ||
1441 | # semicolon, because these will confuse the parser if not removed. | ||
1442 | |||
117 | SKIP_FUNCTION_MACROS = YES | 1443 | SKIP_FUNCTION_MACROS = YES |
118 | TAGFILES = | 1444 | |
119 | GENERATE_TAGFILE = | 1445 | #--------------------------------------------------------------------------- |
1446 | # Configuration::additions related to external references | ||
1447 | #--------------------------------------------------------------------------- | ||
1448 | |||
1449 | # The TAGFILES option can be used to specify one or more tagfiles. | ||
1450 | # Optionally an initial location of the external documentation | ||
1451 | # can be added for each tagfile. The format of a tag file without | ||
1452 | # this location is as follows: | ||
1453 | # | ||
1454 | # TAGFILES = file1 file2 ... | ||
1455 | # Adding location for the tag files is done as follows: | ||
1456 | # | ||
1457 | # TAGFILES = file1=loc1 "file2 = loc2" ... | ||
1458 | # where "loc1" and "loc2" can be relative or absolute paths or | ||
1459 | # URLs. If a location is present for each tag, the installdox tool | ||
1460 | # does not have to be run to correct the links. | ||
1461 | # Note that each tag file must have a unique name | ||
1462 | # (where the name does NOT include the path) | ||
1463 | # If a tag file is not located in the directory in which doxygen | ||
1464 | # is run, you must also specify the path to the tagfile here. | ||
1465 | |||
1466 | TAGFILES = | ||
1467 | |||
1468 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | ||
1469 | # a tag file that is based on the input files it reads. | ||
1470 | |||
1471 | GENERATE_TAGFILE = | ||
1472 | |||
1473 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | ||
1474 | # in the class index. If set to NO only the inherited external classes | ||
1475 | # will be listed. | ||
1476 | |||
120 | ALLEXTERNALS = NO | 1477 | ALLEXTERNALS = NO |
1478 | |||
1479 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | ||
1480 | # in the modules index. If set to NO, only the current project's groups will | ||
1481 | # be listed. | ||
1482 | |||
121 | EXTERNAL_GROUPS = YES | 1483 | EXTERNAL_GROUPS = YES |
1484 | |||
1485 | # The PERL_PATH should be the absolute path and name of the perl script | ||
1486 | # interpreter (i.e. the result of `which perl'). | ||
1487 | |||
122 | PERL_PATH = /usr/bin/perl | 1488 | PERL_PATH = /usr/bin/perl |
1489 | |||
1490 | #--------------------------------------------------------------------------- | ||
1491 | # Configuration options related to the dot tool | ||
1492 | #--------------------------------------------------------------------------- | ||
1493 | |||
1494 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | ||
1495 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base | ||
1496 | # or super classes. Setting the tag to NO turns the diagrams off. Note that | ||
1497 | # this option also works with HAVE_DOT disabled, but it is recommended to | ||
1498 | # install and use dot, since it yields more powerful graphs. | ||
1499 | |||
123 | CLASS_DIAGRAMS = NO | 1500 | CLASS_DIAGRAMS = NO |
1501 | |||
1502 | # You can define message sequence charts within doxygen comments using the \msc | ||
1503 | # command. Doxygen will then run the mscgen tool (see | ||
1504 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | ||
1505 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where | ||
1506 | # the mscgen tool resides. If left empty the tool is assumed to be found in the | ||
1507 | # default search path. | ||
1508 | |||
1509 | MSCGEN_PATH = | ||
1510 | |||
1511 | # If set to YES, the inheritance and collaboration graphs will hide | ||
1512 | # inheritance and usage relations if the target is undocumented | ||
1513 | # or is not a class. | ||
1514 | |||
124 | HIDE_UNDOC_RELATIONS = YES | 1515 | HIDE_UNDOC_RELATIONS = YES |
1516 | |||
1517 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | ||
1518 | # available from the path. This tool is part of Graphviz, a graph visualization | ||
1519 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | ||
1520 | # have no effect if this option is set to NO (the default) | ||
1521 | |||
125 | HAVE_DOT = NO | 1522 | HAVE_DOT = NO |
1523 | |||
1524 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is | ||
1525 | # allowed to run in parallel. When set to 0 (the default) doxygen will | ||
1526 | # base this on the number of processors available in the system. You can set it | ||
1527 | # explicitly to a value larger than 0 to get control over the balance | ||
1528 | # between CPU load and processing speed. | ||
1529 | |||
1530 | DOT_NUM_THREADS = 0 | ||
1531 | |||
1532 | # By default doxygen will write a font called Helvetica to the output | ||
1533 | # directory and reference it in all dot files that doxygen generates. | ||
1534 | # When you want a differently looking font you can specify the font name | ||
1535 | # using DOT_FONTNAME. You need to make sure dot is able to find the font, | ||
1536 | # which can be done by putting it in a standard location or by setting the | ||
1537 | # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | ||
1538 | # containing the font. | ||
1539 | |||
1540 | DOT_FONTNAME = Helvetica | ||
1541 | |||
1542 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. | ||
1543 | # The default size is 10pt. | ||
1544 | |||
1545 | DOT_FONTSIZE = 10 | ||
1546 | |||
1547 | # By default doxygen will tell dot to use the output directory to look for the | ||
1548 | # FreeSans.ttf font (which doxygen will put there itself). If you specify a | ||
1549 | # different font using DOT_FONTNAME you can set the path where dot | ||
1550 | # can find it using this tag. | ||
1551 | |||
1552 | DOT_FONTPATH = | ||
1553 | |||
1554 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
1555 | # will generate a graph for each documented class showing the direct and | ||
1556 | # indirect inheritance relations. Setting this tag to YES will force the | ||
1557 | # the CLASS_DIAGRAMS tag to NO. | ||
1558 | |||
126 | CLASS_GRAPH = NO | 1559 | CLASS_GRAPH = NO |
1560 | |||
1561 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
1562 | # will generate a graph for each documented class showing the direct and | ||
1563 | # indirect implementation dependencies (inheritance, containment, and | ||
1564 | # class references variables) of the class with other documented classes. | ||
1565 | |||
127 | COLLABORATION_GRAPH = NO | 1566 | COLLABORATION_GRAPH = NO |
1567 | |||
1568 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | ||
1569 | # will generate a graph for groups, showing the direct groups dependencies | ||
1570 | |||
1571 | GROUP_GRAPHS = YES | ||
1572 | |||
1573 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | ||
1574 | # collaboration diagrams in a style similar to the OMG's Unified Modeling | ||
1575 | # Language. | ||
1576 | |||
1577 | UML_LOOK = NO | ||
1578 | |||
1579 | # If set to YES, the inheritance and collaboration graphs will show the | ||
1580 | # relations between templates and their instances. | ||
1581 | |||
128 | TEMPLATE_RELATIONS = NO | 1582 | TEMPLATE_RELATIONS = NO |
1583 | |||
1584 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | ||
1585 | # tags are set to YES then doxygen will generate a graph for each documented | ||
1586 | # file showing the direct and indirect include dependencies of the file with | ||
1587 | # other documented files. | ||
1588 | |||
129 | INCLUDE_GRAPH = NO | 1589 | INCLUDE_GRAPH = NO |
1590 | |||
1591 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | ||
1592 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | ||
1593 | # documented header file showing the documented files that directly or | ||
1594 | # indirectly include this file. | ||
1595 | |||
130 | INCLUDED_BY_GRAPH = NO | 1596 | INCLUDED_BY_GRAPH = NO |
1597 | |||
1598 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then | ||
1599 | # doxygen will generate a call dependency graph for every global function | ||
1600 | # or class method. Note that enabling this option will significantly increase | ||
1601 | # the time of a run. So in most cases it will be better to enable call graphs | ||
1602 | # for selected functions only using the \callgraph command. | ||
1603 | |||
1604 | CALL_GRAPH = NO | ||
1605 | |||
1606 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | ||
1607 | # doxygen will generate a caller dependency graph for every global function | ||
1608 | # or class method. Note that enabling this option will significantly increase | ||
1609 | # the time of a run. So in most cases it will be better to enable caller | ||
1610 | # graphs for selected functions only using the \callergraph command. | ||
1611 | |||
1612 | CALLER_GRAPH = NO | ||
1613 | |||
1614 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | ||
1615 | # will generate a graphical hierarchy of all classes instead of a textual one. | ||
1616 | |||
131 | GRAPHICAL_HIERARCHY = NO | 1617 | GRAPHICAL_HIERARCHY = NO |
1618 | |||
1619 | # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | ||
1620 | # then doxygen will show the dependencies a directory has on other directories | ||
1621 | # in a graphical way. The dependency relations are determined by the #include | ||
1622 | # relations between the files in the directories. | ||
1623 | |||
1624 | DIRECTORY_GRAPH = YES | ||
1625 | |||
1626 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | ||
1627 | # generated by dot. Possible values are png, svg, gif or svg. | ||
1628 | # If left blank png will be used. | ||
1629 | |||
132 | DOT_IMAGE_FORMAT = png | 1630 | DOT_IMAGE_FORMAT = png |
133 | DOT_PATH = | 1631 | |
134 | DOTFILE_DIRS = | 1632 | # The tag DOT_PATH can be used to specify the path where the dot tool can be |
135 | MAX_DOT_GRAPH_WIDTH = 512 | 1633 | # found. If left blank, it is assumed the dot tool can be found in the path. |
136 | MAX_DOT_GRAPH_HEIGHT = 512 | 1634 | |
1635 | DOT_PATH = | ||
1636 | |||
1637 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | ||
1638 | # contain dot files that are included in the documentation (see the | ||
1639 | # \dotfile command). | ||
1640 | |||
1641 | DOTFILE_DIRS = | ||
1642 | |||
1643 | # The MSCFILE_DIRS tag can be used to specify one or more directories that | ||
1644 | # contain msc files that are included in the documentation (see the | ||
1645 | # \mscfile command). | ||
1646 | |||
1647 | MSCFILE_DIRS = | ||
1648 | |||
1649 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of | ||
1650 | # nodes that will be shown in the graph. If the number of nodes in a graph | ||
1651 | # becomes larger than this value, doxygen will truncate the graph, which is | ||
1652 | # visualized by representing a node as a red box. Note that doxygen if the | ||
1653 | # number of direct children of the root node in a graph is already larger than | ||
1654 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | ||
1655 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | ||
1656 | |||
1657 | DOT_GRAPH_MAX_NODES = 50 | ||
1658 | |||
1659 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | ||
1660 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | ||
1661 | # from the root by following a path via at most 3 edges will be shown. Nodes | ||
1662 | # that lay further from the root node will be omitted. Note that setting this | ||
1663 | # option to 1 or 2 may greatly reduce the computation time needed for large | ||
1664 | # code bases. Also note that the size of a graph can be further restricted by | ||
1665 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | ||
1666 | |||
1667 | MAX_DOT_GRAPH_DEPTH = 0 | ||
1668 | |||
1669 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | ||
1670 | # background. This is disabled by default, because dot on Windows does not | ||
1671 | # seem to support this out of the box. Warning: Depending on the platform used, | ||
1672 | # enabling this option may lead to badly anti-aliased labels on the edges of | ||
1673 | # a graph (i.e. they become hard to read). | ||
1674 | |||
1675 | DOT_TRANSPARENT = YES | ||
1676 | |||
1677 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | ||
1678 | # files in one run (i.e. multiple -o and -T options on the command line). This | ||
1679 | # makes dot run faster, but since only newer versions of dot (>1.8.10) | ||
1680 | # support this, this feature is disabled by default. | ||
1681 | |||
1682 | DOT_MULTI_TARGETS = NO | ||
1683 | |||
1684 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | ||
1685 | # generate a legend page explaining the meaning of the various boxes and | ||
1686 | # arrows in the dot generated graphs. | ||
1687 | |||
137 | GENERATE_LEGEND = YES | 1688 | GENERATE_LEGEND = YES |
1689 | |||
1690 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | ||
1691 | # remove the intermediate dot files that are used to generate | ||
1692 | # the various graphs. | ||
1693 | |||
138 | DOT_CLEANUP = YES | 1694 | DOT_CLEANUP = YES |
139 | SEARCHENGINE = NO | ||