diff options
author | fluxgen <fluxgen> | 2004-01-14 19:41:13 (GMT) |
---|---|---|
committer | fluxgen <fluxgen> | 2004-01-14 19:41:13 (GMT) |
commit | 09e26fd454f5173057c6c10ab4722c0cf452ac78 (patch) | |
tree | aea0ba1dc082ba31d28b141c199a961bc2a3846f | |
parent | b3421f3895db9c3b6b460a429c1c4bb7e6fb375c (diff) | |
download | fluxbox-09e26fd454f5173057c6c10ab4722c0cf452ac78.zip fluxbox-09e26fd454f5173057c6c10ab4722c0cf452ac78.tar.bz2 |
update
-rw-r--r-- | Doxyfile | 958 |
1 files changed, 925 insertions, 33 deletions
@@ -1,188 +1,1080 @@ | |||
1 | # Doxyfile 1.2.13-20020210 | 1 | # Doxyfile 1.3.4 |
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 (" ") | ||
2 | 12 | ||
3 | #--------------------------------------------------------------------------- | 13 | #--------------------------------------------------------------------------- |
4 | # General configuration options | 14 | # Project related configuration options |
5 | #--------------------------------------------------------------------------- | 15 | #--------------------------------------------------------------------------- |
16 | |||
17 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded | ||
18 | # by quotes) that should identify the project. | ||
19 | |||
6 | PROJECT_NAME = fluxbox | 20 | PROJECT_NAME = fluxbox |
7 | PROJECT_NUMBER = 0.1.15-cvs | 21 | |
22 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. | ||
23 | # This could be handy for archiving the generated documentation or | ||
24 | # if some version control system is used. | ||
25 | |||
26 | PROJECT_NUMBER = 0.9.8 | ||
27 | |||
28 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | ||
29 | # base path where the generated documentation will be put. | ||
30 | # If a relative path is entered, it will be relative to the location | ||
31 | # where doxygen was started. If left blank the current directory will be used. | ||
32 | |||
8 | OUTPUT_DIRECTORY = doc/ | 33 | OUTPUT_DIRECTORY = doc/ |
34 | |||
35 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | ||
36 | # documentation generated by doxygen is written. Doxygen will use this | ||
37 | # information to generate all constant output in the proper language. | ||
38 | # The default language is English, other supported languages are: | ||
39 | # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, | ||
40 | # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en | ||
41 | # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, | ||
42 | # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. | ||
43 | |||
9 | OUTPUT_LANGUAGE = English | 44 | OUTPUT_LANGUAGE = English |
10 | EXTRACT_ALL = NO | 45 | |
11 | EXTRACT_PRIVATE = NO | 46 | # This tag can be used to specify the encoding used in the generated output. |
12 | EXTRACT_STATIC = NO | 47 | # The encoding is not always determined by the language that is chosen, |
13 | EXTRACT_LOCAL_CLASSES = YES | 48 | # but also whether or not the output is meant for Windows or non-Windows users. |
14 | HIDE_UNDOC_MEMBERS = NO | 49 | # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
15 | HIDE_UNDOC_CLASSES = NO | 50 | # forces the Windows encoding (this is the default for the Windows binary), |
51 | # whereas setting the tag to NO uses a Unix-style encoding (the default for | ||
52 | # all platforms other than Windows). | ||
53 | |||
54 | USE_WINDOWS_ENCODING = NO | ||
55 | |||
56 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | ||
57 | # include brief member descriptions after the members that are listed in | ||
58 | # the file and class documentation (similar to JavaDoc). | ||
59 | # Set to NO to disable this. | ||
60 | |||
16 | BRIEF_MEMBER_DESC = YES | 61 | BRIEF_MEMBER_DESC = YES |
62 | |||
63 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | ||
64 | # the brief description of a member or function before the detailed description. | ||
65 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | ||
66 | # brief descriptions will be completely suppressed. | ||
67 | |||
17 | REPEAT_BRIEF = YES | 68 | REPEAT_BRIEF = YES |
69 | |||
70 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | ||
71 | # Doxygen will generate a detailed section even if there is only a brief | ||
72 | # description. | ||
73 | |||
18 | ALWAYS_DETAILED_SEC = NO | 74 | ALWAYS_DETAILED_SEC = NO |
75 | |||
76 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited | ||
77 | # members of a class in the documentation of that class as if those members were | ||
78 | # ordinary class members. Constructors, destructors and assignment operators of | ||
79 | # the base classes will not be shown. | ||
80 | |||
19 | INLINE_INHERITED_MEMB = NO | 81 | INLINE_INHERITED_MEMB = NO |
82 | |||
83 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | ||
84 | # path before files name in the file list and in the header files. If set | ||
85 | # to NO the shortest path that makes the file name unique will be used. | ||
86 | |||
20 | FULL_PATH_NAMES = NO | 87 | FULL_PATH_NAMES = NO |
88 | |||
89 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | ||
90 | # can be used to strip a user-defined part of the path. Stripping is | ||
91 | # only done if one of the specified strings matches the left-hand part of | ||
92 | # the path. It is allowed to use relative paths in the argument list. | ||
93 | |||
21 | STRIP_FROM_PATH = | 94 | STRIP_FROM_PATH = |
22 | INTERNAL_DOCS = NO | 95 | |
23 | STRIP_CODE_COMMENTS = YES | 96 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
24 | CASE_SENSE_NAMES = YES | 97 | # (but less readable) file names. This can be useful is your file systems |
98 | # doesn't support long names like on DOS, Mac, or CD-ROM. | ||
99 | |||
25 | SHORT_NAMES = NO | 100 | SHORT_NAMES = NO |
26 | HIDE_SCOPE_NAMES = NO | 101 | |
27 | VERBATIM_HEADERS = YES | 102 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
28 | SHOW_INCLUDE_FILES = YES | 103 | # will interpret the first line (until the first dot) of a JavaDoc-style |
104 | # comment as the brief description. If set to NO, the JavaDoc | ||
105 | # comments will behave just like the Qt-style comments (thus requiring an | ||
106 | # explict @brief command for a brief description. | ||
107 | |||
29 | JAVADOC_AUTOBRIEF = NO | 108 | JAVADOC_AUTOBRIEF = NO |
109 | |||
110 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | ||
111 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | ||
112 | # comments) as a brief description. This used to be the default behaviour. | ||
113 | # The new default is to treat a multi-line C++ comment block as a detailed | ||
114 | # description. Set this tag to YES if you prefer the old behaviour instead. | ||
115 | |||
30 | MULTILINE_CPP_IS_BRIEF = NO | 116 | MULTILINE_CPP_IS_BRIEF = NO |
117 | |||
118 | # If the DETAILS_AT_TOP tag is set to YES then Doxygen | ||
119 | # will output the detailed description near the top, like JavaDoc. | ||
120 | # If set to NO, the detailed description appears after the member | ||
121 | # documentation. | ||
122 | |||
31 | DETAILS_AT_TOP = NO | 123 | DETAILS_AT_TOP = NO |
124 | |||
125 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | ||
126 | # member inherits the documentation from any documented member that it | ||
127 | # reimplements. | ||
128 | |||
32 | INHERIT_DOCS = YES | 129 | INHERIT_DOCS = YES |
33 | INLINE_INFO = YES | 130 | |
34 | SORT_MEMBER_DOCS = YES | 131 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
132 | # tag is set to YES, then doxygen will reuse the documentation of the first | ||
133 | # member in the group (if any) for the other members of the group. By default | ||
134 | # all members of a group must be documented explicitly. | ||
135 | |||
35 | DISTRIBUTE_GROUP_DOC = NO | 136 | DISTRIBUTE_GROUP_DOC = NO |
137 | |||
138 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. | ||
139 | # Doxygen uses this value to replace tabs by spaces in code fragments. | ||
140 | |||
36 | TAB_SIZE = 4 | 141 | TAB_SIZE = 4 |
142 | |||
143 | # This tag can be used to specify a number of aliases that acts | ||
144 | # as commands in the documentation. An alias has the form "name=value". | ||
145 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | ||
146 | # put the command \sideeffect (or @sideeffect) in the documentation, which | ||
147 | # will result in a user-defined paragraph with heading "Side Effects:". | ||
148 | # You can put \n's in the value part of an alias to insert newlines. | ||
149 | |||
150 | ALIASES = | ||
151 | |||
152 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | ||
153 | # only. Doxygen will then generate output that is more tailored for C. | ||
154 | # For instance, some of the names that are used will be different. The list | ||
155 | # of all members will be omitted, etc. | ||
156 | |||
157 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
158 | |||
159 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | ||
160 | # only. Doxygen will then generate output that is more tailored for Java. | ||
161 | # For instance, namespaces will be presented as packages, qualified scopes | ||
162 | # will look different, etc. | ||
163 | |||
164 | OPTIMIZE_OUTPUT_JAVA = NO | ||
165 | |||
166 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | ||
167 | # the same type (for instance a group of public functions) to be put as a | ||
168 | # subgroup of that type (e.g. under the Public Functions section). Set it to | ||
169 | # NO to prevent subgrouping. Alternatively, this can be done per class using | ||
170 | # the \nosubgrouping command. | ||
171 | |||
172 | SUBGROUPING = YES | ||
173 | |||
174 | #--------------------------------------------------------------------------- | ||
175 | # Build related configuration options | ||
176 | #--------------------------------------------------------------------------- | ||
177 | |||
178 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | ||
179 | # documentation are documented, even if no documentation was available. | ||
180 | # Private class members and static file members will be hidden unless | ||
181 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | ||
182 | |||
183 | EXTRACT_ALL = NO | ||
184 | |||
185 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | ||
186 | # will be included in the documentation. | ||
187 | |||
188 | EXTRACT_PRIVATE = NO | ||
189 | |||
190 | # If the EXTRACT_STATIC tag is set to YES all static members of a file | ||
191 | # will be included in the documentation. | ||
192 | |||
193 | EXTRACT_STATIC = NO | ||
194 | |||
195 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | ||
196 | # defined locally in source files will be included in the documentation. | ||
197 | # If set to NO only classes defined in header files are included. | ||
198 | |||
199 | EXTRACT_LOCAL_CLASSES = YES | ||
200 | |||
201 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | ||
202 | # undocumented members of documented classes, files or namespaces. | ||
203 | # If set to NO (the default) these members will be included in the | ||
204 | # various overviews, but no documentation section is generated. | ||
205 | # This option has no effect if EXTRACT_ALL is enabled. | ||
206 | |||
207 | HIDE_UNDOC_MEMBERS = NO | ||
208 | |||
209 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | ||
210 | # undocumented classes that are normally visible in the class hierarchy. | ||
211 | # If set to NO (the default) these classes will be included in the various | ||
212 | # overviews. This option has no effect if EXTRACT_ALL is enabled. | ||
213 | |||
214 | HIDE_UNDOC_CLASSES = NO | ||
215 | |||
216 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | ||
217 | # friend (class|struct|union) declarations. | ||
218 | # If set to NO (the default) these declarations will be included in the | ||
219 | # documentation. | ||
220 | |||
221 | HIDE_FRIEND_COMPOUNDS = NO | ||
222 | |||
223 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any | ||
224 | # documentation blocks found inside the body of a function. | ||
225 | # If set to NO (the default) these blocks will be appended to the | ||
226 | # function's detailed documentation block. | ||
227 | |||
228 | HIDE_IN_BODY_DOCS = NO | ||
229 | |||
230 | # The INTERNAL_DOCS tag determines if documentation | ||
231 | # that is typed after a \internal command is included. If the tag is set | ||
232 | # to NO (the default) then the documentation will be excluded. | ||
233 | # Set it to YES to include the internal documentation. | ||
234 | |||
235 | INTERNAL_DOCS = NO | ||
236 | |||
237 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | ||
238 | # file names in lower-case letters. If set to YES upper-case letters are also | ||
239 | # allowed. This is useful if you have classes or files whose names only differ | ||
240 | # in case and if your file system supports case sensitive file names. Windows | ||
241 | # users are advised to set this option to NO. | ||
242 | |||
243 | CASE_SENSE_NAMES = YES | ||
244 | |||
245 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | ||
246 | # will show members with their full class and namespace scopes in the | ||
247 | # documentation. If set to YES the scope will be hidden. | ||
248 | |||
249 | HIDE_SCOPE_NAMES = NO | ||
250 | |||
251 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | ||
252 | # will put a list of the files that are included by a file in the documentation | ||
253 | # of that file. | ||
254 | |||
255 | SHOW_INCLUDE_FILES = YES | ||
256 | |||
257 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | ||
258 | # is inserted in the documentation for inline members. | ||
259 | |||
260 | INLINE_INFO = YES | ||
261 | |||
262 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | ||
263 | # will sort the (detailed) documentation of file and class members | ||
264 | # alphabetically by member name. If set to NO the members will appear in | ||
265 | # declaration order. | ||
266 | |||
267 | SORT_MEMBER_DOCS = YES | ||
268 | |||
269 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | ||
270 | # disable (NO) the todo list. This list is created by putting \todo | ||
271 | # commands in the documentation. | ||
272 | |||
37 | GENERATE_TODOLIST = YES | 273 | GENERATE_TODOLIST = YES |
274 | |||
275 | # The GENERATE_TESTLIST tag can be used to enable (YES) or | ||
276 | # disable (NO) the test list. This list is created by putting \test | ||
277 | # commands in the documentation. | ||
278 | |||
38 | GENERATE_TESTLIST = YES | 279 | GENERATE_TESTLIST = YES |
280 | |||
281 | # The GENERATE_BUGLIST tag can be used to enable (YES) or | ||
282 | # disable (NO) the bug list. This list is created by putting \bug | ||
283 | # commands in the documentation. | ||
284 | |||
39 | GENERATE_BUGLIST = YES | 285 | GENERATE_BUGLIST = YES |
40 | ALIASES = | 286 | |
287 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | ||
288 | # disable (NO) the deprecated list. This list is created by putting | ||
289 | # \deprecated commands in the documentation. | ||
290 | |||
291 | GENERATE_DEPRECATEDLIST= YES | ||
292 | |||
293 | # The ENABLED_SECTIONS tag can be used to enable conditional | ||
294 | # documentation sections, marked by \if sectionname ... \endif. | ||
295 | |||
41 | ENABLED_SECTIONS = | 296 | ENABLED_SECTIONS = |
297 | |||
298 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | ||
299 | # the initial value of a variable or define consists of for it to appear in | ||
300 | # the documentation. If the initializer consists of more lines than specified | ||
301 | # here it will be hidden. Use a value of 0 to hide initializers completely. | ||
302 | # The appearance of the initializer of individual variables and defines in the | ||
303 | # documentation can be controlled using \showinitializer or \hideinitializer | ||
304 | # command in the documentation regardless of this setting. | ||
305 | |||
42 | MAX_INITIALIZER_LINES = 30 | 306 | MAX_INITIALIZER_LINES = 30 |
43 | OPTIMIZE_OUTPUT_FOR_C = NO | 307 | |
44 | OPTIMIZE_OUTPUT_JAVA = NO | 308 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
309 | # at the bottom of the documentation of classes and structs. If set to YES the | ||
310 | # list will mention the files that were used to generate the documentation. | ||
311 | |||
45 | SHOW_USED_FILES = YES | 312 | SHOW_USED_FILES = YES |
313 | |||
46 | #--------------------------------------------------------------------------- | 314 | #--------------------------------------------------------------------------- |
47 | # configuration options related to warning and progress messages | 315 | # configuration options related to warning and progress messages |
48 | #--------------------------------------------------------------------------- | 316 | #--------------------------------------------------------------------------- |
317 | |||
318 | # The QUIET tag can be used to turn on/off the messages that are generated | ||
319 | # by doxygen. Possible values are YES and NO. If left blank NO is used. | ||
320 | |||
49 | QUIET = NO | 321 | QUIET = NO |
322 | |||
323 | # The WARNINGS tag can be used to turn on/off the warning messages that are | ||
324 | # generated by doxygen. Possible values are YES and NO. If left blank | ||
325 | # NO is used. | ||
326 | |||
50 | WARNINGS = YES | 327 | WARNINGS = YES |
328 | |||
329 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | ||
330 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | ||
331 | # automatically be disabled. | ||
332 | |||
51 | WARN_IF_UNDOCUMENTED = YES | 333 | WARN_IF_UNDOCUMENTED = YES |
334 | |||
335 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for | ||
336 | # potential errors in the documentation, such as not documenting some | ||
337 | # parameters in a documented function, or documenting parameters that | ||
338 | # don't exist or using markup commands wrongly. | ||
339 | |||
340 | WARN_IF_DOC_ERROR = YES | ||
341 | |||
342 | # The WARN_FORMAT tag determines the format of the warning messages that | ||
343 | # doxygen can produce. The string should contain the $file, $line, and $text | ||
344 | # tags, which will be replaced by the file and line number from which the | ||
345 | # warning originated and the warning text. | ||
346 | |||
52 | WARN_FORMAT = "$file:$line: $text" | 347 | WARN_FORMAT = "$file:$line: $text" |
348 | |||
349 | # The WARN_LOGFILE tag can be used to specify a file to which warning | ||
350 | # and error messages should be written. If left blank the output is written | ||
351 | # to stderr. | ||
352 | |||
53 | WARN_LOGFILE = | 353 | WARN_LOGFILE = |
354 | |||
54 | #--------------------------------------------------------------------------- | 355 | #--------------------------------------------------------------------------- |
55 | # configuration options related to the input files | 356 | # configuration options related to the input files |
56 | #--------------------------------------------------------------------------- | 357 | #--------------------------------------------------------------------------- |
57 | INPUT = src/ src/FbTk/ | 358 | |
58 | FILE_PATTERNS = *.hh *.cc | 359 | # The INPUT tag can be used to specify the files and/or directories that contain |
360 | # documented source files. You may enter file names like "myfile.cpp" or | ||
361 | # directories like "/usr/src/myproject". Separate the files or directories | ||
362 | # with spaces. | ||
363 | |||
364 | INPUT = src/ \ | ||
365 | src/FbTk/ | ||
366 | |||
367 | # If the value of the INPUT tag contains directories, you can use the | ||
368 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
369 | # and *.h) to filter out the source-files in the directories. If left | ||
370 | # blank the following patterns are tested: | ||
371 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | ||
372 | # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc | ||
373 | |||
374 | FILE_PATTERNS = *.hh \ | ||
375 | *.cc | ||
376 | |||
377 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories | ||
378 | # should be searched for input files as well. Possible values are YES and NO. | ||
379 | # If left blank NO is used. | ||
380 | |||
59 | RECURSIVE = NO | 381 | RECURSIVE = NO |
60 | EXCLUDE = | 382 | |
383 | # The EXCLUDE tag can be used to specify files and/or directories that should | ||
384 | # excluded from the INPUT source files. This way you can easily exclude a | ||
385 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | ||
386 | |||
387 | EXCLUDE = | ||
388 | |||
389 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | ||
390 | # that are symbolic links (a Unix filesystem feature) are excluded from the input. | ||
391 | |||
61 | EXCLUDE_SYMLINKS = NO | 392 | EXCLUDE_SYMLINKS = NO |
393 | |||
394 | # If the value of the INPUT tag contains directories, you can use the | ||
395 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | ||
396 | # certain files from those directories. | ||
397 | |||
62 | EXCLUDE_PATTERNS = ~* | 398 | EXCLUDE_PATTERNS = ~* |
399 | |||
400 | # The EXAMPLE_PATH tag can be used to specify one or more files or | ||
401 | # directories that contain example code fragments that are included (see | ||
402 | # the \include command). | ||
403 | |||
63 | EXAMPLE_PATH = | 404 | EXAMPLE_PATH = |
405 | |||
406 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | ||
407 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | ||
408 | # and *.h) to filter out the source-files in the directories. If left | ||
409 | # blank all files are included. | ||
410 | |||
64 | EXAMPLE_PATTERNS = | 411 | EXAMPLE_PATTERNS = |
412 | |||
413 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | ||
414 | # searched for input files to be used with the \include or \dontinclude | ||
415 | # commands irrespective of the value of the RECURSIVE tag. | ||
416 | # Possible values are YES and NO. If left blank NO is used. | ||
417 | |||
65 | EXAMPLE_RECURSIVE = NO | 418 | EXAMPLE_RECURSIVE = NO |
419 | |||
420 | # The IMAGE_PATH tag can be used to specify one or more files or | ||
421 | # directories that contain image that are included in the documentation (see | ||
422 | # the \image command). | ||
423 | |||
66 | IMAGE_PATH = | 424 | IMAGE_PATH = |
425 | |||
426 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | ||
427 | # invoke to filter for each input file. Doxygen will invoke the filter program | ||
428 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | ||
429 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | ||
430 | # input file. Doxygen will then use the output that the filter program writes | ||
431 | # to standard output. | ||
432 | |||
67 | INPUT_FILTER = | 433 | INPUT_FILTER = |
434 | |||
435 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | ||
436 | # INPUT_FILTER) will be used to filter the input files when producing source | ||
437 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). | ||
438 | |||
68 | FILTER_SOURCE_FILES = NO | 439 | FILTER_SOURCE_FILES = NO |
440 | |||
69 | #--------------------------------------------------------------------------- | 441 | #--------------------------------------------------------------------------- |
70 | # configuration options related to source browsing | 442 | # configuration options related to source browsing |
71 | #--------------------------------------------------------------------------- | 443 | #--------------------------------------------------------------------------- |
444 | |||
445 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | ||
446 | # be generated. Documented entities will be cross-referenced with these sources. | ||
447 | |||
72 | SOURCE_BROWSER = YES | 448 | SOURCE_BROWSER = YES |
449 | |||
450 | # Setting the INLINE_SOURCES tag to YES will include the body | ||
451 | # of functions and classes directly in the documentation. | ||
452 | |||
73 | INLINE_SOURCES = YES | 453 | INLINE_SOURCES = YES |
454 | |||
455 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | ||
456 | # doxygen to hide any special comment blocks from generated source code | ||
457 | # fragments. Normal C and C++ comments will always remain visible. | ||
458 | |||
459 | STRIP_CODE_COMMENTS = YES | ||
460 | |||
461 | # If the REFERENCED_BY_RELATION tag is set to YES (the default) | ||
462 | # then for each documented function all documented | ||
463 | # functions referencing it will be listed. | ||
464 | |||
74 | REFERENCED_BY_RELATION = YES | 465 | REFERENCED_BY_RELATION = YES |
466 | |||
467 | # If the REFERENCES_RELATION tag is set to YES (the default) | ||
468 | # then for each documented function all documented entities | ||
469 | # called/used by that function will be listed. | ||
470 | |||
75 | REFERENCES_RELATION = YES | 471 | REFERENCES_RELATION = YES |
472 | |||
473 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | ||
474 | # will generate a verbatim copy of the header file for each class for | ||
475 | # which an include is specified. Set to NO to disable this. | ||
476 | |||
477 | VERBATIM_HEADERS = YES | ||
478 | |||
76 | #--------------------------------------------------------------------------- | 479 | #--------------------------------------------------------------------------- |
77 | # configuration options related to the alphabetical class index | 480 | # configuration options related to the alphabetical class index |
78 | #--------------------------------------------------------------------------- | 481 | #--------------------------------------------------------------------------- |
482 | |||
483 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | ||
484 | # of all compounds will be generated. Enable this if the project | ||
485 | # contains a lot of classes, structs, unions or interfaces. | ||
486 | |||
79 | ALPHABETICAL_INDEX = YES | 487 | ALPHABETICAL_INDEX = YES |
488 | |||
489 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | ||
490 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | ||
491 | # in which this list will be split (can be a number in the range [1..20]) | ||
492 | |||
80 | COLS_IN_ALPHA_INDEX = 5 | 493 | COLS_IN_ALPHA_INDEX = 5 |
494 | |||
495 | # In case all classes in a project start with a common prefix, all | ||
496 | # classes will be put under the same header in the alphabetical index. | ||
497 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | ||
498 | # should be ignored while generating the index headers. | ||
499 | |||
81 | IGNORE_PREFIX = | 500 | IGNORE_PREFIX = |
501 | |||
82 | #--------------------------------------------------------------------------- | 502 | #--------------------------------------------------------------------------- |
83 | # configuration options related to the HTML output | 503 | # configuration options related to the HTML output |
84 | #--------------------------------------------------------------------------- | 504 | #--------------------------------------------------------------------------- |
505 | |||
506 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | ||
507 | # generate HTML output. | ||
508 | |||
85 | GENERATE_HTML = YES | 509 | GENERATE_HTML = YES |
510 | |||
511 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | ||
512 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
513 | # put in front of it. If left blank `html' will be used as the default path. | ||
514 | |||
86 | HTML_OUTPUT = html | 515 | HTML_OUTPUT = html |
87 | HTML_FILE_EXTENSION = .html # for fluxbox webpage | 516 | |
88 | HTML_HEADER = # header # note: only for fluxbox webpage | 517 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
89 | HTML_FOOTER = # footer # note: only for fluxbox webpage | 518 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
90 | HTML_STYLESHEET = # doc/style.css # note: only for fluxbox webpage | 519 | # doxygen will generate files with .html extension. |
520 | |||
521 | HTML_FILE_EXTENSION = .html | ||
522 | |||
523 | # The HTML_HEADER tag can be used to specify a personal HTML header for | ||
524 | # each generated HTML page. If it is left blank doxygen will generate a | ||
525 | # standard header. | ||
526 | |||
527 | HTML_HEADER = | ||
528 | |||
529 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | ||
530 | # each generated HTML page. If it is left blank doxygen will generate a | ||
531 | # standard footer. | ||
532 | |||
533 | HTML_FOOTER = | ||
534 | |||
535 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | ||
536 | # style sheet that is used by each HTML page. It can be used to | ||
537 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | ||
538 | # will generate a default style sheet | ||
539 | |||
540 | HTML_STYLESHEET = | ||
541 | |||
542 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | ||
543 | # files or namespaces will be aligned in HTML using tables. If set to | ||
544 | # NO a bullet list will be used. | ||
545 | |||
91 | HTML_ALIGN_MEMBERS = YES | 546 | HTML_ALIGN_MEMBERS = YES |
547 | |||
548 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | ||
549 | # will be generated that can be used as input for tools like the | ||
550 | # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | ||
551 | # of the generated HTML documentation. | ||
552 | |||
92 | GENERATE_HTMLHELP = NO | 553 | GENERATE_HTMLHELP = NO |
554 | |||
555 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | ||
556 | # be used to specify the file name of the resulting .chm file. You | ||
557 | # can add a path in front of the file if the result should not be | ||
558 | # written to the html output dir. | ||
559 | |||
93 | CHM_FILE = | 560 | CHM_FILE = |
561 | |||
562 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | ||
563 | # be used to specify the location (absolute path including file name) of | ||
564 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run | ||
565 | # the HTML help compiler on the generated index.hhp. | ||
566 | |||
94 | HHC_LOCATION = | 567 | HHC_LOCATION = |
568 | |||
569 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | ||
570 | # controls if a separate .chi index file is generated (YES) or that | ||
571 | # it should be included in the master .chm file (NO). | ||
572 | |||
95 | GENERATE_CHI = NO | 573 | GENERATE_CHI = NO |
574 | |||
575 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | ||
576 | # controls whether a binary table of contents is generated (YES) or a | ||
577 | # normal table of contents (NO) in the .chm file. | ||
578 | |||
96 | BINARY_TOC = NO | 579 | BINARY_TOC = NO |
580 | |||
581 | # The TOC_EXPAND flag can be set to YES to add extra items for group members | ||
582 | # to the contents of the HTML help documentation and to the tree view. | ||
583 | |||
97 | TOC_EXPAND = NO | 584 | TOC_EXPAND = NO |
585 | |||
586 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | ||
587 | # top of each HTML page. The value NO (the default) enables the index and | ||
588 | # the value YES disables it. | ||
589 | |||
98 | DISABLE_INDEX = NO | 590 | DISABLE_INDEX = NO |
591 | |||
592 | # This tag can be used to set the number of enum values (range [1..20]) | ||
593 | # that doxygen will group on one line in the generated HTML documentation. | ||
594 | |||
99 | ENUM_VALUES_PER_LINE = 4 | 595 | ENUM_VALUES_PER_LINE = 4 |
596 | |||
597 | # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | ||
598 | # generated containing a tree-like index structure (just like the one that | ||
599 | # is generated for HTML Help). For this to work a browser that supports | ||
600 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | ||
601 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | ||
602 | # probably better off using the HTML help feature. | ||
603 | |||
100 | GENERATE_TREEVIEW = NO | 604 | GENERATE_TREEVIEW = NO |
605 | |||
606 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | ||
607 | # used to set the initial width (in pixels) of the frame in which the tree | ||
608 | # is shown. | ||
609 | |||
101 | TREEVIEW_WIDTH = 250 | 610 | TREEVIEW_WIDTH = 250 |
611 | |||
102 | #--------------------------------------------------------------------------- | 612 | #--------------------------------------------------------------------------- |
103 | # configuration options related to the LaTeX output | 613 | # configuration options related to the LaTeX output |
104 | #--------------------------------------------------------------------------- | 614 | #--------------------------------------------------------------------------- |
615 | |||
616 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | ||
617 | # generate Latex output. | ||
618 | |||
105 | GENERATE_LATEX = NO | 619 | GENERATE_LATEX = NO |
620 | |||
621 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | ||
622 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
623 | # put in front of it. If left blank `latex' will be used as the default path. | ||
624 | |||
106 | LATEX_OUTPUT = latex | 625 | LATEX_OUTPUT = latex |
626 | |||
627 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be | ||
628 | # invoked. If left blank `latex' will be used as the default command name. | ||
629 | |||
107 | LATEX_CMD_NAME = latex | 630 | LATEX_CMD_NAME = latex |
631 | |||
632 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | ||
633 | # generate index for LaTeX. If left blank `makeindex' will be used as the | ||
634 | # default command name. | ||
635 | |||
108 | MAKEINDEX_CMD_NAME = makeindex | 636 | MAKEINDEX_CMD_NAME = makeindex |
637 | |||
638 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | ||
639 | # LaTeX documents. This may be useful for small projects and may help to | ||
640 | # save some trees in general. | ||
641 | |||
109 | COMPACT_LATEX = NO | 642 | COMPACT_LATEX = NO |
643 | |||
644 | # The PAPER_TYPE tag can be used to set the paper type that is used | ||
645 | # by the printer. Possible values are: a4, a4wide, letter, legal and | ||
646 | # executive. If left blank a4wide will be used. | ||
647 | |||
110 | PAPER_TYPE = a4wide | 648 | PAPER_TYPE = a4wide |
649 | |||
650 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | ||
651 | # packages that should be included in the LaTeX output. | ||
652 | |||
111 | EXTRA_PACKAGES = | 653 | EXTRA_PACKAGES = |
654 | |||
655 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | ||
656 | # the generated latex document. The header should contain everything until | ||
657 | # the first chapter. If it is left blank doxygen will generate a | ||
658 | # standard header. Notice: only use this tag if you know what you are doing! | ||
659 | |||
112 | LATEX_HEADER = | 660 | LATEX_HEADER = |
661 | |||
662 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | ||
663 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | ||
664 | # contain links (just like the HTML output) instead of page references | ||
665 | # This makes the output suitable for online browsing using a pdf viewer. | ||
666 | |||
113 | PDF_HYPERLINKS = NO | 667 | PDF_HYPERLINKS = NO |
668 | |||
669 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | ||
670 | # plain latex in the generated Makefile. Set this option to YES to get a | ||
671 | # higher quality PDF documentation. | ||
672 | |||
114 | USE_PDFLATEX = NO | 673 | USE_PDFLATEX = NO |
674 | |||
675 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | ||
676 | # command to the generated LaTeX files. This will instruct LaTeX to keep | ||
677 | # running if errors occur, instead of asking the user for help. | ||
678 | # This option is also used when generating formulas in HTML. | ||
679 | |||
115 | LATEX_BATCHMODE = NO | 680 | LATEX_BATCHMODE = NO |
681 | |||
682 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not | ||
683 | # include the index chapters (such as File Index, Compound Index, etc.) | ||
684 | # in the output. | ||
685 | |||
686 | LATEX_HIDE_INDICES = NO | ||
687 | |||
116 | #--------------------------------------------------------------------------- | 688 | #--------------------------------------------------------------------------- |
117 | # configuration options related to the RTF output | 689 | # configuration options related to the RTF output |
118 | #--------------------------------------------------------------------------- | 690 | #--------------------------------------------------------------------------- |
691 | |||
692 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | ||
693 | # The RTF output is optimised for Word 97 and may not look very pretty with | ||
694 | # other RTF readers or editors. | ||
695 | |||
119 | GENERATE_RTF = NO | 696 | GENERATE_RTF = NO |
697 | |||
698 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | ||
699 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
700 | # put in front of it. If left blank `rtf' will be used as the default path. | ||
701 | |||
120 | RTF_OUTPUT = rtf | 702 | RTF_OUTPUT = rtf |
703 | |||
704 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | ||
705 | # RTF documents. This may be useful for small projects and may help to | ||
706 | # save some trees in general. | ||
707 | |||
121 | COMPACT_RTF = NO | 708 | COMPACT_RTF = NO |
709 | |||
710 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | ||
711 | # will contain hyperlink fields. The RTF file will | ||
712 | # contain links (just like the HTML output) instead of page references. | ||
713 | # This makes the output suitable for online browsing using WORD or other | ||
714 | # programs which support those fields. | ||
715 | # Note: wordpad (write) and others do not support links. | ||
716 | |||
122 | RTF_HYPERLINKS = NO | 717 | RTF_HYPERLINKS = NO |
718 | |||
719 | # Load stylesheet definitions from file. Syntax is similar to doxygen's | ||
720 | # config file, i.e. a series of assigments. You only have to provide | ||
721 | # replacements, missing definitions are set to their default value. | ||
722 | |||
123 | RTF_STYLESHEET_FILE = | 723 | RTF_STYLESHEET_FILE = |
724 | |||
725 | # Set optional variables used in the generation of an rtf document. | ||
726 | # Syntax is similar to doxygen's config file. | ||
727 | |||
124 | RTF_EXTENSIONS_FILE = | 728 | RTF_EXTENSIONS_FILE = |
729 | |||
125 | #--------------------------------------------------------------------------- | 730 | #--------------------------------------------------------------------------- |
126 | # configuration options related to the man page output | 731 | # configuration options related to the man page output |
127 | #--------------------------------------------------------------------------- | 732 | #--------------------------------------------------------------------------- |
733 | |||
734 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | ||
735 | # generate man pages | ||
736 | |||
128 | GENERATE_MAN = NO | 737 | GENERATE_MAN = NO |
738 | |||
739 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | ||
740 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
741 | # put in front of it. If left blank `man' will be used as the default path. | ||
742 | |||
129 | MAN_OUTPUT = man | 743 | MAN_OUTPUT = man |
744 | |||
745 | # The MAN_EXTENSION tag determines the extension that is added to | ||
746 | # the generated man pages (default is the subroutine's section .3) | ||
747 | |||
130 | MAN_EXTENSION = .3 | 748 | MAN_EXTENSION = .3 |
749 | |||
750 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | ||
751 | # then it will generate one additional man file for each entity | ||
752 | # documented in the real man page(s). These additional files | ||
753 | # only source the real man page, but without them the man command | ||
754 | # would be unable to find the correct page. The default is NO. | ||
755 | |||
131 | MAN_LINKS = NO | 756 | MAN_LINKS = NO |
757 | |||
132 | #--------------------------------------------------------------------------- | 758 | #--------------------------------------------------------------------------- |
133 | # configuration options related to the XML output | 759 | # configuration options related to the XML output |
134 | #--------------------------------------------------------------------------- | 760 | #--------------------------------------------------------------------------- |
761 | |||
762 | # If the GENERATE_XML tag is set to YES Doxygen will | ||
763 | # generate an XML file that captures the structure of | ||
764 | # the code including all documentation. Note that this | ||
765 | # feature is still experimental and incomplete at the | ||
766 | # moment. | ||
767 | |||
135 | GENERATE_XML = NO | 768 | GENERATE_XML = NO |
769 | |||
770 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. | ||
771 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | ||
772 | # put in front of it. If left blank `xml' will be used as the default path. | ||
773 | |||
774 | XML_OUTPUT = xml | ||
775 | |||
776 | # The XML_SCHEMA tag can be used to specify an XML schema, | ||
777 | # which can be used by a validating XML parser to check the | ||
778 | # syntax of the XML files. | ||
779 | |||
780 | XML_SCHEMA = | ||
781 | |||
782 | # The XML_DTD tag can be used to specify an XML DTD, | ||
783 | # which can be used by a validating XML parser to check the | ||
784 | # syntax of the XML files. | ||
785 | |||
786 | XML_DTD = | ||
787 | |||
136 | #--------------------------------------------------------------------------- | 788 | #--------------------------------------------------------------------------- |
137 | # configuration options for the AutoGen Definitions output | 789 | # configuration options for the AutoGen Definitions output |
138 | #--------------------------------------------------------------------------- | 790 | #--------------------------------------------------------------------------- |
791 | |||
792 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | ||
793 | # generate an AutoGen Definitions (see autogen.sf.net) file | ||
794 | # that captures the structure of the code including all | ||
795 | # documentation. Note that this feature is still experimental | ||
796 | # and incomplete at the moment. | ||
797 | |||
139 | GENERATE_AUTOGEN_DEF = NO | 798 | GENERATE_AUTOGEN_DEF = NO |
799 | |||
800 | #--------------------------------------------------------------------------- | ||
801 | # configuration options related to the Perl module output | ||
802 | #--------------------------------------------------------------------------- | ||
803 | |||
804 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will | ||
805 | # generate a Perl module file that captures the structure of | ||
806 | # the code including all documentation. Note that this | ||
807 | # feature is still experimental and incomplete at the | ||
808 | # moment. | ||
809 | |||
810 | GENERATE_PERLMOD = NO | ||
811 | |||
812 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate | ||
813 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able | ||
814 | # to generate PDF and DVI output from the Perl module output. | ||
815 | |||
816 | PERLMOD_LATEX = NO | ||
817 | |||
818 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be | ||
819 | # nicely formatted so it can be parsed by a human reader. This is useful | ||
820 | # if you want to understand what is going on. On the other hand, if this | ||
821 | # tag is set to NO the size of the Perl module output will be much smaller | ||
822 | # and Perl will parse it just the same. | ||
823 | |||
824 | PERLMOD_PRETTY = YES | ||
825 | |||
826 | # The names of the make variables in the generated doxyrules.make file | ||
827 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. | ||
828 | # This is useful so different doxyrules.make files included by the same | ||
829 | # Makefile don't overwrite each other's variables. | ||
830 | |||
831 | PERLMOD_MAKEVAR_PREFIX = | ||
832 | |||
140 | #--------------------------------------------------------------------------- | 833 | #--------------------------------------------------------------------------- |
141 | # Configuration options related to the preprocessor | 834 | # Configuration options related to the preprocessor |
142 | #--------------------------------------------------------------------------- | 835 | #--------------------------------------------------------------------------- |
836 | |||
837 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | ||
838 | # evaluate all C-preprocessor directives found in the sources and include | ||
839 | # files. | ||
840 | |||
143 | ENABLE_PREPROCESSING = YES | 841 | ENABLE_PREPROCESSING = YES |
842 | |||
843 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | ||
844 | # names in the source code. If set to NO (the default) only conditional | ||
845 | # compilation will be performed. Macro expansion can be done in a controlled | ||
846 | # way by setting EXPAND_ONLY_PREDEF to YES. | ||
847 | |||
144 | MACRO_EXPANSION = NO | 848 | MACRO_EXPANSION = NO |
849 | |||
850 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | ||
851 | # then the macro expansion is limited to the macros specified with the | ||
852 | # PREDEFINED and EXPAND_AS_PREDEFINED tags. | ||
853 | |||
145 | EXPAND_ONLY_PREDEF = NO | 854 | EXPAND_ONLY_PREDEF = NO |
855 | |||
856 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | ||
857 | # in the INCLUDE_PATH (see below) will be search if a #include is found. | ||
858 | |||
146 | SEARCH_INCLUDES = YES | 859 | SEARCH_INCLUDES = YES |
860 | |||
861 | # The INCLUDE_PATH tag can be used to specify one or more directories that | ||
862 | # contain include files that are not input files but should be processed by | ||
863 | # the preprocessor. | ||
864 | |||
147 | INCLUDE_PATH = | 865 | INCLUDE_PATH = |
866 | |||
867 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | ||
868 | # patterns (like *.h and *.hpp) to filter out the header-files in the | ||
869 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | ||
870 | # be used. | ||
871 | |||
148 | INCLUDE_FILE_PATTERNS = | 872 | INCLUDE_FILE_PATTERNS = |
873 | |||
874 | # The PREDEFINED tag can be used to specify one or more macro names that | ||
875 | # are defined before the preprocessor is started (similar to the -D option of | ||
876 | # gcc). The argument of the tag is a list of macros of the form: name | ||
877 | # or name=definition (no spaces). If the definition and the = are | ||
878 | # omitted =1 is assumed. | ||
879 | |||
149 | PREDEFINED = | 880 | PREDEFINED = |
881 | |||
882 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | ||
883 | # this tag can be used to specify a list of macro names that should be expanded. | ||
884 | # The macro definition that is found in the sources will be used. | ||
885 | # Use the PREDEFINED tag if you want to use a different macro definition. | ||
886 | |||
150 | EXPAND_AS_DEFINED = | 887 | EXPAND_AS_DEFINED = |
888 | |||
889 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | ||
890 | # doxygen's preprocessor will remove all function-like macros that are alone | ||
891 | # on a line, have an all uppercase name, and do not end with a semicolon. Such | ||
892 | # function macros are typically used for boiler-plate code, and will confuse the | ||
893 | # parser if not removed. | ||
894 | |||
151 | SKIP_FUNCTION_MACROS = YES | 895 | SKIP_FUNCTION_MACROS = YES |
896 | |||
152 | #--------------------------------------------------------------------------- | 897 | #--------------------------------------------------------------------------- |
153 | # Configuration::addtions related to external references | 898 | # Configuration::addtions related to external references |
154 | #--------------------------------------------------------------------------- | 899 | #--------------------------------------------------------------------------- |
900 | |||
901 | # The TAGFILES option can be used to specify one or more tagfiles. | ||
902 | # Optionally an initial location of the external documentation | ||
903 | # can be added for each tagfile. The format of a tag file without | ||
904 | # this location is as follows: | ||
905 | # TAGFILES = file1 file2 ... | ||
906 | # Adding location for the tag files is done as follows: | ||
907 | # TAGFILES = file1=loc1 "file2 = loc2" ... | ||
908 | # where "loc1" and "loc2" can be relative or absolute paths or | ||
909 | # URLs. If a location is present for each tag, the installdox tool | ||
910 | # does not have to be run to correct the links. | ||
911 | # Note that each tag file must have a unique name | ||
912 | # (where the name does NOT include the path) | ||
913 | # If a tag file is not located in the directory in which doxygen | ||
914 | # is run, you must also specify the path to the tagfile here. | ||
915 | |||
155 | TAGFILES = | 916 | TAGFILES = |
917 | |||
918 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | ||
919 | # a tag file that is based on the input files it reads. | ||
920 | |||
156 | GENERATE_TAGFILE = | 921 | GENERATE_TAGFILE = |
922 | |||
923 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | ||
924 | # in the class index. If set to NO only the inherited external classes | ||
925 | # will be listed. | ||
926 | |||
157 | ALLEXTERNALS = NO | 927 | ALLEXTERNALS = NO |
928 | |||
929 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | ||
930 | # in the modules index. If set to NO, only the current project's groups will | ||
931 | # be listed. | ||
932 | |||
158 | EXTERNAL_GROUPS = YES | 933 | EXTERNAL_GROUPS = YES |
934 | |||
935 | # The PERL_PATH should be the absolute path and name of the perl script | ||
936 | # interpreter (i.e. the result of `which perl'). | ||
937 | |||
159 | PERL_PATH = /usr/bin/perl | 938 | PERL_PATH = /usr/bin/perl |
939 | |||
160 | #--------------------------------------------------------------------------- | 940 | #--------------------------------------------------------------------------- |
161 | # Configuration options related to the dot tool | 941 | # Configuration options related to the dot tool |
162 | #--------------------------------------------------------------------------- | 942 | #--------------------------------------------------------------------------- |
943 | |||
944 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | ||
945 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or | ||
946 | # super classes. Setting the tag to NO turns the diagrams off. Note that this | ||
947 | # option is superceded by the HAVE_DOT option below. This is only a fallback. It is | ||
948 | # recommended to install and use dot, since it yields more powerful graphs. | ||
949 | |||
163 | CLASS_DIAGRAMS = YES | 950 | CLASS_DIAGRAMS = YES |
951 | |||
952 | # If set to YES, the inheritance and collaboration graphs will hide | ||
953 | # inheritance and usage relations if the target is undocumented | ||
954 | # or is not a class. | ||
955 | |||
164 | HIDE_UNDOC_RELATIONS = YES | 956 | HIDE_UNDOC_RELATIONS = YES |
957 | |||
958 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | ||
959 | # available from the path. This tool is part of Graphviz, a graph visualization | ||
960 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | ||
961 | # have no effect if this option is set to NO (the default) | ||
962 | |||
165 | HAVE_DOT = NO | 963 | HAVE_DOT = NO |
964 | |||
965 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
966 | # will generate a graph for each documented class showing the direct and | ||
967 | # indirect inheritance relations. Setting this tag to YES will force the | ||
968 | # the CLASS_DIAGRAMS tag to NO. | ||
969 | |||
166 | CLASS_GRAPH = YES | 970 | CLASS_GRAPH = YES |
971 | |||
972 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | ||
973 | # will generate a graph for each documented class showing the direct and | ||
974 | # indirect implementation dependencies (inheritance, containment, and | ||
975 | # class references variables) of the class with other documented classes. | ||
976 | |||
167 | COLLABORATION_GRAPH = YES | 977 | COLLABORATION_GRAPH = YES |
978 | |||
979 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | ||
980 | # collaboration diagrams in a style similiar to the OMG's Unified Modeling | ||
981 | # Language. | ||
982 | |||
983 | UML_LOOK = NO | ||
984 | |||
985 | # If set to YES, the inheritance and collaboration graphs will show the | ||
986 | # relations between templates and their instances. | ||
987 | |||
168 | TEMPLATE_RELATIONS = YES | 988 | TEMPLATE_RELATIONS = YES |
989 | |||
990 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | ||
991 | # tags are set to YES then doxygen will generate a graph for each documented | ||
992 | # file showing the direct and indirect include dependencies of the file with | ||
993 | # other documented files. | ||
994 | |||
169 | INCLUDE_GRAPH = YES | 995 | INCLUDE_GRAPH = YES |
996 | |||
997 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | ||
998 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | ||
999 | # documented header file showing the documented files that directly or | ||
1000 | # indirectly include this file. | ||
1001 | |||
170 | INCLUDED_BY_GRAPH = YES | 1002 | INCLUDED_BY_GRAPH = YES |
1003 | |||
1004 | # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will | ||
1005 | # generate a call dependency graph for every global function or class method. | ||
1006 | # Note that enabling this option will significantly increase the time of a run. | ||
1007 | # So in most cases it will be better to enable call graphs for selected | ||
1008 | # functions only using the \callgraph command. | ||
1009 | |||
1010 | CALL_GRAPH = NO | ||
1011 | |||
1012 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | ||
1013 | # will graphical hierarchy of all classes instead of a textual one. | ||
1014 | |||
171 | GRAPHICAL_HIERARCHY = YES | 1015 | GRAPHICAL_HIERARCHY = YES |
1016 | |||
1017 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | ||
1018 | # generated by dot. Possible values are png, jpg, or gif | ||
1019 | # If left blank png will be used. | ||
1020 | |||
172 | DOT_IMAGE_FORMAT = png | 1021 | DOT_IMAGE_FORMAT = png |
1022 | |||
1023 | # The tag DOT_PATH can be used to specify the path where the dot tool can be | ||
1024 | # found. If left blank, it is assumed the dot tool can be found on the path. | ||
1025 | |||
173 | DOT_PATH = | 1026 | DOT_PATH = |
1027 | |||
1028 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | ||
1029 | # contain dot files that are included in the documentation (see the | ||
1030 | # \dotfile command). | ||
1031 | |||
174 | DOTFILE_DIRS = | 1032 | DOTFILE_DIRS = |
1033 | |||
1034 | # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | ||
1035 | # (in pixels) of the graphs generated by dot. If a graph becomes larger than | ||
1036 | # this value, doxygen will try to truncate the graph, so that it fits within | ||
1037 | # the specified constraint. Beware that most browsers cannot cope with very | ||
1038 | # large images. | ||
1039 | |||
175 | MAX_DOT_GRAPH_WIDTH = 1024 | 1040 | MAX_DOT_GRAPH_WIDTH = 1024 |
1041 | |||
1042 | # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | ||
1043 | # (in pixels) of the graphs generated by dot. If a graph becomes larger than | ||
1044 | # this value, doxygen will try to truncate the graph, so that it fits within | ||
1045 | # the specified constraint. Beware that most browsers cannot cope with very | ||
1046 | # large images. | ||
1047 | |||
176 | MAX_DOT_GRAPH_HEIGHT = 1024 | 1048 | MAX_DOT_GRAPH_HEIGHT = 1024 |
1049 | |||
1050 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | ||
1051 | # graphs generated by dot. A depth value of 3 means that only nodes reachable | ||
1052 | # from the root by following a path via at most 3 edges will be shown. Nodes that | ||
1053 | # lay further from the root node will be omitted. Note that setting this option to | ||
1054 | # 1 or 2 may greatly reduce the computation time needed for large code bases. Also | ||
1055 | # note that a graph may be further truncated if the graph's image dimensions are | ||
1056 | # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). | ||
1057 | # If 0 is used for the depth value (the default), the graph is not depth-constrained. | ||
1058 | |||
1059 | MAX_DOT_GRAPH_DEPTH = 0 | ||
1060 | |||
1061 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | ||
1062 | # generate a legend page explaining the meaning of the various boxes and | ||
1063 | # arrows in the dot generated graphs. | ||
1064 | |||
177 | GENERATE_LEGEND = YES | 1065 | GENERATE_LEGEND = YES |
1066 | |||
1067 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | ||
1068 | # remove the intermediate dot files that are used to generate | ||
1069 | # the various graphs. | ||
1070 | |||
178 | DOT_CLEANUP = YES | 1071 | DOT_CLEANUP = YES |
1072 | |||
179 | #--------------------------------------------------------------------------- | 1073 | #--------------------------------------------------------------------------- |
180 | # Configuration::addtions related to the search engine | 1074 | # Configuration::addtions related to the search engine |
181 | #--------------------------------------------------------------------------- | 1075 | #--------------------------------------------------------------------------- |
1076 | |||
1077 | # The SEARCHENGINE tag specifies whether or not a search engine should be | ||
1078 | # used. If set to NO the values of all tags below this one will be ignored. | ||
1079 | |||
182 | SEARCHENGINE = NO | 1080 | SEARCHENGINE = NO |
183 | CGI_NAME = search.cgi | ||
184 | CGI_URL = | ||
185 | DOC_URL = | ||
186 | DOC_ABSPATH = | ||
187 | BIN_ABSPATH = /usr/local/bin/ | ||
188 | EXT_DOC_PATHS = | ||