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