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