Mercurial > hg > easyhg-kdiff3
comparison kdiff3/admin/Doxyfile.global @ 14:415083d043f3
KDiff3 version 0.9.70
author | joachim99 |
---|---|
date | Mon, 06 Oct 2003 19:19:11 +0000 |
parents | |
children | efe33e938730 |
comparison
equal
deleted
inserted
replaced
13:266aeefa1b11 | 14:415083d043f3 |
---|---|
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 = | |
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 = NO | |
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 # @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them | |
232 # to nothing here | |
233 | |
234 ALIASES = libdoc=@mainpage \ | |
235 sect=<p><b> \ | |
236 reimplemented= \ | |
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | |
238 obsolete=@deprecated \ | |
239 ref= | |
240 | |
241 # The ENABLED_SECTIONS tag can be used to enable conditional | |
242 # documentation sections, marked by \if sectionname ... \endif. | |
243 | |
244 ENABLED_SECTIONS = | |
245 | |
246 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | |
247 # the initial value of a variable or define consist of for it to appear in | |
248 # the documentation. If the initializer consists of more lines than specified | |
249 # here it will be hidden. Use a value of 0 to hide initializers completely. | |
250 # The appearance of the initializer of individual variables and defines in the | |
251 # documentation can be controlled using \showinitializer or \hideinitializer | |
252 # command in the documentation regardless of this setting. | |
253 | |
254 MAX_INITIALIZER_LINES = 30 | |
255 | |
256 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | |
257 # only. Doxygen will then generate output that is more tailored for C. | |
258 # For instance some of the names that are used will be different. The list | |
259 # of all members will be omitted, etc. | |
260 | |
261 OPTIMIZE_OUTPUT_FOR_C = NO | |
262 | |
263 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | |
264 # only. Doxygen will then generate output that is more tailored for Java. | |
265 # For instance namespaces will be presented as packages, qualified scopes | |
266 # will look different, etc. | |
267 | |
268 OPTIMIZE_OUTPUT_JAVA = NO | |
269 | |
270 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | |
271 # at the bottom of the documentation of classes and structs. If set to YES the | |
272 # list will mention the files that were used to generate the documentation. | |
273 | |
274 SHOW_USED_FILES = YES | |
275 | |
276 #--------------------------------------------------------------------------- | |
277 # configuration options related to warning and progress messages | |
278 #--------------------------------------------------------------------------- | |
279 | |
280 # The QUIET tag can be used to turn on/off the messages that are generated | |
281 # by doxygen. Possible values are YES and NO. If left blank NO is used. | |
282 | |
283 QUIET = YES | |
284 | |
285 # The WARNINGS tag can be used to turn on/off the warning messages that are | |
286 # generated by doxygen. Possible values are YES and NO. If left blank | |
287 # NO is used. | |
288 | |
289 WARNINGS = YES | |
290 | |
291 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | |
292 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | |
293 # automatically be disabled. | |
294 | |
295 WARN_IF_UNDOCUMENTED = NO | |
296 | |
297 # The WARN_FORMAT tag determines the format of the warning messages that | |
298 # doxygen can produce. The string should contain the $file, $line, and $text | |
299 # tags, which will be replaced by the file and line number from which the | |
300 # warning originated and the warning text. | |
301 | |
302 WARN_FORMAT = | |
303 | |
304 # The WARN_LOGFILE tag can be used to specify a file to which warning | |
305 # and error messages should be written. If left blank the output is written | |
306 # to stderr. | |
307 | |
308 WARN_LOGFILE = | |
309 | |
310 #--------------------------------------------------------------------------- | |
311 # configuration options related to the input files | |
312 #--------------------------------------------------------------------------- | |
313 | |
314 # The INPUT tag can be used to specify the files and/or directories that contain | |
315 # documented source files. You may enter file names like "myfile.cpp" or | |
316 # directories like "/usr/src/myproject". Separate the files or directories | |
317 # with spaces. | |
318 | |
319 INPUT = | |
320 | |
321 # If the value of the INPUT tag contains directories, you can use the | |
322 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
323 # and *.h) to filter out the source-files in the directories. If left | |
324 # blank the following patterns are tested: | |
325 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | |
326 # *.h++ *.idl *.odl | |
327 | |
328 FILE_PATTERNS = *.h \ | |
329 *.cpp \ | |
330 *.cc \ | |
331 *.hpp | |
332 | |
333 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | |
334 # should be searched for input files as well. Possible values are YES and NO. | |
335 # If left blank NO is used. | |
336 | |
337 RECURSIVE = YES | |
338 | |
339 # The EXCLUDE tag can be used to specify files and/or directories that should | |
340 # excluded from the INPUT source files. This way you can easily exclude a | |
341 # subdirectory from a directory tree whose root is specified with the INPUT tag. | |
342 | |
343 EXCLUDE = | |
344 | |
345 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | |
346 # that are symbolic links (a Unix filesystem feature) are excluded from the input. | |
347 | |
348 EXCLUDE_SYMLINKS = NO | |
349 | |
350 # If the value of the INPUT tag contains directories, you can use the | |
351 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | |
352 # certain files from those directories. | |
353 | |
354 EXCLUDE_PATTERNS = *.moc.* \ | |
355 moc* \ | |
356 *.all_cpp.* \ | |
357 *unload.* \ | |
358 */test/* \ | |
359 */tests/* | |
360 | |
361 # The EXAMPLE_PATH tag can be used to specify one or more files or | |
362 # directories that contain example code fragments that are included (see | |
363 # the \include command). | |
364 | |
365 EXAMPLE_PATH = | |
366 | |
367 # If the value of the EXAMPLE_PATH tag contains directories, you can use the | |
368 # EXAMPLE_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 all files are included. | |
371 | |
372 EXAMPLE_PATTERNS = | |
373 | |
374 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | |
375 # searched for input files to be used with the \include or \dontinclude | |
376 # commands irrespective of the value of the RECURSIVE tag. | |
377 # Possible values are YES and NO. If left blank NO is used. | |
378 | |
379 EXAMPLE_RECURSIVE = NO | |
380 | |
381 # The IMAGE_PATH tag can be used to specify one or more files or | |
382 # directories that contain image that are included in the documentation (see | |
383 # the \image command). | |
384 | |
385 IMAGE_PATH = | |
386 | |
387 # The INPUT_FILTER tag can be used to specify a program that doxygen should | |
388 # invoke to filter for each input file. Doxygen will invoke the filter program | |
389 # by executing (via popen()) the command <filter> <input-file>, where <filter> | |
390 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | |
391 # input file. Doxygen will then use the output that the filter program writes | |
392 # to standard output. | |
393 | |
394 INPUT_FILTER = | |
395 | |
396 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | |
397 # INPUT_FILTER) will be used to filter the input files when producing source | |
398 # files to browse. | |
399 | |
400 FILTER_SOURCE_FILES = NO | |
401 | |
402 #--------------------------------------------------------------------------- | |
403 # configuration options related to source browsing | |
404 #--------------------------------------------------------------------------- | |
405 | |
406 # If the SOURCE_BROWSER tag is set to YES then a list of source files will | |
407 # be generated. Documented entities will be cross-referenced with these sources. | |
408 | |
409 SOURCE_BROWSER = YES | |
410 | |
411 # Setting the INLINE_SOURCES tag to YES will include the body | |
412 # of functions and classes directly in the documentation. | |
413 | |
414 INLINE_SOURCES = NO | |
415 | |
416 # If the REFERENCED_BY_RELATION tag is set to YES (the default) | |
417 # then for each documented function all documented | |
418 # functions referencing it will be listed. | |
419 | |
420 REFERENCED_BY_RELATION = YES | |
421 | |
422 # If the REFERENCES_RELATION tag is set to YES (the default) | |
423 # then for each documented function all documented entities | |
424 # called/used by that function will be listed. | |
425 | |
426 REFERENCES_RELATION = YES | |
427 | |
428 #--------------------------------------------------------------------------- | |
429 # configuration options related to the alphabetical class index | |
430 #--------------------------------------------------------------------------- | |
431 | |
432 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | |
433 # of all compounds will be generated. Enable this if the project | |
434 # contains a lot of classes, structs, unions or interfaces. | |
435 | |
436 ALPHABETICAL_INDEX = YES | |
437 | |
438 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | |
439 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | |
440 # in which this list will be split (can be a number in the range [1..20]) | |
441 | |
442 COLS_IN_ALPHA_INDEX = 3 | |
443 | |
444 # In case all classes in a project start with a common prefix, all | |
445 # classes will be put under the same header in the alphabetical index. | |
446 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | |
447 # should be ignored while generating the index headers. | |
448 | |
449 IGNORE_PREFIX = K | |
450 | |
451 #--------------------------------------------------------------------------- | |
452 # configuration options related to the HTML output | |
453 #--------------------------------------------------------------------------- | |
454 | |
455 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | |
456 # generate HTML output. | |
457 | |
458 GENERATE_HTML = NO | |
459 | |
460 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | |
461 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
462 # put in front of it. If left blank `html' will be used as the default path. | |
463 | |
464 HTML_OUTPUT = | |
465 | |
466 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | |
467 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | |
468 # doxygen will generate files with .html extension. | |
469 | |
470 HTML_FILE_EXTENSION = .html | |
471 | |
472 # The HTML_HEADER tag can be used to specify a personal HTML header for | |
473 # each generated HTML page. If it is left blank doxygen will generate a | |
474 # standard header. | |
475 | |
476 HTML_HEADER = ../apidocs/common/header.html | |
477 | |
478 # The HTML_FOOTER tag can be used to specify a personal HTML footer for | |
479 # each generated HTML page. If it is left blank doxygen will generate a | |
480 # standard footer. | |
481 | |
482 HTML_FOOTER = ../apidocs/common/footer.html | |
483 | |
484 # The HTML_STYLESHEET tag can be used to specify a user defined cascading | |
485 # style sheet that is used by each HTML page. It can be used to | |
486 # fine-tune the look of the HTML output. If the tag is left blank doxygen | |
487 # will generate a default style sheet | |
488 | |
489 HTML_STYLESHEET = ../apidocs/common/doxygen.css | |
490 | |
491 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | |
492 # files or namespaces will be aligned in HTML using tables. If set to | |
493 # NO a bullet list will be used. | |
494 | |
495 HTML_ALIGN_MEMBERS = YES | |
496 | |
497 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | |
498 # will be generated that can be used as input for tools like the | |
499 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | |
500 # of the generated HTML documentation. | |
501 | |
502 GENERATE_HTMLHELP = NO | |
503 | |
504 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | |
505 # controls if a separate .chi index file is generated (YES) or that | |
506 # it should be included in the master .chm file (NO). | |
507 | |
508 GENERATE_CHI = NO | |
509 | |
510 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | |
511 # controls whether a binary table of contents is generated (YES) or a | |
512 # normal table of contents (NO) in the .chm file. | |
513 | |
514 BINARY_TOC = NO | |
515 | |
516 # The TOC_EXPAND flag can be set to YES to add extra items for group members | |
517 # to the contents of the Html help documentation and to the tree view. | |
518 | |
519 TOC_EXPAND = NO | |
520 | |
521 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | |
522 # top of each HTML page. The value NO (the default) enables the index and | |
523 # the value YES disables it. | |
524 | |
525 DISABLE_INDEX = YES | |
526 | |
527 # This tag can be used to set the number of enum values (range [1..20]) | |
528 # that doxygen will group on one line in the generated HTML documentation. | |
529 | |
530 ENUM_VALUES_PER_LINE = 4 | |
531 | |
532 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | |
533 # generated containing a tree-like index structure (just like the one that | |
534 # is generated for HTML Help). For this to work a browser that supports | |
535 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, | |
536 # or Internet explorer 4.0+). Note that for large projects the tree generation | |
537 # can take a very long time. In such cases it is better to disable this feature. | |
538 # Windows users are probably better off using the HTML help feature. | |
539 | |
540 GENERATE_TREEVIEW = NO | |
541 | |
542 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | |
543 # used to set the initial width (in pixels) of the frame in which the tree | |
544 # is shown. | |
545 | |
546 TREEVIEW_WIDTH = 250 | |
547 | |
548 #--------------------------------------------------------------------------- | |
549 # configuration options related to the LaTeX output | |
550 #--------------------------------------------------------------------------- | |
551 | |
552 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | |
553 # generate Latex output. | |
554 | |
555 GENERATE_LATEX = NO | |
556 | |
557 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | |
558 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
559 # put in front of it. If left blank `latex' will be used as the default path. | |
560 | |
561 LATEX_OUTPUT = | |
562 | |
563 # 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. | |
564 | |
565 LATEX_CMD_NAME = latex | |
566 | |
567 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | |
568 # generate index for LaTeX. If left blank `makeindex' will be used as the | |
569 # default command name. | |
570 | |
571 MAKEINDEX_CMD_NAME = makeindex | |
572 | |
573 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | |
574 # LaTeX documents. This may be useful for small projects and may help to | |
575 # save some trees in general. | |
576 | |
577 COMPACT_LATEX = NO | |
578 | |
579 # The PAPER_TYPE tag can be used to set the paper type that is used | |
580 # by the printer. Possible values are: a4, a4wide, letter, legal and | |
581 # executive. If left blank a4wide will be used. | |
582 | |
583 PAPER_TYPE = a4wide | |
584 | |
585 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | |
586 # packages that should be included in the LaTeX output. | |
587 | |
588 EXTRA_PACKAGES = | |
589 | |
590 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | |
591 # the generated latex document. The header should contain everything until | |
592 # the first chapter. If it is left blank doxygen will generate a | |
593 # standard header. Notice: only use this tag if you know what you are doing! | |
594 | |
595 LATEX_HEADER = | |
596 | |
597 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | |
598 # is prepared for conversion to pdf (using ps2pdf). The pdf file will | |
599 # contain links (just like the HTML output) instead of page references | |
600 # This makes the output suitable for online browsing using a pdf viewer. | |
601 | |
602 PDF_HYPERLINKS = NO | |
603 | |
604 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | |
605 # plain latex in the generated Makefile. Set this option to YES to get a | |
606 # higher quality PDF documentation. | |
607 | |
608 USE_PDFLATEX = NO | |
609 | |
610 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | |
611 # command to the generated LaTeX files. This will instruct LaTeX to keep | |
612 # running if errors occur, instead of asking the user for help. | |
613 # This option is also used when generating formulas in HTML. | |
614 | |
615 LATEX_BATCHMODE = NO | |
616 | |
617 #--------------------------------------------------------------------------- | |
618 # configuration options related to the RTF output | |
619 #--------------------------------------------------------------------------- | |
620 | |
621 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | |
622 # The RTF output is optimised for Word 97 and may not look very pretty with | |
623 # other RTF readers or editors. | |
624 | |
625 GENERATE_RTF = NO | |
626 | |
627 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | |
628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
629 # put in front of it. If left blank `rtf' will be used as the default path. | |
630 | |
631 RTF_OUTPUT = | |
632 | |
633 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | |
634 # RTF documents. This may be useful for small projects and may help to | |
635 # save some trees in general. | |
636 | |
637 COMPACT_RTF = NO | |
638 | |
639 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | |
640 # will contain hyperlink fields. The RTF file will | |
641 # contain links (just like the HTML output) instead of page references. | |
642 # This makes the output suitable for online browsing using WORD or other | |
643 # programs which support those fields. | |
644 # Note: wordpad (write) and others do not support links. | |
645 | |
646 RTF_HYPERLINKS = NO | |
647 | |
648 # Load stylesheet definitions from file. Syntax is similar to doxygen's | |
649 # config file, i.e. a series of assigments. You only have to provide | |
650 # replacements, missing definitions are set to their default value. | |
651 | |
652 RTF_STYLESHEET_FILE = | |
653 | |
654 # Set optional variables used in the generation of an rtf document. | |
655 # Syntax is similar to doxygen's config file. | |
656 | |
657 RTF_EXTENSIONS_FILE = | |
658 | |
659 #--------------------------------------------------------------------------- | |
660 # configuration options related to the man page output | |
661 #--------------------------------------------------------------------------- | |
662 | |
663 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | |
664 # generate man pages | |
665 | |
666 GENERATE_MAN = NO | |
667 | |
668 # The MAN_OUTPUT tag is used to specify where the man pages will be put. | |
669 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
670 # put in front of it. If left blank `man' will be used as the default path. | |
671 | |
672 MAN_OUTPUT = | |
673 | |
674 # The MAN_EXTENSION tag determines the extension that is added to | |
675 # the generated man pages (default is the subroutine's section .3) | |
676 | |
677 MAN_EXTENSION = .kde3 | |
678 | |
679 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | |
680 # then it will generate one additional man file for each entity | |
681 # documented in the real man page(s). These additional files | |
682 # only source the real man page, but without them the man command | |
683 # would be unable to find the correct page. The default is NO. | |
684 | |
685 MAN_LINKS = YES | |
686 | |
687 #--------------------------------------------------------------------------- | |
688 # configuration options related to the XML output | |
689 #--------------------------------------------------------------------------- | |
690 | |
691 # If the GENERATE_XML tag is set to YES Doxygen will | |
692 # generate an XML file that captures the structure of | |
693 # the code including all documentation. Note that this | |
694 # feature is still experimental and incomplete at the | |
695 # moment. | |
696 | |
697 GENERATE_XML = NO | |
698 | |
699 #--------------------------------------------------------------------------- | |
700 # configuration options for the AutoGen Definitions output | |
701 #--------------------------------------------------------------------------- | |
702 | |
703 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | |
704 # generate an AutoGen Definitions (see autogen.sf.net) file | |
705 # that captures the structure of the code including all | |
706 # documentation. Note that this feature is still experimental | |
707 # and incomplete at the moment. | |
708 | |
709 GENERATE_AUTOGEN_DEF = NO | |
710 | |
711 #--------------------------------------------------------------------------- | |
712 # Configuration options related to the preprocessor | |
713 #--------------------------------------------------------------------------- | |
714 | |
715 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | |
716 # evaluate all C-preprocessor directives found in the sources and include | |
717 # files. | |
718 | |
719 ENABLE_PREPROCESSING = YES | |
720 | |
721 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | |
722 # names in the source code. If set to NO (the default) only conditional | |
723 # compilation will be performed. Macro expansion can be done in a controlled | |
724 # way by setting EXPAND_ONLY_PREDEF to YES. | |
725 | |
726 MACRO_EXPANSION = NO | |
727 | |
728 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | |
729 # then the macro expansion is limited to the macros specified with the | |
730 # PREDEFINED and EXPAND_AS_PREDEFINED tags. | |
731 | |
732 EXPAND_ONLY_PREDEF = NO | |
733 | |
734 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | |
735 # in the INCLUDE_PATH (see below) will be search if a #include is found. | |
736 | |
737 SEARCH_INCLUDES = YES | |
738 | |
739 # The INCLUDE_PATH tag can be used to specify one or more directories that | |
740 # contain include files that are not input files but should be processed by | |
741 # the preprocessor. | |
742 | |
743 INCLUDE_PATH = | |
744 | |
745 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | |
746 # patterns (like *.h and *.hpp) to filter out the header-files in the | |
747 # directories. If left blank, the patterns specified with FILE_PATTERNS will | |
748 # be used. | |
749 | |
750 INCLUDE_FILE_PATTERNS = | |
751 | |
752 # The PREDEFINED tag can be used to specify one or more macro names that | |
753 # are defined before the preprocessor is started (similar to the -D option of | |
754 # gcc). The argument of the tag is a list of macros of the form: name | |
755 # or name=definition (no spaces). If the definition and the = are | |
756 # omitted =1 is assumed. | |
757 | |
758 PREDEFINED = QT_VERSION=305 | |
759 | |
760 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then | |
761 # this tag can be used to specify a list of macro names that should be expanded. | |
762 # The macro definition that is found in the sources will be used. | |
763 # Use the PREDEFINED tag if you want to use a different macro definition. | |
764 | |
765 EXPAND_AS_DEFINED = | |
766 | |
767 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | |
768 # doxygen's preprocessor will remove all function-like macros that are alone | |
769 # on a line and do not end with a semicolon. Such function macros are typically | |
770 # used for boiler-plate code, and will confuse the parser if not removed. | |
771 | |
772 SKIP_FUNCTION_MACROS = YES | |
773 | |
774 #--------------------------------------------------------------------------- | |
775 # Configuration::addtions related to external references | |
776 #--------------------------------------------------------------------------- | |
777 | |
778 # The TAGFILES tag can be used to specify one or more tagfiles. | |
779 | |
780 TAGFILES = | |
781 | |
782 # When a file name is specified after GENERATE_TAGFILE, doxygen will create | |
783 # a tag file that is based on the input files it reads. | |
784 | |
785 GENERATE_TAGFILE = | |
786 | |
787 # If the ALLEXTERNALS tag is set to YES all external classes will be listed | |
788 # in the class index. If set to NO only the inherited external classes | |
789 # will be listed. | |
790 | |
791 ALLEXTERNALS = NO | |
792 | |
793 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | |
794 # in the modules index. If set to NO, only the current project's groups will | |
795 # be listed. | |
796 | |
797 EXTERNAL_GROUPS = NO | |
798 | |
799 # The PERL_PATH should be the absolute path and name of the perl script | |
800 # interpreter (i.e. the result of `which perl'). | |
801 | |
802 PERL_PATH = | |
803 | |
804 #--------------------------------------------------------------------------- | |
805 # Configuration options related to the dot tool | |
806 #--------------------------------------------------------------------------- | |
807 | |
808 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | |
809 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or | |
810 # super classes. Setting the tag to NO turns the diagrams off. Note that this | |
811 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is | |
812 # recommended to install and use dot, since it yield more powerful graphs. | |
813 | |
814 CLASS_DIAGRAMS = YES | |
815 | |
816 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | |
817 # available from the path. This tool is part of Graphviz, a graph visualization | |
818 # toolkit from AT&T and Lucent Bell Labs. The other options in this section | |
819 # have no effect if this option is set to NO (the default) | |
820 | |
821 HAVE_DOT = NO | |
822 | |
823 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
824 # will generate a graph for each documented class showing the direct and | |
825 # indirect inheritance relations. Setting this tag to YES will force the | |
826 # the CLASS_DIAGRAMS tag to NO. | |
827 | |
828 CLASS_GRAPH = YES | |
829 | |
830 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
831 # will generate a graph for each documented class showing the direct and | |
832 # indirect implementation dependencies (inheritance, containment, and | |
833 # class references variables) of the class with other documented classes. | |
834 | |
835 COLLABORATION_GRAPH = YES | |
836 | |
837 # If set to YES, the inheritance and collaboration graphs will show the | |
838 # relations between templates and their instances. | |
839 | |
840 TEMPLATE_RELATIONS = YES | |
841 | |
842 # If set to YES, the inheritance and collaboration graphs will hide | |
843 # inheritance and usage relations if the target is undocumented | |
844 # or is not a class. | |
845 | |
846 HIDE_UNDOC_RELATIONS = NO | |
847 | |
848 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | |
849 # tags are set to YES then doxygen will generate a graph for each documented | |
850 # file showing the direct and indirect include dependencies of the file with | |
851 # other documented files. | |
852 | |
853 INCLUDE_GRAPH = YES | |
854 | |
855 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | |
856 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | |
857 # documented header file showing the documented files that directly or | |
858 # indirectly include this file. | |
859 | |
860 INCLUDED_BY_GRAPH = YES | |
861 | |
862 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | |
863 # will graphical hierarchy of all classes instead of a textual one. | |
864 | |
865 GRAPHICAL_HIERARCHY = NO | |
866 | |
867 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | |
868 # generated by dot. Possible values are png, jpg, or gif | |
869 # If left blank png will be used. | |
870 | |
871 DOT_IMAGE_FORMAT = png | |
872 | |
873 # The tag DOT_PATH can be used to specify the path where the dot tool can be | |
874 # found. If left blank, it is assumed the dot tool can be found on the path. | |
875 | |
876 DOT_PATH = | |
877 | |
878 # The DOTFILE_DIRS tag can be used to specify one or more directories that | |
879 # contain dot files that are included in the documentation (see the | |
880 # \dotfile command). | |
881 | |
882 DOTFILE_DIRS = | |
883 | |
884 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | |
885 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
886 # this value, doxygen will try to truncate the graph, so that it fits within | |
887 # the specified constraint. Beware that most browsers cannot cope with very | |
888 # large images. | |
889 | |
890 MAX_DOT_GRAPH_WIDTH = 800 | |
891 | |
892 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | |
893 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
894 # this value, doxygen will try to truncate the graph, so that it fits within | |
895 # the specified constraint. Beware that most browsers cannot cope with very | |
896 # large images. | |
897 | |
898 MAX_DOT_GRAPH_HEIGHT = 1024 | |
899 | |
900 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | |
901 # generate a legend page explaining the meaning of the various boxes and | |
902 # arrows in the dot generated graphs. | |
903 | |
904 GENERATE_LEGEND = YES | |
905 | |
906 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | |
907 # remove the intermedate dot files that are used to generate | |
908 # the various graphs. | |
909 | |
910 DOT_CLEANUP = YES | |
911 | |
912 #--------------------------------------------------------------------------- | |
913 # Configuration::addtions related to the search engine | |
914 #--------------------------------------------------------------------------- | |
915 | |
916 # The SEARCHENGINE tag specifies whether or not a search engine should be | |
917 # used. If set to NO the values of all tags below this one will be ignored. | |
918 | |
919 SEARCHENGINE = NO | |
920 | |
921 # The CGI_NAME tag should be the name of the CGI script that | |
922 # starts the search engine (doxysearch) with the correct parameters. | |
923 # A script with this name will be generated by doxygen. | |
924 | |
925 CGI_NAME = | |
926 | |
927 # The CGI_URL tag should be the absolute URL to the directory where the | |
928 # cgi binaries are located. See the documentation of your http daemon for | |
929 # details. | |
930 | |
931 CGI_URL = | |
932 | |
933 # The DOC_URL tag should be the absolute URL to the directory where the | |
934 # documentation is located. If left blank the absolute path to the | |
935 # documentation, with file:// prepended to it, will be used. | |
936 | |
937 DOC_URL = | |
938 | |
939 # The DOC_ABSPATH tag should be the absolute path to the directory where the | |
940 # documentation is located. If left blank the directory on the local machine | |
941 # will be used. | |
942 | |
943 DOC_ABSPATH = | |
944 | |
945 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary | |
946 # is installed. | |
947 | |
948 BIN_ABSPATH = | |
949 | |
950 # The EXT_DOC_PATHS tag can be used to specify one or more paths to | |
951 # documentation generated for other projects. This allows doxysearch to search | |
952 # the documentation for these projects as well. | |
953 | |
954 EXT_DOC_PATHS = |