Salome HOME
Update copyright information
[modules/filter.git] / doc / salome / doxyfile
1 #  Copyright (C) 2007-2008  CEA/DEN, EDF R&D
2 #
3 #  This library is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU Lesser General Public
5 #  License as published by the Free Software Foundation; either
6 #  version 2.1 of the License.
7 #
8 #  This library is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 #  Lesser General Public License for more details.
12 #
13 #  You should have received a copy of the GNU Lesser General Public
14 #  License along with this library; if not, write to the Free Software
15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 #
17 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 #
19 # Doxyfile 1.5.3
20
21 # This file describes the settings to be used by the documentation system
22 # doxygen (www.doxygen.org) for a project
23 #
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 #---------------------------------------------------------------------------
32 # Project related configuration options
33 #---------------------------------------------------------------------------
34
35 # This tag specifies the encoding used for all characters in the config file that 
36 # follow. The default is UTF-8 which is also the encoding used for all text before 
37 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
38 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
39 # possible encodings.
40
41 DOXYFILE_ENCODING      = UTF-8
42
43 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
44 # by quotes) that should identify the project.
45
46 PROJECT_NAME           = 
47
48 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
49 # This could be handy for archiving the generated documentation or 
50 # if some version control system is used.
51
52 PROJECT_NUMBER         = 
53
54 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
55 # base path where the generated documentation will be put. 
56 # If a relative path is entered, it will be relative to the location 
57 # where doxygen was started. If left blank the current directory will be used.
58
59 OUTPUT_DIRECTORY       = 
60
61 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
62 # 4096 sub-directories (in 2 levels) under the output directory of each output 
63 # format and will distribute the generated files over these directories. 
64 # Enabling this option can be useful when feeding doxygen a huge amount of 
65 # source files, where putting all generated files in the same directory would 
66 # otherwise cause performance problems for the file system.
67
68 CREATE_SUBDIRS         = NO
69
70 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
71 # documentation generated by doxygen is written. Doxygen will use this 
72 # information to generate all constant output in the proper language. 
73 # The default language is English, other supported languages are: 
74 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
75 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
76 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
77 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
78 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
79
80 OUTPUT_LANGUAGE        = English
81
82 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
83 # include brief member descriptions after the members that are listed in 
84 # the file and class documentation (similar to JavaDoc). 
85 # Set to NO to disable this.
86
87 BRIEF_MEMBER_DESC      = YES
88
89 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
90 # the brief description of a member or function before the detailed description. 
91 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
92 # brief descriptions will be completely suppressed.
93
94 REPEAT_BRIEF           = YES
95
96 # This tag implements a quasi-intelligent brief description abbreviator 
97 # that is used to form the text in various listings. Each string 
98 # in this list, if found as the leading text of the brief description, will be 
99 # stripped from the text and the result after processing the whole list, is 
100 # used as the annotated text. Otherwise, the brief description is used as-is. 
101 # If left blank, the following values are used ("$name" is automatically 
102 # replaced with the name of the entity): "The $name class" "The $name widget" 
103 # "The $name file" "is" "provides" "specifies" "contains" 
104 # "represents" "a" "an" "the"
105
106 ABBREVIATE_BRIEF       = 
107
108 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
109 # Doxygen will generate a detailed section even if there is only a brief 
110 # description.
111
112 ALWAYS_DETAILED_SEC    = NO
113
114 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
115 # inherited members of a class in the documentation of that class as if those 
116 # members were ordinary class members. Constructors, destructors and assignment 
117 # operators of the base classes will not be shown.
118
119 INLINE_INHERITED_MEMB  = NO
120
121 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
122 # path before files name in the file list and in the header files. If set 
123 # to NO the shortest path that makes the file name unique will be used.
124
125 FULL_PATH_NAMES        = YES
126
127 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
128 # can be used to strip a user-defined part of the path. Stripping is 
129 # only done if one of the specified strings matches the left-hand part of 
130 # the path. The tag can be used to show relative paths in the file list. 
131 # If left blank the directory from which doxygen is run is used as the 
132 # path to strip.
133
134 STRIP_FROM_PATH        = 
135
136 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
137 # the path mentioned in the documentation of a class, which tells 
138 # the reader which header file to include in order to use a class. 
139 # If left blank only the name of the header file containing the class 
140 # definition is used. Otherwise one should specify the include paths that 
141 # are normally passed to the compiler using the -I flag.
142
143 STRIP_FROM_INC_PATH    = 
144
145 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
146 # (but less readable) file names. This can be useful is your file systems 
147 # doesn't support long names like on DOS, Mac, or CD-ROM.
148
149 SHORT_NAMES            = NO
150
151 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
152 # will interpret the first line (until the first dot) of a JavaDoc-style 
153 # comment as the brief description. If set to NO, the JavaDoc 
154 # comments will behave just like regular Qt-style comments 
155 # (thus requiring an explicit @brief command for a brief description.)
156
157 JAVADOC_AUTOBRIEF      = NO
158
159 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
160 # interpret the first line (until the first dot) of a Qt-style 
161 # comment as the brief description. If set to NO, the comments 
162 # will behave just like regular Qt-style comments (thus requiring 
163 # an explicit \brief command for a brief description.)
164
165 QT_AUTOBRIEF           = NO
166
167 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
168 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
169 # comments) as a brief description. This used to be the default behaviour. 
170 # The new default is to treat a multi-line C++ comment block as a detailed 
171 # description. Set this tag to YES if you prefer the old behaviour instead.
172
173 MULTILINE_CPP_IS_BRIEF = NO
174
175 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
176 # will output the detailed description near the top, like JavaDoc.
177 # If set to NO, the detailed description appears after the member 
178 # documentation.
179
180 DETAILS_AT_TOP         = NO
181
182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
183 # member inherits the documentation from any documented member that it 
184 # re-implements.
185
186 INHERIT_DOCS           = YES
187
188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
189 # a new page for each member. If set to NO, the documentation of a member will 
190 # be part of the file/class/namespace that contains it.
191
192 SEPARATE_MEMBER_PAGES  = NO
193
194 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
195 # Doxygen uses this value to replace tabs by spaces in code fragments.
196
197 TAB_SIZE               = 8
198
199 # This tag can be used to specify a number of aliases that acts 
200 # as commands in the documentation. An alias has the form "name=value". 
201 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
202 # put the command \sideeffect (or @sideeffect) in the documentation, which 
203 # will result in a user-defined paragraph with heading "Side Effects:". 
204 # You can put \n's in the value part of an alias to insert newlines.
205
206 ALIASES                = 
207
208 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
209 # sources only. Doxygen will then generate output that is more tailored for C. 
210 # For instance, some of the names that are used will be different. The list 
211 # of all members will be omitted, etc.
212
213 OPTIMIZE_OUTPUT_FOR_C  = NO
214
215 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
216 # sources only. Doxygen will then generate output that is more tailored for Java. 
217 # For instance, namespaces will be presented as packages, qualified scopes 
218 # will look different, etc.
219
220 OPTIMIZE_OUTPUT_JAVA   = NO
221
222 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
223 # include (a tag file for) the STL sources as input, then you should 
224 # set this tag to YES in order to let doxygen match functions declarations and 
225 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
226 # func(std::string) {}). This also make the inheritance and collaboration 
227 # diagrams that involve STL classes more complete and accurate.
228
229 BUILTIN_STL_SUPPORT    = NO
230
231 # If you use Microsoft's C++/CLI language, you should set this option to YES to
232 # enable parsing support.
233
234 CPP_CLI_SUPPORT        = NO
235
236 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
237 # tag is set to YES, then doxygen will reuse the documentation of the first 
238 # member in the group (if any) for the other members of the group. By default 
239 # all members of a group must be documented explicitly.
240
241 DISTRIBUTE_GROUP_DOC   = NO
242
243 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
244 # the same type (for instance a group of public functions) to be put as a 
245 # subgroup of that type (e.g. under the Public Functions section). Set it to 
246 # NO to prevent subgrouping. Alternatively, this can be done per class using 
247 # the \nosubgrouping command.
248
249 SUBGROUPING            = YES
250
251 #---------------------------------------------------------------------------
252 # Build related configuration options
253 #---------------------------------------------------------------------------
254
255 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
256 # documentation are documented, even if no documentation was available. 
257 # Private class members and static file members will be hidden unless 
258 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
259
260 EXTRACT_ALL            = NO
261
262 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
263 # will be included in the documentation.
264
265 EXTRACT_PRIVATE        = NO
266
267 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
268 # will be included in the documentation.
269
270 EXTRACT_STATIC         = NO
271
272 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
273 # defined locally in source files will be included in the documentation. 
274 # If set to NO only classes defined in header files are included.
275
276 EXTRACT_LOCAL_CLASSES  = YES
277
278 # This flag is only useful for Objective-C code. When set to YES local 
279 # methods, which are defined in the implementation section but not in 
280 # the interface are included in the documentation. 
281 # If set to NO (the default) only methods in the interface are included.
282
283 EXTRACT_LOCAL_METHODS  = NO
284
285 # If this flag is set to YES, the members of anonymous namespaces will be extracted 
286 # and appear in the documentation as a namespace called 'anonymous_namespace{file}', 
287 # where file will be replaced with the base name of the file that contains the anonymous 
288 # namespace. By default anonymous namespace are hidden.
289
290 EXTRACT_ANON_NSPACES   = NO
291
292 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
293 # undocumented members of documented classes, files or namespaces. 
294 # If set to NO (the default) these members will be included in the 
295 # various overviews, but no documentation section is generated. 
296 # This option has no effect if EXTRACT_ALL is enabled.
297
298 HIDE_UNDOC_MEMBERS     = NO
299
300 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
301 # undocumented classes that are normally visible in the class hierarchy. 
302 # If set to NO (the default) these classes will be included in the various 
303 # overviews. This option has no effect if EXTRACT_ALL is enabled.
304
305 HIDE_UNDOC_CLASSES     = NO
306
307 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
308 # friend (class|struct|union) declarations. 
309 # If set to NO (the default) these declarations will be included in the 
310 # documentation.
311
312 HIDE_FRIEND_COMPOUNDS  = NO
313
314 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
315 # documentation blocks found inside the body of a function. 
316 # If set to NO (the default) these blocks will be appended to the 
317 # function's detailed documentation block.
318
319 HIDE_IN_BODY_DOCS      = NO
320
321 # The INTERNAL_DOCS tag determines if documentation 
322 # that is typed after a \internal command is included. If the tag is set 
323 # to NO (the default) then the documentation will be excluded. 
324 # Set it to YES to include the internal documentation.
325
326 INTERNAL_DOCS          = NO
327
328 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
329 # file names in lower-case letters. If set to YES upper-case letters are also 
330 # allowed. This is useful if you have classes or files whose names only differ 
331 # in case and if your file system supports case sensitive file names. Windows 
332 # and Mac users are advised to set this option to NO.
333
334 CASE_SENSE_NAMES       = YES
335
336 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
337 # will show members with their full class and namespace scopes in the 
338 # documentation. If set to YES the scope will be hidden.
339
340 HIDE_SCOPE_NAMES       = NO
341
342 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
343 # will put a list of the files that are included by a file in the documentation 
344 # of that file.
345
346 SHOW_INCLUDE_FILES     = YES
347
348 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
349 # is inserted in the documentation for inline members.
350
351 INLINE_INFO            = YES
352
353 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
354 # will sort the (detailed) documentation of file and class members 
355 # alphabetically by member name. If set to NO the members will appear in 
356 # declaration order.
357
358 SORT_MEMBER_DOCS       = YES
359
360 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
361 # brief documentation of file, namespace and class members alphabetically 
362 # by member name. If set to NO (the default) the members will appear in 
363 # declaration order.
364
365 SORT_BRIEF_DOCS        = NO
366
367 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
368 # sorted by fully-qualified names, including namespaces. If set to 
369 # NO (the default), the class list will be sorted only by class name, 
370 # not including the namespace part. 
371 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
372 # Note: This option applies only to the class list, not to the 
373 # alphabetical list.
374
375 SORT_BY_SCOPE_NAME     = NO
376
377 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
378 # disable (NO) the todo list. This list is created by putting \todo 
379 # commands in the documentation.
380
381 GENERATE_TODOLIST      = YES
382
383 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
384 # disable (NO) the test list. This list is created by putting \test 
385 # commands in the documentation.
386
387 GENERATE_TESTLIST      = YES
388
389 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
390 # disable (NO) the bug list. This list is created by putting \bug 
391 # commands in the documentation.
392
393 GENERATE_BUGLIST       = YES
394
395 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
396 # disable (NO) the deprecated list. This list is created by putting 
397 # \deprecated commands in the documentation.
398
399 GENERATE_DEPRECATEDLIST= YES
400
401 # The ENABLED_SECTIONS tag can be used to enable conditional 
402 # documentation sections, marked by \if sectionname ... \endif.
403
404 ENABLED_SECTIONS       = 
405
406 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
407 # the initial value of a variable or define consists of for it to appear in 
408 # the documentation. If the initializer consists of more lines than specified 
409 # here it will be hidden. Use a value of 0 to hide initializers completely. 
410 # The appearance of the initializer of individual variables and defines in the 
411 # documentation can be controlled using \showinitializer or \hideinitializer 
412 # command in the documentation regardless of this setting.
413
414 MAX_INITIALIZER_LINES  = 30
415
416 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
417 # at the bottom of the documentation of classes and structs. If set to YES the 
418 # list will mention the files that were used to generate the documentation.
419
420 SHOW_USED_FILES        = YES
421
422 # If the sources in your project are distributed over multiple directories 
423 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
424 # in the documentation. The default is NO.
425
426 SHOW_DIRECTORIES       = NO
427
428 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
429 # doxygen should invoke to get the current version for each file (typically from the 
430 # version control system). Doxygen will invoke the program by executing (via 
431 # popen()) the command <command> <input-file>, where <command> is the value of 
432 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
433 # provided by doxygen. Whatever the program writes to standard output 
434 # is used as the file version. See the manual for examples.
435
436 FILE_VERSION_FILTER    = 
437
438 #---------------------------------------------------------------------------
439 # configuration options related to warning and progress messages
440 #---------------------------------------------------------------------------
441
442 # The QUIET tag can be used to turn on/off the messages that are generated 
443 # by doxygen. Possible values are YES and NO. If left blank NO is used.
444
445 QUIET                  = NO
446
447 # The WARNINGS tag can be used to turn on/off the warning messages that are 
448 # generated by doxygen. Possible values are YES and NO. If left blank 
449 # NO is used.
450
451 WARNINGS               = YES
452
453 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
454 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
455 # automatically be disabled.
456
457 WARN_IF_UNDOCUMENTED   = YES
458
459 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
460 # potential errors in the documentation, such as not documenting some 
461 # parameters in a documented function, or documenting parameters that 
462 # don't exist or using markup commands wrongly.
463
464 WARN_IF_DOC_ERROR      = YES
465
466 # This WARN_NO_PARAMDOC option can be abled to get warnings for 
467 # functions that are documented, but have no documentation for their parameters 
468 # or return value. If set to NO (the default) doxygen will only warn about 
469 # wrong or incomplete parameter documentation, but not about the absence of 
470 # documentation.
471
472 WARN_NO_PARAMDOC       = NO
473
474 # The WARN_FORMAT tag determines the format of the warning messages that 
475 # doxygen can produce. The string should contain the $file, $line, and $text 
476 # tags, which will be replaced by the file and line number from which the 
477 # warning originated and the warning text. Optionally the format may contain 
478 # $version, which will be replaced by the version of the file (if it could 
479 # be obtained via FILE_VERSION_FILTER)
480
481 WARN_FORMAT            = "$file:$line: $text"
482
483 # The WARN_LOGFILE tag can be used to specify a file to which warning 
484 # and error messages should be written. If left blank the output is written 
485 # to stderr.
486
487 WARN_LOGFILE           = 
488
489 #---------------------------------------------------------------------------
490 # configuration options related to the input files
491 #---------------------------------------------------------------------------
492
493 # The INPUT tag can be used to specify the files and/or directories that contain 
494 # documented source files. You may enter file names like "myfile.cpp" or 
495 # directories like "/usr/src/myproject". Separate the files or directories 
496 # with spaces.
497
498 INPUT                  = 
499
500 # This tag can be used to specify the character encoding of the source files that 
501 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
502 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
503 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
504
505 INPUT_ENCODING         = UTF-8
506
507 # If the value of the INPUT tag contains directories, you can use the 
508 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
509 # and *.h) to filter out the source-files in the directories. If left 
510 # blank the following patterns are tested: 
511 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
512 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
513
514 FILE_PATTERNS          = 
515
516 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
517 # should be searched for input files as well. Possible values are YES and NO. 
518 # If left blank NO is used.
519
520 RECURSIVE              = NO
521
522 # The EXCLUDE tag can be used to specify files and/or directories that should 
523 # excluded from the INPUT source files. This way you can easily exclude a 
524 # subdirectory from a directory tree whose root is specified with the INPUT tag.
525
526 EXCLUDE                = 
527
528 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
529 # directories that are symbolic links (a Unix filesystem feature) are excluded 
530 # from the input.
531
532 EXCLUDE_SYMLINKS       = NO
533
534 # If the value of the INPUT tag contains directories, you can use the 
535 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
536 # certain files from those directories. Note that the wildcards are matched 
537 # against the file with absolute path, so to exclude all test directories 
538 # for example use the pattern */test/*
539
540 EXCLUDE_PATTERNS       = 
541
542 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
543 # (namespaces, classes, functions, etc.) that should be excluded from the output. 
544 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
545 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
546
547 EXCLUDE_SYMBOLS        = 
548
549 # The EXAMPLE_PATH tag can be used to specify one or more files or 
550 # directories that contain example code fragments that are included (see 
551 # the \include command).
552
553 EXAMPLE_PATH           = 
554
555 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
556 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
557 # and *.h) to filter out the source-files in the directories. If left 
558 # blank all files are included.
559
560 EXAMPLE_PATTERNS       = 
561
562 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
563 # searched for input files to be used with the \include or \dontinclude 
564 # commands irrespective of the value of the RECURSIVE tag. 
565 # Possible values are YES and NO. If left blank NO is used.
566
567 EXAMPLE_RECURSIVE      = NO
568
569 # The IMAGE_PATH tag can be used to specify one or more files or 
570 # directories that contain image that are included in the documentation (see 
571 # the \image command).
572
573 IMAGE_PATH             = ./images
574
575 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
576 # invoke to filter for each input file. Doxygen will invoke the filter program 
577 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
578 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
579 # input file. Doxygen will then use the output that the filter program writes 
580 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
581 # ignored.
582
583 INPUT_FILTER           = 
584
585 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
586 # basis.  Doxygen will compare the file name with each pattern and apply the 
587 # filter if there is a match.  The filters are a list of the form: 
588 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
589 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
590 # is applied to all files.
591
592 FILTER_PATTERNS        = 
593
594 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
595 # INPUT_FILTER) will be used to filter the input files when producing source 
596 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
597
598 FILTER_SOURCE_FILES    = NO
599
600 #---------------------------------------------------------------------------
601 # configuration options related to source browsing
602 #---------------------------------------------------------------------------
603
604 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
605 # be generated. Documented entities will be cross-referenced with these sources. 
606 # Note: To get rid of all source code in the generated output, make sure also 
607 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH 
608 # then you must also enable this option. If you don't then doxygen will produce 
609 # a warning and turn it on anyway
610
611 SOURCE_BROWSER         = NO
612
613 # Setting the INLINE_SOURCES tag to YES will include the body 
614 # of functions and classes directly in the documentation.
615
616 INLINE_SOURCES         = NO
617
618 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
619 # doxygen to hide any special comment blocks from generated source code 
620 # fragments. Normal C and C++ comments will always remain visible.
621
622 STRIP_CODE_COMMENTS    = YES
623
624 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
625 # then for each documented function all documented 
626 # functions referencing it will be listed.
627
628 REFERENCED_BY_RELATION = YES
629
630 # If the REFERENCES_RELATION tag is set to YES (the default) 
631 # then for each documented function all documented entities 
632 # called/used by that function will be listed.
633
634 REFERENCES_RELATION    = YES
635
636 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
637 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
638 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
639 # link to the source code.  Otherwise they will link to the documentstion.
640
641 REFERENCES_LINK_SOURCE = YES
642
643 # If the USE_HTAGS tag is set to YES then the references to source code 
644 # will point to the HTML generated by the htags(1) tool instead of doxygen 
645 # built-in source browser. The htags tool is part of GNU's global source 
646 # tagging system (see http://www.gnu.org/software/global/global.html). You 
647 # will need version 4.8.6 or higher.
648
649 USE_HTAGS              = NO
650
651 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
652 # will generate a verbatim copy of the header file for each class for 
653 # which an include is specified. Set to NO to disable this.
654
655 VERBATIM_HEADERS       = YES
656
657 #---------------------------------------------------------------------------
658 # configuration options related to the alphabetical class index
659 #---------------------------------------------------------------------------
660
661 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
662 # of all compounds will be generated. Enable this if the project 
663 # contains a lot of classes, structs, unions or interfaces.
664
665 ALPHABETICAL_INDEX     = NO
666
667 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
668 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
669 # in which this list will be split (can be a number in the range [1..20])
670
671 COLS_IN_ALPHA_INDEX    = 5
672
673 # In case all classes in a project start with a common prefix, all 
674 # classes will be put under the same header in the alphabetical index. 
675 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
676 # should be ignored while generating the index headers.
677
678 IGNORE_PREFIX          = 
679
680 #---------------------------------------------------------------------------
681 # configuration options related to the HTML output
682 #---------------------------------------------------------------------------
683
684 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
685 # generate HTML output.
686
687 GENERATE_HTML          = YES
688
689 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
690 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
691 # put in front of it. If left blank `html' will be used as the default path.
692
693 HTML_OUTPUT            = html
694
695 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
696 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
697 # doxygen will generate files with .html extension.
698
699 HTML_FILE_EXTENSION    = .html
700
701 # The HTML_HEADER tag can be used to specify a personal HTML header for 
702 # each generated HTML page. If it is left blank doxygen will generate a 
703 # standard header.
704
705 HTML_HEADER            = 
706
707 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
708 # each generated HTML page. If it is left blank doxygen will generate a 
709 # standard footer.
710
711 HTML_FOOTER            = 
712
713 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
714 # style sheet that is used by each HTML page. It can be used to 
715 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
716 # will generate a default style sheet. Note that doxygen will try to copy 
717 # the style sheet file to the HTML output directory, so don't put your own 
718 # stylesheet in the HTML output directory as well, or it will be erased!
719
720 HTML_STYLESHEET        = 
721
722 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
723 # files or namespaces will be aligned in HTML using tables. If set to 
724 # NO a bullet list will be used.
725
726 HTML_ALIGN_MEMBERS     = YES
727
728 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
729 # will be generated that can be used as input for tools like the 
730 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
731 # of the generated HTML documentation.
732
733 GENERATE_HTMLHELP      = NO
734
735 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
736 # documentation will contain sections that can be hidden and shown after the 
737 # page has loaded. For this to work a browser that supports 
738 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
739 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
740
741 HTML_DYNAMIC_SECTIONS  = NO
742
743 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
744 # be used to specify the file name of the resulting .chm file. You 
745 # can add a path in front of the file if the result should not be 
746 # written to the html output directory.
747
748 CHM_FILE               = 
749
750 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
751 # be used to specify the location (absolute path including file name) of 
752 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
753 # the HTML help compiler on the generated index.hhp.
754
755 HHC_LOCATION           = 
756
757 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
758 # controls if a separate .chi index file is generated (YES) or that 
759 # it should be included in the master .chm file (NO).
760
761 GENERATE_CHI           = NO
762
763 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
764 # controls whether a binary table of contents is generated (YES) or a 
765 # normal table of contents (NO) in the .chm file.
766
767 BINARY_TOC             = NO
768
769 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
770 # to the contents of the HTML help documentation and to the tree view.
771
772 TOC_EXPAND             = NO
773
774 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
775 # top of each HTML page. The value NO (the default) enables the index and 
776 # the value YES disables it.
777
778 DISABLE_INDEX          = NO
779
780 # This tag can be used to set the number of enum values (range [1..20]) 
781 # that doxygen will group on one line in the generated HTML documentation.
782
783 ENUM_VALUES_PER_LINE   = 4
784
785 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
786 # generated containing a tree-like index structure (just like the one that 
787 # is generated for HTML Help). For this to work a browser that supports 
788 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
789 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
790 # probably better off using the HTML help feature.
791
792 GENERATE_TREEVIEW      = NO
793
794 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
795 # used to set the initial width (in pixels) of the frame in which the tree 
796 # is shown.
797
798 TREEVIEW_WIDTH         = 250
799
800 #---------------------------------------------------------------------------
801 # configuration options related to the LaTeX output
802 #---------------------------------------------------------------------------
803
804 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
805 # generate Latex output.
806
807 GENERATE_LATEX         = YES
808
809 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
810 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
811 # put in front of it. If left blank `latex' will be used as the default path.
812
813 LATEX_OUTPUT           = latex
814
815 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
816 # invoked. If left blank `latex' will be used as the default command name.
817
818 LATEX_CMD_NAME         = latex
819
820 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
821 # generate index for LaTeX. If left blank `makeindex' will be used as the 
822 # default command name.
823
824 MAKEINDEX_CMD_NAME     = makeindex
825
826 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
827 # LaTeX documents. This may be useful for small projects and may help to 
828 # save some trees in general.
829
830 COMPACT_LATEX          = NO
831
832 # The PAPER_TYPE tag can be used to set the paper type that is used 
833 # by the printer. Possible values are: a4, a4wide, letter, legal and 
834 # executive. If left blank a4wide will be used.
835
836 PAPER_TYPE             = a4wide
837
838 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
839 # packages that should be included in the LaTeX output.
840
841 EXTRA_PACKAGES         = 
842
843 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
844 # the generated latex document. The header should contain everything until 
845 # the first chapter. If it is left blank doxygen will generate a 
846 # standard header. Notice: only use this tag if you know what you are doing!
847
848 LATEX_HEADER           = 
849
850 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
851 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
852 # contain links (just like the HTML output) instead of page references 
853 # This makes the output suitable for online browsing using a pdf viewer.
854
855 PDF_HYPERLINKS         = NO
856
857 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
858 # plain latex in the generated Makefile. Set this option to YES to get a 
859 # higher quality PDF documentation.
860
861 USE_PDFLATEX           = NO
862
863 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
864 # command to the generated LaTeX files. This will instruct LaTeX to keep 
865 # running if errors occur, instead of asking the user for help. 
866 # This option is also used when generating formulas in HTML.
867
868 LATEX_BATCHMODE        = NO
869
870 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
871 # include the index chapters (such as File Index, Compound Index, etc.) 
872 # in the output.
873
874 LATEX_HIDE_INDICES     = NO
875
876 #---------------------------------------------------------------------------
877 # configuration options related to the RTF output
878 #---------------------------------------------------------------------------
879
880 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
881 # The RTF output is optimized for Word 97 and may not look very pretty with 
882 # other RTF readers or editors.
883
884 GENERATE_RTF           = NO
885
886 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
887 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
888 # put in front of it. If left blank `rtf' will be used as the default path.
889
890 RTF_OUTPUT             = rtf
891
892 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
893 # RTF documents. This may be useful for small projects and may help to 
894 # save some trees in general.
895
896 COMPACT_RTF            = NO
897
898 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
899 # will contain hyperlink fields. The RTF file will 
900 # contain links (just like the HTML output) instead of page references. 
901 # This makes the output suitable for online browsing using WORD or other 
902 # programs which support those fields. 
903 # Note: wordpad (write) and others do not support links.
904
905 RTF_HYPERLINKS         = NO
906
907 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
908 # config file, i.e. a series of assignments. You only have to provide 
909 # replacements, missing definitions are set to their default value.
910
911 RTF_STYLESHEET_FILE    = 
912
913 # Set optional variables used in the generation of an rtf document. 
914 # Syntax is similar to doxygen's config file.
915
916 RTF_EXTENSIONS_FILE    = 
917
918 #---------------------------------------------------------------------------
919 # configuration options related to the man page output
920 #---------------------------------------------------------------------------
921
922 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
923 # generate man pages
924
925 GENERATE_MAN           = NO
926
927 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
928 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
929 # put in front of it. If left blank `man' will be used as the default path.
930
931 MAN_OUTPUT             = man
932
933 # The MAN_EXTENSION tag determines the extension that is added to 
934 # the generated man pages (default is the subroutine's section .3)
935
936 MAN_EXTENSION          = .3
937
938 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
939 # then it will generate one additional man file for each entity 
940 # documented in the real man page(s). These additional files 
941 # only source the real man page, but without them the man command 
942 # would be unable to find the correct page. The default is NO.
943
944 MAN_LINKS              = NO
945
946 #---------------------------------------------------------------------------
947 # configuration options related to the XML output
948 #---------------------------------------------------------------------------
949
950 # If the GENERATE_XML tag is set to YES Doxygen will 
951 # generate an XML file that captures the structure of 
952 # the code including all documentation.
953
954 GENERATE_XML           = NO
955
956 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
957 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
958 # put in front of it. If left blank `xml' will be used as the default path.
959
960 XML_OUTPUT             = xml
961
962 # The XML_SCHEMA tag can be used to specify an XML schema, 
963 # which can be used by a validating XML parser to check the 
964 # syntax of the XML files.
965
966 XML_SCHEMA             = 
967
968 # The XML_DTD tag can be used to specify an XML DTD, 
969 # which can be used by a validating XML parser to check the 
970 # syntax of the XML files.
971
972 XML_DTD                = 
973
974 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
975 # dump the program listings (including syntax highlighting 
976 # and cross-referencing information) to the XML output. Note that 
977 # enabling this will significantly increase the size of the XML output.
978
979 XML_PROGRAMLISTING     = YES
980
981 #---------------------------------------------------------------------------
982 # configuration options for the AutoGen Definitions output
983 #---------------------------------------------------------------------------
984
985 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
986 # generate an AutoGen Definitions (see autogen.sf.net) file 
987 # that captures the structure of the code including all 
988 # documentation. Note that this feature is still experimental 
989 # and incomplete at the moment.
990
991 GENERATE_AUTOGEN_DEF   = NO
992
993 #---------------------------------------------------------------------------
994 # configuration options related to the Perl module output
995 #---------------------------------------------------------------------------
996
997 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
998 # generate a Perl module file that captures the structure of 
999 # the code including all documentation. Note that this 
1000 # feature is still experimental and incomplete at the 
1001 # moment.
1002
1003 GENERATE_PERLMOD       = NO
1004
1005 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1006 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1007 # to generate PDF and DVI output from the Perl module output.
1008
1009 PERLMOD_LATEX          = NO
1010
1011 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1012 # nicely formatted so it can be parsed by a human reader.  This is useful 
1013 # if you want to understand what is going on.  On the other hand, if this 
1014 # tag is set to NO the size of the Perl module output will be much smaller 
1015 # and Perl will parse it just the same.
1016
1017 PERLMOD_PRETTY         = YES
1018
1019 # The names of the make variables in the generated doxyrules.make file 
1020 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1021 # This is useful so different doxyrules.make files included by the same 
1022 # Makefile don't overwrite each other's variables.
1023
1024 PERLMOD_MAKEVAR_PREFIX = 
1025
1026 #---------------------------------------------------------------------------
1027 # Configuration options related to the preprocessor   
1028 #---------------------------------------------------------------------------
1029
1030 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1031 # evaluate all C-preprocessor directives found in the sources and include 
1032 # files.
1033
1034 ENABLE_PREPROCESSING   = YES
1035
1036 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1037 # names in the source code. If set to NO (the default) only conditional 
1038 # compilation will be performed. Macro expansion can be done in a controlled 
1039 # way by setting EXPAND_ONLY_PREDEF to YES.
1040
1041 MACRO_EXPANSION        = NO
1042
1043 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1044 # then the macro expansion is limited to the macros specified with the 
1045 # PREDEFINED and EXPAND_AS_DEFINED tags.
1046
1047 EXPAND_ONLY_PREDEF     = NO
1048
1049 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1050 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1051
1052 SEARCH_INCLUDES        = YES
1053
1054 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1055 # contain include files that are not input files but should be processed by 
1056 # the preprocessor.
1057
1058 INCLUDE_PATH           = 
1059
1060 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1061 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1062 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1063 # be used.
1064
1065 INCLUDE_FILE_PATTERNS  = 
1066
1067 # The PREDEFINED tag can be used to specify one or more macro names that 
1068 # are defined before the preprocessor is started (similar to the -D option of 
1069 # gcc). The argument of the tag is a list of macros of the form: name 
1070 # or name=definition (no spaces). If the definition and the = are 
1071 # omitted =1 is assumed. To prevent a macro definition from being 
1072 # undefined via #undef or recursively expanded use the := operator 
1073 # instead of the = operator.
1074
1075 PREDEFINED             = 
1076
1077 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1078 # this tag can be used to specify a list of macro names that should be expanded. 
1079 # The macro definition that is found in the sources will be used. 
1080 # Use the PREDEFINED tag if you want to use a different macro definition.
1081
1082 EXPAND_AS_DEFINED      = 
1083
1084 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1085 # doxygen's preprocessor will remove all function-like macros that are alone 
1086 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
1087 # function macros are typically used for boiler-plate code, and will confuse 
1088 # the parser if not removed.
1089
1090 SKIP_FUNCTION_MACROS   = YES
1091
1092 #---------------------------------------------------------------------------
1093 # Configuration::additions related to external references   
1094 #---------------------------------------------------------------------------
1095
1096 # The TAGFILES option can be used to specify one or more tagfiles. 
1097 # Optionally an initial location of the external documentation 
1098 # can be added for each tagfile. The format of a tag file without 
1099 # this location is as follows: 
1100 #   TAGFILES = file1 file2 ... 
1101 # Adding location for the tag files is done as follows: 
1102 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1103 # where "loc1" and "loc2" can be relative or absolute paths or 
1104 # URLs. If a location is present for each tag, the installdox tool 
1105 # does not have to be run to correct the links.
1106 # Note that each tag file must have a unique name
1107 # (where the name does NOT include the path)
1108 # If a tag file is not located in the directory in which doxygen 
1109 # is run, you must also specify the path to the tagfile here.
1110
1111 TAGFILES               = 
1112
1113 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1114 # a tag file that is based on the input files it reads.
1115
1116 GENERATE_TAGFILE       = 
1117
1118 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1119 # in the class index. If set to NO only the inherited external classes 
1120 # will be listed.
1121
1122 ALLEXTERNALS           = NO
1123
1124 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1125 # in the modules index. If set to NO, only the current project's groups will 
1126 # be listed.
1127
1128 EXTERNAL_GROUPS        = YES
1129
1130 # The PERL_PATH should be the absolute path and name of the perl script 
1131 # interpreter (i.e. the result of `which perl').
1132
1133 PERL_PATH              = /usr/bin/perl
1134
1135 #---------------------------------------------------------------------------
1136 # Configuration options related to the dot tool   
1137 #---------------------------------------------------------------------------
1138
1139 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1140 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1141 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1142 # this option is superseded by the HAVE_DOT option below. This is only a 
1143 # fallback. It is recommended to install and use dot, since it yields more 
1144 # powerful graphs.
1145
1146 CLASS_DIAGRAMS         = YES
1147
1148 # You can define message sequence charts within doxygen comments using the \msc 
1149 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
1150 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
1151 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
1152 # be found in the default search path.
1153
1154 MSCGEN_PATH            = 
1155
1156 # If set to YES, the inheritance and collaboration graphs will hide 
1157 # inheritance and usage relations if the target is undocumented 
1158 # or is not a class.
1159
1160 HIDE_UNDOC_RELATIONS   = YES
1161
1162 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1163 # available from the path. This tool is part of Graphviz, a graph visualization 
1164 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1165 # have no effect if this option is set to NO (the default)
1166
1167 HAVE_DOT               = NO
1168
1169 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1170 # will generate a graph for each documented class showing the direct and 
1171 # indirect inheritance relations. Setting this tag to YES will force the 
1172 # the CLASS_DIAGRAMS tag to NO.
1173
1174 CLASS_GRAPH            = YES
1175
1176 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1177 # will generate a graph for each documented class showing the direct and 
1178 # indirect implementation dependencies (inheritance, containment, and 
1179 # class references variables) of the class with other documented classes.
1180
1181 COLLABORATION_GRAPH    = YES
1182
1183 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1184 # will generate a graph for groups, showing the direct groups dependencies
1185
1186 GROUP_GRAPHS           = YES
1187
1188 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1189 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1190 # Language.
1191
1192 UML_LOOK               = NO
1193
1194 # If set to YES, the inheritance and collaboration graphs will show the 
1195 # relations between templates and their instances.
1196
1197 TEMPLATE_RELATIONS     = NO
1198
1199 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1200 # tags are set to YES then doxygen will generate a graph for each documented 
1201 # file showing the direct and indirect include dependencies of the file with 
1202 # other documented files.
1203
1204 INCLUDE_GRAPH          = YES
1205
1206 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1207 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1208 # documented header file showing the documented files that directly or 
1209 # indirectly include this file.
1210
1211 INCLUDED_BY_GRAPH      = YES
1212
1213 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
1214 # generate a call dependency graph for every global function or class method. 
1215 # Note that enabling this option will significantly increase the time of a run. 
1216 # So in most cases it will be better to enable call graphs for selected 
1217 # functions only using the \callgraph command.
1218
1219 CALL_GRAPH             = NO
1220
1221 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
1222 # generate a caller dependency graph for every global function or class method. 
1223 # Note that enabling this option will significantly increase the time of a run. 
1224 # So in most cases it will be better to enable caller graphs for selected 
1225 # functions only using the \callergraph command.
1226
1227 CALLER_GRAPH           = NO
1228
1229 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1230 # will graphical hierarchy of all classes instead of a textual one.
1231
1232 GRAPHICAL_HIERARCHY    = YES
1233
1234 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1235 # then doxygen will show the dependencies a directory has on other directories 
1236 # in a graphical way. The dependency relations are determined by the #include
1237 # relations between the files in the directories.
1238
1239 DIRECTORY_GRAPH        = YES
1240
1241 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1242 # generated by dot. Possible values are png, jpg, or gif
1243 # If left blank png will be used.
1244
1245 DOT_IMAGE_FORMAT       = png
1246
1247 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1248 # found. If left blank, it is assumed the dot tool can be found in the path.
1249
1250 DOT_PATH               = 
1251
1252 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1253 # contain dot files that are included in the documentation (see the 
1254 # \dotfile command).
1255
1256 DOTFILE_DIRS           = 
1257
1258 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1259 # nodes that will be shown in the graph. If the number of nodes in a graph 
1260 # becomes larger than this value, doxygen will truncate the graph, which is 
1261 # visualized by representing a node as a red box. Note that doxygen if the number 
1262 # of direct children of the root node in a graph is already larger than 
1263 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note 
1264 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1265
1266 DOT_GRAPH_MAX_NODES    = 50
1267
1268 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1269 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1270 # from the root by following a path via at most 3 edges will be shown. Nodes 
1271 # that lay further from the root node will be omitted. Note that setting this 
1272 # option to 1 or 2 may greatly reduce the computation time needed for large 
1273 # code bases. Also note that the size of a graph can be further restricted by 
1274 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1275
1276 MAX_DOT_GRAPH_DEPTH    = 0
1277
1278 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1279 # background. This is disabled by default, which results in a white background. 
1280 # Warning: Depending on the platform used, enabling this option may lead to 
1281 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1282 # read).
1283
1284 DOT_TRANSPARENT        = NO
1285
1286 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1287 # files in one run (i.e. multiple -o and -T options on the command line). This 
1288 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1289 # support this, this feature is disabled by default.
1290
1291 DOT_MULTI_TARGETS      = NO
1292
1293 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1294 # generate a legend page explaining the meaning of the various boxes and 
1295 # arrows in the dot generated graphs.
1296
1297 GENERATE_LEGEND        = YES
1298
1299 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1300 # remove the intermediate dot files that are used to generate 
1301 # the various graphs.
1302
1303 DOT_CLEANUP            = YES
1304
1305 #---------------------------------------------------------------------------
1306 # Configuration::additions related to the search engine   
1307 #---------------------------------------------------------------------------
1308
1309 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1310 # used. If set to NO the values of all tags below this one will be ignored.
1311
1312 SEARCHENGINE           = NO