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