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