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