tdb: test for readonly locks mode on tdbbackup command
[samba.git] / lib / tdb / doxy.config
1 # Doxyfile 1.7.3
2
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
5 #
6 # All text after a hash (#) is considered a comment and will be ignored.
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ").
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING      = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME           = tdb
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33
34 PROJECT_NUMBER         = 1.2.9
35
36 # Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
37
38 PROJECT_BRIEF          =
39
40 # With the PROJECT_LOGO tag one can specify an logo or icon that is
41 # included in the documentation. The maximum height of the logo should not
42 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
43 # Doxygen will copy the logo to the output directory.
44
45 PROJECT_LOGO           =
46
47 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
48 # base path where the generated documentation will be put.
49 # If a relative path is entered, it will be relative to the location
50 # where doxygen was started. If left blank the current directory will be used.
51
52 OUTPUT_DIRECTORY       = docs
53
54 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
55 # 4096 sub-directories (in 2 levels) under the output directory of each output
56 # format and will distribute the generated files over these directories.
57 # Enabling this option can be useful when feeding doxygen a huge amount of
58 # source files, where putting all generated files in the same directory would
59 # otherwise cause performance problems for the file system.
60
61 CREATE_SUBDIRS         = NO
62
63 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
64 # documentation generated by doxygen is written. Doxygen will use this
65 # information to generate all constant output in the proper language.
66 # The default language is English, other supported languages are:
67 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
68 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
69 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
70 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
71 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
72 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
73
74 OUTPUT_LANGUAGE        = English
75
76 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
77 # include brief member descriptions after the members that are listed in
78 # the file and class documentation (similar to JavaDoc).
79 # Set to NO to disable this.
80
81 BRIEF_MEMBER_DESC      = YES
82
83 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
84 # the brief description of a member or function before the detailed description.
85 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86 # brief descriptions will be completely suppressed.
87
88 REPEAT_BRIEF           = YES
89
90 # This tag implements a quasi-intelligent brief description abbreviator
91 # that is used to form the text in various listings. Each string
92 # in this list, if found as the leading text of the brief description, will be
93 # stripped from the text and the result after processing the whole list, is
94 # used as the annotated text. Otherwise, the brief description is used as-is.
95 # If left blank, the following values are used ("$name" is automatically
96 # replaced with the name of the entity): "The $name class" "The $name widget"
97 # "The $name file" "is" "provides" "specifies" "contains"
98 # "represents" "a" "an" "the"
99
100 ABBREVIATE_BRIEF       = "The $name class" \
101                          "The $name widget" \
102                          "The $name file" \
103                          is \
104                          provides \
105                          specifies \
106                          contains \
107                          represents \
108                          a \
109                          an \
110                          the
111
112 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
113 # Doxygen will generate a detailed section even if there is only a brief
114 # description.
115
116 ALWAYS_DETAILED_SEC    = NO
117
118 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
119 # inherited members of a class in the documentation of that class as if those
120 # members were ordinary class members. Constructors, destructors and assignment
121 # operators of the base classes will not be shown.
122
123 INLINE_INHERITED_MEMB  = NO
124
125 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
126 # path before files name in the file list and in the header files. If set
127 # to NO the shortest path that makes the file name unique will be used.
128
129 FULL_PATH_NAMES        = YES
130
131 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132 # can be used to strip a user-defined part of the path. Stripping is
133 # only done if one of the specified strings matches the left-hand part of
134 # the path. The tag can be used to show relative paths in the file list.
135 # If left blank the directory from which doxygen is run is used as the
136 # path to strip.
137
138 STRIP_FROM_PATH        =
139
140 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
141 # the path mentioned in the documentation of a class, which tells
142 # the reader which header file to include in order to use a class.
143 # If left blank only the name of the header file containing the class
144 # definition is used. Otherwise one should specify the include paths that
145 # are normally passed to the compiler using the -I flag.
146
147 STRIP_FROM_INC_PATH    =
148
149 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
150 # (but less readable) file names. This can be useful if your file system
151 # doesn't support long names like on DOS, Mac, or CD-ROM.
152
153 SHORT_NAMES            = NO
154
155 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
156 # will interpret the first line (until the first dot) of a JavaDoc-style
157 # comment as the brief description. If set to NO, the JavaDoc
158 # comments will behave just like regular Qt-style comments
159 # (thus requiring an explicit @brief command for a brief description.)
160
161 JAVADOC_AUTOBRIEF      = YES
162
163 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
164 # interpret the first line (until the first dot) of a Qt-style
165 # comment as the brief description. If set to NO, the comments
166 # will behave just like regular Qt-style comments (thus requiring
167 # an explicit \brief command for a brief description.)
168
169 QT_AUTOBRIEF           = NO
170
171 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
172 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
173 # comments) as a brief description. This used to be the default behaviour.
174 # The new default is to treat a multi-line C++ comment block as a detailed
175 # description. Set this tag to YES if you prefer the old behaviour instead.
176
177 MULTILINE_CPP_IS_BRIEF = NO
178
179 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
180 # member inherits the documentation from any documented member that it
181 # re-implements.
182
183 INHERIT_DOCS           = YES
184
185 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
186 # a new page for each member. If set to NO, the documentation of a member will
187 # be part of the file/class/namespace that contains it.
188
189 SEPARATE_MEMBER_PAGES  = NO
190
191 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
192 # Doxygen uses this value to replace tabs by spaces in code fragments.
193
194 TAB_SIZE               = 8
195
196 # This tag can be used to specify a number of aliases that acts
197 # as commands in the documentation. An alias has the form "name=value".
198 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
199 # put the command \sideeffect (or @sideeffect) in the documentation, which
200 # will result in a user-defined paragraph with heading "Side Effects:".
201 # You can put \n's in the value part of an alias to insert newlines.
202
203 ALIASES                =
204
205 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206 # sources only. Doxygen will then generate output that is more tailored for C.
207 # For instance, some of the names that are used will be different. The list
208 # of all members will be omitted, etc.
209
210 OPTIMIZE_OUTPUT_FOR_C  = YES
211
212 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
213 # sources only. Doxygen will then generate output that is more tailored for
214 # Java. For instance, namespaces will be presented as packages, qualified
215 # scopes will look different, etc.
216
217 OPTIMIZE_OUTPUT_JAVA   = NO
218
219 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
220 # sources only. Doxygen will then generate output that is more tailored for
221 # Fortran.
222
223 OPTIMIZE_FOR_FORTRAN   = NO
224
225 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
226 # sources. Doxygen will then generate output that is tailored for
227 # VHDL.
228
229 OPTIMIZE_OUTPUT_VHDL   = NO
230
231 # Doxygen selects the parser to use depending on the extension of the files it
232 # parses. With this tag you can assign which parser to use for a given extension.
233 # Doxygen has a built-in mapping, but you can override or extend it using this
234 # tag. The format is ext=language, where ext is a file extension, and language
235 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
236 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
237 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
238 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
240
241 EXTENSION_MAPPING      =
242
243 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
244 # to include (a tag file for) the STL sources as input, then you should
245 # set this tag to YES in order to let doxygen match functions declarations and
246 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
247 # func(std::string) {}). This also makes the inheritance and collaboration
248 # diagrams that involve STL classes more complete and accurate.
249
250 BUILTIN_STL_SUPPORT    = NO
251
252 # If you use Microsoft's C++/CLI language, you should set this option to YES to
253 # enable parsing support.
254
255 CPP_CLI_SUPPORT        = NO
256
257 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
258 # Doxygen will parse them like normal C++ but will assume all classes use public
259 # instead of private inheritance when no explicit protection keyword is present.
260
261 SIP_SUPPORT            = NO
262
263 # For Microsoft's IDL there are propget and propput attributes to indicate getter
264 # and setter methods for a property. Setting this option to YES (the default)
265 # will make doxygen replace the get and set methods by a property in the
266 # documentation. This will only work if the methods are indeed getting or
267 # setting a simple type. If this is not the case, or you want to show the
268 # methods anyway, you should set this option to NO.
269
270 IDL_PROPERTY_SUPPORT   = YES
271
272 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
273 # tag is set to YES, then doxygen will reuse the documentation of the first
274 # member in the group (if any) for the other members of the group. By default
275 # all members of a group must be documented explicitly.
276
277 DISTRIBUTE_GROUP_DOC   = NO
278
279 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
280 # the same type (for instance a group of public functions) to be put as a
281 # subgroup of that type (e.g. under the Public Functions section). Set it to
282 # NO to prevent subgrouping. Alternatively, this can be done per class using
283 # the \nosubgrouping command.
284
285 SUBGROUPING            = YES
286
287 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
288 # is documented as struct, union, or enum with the name of the typedef. So
289 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
290 # with name TypeT. When disabled the typedef will appear as a member of a file,
291 # namespace, or class. And the struct will be named TypeS. This can typically
292 # be useful for C code in case the coding convention dictates that all compound
293 # types are typedef'ed and only the typedef is referenced, never the tag name.
294
295 TYPEDEF_HIDES_STRUCT   = NO
296
297 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
298 # determine which symbols to keep in memory and which to flush to disk.
299 # When the cache is full, less often used symbols will be written to disk.
300 # For small to medium size projects (<1000 input files) the default value is
301 # probably good enough. For larger projects a too small cache size can cause
302 # doxygen to be busy swapping symbols to and from disk most of the time
303 # causing a significant performance penalty.
304 # If the system has enough physical memory increasing the cache will improve the
305 # performance by keeping more symbols in memory. Note that the value works on
306 # a logarithmic scale so increasing the size by one will roughly double the
307 # memory usage. The cache size is given by this formula:
308 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
309 # corresponding to a cache size of 2^16 = 65536 symbols
310
311 SYMBOL_CACHE_SIZE      = 0
312
313 #---------------------------------------------------------------------------
314 # Build related configuration options
315 #---------------------------------------------------------------------------
316
317 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
318 # documentation are documented, even if no documentation was available.
319 # Private class members and static file members will be hidden unless
320 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
321
322 EXTRACT_ALL            = NO
323
324 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
325 # will be included in the documentation.
326
327 EXTRACT_PRIVATE        = NO
328
329 # If the EXTRACT_STATIC tag is set to YES all static members of a file
330 # will be included in the documentation.
331
332 EXTRACT_STATIC         = NO
333
334 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
335 # defined locally in source files will be included in the documentation.
336 # If set to NO only classes defined in header files are included.
337
338 EXTRACT_LOCAL_CLASSES  = NO
339
340 # This flag is only useful for Objective-C code. When set to YES local
341 # methods, which are defined in the implementation section but not in
342 # the interface are included in the documentation.
343 # If set to NO (the default) only methods in the interface are included.
344
345 EXTRACT_LOCAL_METHODS  = NO
346
347 # If this flag is set to YES, the members of anonymous namespaces will be
348 # extracted and appear in the documentation as a namespace called
349 # 'anonymous_namespace{file}', where file will be replaced with the base
350 # name of the file that contains the anonymous namespace. By default
351 # anonymous namespaces are hidden.
352
353 EXTRACT_ANON_NSPACES   = NO
354
355 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
356 # undocumented members of documented classes, files or namespaces.
357 # If set to NO (the default) these members will be included in the
358 # various overviews, but no documentation section is generated.
359 # This option has no effect if EXTRACT_ALL is enabled.
360
361 HIDE_UNDOC_MEMBERS     = YES
362
363 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
364 # undocumented classes that are normally visible in the class hierarchy.
365 # If set to NO (the default) these classes will be included in the various
366 # overviews. This option has no effect if EXTRACT_ALL is enabled.
367
368 HIDE_UNDOC_CLASSES     = YES
369
370 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
371 # friend (class|struct|union) declarations.
372 # If set to NO (the default) these declarations will be included in the
373 # documentation.
374
375 HIDE_FRIEND_COMPOUNDS  = NO
376
377 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
378 # documentation blocks found inside the body of a function.
379 # If set to NO (the default) these blocks will be appended to the
380 # function's detailed documentation block.
381
382 HIDE_IN_BODY_DOCS      = NO
383
384 # The INTERNAL_DOCS tag determines if documentation
385 # that is typed after a \internal command is included. If the tag is set
386 # to NO (the default) then the documentation will be excluded.
387 # Set it to YES to include the internal documentation.
388
389 INTERNAL_DOCS          = NO
390
391 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
392 # file names in lower-case letters. If set to YES upper-case letters are also
393 # allowed. This is useful if you have classes or files whose names only differ
394 # in case and if your file system supports case sensitive file names. Windows
395 # and Mac users are advised to set this option to NO.
396
397 CASE_SENSE_NAMES       = YES
398
399 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
400 # will show members with their full class and namespace scopes in the
401 # documentation. If set to YES the scope will be hidden.
402
403 HIDE_SCOPE_NAMES       = NO
404
405 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
406 # will put a list of the files that are included by a file in the documentation
407 # of that file.
408
409 SHOW_INCLUDE_FILES     = YES
410
411 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
412 # will list include files with double quotes in the documentation
413 # rather than with sharp brackets.
414
415 FORCE_LOCAL_INCLUDES   = NO
416
417 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
418 # is inserted in the documentation for inline members.
419
420 INLINE_INFO            = YES
421
422 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
423 # will sort the (detailed) documentation of file and class members
424 # alphabetically by member name. If set to NO the members will appear in
425 # declaration order.
426
427 SORT_MEMBER_DOCS       = YES
428
429 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
430 # brief documentation of file, namespace and class members alphabetically
431 # by member name. If set to NO (the default) the members will appear in
432 # declaration order.
433
434 SORT_BRIEF_DOCS        = NO
435
436 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
437 # will sort the (brief and detailed) documentation of class members so that
438 # constructors and destructors are listed first. If set to NO (the default)
439 # the constructors will appear in the respective orders defined by
440 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
441 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
442 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
443
444 SORT_MEMBERS_CTORS_1ST = NO
445
446 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
447 # hierarchy of group names into alphabetical order. If set to NO (the default)
448 # the group names will appear in their defined order.
449
450 SORT_GROUP_NAMES       = NO
451
452 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
453 # sorted by fully-qualified names, including namespaces. If set to
454 # NO (the default), the class list will be sorted only by class name,
455 # not including the namespace part.
456 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
457 # Note: This option applies only to the class list, not to the
458 # alphabetical list.
459
460 SORT_BY_SCOPE_NAME     = NO
461
462 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a
463 # match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
464 # will still accept a match between prototype and implementation in such cases.
465
466 STRICT_PROTO_MATCHING  = NO
467
468 # The GENERATE_TODOLIST tag can be used to enable (YES) or
469 # disable (NO) the todo list. This list is created by putting \todo
470 # commands in the documentation.
471
472 GENERATE_TODOLIST      = YES
473
474 # The GENERATE_TESTLIST tag can be used to enable (YES) or
475 # disable (NO) the test list. This list is created by putting \test
476 # commands in the documentation.
477
478 GENERATE_TESTLIST      = YES
479
480 # The GENERATE_BUGLIST tag can be used to enable (YES) or
481 # disable (NO) the bug list. This list is created by putting \bug
482 # commands in the documentation.
483
484 GENERATE_BUGLIST       = YES
485
486 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
487 # disable (NO) the deprecated list. This list is created by putting
488 # \deprecated commands in the documentation.
489
490 GENERATE_DEPRECATEDLIST= YES
491
492 # The ENABLED_SECTIONS tag can be used to enable conditional
493 # documentation sections, marked by \if sectionname ... \endif.
494
495 ENABLED_SECTIONS       =
496
497 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
498 # the initial value of a variable or macro consists of for it to appear in
499 # the documentation. If the initializer consists of more lines than specified
500 # here it will be hidden. Use a value of 0 to hide initializers completely.
501 # The appearance of the initializer of individual variables and macros in the
502 # documentation can be controlled using \showinitializer or \hideinitializer
503 # command in the documentation regardless of this setting.
504
505 MAX_INITIALIZER_LINES  = 30
506
507 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
508 # at the bottom of the documentation of classes and structs. If set to YES the
509 # list will mention the files that were used to generate the documentation.
510
511 SHOW_USED_FILES        = YES
512
513 # If the sources in your project are distributed over multiple directories
514 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
515 # in the documentation. The default is NO.
516
517 SHOW_DIRECTORIES       = NO
518
519 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
520 # This will remove the Files entry from the Quick Index and from the
521 # Folder Tree View (if specified). The default is YES.
522
523 SHOW_FILES             = YES
524
525 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
526 # Namespaces page.
527 # This will remove the Namespaces entry from the Quick Index
528 # and from the Folder Tree View (if specified). The default is YES.
529
530 SHOW_NAMESPACES        = YES
531
532 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
533 # doxygen should invoke to get the current version for each file (typically from
534 # the version control system). Doxygen will invoke the program by executing (via
535 # popen()) the command <command> <input-file>, where <command> is the value of
536 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
537 # provided by doxygen. Whatever the program writes to standard output
538 # is used as the file version. See the manual for examples.
539
540 FILE_VERSION_FILTER    =
541
542 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
543 # by doxygen. The layout file controls the global structure of the generated
544 # output files in an output format independent way. The create the layout file
545 # that represents doxygen's defaults, run doxygen with the -l option.
546 # You can optionally specify a file name after the option, if omitted
547 # DoxygenLayout.xml will be used as the name of the layout file.
548
549 LAYOUT_FILE            =
550
551 #---------------------------------------------------------------------------
552 # configuration options related to warning and progress messages
553 #---------------------------------------------------------------------------
554
555 # The QUIET tag can be used to turn on/off the messages that are generated
556 # by doxygen. Possible values are YES and NO. If left blank NO is used.
557
558 QUIET                  = NO
559
560 # The WARNINGS tag can be used to turn on/off the warning messages that are
561 # generated by doxygen. Possible values are YES and NO. If left blank
562 # NO is used.
563
564 WARNINGS               = YES
565
566 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
567 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
568 # automatically be disabled.
569
570 WARN_IF_UNDOCUMENTED   = YES
571
572 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
573 # potential errors in the documentation, such as not documenting some
574 # parameters in a documented function, or documenting parameters that
575 # don't exist or using markup commands wrongly.
576
577 WARN_IF_DOC_ERROR      = YES
578
579 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
580 # functions that are documented, but have no documentation for their parameters
581 # or return value. If set to NO (the default) doxygen will only warn about
582 # wrong or incomplete parameter documentation, but not about the absence of
583 # documentation.
584
585 WARN_NO_PARAMDOC       = NO
586
587 # The WARN_FORMAT tag determines the format of the warning messages that
588 # doxygen can produce. The string should contain the $file, $line, and $text
589 # tags, which will be replaced by the file and line number from which the
590 # warning originated and the warning text. Optionally the format may contain
591 # $version, which will be replaced by the version of the file (if it could
592 # be obtained via FILE_VERSION_FILTER)
593
594 WARN_FORMAT            = "$file:$line: $text"
595
596 # The WARN_LOGFILE tag can be used to specify a file to which warning
597 # and error messages should be written. If left blank the output is written
598 # to stderr.
599
600 WARN_LOGFILE           =
601
602 #---------------------------------------------------------------------------
603 # configuration options related to the input files
604 #---------------------------------------------------------------------------
605
606 # The INPUT tag can be used to specify the files and/or directories that contain
607 # documented source files. You may enter file names like "myfile.cpp" or
608 # directories like "/usr/src/myproject". Separate the files or directories
609 # with spaces.
610
611 INPUT                  = include \
612                          docs
613
614 # This tag can be used to specify the character encoding of the source files
615 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
616 # also the default input encoding. Doxygen uses libiconv (or the iconv built
617 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
618 # the list of possible encodings.
619
620 INPUT_ENCODING         = UTF-8
621
622 # If the value of the INPUT tag contains directories, you can use the
623 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
624 # and *.h) to filter out the source-files in the directories. If left
625 # blank the following patterns are tested:
626 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
627 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
628 # *.f90 *.f *.for *.vhd *.vhdl
629
630 FILE_PATTERNS          = *.cpp \
631                          *.cc \
632                          *.c \
633                          *.h \
634                          *.hh \
635                          *.hpp \
636                          *.dox
637
638 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
639 # should be searched for input files as well. Possible values are YES and NO.
640 # If left blank NO is used.
641
642 RECURSIVE              = NO
643
644 # The EXCLUDE tag can be used to specify files and/or directories that should
645 # excluded from the INPUT source files. This way you can easily exclude a
646 # subdirectory from a directory tree whose root is specified with the INPUT tag.
647
648 EXCLUDE                =
649
650 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
651 # directories that are symbolic links (a Unix file system feature) are excluded
652 # from the input.
653
654 EXCLUDE_SYMLINKS       = NO
655
656 # If the value of the INPUT tag contains directories, you can use the
657 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
658 # certain files from those directories. Note that the wildcards are matched
659 # against the file with absolute path, so to exclude all test directories
660 # for example use the pattern */test/*
661
662 EXCLUDE_PATTERNS       = */.git/*
663
664 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
665 # (namespaces, classes, functions, etc.) that should be excluded from the
666 # output. The symbol name can be a fully qualified name, a word, or if the
667 # wildcard * is used, a substring. Examples: ANamespace, AClass,
668 # AClass::ANamespace, ANamespace::*Test
669
670 EXCLUDE_SYMBOLS        =
671
672 # The EXAMPLE_PATH tag can be used to specify one or more files or
673 # directories that contain example code fragments that are included (see
674 # the \include command).
675
676 EXAMPLE_PATH           =
677
678 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
679 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
680 # and *.h) to filter out the source-files in the directories. If left
681 # blank all files are included.
682
683 EXAMPLE_PATTERNS       =
684
685 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
686 # searched for input files to be used with the \include or \dontinclude
687 # commands irrespective of the value of the RECURSIVE tag.
688 # Possible values are YES and NO. If left blank NO is used.
689
690 EXAMPLE_RECURSIVE      = NO
691
692 # The IMAGE_PATH tag can be used to specify one or more files or
693 # directories that contain image that are included in the documentation (see
694 # the \image command).
695
696 IMAGE_PATH             =
697
698 # The INPUT_FILTER tag can be used to specify a program that doxygen should
699 # invoke to filter for each input file. Doxygen will invoke the filter program
700 # by executing (via popen()) the command <filter> <input-file>, where <filter>
701 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
702 # input file. Doxygen will then use the output that the filter program writes
703 # to standard output.
704 # If FILTER_PATTERNS is specified, this tag will be
705 # ignored.
706
707 INPUT_FILTER           =
708
709 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
710 # basis.
711 # Doxygen will compare the file name with each pattern and apply the
712 # filter if there is a match.
713 # The filters are a list of the form:
714 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
715 # info on how filters are used. If FILTER_PATTERNS is empty or if
716 # non of the patterns match the file name, INPUT_FILTER is applied.
717
718 FILTER_PATTERNS        =
719
720 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
721 # INPUT_FILTER) will be used to filter the input files when producing source
722 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
723
724 FILTER_SOURCE_FILES    = NO
725
726 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
727 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
728 # and it is also possible to disable source filtering for a specific pattern
729 # using *.ext= (so without naming a filter). This option only has effect when
730 # FILTER_SOURCE_FILES is enabled.
731
732 FILTER_SOURCE_PATTERNS =
733
734 #---------------------------------------------------------------------------
735 # configuration options related to source browsing
736 #---------------------------------------------------------------------------
737
738 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
739 # be generated. Documented entities will be cross-referenced with these sources.
740 # Note: To get rid of all source code in the generated output, make sure also
741 # VERBATIM_HEADERS is set to NO.
742
743 SOURCE_BROWSER         = NO
744
745 # Setting the INLINE_SOURCES tag to YES will include the body
746 # of functions and classes directly in the documentation.
747
748 INLINE_SOURCES         = NO
749
750 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
751 # doxygen to hide any special comment blocks from generated source code
752 # fragments. Normal C and C++ comments will always remain visible.
753
754 STRIP_CODE_COMMENTS    = YES
755
756 # If the REFERENCED_BY_RELATION tag is set to YES
757 # then for each documented function all documented
758 # functions referencing it will be listed.
759
760 REFERENCED_BY_RELATION = NO
761
762 # If the REFERENCES_RELATION tag is set to YES
763 # then for each documented function all documented entities
764 # called/used by that function will be listed.
765
766 REFERENCES_RELATION    = NO
767
768 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
769 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
770 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
771 # link to the source code.
772 # Otherwise they will link to the documentation.
773
774 REFERENCES_LINK_SOURCE = YES
775
776 # If the USE_HTAGS tag is set to YES then the references to source code
777 # will point to the HTML generated by the htags(1) tool instead of doxygen
778 # built-in source browser. The htags tool is part of GNU's global source
779 # tagging system (see http://www.gnu.org/software/global/global.html). You
780 # will need version 4.8.6 or higher.
781
782 USE_HTAGS              = NO
783
784 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
785 # will generate a verbatim copy of the header file for each class for
786 # which an include is specified. Set to NO to disable this.
787
788 VERBATIM_HEADERS       = YES
789
790 #---------------------------------------------------------------------------
791 # configuration options related to the alphabetical class index
792 #---------------------------------------------------------------------------
793
794 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
795 # of all compounds will be generated. Enable this if the project
796 # contains a lot of classes, structs, unions or interfaces.
797
798 ALPHABETICAL_INDEX     = NO
799
800 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
801 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
802 # in which this list will be split (can be a number in the range [1..20])
803
804 COLS_IN_ALPHA_INDEX    = 5
805
806 # In case all classes in a project start with a common prefix, all
807 # classes will be put under the same header in the alphabetical index.
808 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
809 # should be ignored while generating the index headers.
810
811 IGNORE_PREFIX          =
812
813 #---------------------------------------------------------------------------
814 # configuration options related to the HTML output
815 #---------------------------------------------------------------------------
816
817 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
818 # generate HTML output.
819
820 GENERATE_HTML          = YES
821
822 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
823 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
824 # put in front of it. If left blank `html' will be used as the default path.
825
826 HTML_OUTPUT            = html
827
828 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
829 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
830 # doxygen will generate files with .html extension.
831
832 HTML_FILE_EXTENSION    = .html
833
834 # The HTML_HEADER tag can be used to specify a personal HTML header for
835 # each generated HTML page. If it is left blank doxygen will generate a
836 # standard header.
837
838 HTML_HEADER            =
839
840 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
841 # each generated HTML page. If it is left blank doxygen will generate a
842 # standard footer.
843
844 HTML_FOOTER            =
845
846 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
847 # style sheet that is used by each HTML page. It can be used to
848 # fine-tune the look of the HTML output. If the tag is left blank doxygen
849 # will generate a default style sheet. Note that doxygen will try to copy
850 # the style sheet file to the HTML output directory, so don't put your own
851 # stylesheet in the HTML output directory as well, or it will be erased!
852
853 HTML_STYLESHEET        =
854
855 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
856 # Doxygen will adjust the colors in the stylesheet and background images
857 # according to this color. Hue is specified as an angle on a colorwheel,
858 # see http://en.wikipedia.org/wiki/Hue for more information.
859 # For instance the value 0 represents red, 60 is yellow, 120 is green,
860 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
861 # The allowed range is 0 to 359.
862
863 HTML_COLORSTYLE_HUE    = 220
864
865 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
866 # the colors in the HTML output. For a value of 0 the output will use
867 # grayscales only. A value of 255 will produce the most vivid colors.
868
869 HTML_COLORSTYLE_SAT    = 100
870
871 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
872 # the luminance component of the colors in the HTML output. Values below
873 # 100 gradually make the output lighter, whereas values above 100 make
874 # the output darker. The value divided by 100 is the actual gamma applied,
875 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
876 # and 100 does not change the gamma.
877
878 HTML_COLORSTYLE_GAMMA  = 80
879
880 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
881 # page will contain the date and time when the page was generated. Setting
882 # this to NO can help when comparing the output of multiple runs.
883
884 HTML_TIMESTAMP         = NO
885
886 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
887 # files or namespaces will be aligned in HTML using tables. If set to
888 # NO a bullet list will be used.
889
890 HTML_ALIGN_MEMBERS     = YES
891
892 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
893 # documentation will contain sections that can be hidden and shown after the
894 # page has loaded. For this to work a browser that supports
895 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
896 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
897
898 HTML_DYNAMIC_SECTIONS  = NO
899
900 # If the GENERATE_DOCSET tag is set to YES, additional index files
901 # will be generated that can be used as input for Apple's Xcode 3
902 # integrated development environment, introduced with OSX 10.5 (Leopard).
903 # To create a documentation set, doxygen will generate a Makefile in the
904 # HTML output directory. Running make will produce the docset in that
905 # directory and running "make install" will install the docset in
906 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
907 # it at startup.
908 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
909 # for more information.
910
911 GENERATE_DOCSET        = NO
912
913 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
914 # feed. A documentation feed provides an umbrella under which multiple
915 # documentation sets from a single provider (such as a company or product suite)
916 # can be grouped.
917
918 DOCSET_FEEDNAME        = "Doxygen generated docs"
919
920 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
921 # should uniquely identify the documentation set bundle. This should be a
922 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
923 # will append .docset to the name.
924
925 DOCSET_BUNDLE_ID       = org.doxygen.Project
926
927 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
928 # the documentation publisher. This should be a reverse domain-name style
929 # string, e.g. com.mycompany.MyDocSet.documentation.
930
931 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
932
933 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
934
935 DOCSET_PUBLISHER_NAME  = Publisher
936
937 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
938 # will be generated that can be used as input for tools like the
939 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
940 # of the generated HTML documentation.
941
942 GENERATE_HTMLHELP      = NO
943
944 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
945 # be used to specify the file name of the resulting .chm file. You
946 # can add a path in front of the file if the result should not be
947 # written to the html output directory.
948
949 CHM_FILE               =
950
951 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
952 # be used to specify the location (absolute path including file name) of
953 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
954 # the HTML help compiler on the generated index.hhp.
955
956 HHC_LOCATION           =
957
958 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
959 # controls if a separate .chi index file is generated (YES) or that
960 # it should be included in the master .chm file (NO).
961
962 GENERATE_CHI           = NO
963
964 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
965 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
966 # content.
967
968 CHM_INDEX_ENCODING     =
969
970 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
971 # controls whether a binary table of contents is generated (YES) or a
972 # normal table of contents (NO) in the .chm file.
973
974 BINARY_TOC             = NO
975
976 # The TOC_EXPAND flag can be set to YES to add extra items for group members
977 # to the contents of the HTML help documentation and to the tree view.
978
979 TOC_EXPAND             = NO
980
981 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
982 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
983 # that can be used as input for Qt's qhelpgenerator to generate a
984 # Qt Compressed Help (.qch) of the generated HTML documentation.
985
986 GENERATE_QHP           = NO
987
988 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
989 # be used to specify the file name of the resulting .qch file.
990 # The path specified is relative to the HTML output folder.
991
992 QCH_FILE               =
993
994 # The QHP_NAMESPACE tag specifies the namespace to use when generating
995 # Qt Help Project output. For more information please see
996 # http://doc.trolltech.com/qthelpproject.html#namespace
997
998 QHP_NAMESPACE          =
999
1000 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1001 # Qt Help Project output. For more information please see
1002 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1003
1004 QHP_VIRTUAL_FOLDER     = doc
1005
1006 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1007 # add. For more information please see
1008 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1009
1010 QHP_CUST_FILTER_NAME   =
1011
1012 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1013 # custom filter to add. For more information please see
1014 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1015 # Qt Help Project / Custom Filters</a>.
1016
1017 QHP_CUST_FILTER_ATTRS  =
1018
1019 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1020 # project's
1021 # filter section matches.
1022 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1023 # Qt Help Project / Filter Attributes</a>.
1024
1025 QHP_SECT_FILTER_ATTRS  =
1026
1027 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1028 # be used to specify the location of Qt's qhelpgenerator.
1029 # If non-empty doxygen will try to run qhelpgenerator on the generated
1030 # .qhp file.
1031
1032 QHG_LOCATION           =
1033
1034 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1035 #  will be generated, which together with the HTML files, form an Eclipse help
1036 # plugin. To install this plugin and make it available under the help contents
1037 # menu in Eclipse, the contents of the directory containing the HTML and XML
1038 # files needs to be copied into the plugins directory of eclipse. The name of
1039 # the directory within the plugins directory should be the same as
1040 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1041 # the help appears.
1042
1043 GENERATE_ECLIPSEHELP   = NO
1044
1045 # A unique identifier for the eclipse help plugin. When installing the plugin
1046 # the directory name containing the HTML and XML files should also have
1047 # this name.
1048
1049 ECLIPSE_DOC_ID         = org.doxygen.Project
1050
1051 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1052 # top of each HTML page. The value NO (the default) enables the index and
1053 # the value YES disables it.
1054
1055 DISABLE_INDEX          = NO
1056
1057 # This tag can be used to set the number of enum values (range [0,1..20])
1058 # that doxygen will group on one line in the generated HTML documentation.
1059 # Note that a value of 0 will completely suppress the enum values from appearing in the overview section.
1060
1061 ENUM_VALUES_PER_LINE   = 4
1062
1063 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1064 # structure should be generated to display hierarchical information.
1065 # If the tag value is set to YES, a side panel will be generated
1066 # containing a tree-like index structure (just like the one that
1067 # is generated for HTML Help). For this to work a browser that supports
1068 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1069 # Windows users are probably better off using the HTML help feature.
1070
1071 GENERATE_TREEVIEW      = NONE
1072
1073 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1074 # and Class Hierarchy pages using a tree view instead of an ordered list.
1075
1076 USE_INLINE_TREES       = NO
1077
1078 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1079 # used to set the initial width (in pixels) of the frame in which the tree
1080 # is shown.
1081
1082 TREEVIEW_WIDTH         = 250
1083
1084 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1085 # links to external symbols imported via tag files in a separate window.
1086
1087 EXT_LINKS_IN_WINDOW    = NO
1088
1089 # Use this tag to change the font size of Latex formulas included
1090 # as images in the HTML documentation. The default is 10. Note that
1091 # when you change the font size after a successful doxygen run you need
1092 # to manually remove any form_*.png images from the HTML output directory
1093 # to force them to be regenerated.
1094
1095 FORMULA_FONTSIZE       = 10
1096
1097 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1098 # generated for formulas are transparent PNGs. Transparent PNGs are
1099 # not supported properly for IE 6.0, but are supported on all modern browsers.
1100 # Note that when changing this option you need to delete any form_*.png files
1101 # in the HTML output before the changes have effect.
1102
1103 FORMULA_TRANSPARENT    = YES
1104
1105 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1106 # (see http://www.mathjax.org) which uses client side Javascript for the
1107 # rendering instead of using prerendered bitmaps. Use this if you do not
1108 # have LaTeX installed or if you want to formulas look prettier in the HTML
1109 # output. When enabled you also need to install MathJax separately and
1110 # configure the path to it using the MATHJAX_RELPATH option.
1111
1112 USE_MATHJAX            = NO
1113
1114 # When MathJax is enabled you need to specify the location relative to the
1115 # HTML output directory using the MATHJAX_RELPATH option. The destination
1116 # directory should contain the MathJax.js script. For instance, if the mathjax
1117 # directory is located at the same level as the HTML output directory, then
1118 # MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing
1119 # MathJax, but it is strongly recommended to install a local copy of MathJax
1120 # before deployment.
1121
1122 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1123
1124 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1125 # for the HTML output. The underlying search engine uses javascript
1126 # and DHTML and should work on any modern browser. Note that when using
1127 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1128 # (GENERATE_DOCSET) there is already a search function so this one should
1129 # typically be disabled. For large projects the javascript based search engine
1130 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1131
1132 SEARCHENGINE           = NO
1133
1134 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1135 # implemented using a PHP enabled web server instead of at the web client
1136 # using Javascript. Doxygen will generate the search PHP script and index
1137 # file to put on the web server. The advantage of the server
1138 # based approach is that it scales better to large projects and allows
1139 # full text search. The disadvantages are that it is more difficult to setup
1140 # and does not have live searching capabilities.
1141
1142 SERVER_BASED_SEARCH    = NO
1143
1144 #---------------------------------------------------------------------------
1145 # configuration options related to the LaTeX output
1146 #---------------------------------------------------------------------------
1147
1148 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1149 # generate Latex output.
1150
1151 GENERATE_LATEX         = YES
1152
1153 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1154 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1155 # put in front of it. If left blank `latex' will be used as the default path.
1156
1157 LATEX_OUTPUT           = latex
1158
1159 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1160 # invoked. If left blank `latex' will be used as the default command name.
1161 # Note that when enabling USE_PDFLATEX this option is only used for
1162 # generating bitmaps for formulas in the HTML output, but not in the
1163 # Makefile that is written to the output directory.
1164
1165 LATEX_CMD_NAME         = latex
1166
1167 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1168 # generate index for LaTeX. If left blank `makeindex' will be used as the
1169 # default command name.
1170
1171 MAKEINDEX_CMD_NAME     = makeindex
1172
1173 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1174 # LaTeX documents. This may be useful for small projects and may help to
1175 # save some trees in general.
1176
1177 COMPACT_LATEX          = NO
1178
1179 # The PAPER_TYPE tag can be used to set the paper type that is used
1180 # by the printer. Possible values are: a4, letter, legal and
1181 # executive. If left blank a4wide will be used.
1182
1183 PAPER_TYPE             = a4wide
1184
1185 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1186 # packages that should be included in the LaTeX output.
1187
1188 EXTRA_PACKAGES         =
1189
1190 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1191 # the generated latex document. The header should contain everything until
1192 # the first chapter. If it is left blank doxygen will generate a
1193 # standard header. Notice: only use this tag if you know what you are doing!
1194
1195 LATEX_HEADER           =
1196
1197 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1198 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1199 # contain links (just like the HTML output) instead of page references
1200 # This makes the output suitable for online browsing using a pdf viewer.
1201
1202 PDF_HYPERLINKS         = YES
1203
1204 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1205 # plain latex in the generated Makefile. Set this option to YES to get a
1206 # higher quality PDF documentation.
1207
1208 USE_PDFLATEX           = YES
1209
1210 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1211 # command to the generated LaTeX files. This will instruct LaTeX to keep
1212 # running if errors occur, instead of asking the user for help.
1213 # This option is also used when generating formulas in HTML.
1214
1215 LATEX_BATCHMODE        = NO
1216
1217 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1218 # include the index chapters (such as File Index, Compound Index, etc.)
1219 # in the output.
1220
1221 LATEX_HIDE_INDICES     = NO
1222
1223 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1224 # source code with syntax highlighting in the LaTeX output.
1225 # Note that which sources are shown also depends on other settings
1226 # such as SOURCE_BROWSER.
1227
1228 LATEX_SOURCE_CODE      = NO
1229
1230 #---------------------------------------------------------------------------
1231 # configuration options related to the RTF output
1232 #---------------------------------------------------------------------------
1233
1234 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1235 # The RTF output is optimized for Word 97 and may not look very pretty with
1236 # other RTF readers or editors.
1237
1238 GENERATE_RTF           = NO
1239
1240 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1241 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1242 # put in front of it. If left blank `rtf' will be used as the default path.
1243
1244 RTF_OUTPUT             = rtf
1245
1246 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1247 # RTF documents. This may be useful for small projects and may help to
1248 # save some trees in general.
1249
1250 COMPACT_RTF            = NO
1251
1252 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1253 # will contain hyperlink fields. The RTF file will
1254 # contain links (just like the HTML output) instead of page references.
1255 # This makes the output suitable for online browsing using WORD or other
1256 # programs which support those fields.
1257 # Note: wordpad (write) and others do not support links.
1258
1259 RTF_HYPERLINKS         = NO
1260
1261 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1262 # config file, i.e. a series of assignments. You only have to provide
1263 # replacements, missing definitions are set to their default value.
1264
1265 RTF_STYLESHEET_FILE    =
1266
1267 # Set optional variables used in the generation of an rtf document.
1268 # Syntax is similar to doxygen's config file.
1269
1270 RTF_EXTENSIONS_FILE    =
1271
1272 #---------------------------------------------------------------------------
1273 # configuration options related to the man page output
1274 #---------------------------------------------------------------------------
1275
1276 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1277 # generate man pages
1278
1279 GENERATE_MAN           = YES
1280
1281 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1282 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1283 # put in front of it. If left blank `man' will be used as the default path.
1284
1285 MAN_OUTPUT             = man
1286
1287 # The MAN_EXTENSION tag determines the extension that is added to
1288 # the generated man pages (default is the subroutine's section .3)
1289
1290 MAN_EXTENSION          = .3
1291
1292 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1293 # then it will generate one additional man file for each entity
1294 # documented in the real man page(s). These additional files
1295 # only source the real man page, but without them the man command
1296 # would be unable to find the correct page. The default is NO.
1297
1298 MAN_LINKS              = NO
1299
1300 #---------------------------------------------------------------------------
1301 # configuration options related to the XML output
1302 #---------------------------------------------------------------------------
1303
1304 # If the GENERATE_XML tag is set to YES Doxygen will
1305 # generate an XML file that captures the structure of
1306 # the code including all documentation.
1307
1308 GENERATE_XML           = NO
1309
1310 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1311 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1312 # put in front of it. If left blank `xml' will be used as the default path.
1313
1314 XML_OUTPUT             = xml
1315
1316 # The XML_SCHEMA tag can be used to specify an XML schema,
1317 # which can be used by a validating XML parser to check the
1318 # syntax of the XML files.
1319
1320 XML_SCHEMA             =
1321
1322 # The XML_DTD tag can be used to specify an XML DTD,
1323 # which can be used by a validating XML parser to check the
1324 # syntax of the XML files.
1325
1326 XML_DTD                =
1327
1328 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1329 # dump the program listings (including syntax highlighting
1330 # and cross-referencing information) to the XML output. Note that
1331 # enabling this will significantly increase the size of the XML output.
1332
1333 XML_PROGRAMLISTING     = YES
1334
1335 #---------------------------------------------------------------------------
1336 # configuration options for the AutoGen Definitions output
1337 #---------------------------------------------------------------------------
1338
1339 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1340 # generate an AutoGen Definitions (see autogen.sf.net) file
1341 # that captures the structure of the code including all
1342 # documentation. Note that this feature is still experimental
1343 # and incomplete at the moment.
1344
1345 GENERATE_AUTOGEN_DEF   = NO
1346
1347 #---------------------------------------------------------------------------
1348 # configuration options related to the Perl module output
1349 #---------------------------------------------------------------------------
1350
1351 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1352 # generate a Perl module file that captures the structure of
1353 # the code including all documentation. Note that this
1354 # feature is still experimental and incomplete at the
1355 # moment.
1356
1357 GENERATE_PERLMOD       = NO
1358
1359 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1360 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1361 # to generate PDF and DVI output from the Perl module output.
1362
1363 PERLMOD_LATEX          = NO
1364
1365 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1366 # nicely formatted so it can be parsed by a human reader.
1367 # This is useful
1368 # if you want to understand what is going on.
1369 # On the other hand, if this
1370 # tag is set to NO the size of the Perl module output will be much smaller
1371 # and Perl will parse it just the same.
1372
1373 PERLMOD_PRETTY         = YES
1374
1375 # The names of the make variables in the generated doxyrules.make file
1376 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1377 # This is useful so different doxyrules.make files included by the same
1378 # Makefile don't overwrite each other's variables.
1379
1380 PERLMOD_MAKEVAR_PREFIX =
1381
1382 #---------------------------------------------------------------------------
1383 # Configuration options related to the preprocessor
1384 #---------------------------------------------------------------------------
1385
1386 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1387 # evaluate all C-preprocessor directives found in the sources and include
1388 # files.
1389
1390 ENABLE_PREPROCESSING   = YES
1391
1392 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1393 # names in the source code. If set to NO (the default) only conditional
1394 # compilation will be performed. Macro expansion can be done in a controlled
1395 # way by setting EXPAND_ONLY_PREDEF to YES.
1396
1397 MACRO_EXPANSION        = YES
1398
1399 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1400 # then the macro expansion is limited to the macros specified with the
1401 # PREDEFINED and EXPAND_AS_DEFINED tags.
1402
1403 EXPAND_ONLY_PREDEF     = YES
1404
1405 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1406 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1407
1408 SEARCH_INCLUDES        = YES
1409
1410 # The INCLUDE_PATH tag can be used to specify one or more directories that
1411 # contain include files that are not input files but should be processed by
1412 # the preprocessor.
1413
1414 INCLUDE_PATH           =
1415
1416 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1417 # patterns (like *.h and *.hpp) to filter out the header-files in the
1418 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1419 # be used.
1420
1421 INCLUDE_FILE_PATTERNS  =
1422
1423 # The PREDEFINED tag can be used to specify one or more macro names that
1424 # are defined before the preprocessor is started (similar to the -D option of
1425 # gcc). The argument of the tag is a list of macros of the form: name
1426 # or name=definition (no spaces). If the definition and the = are
1427 # omitted =1 is assumed. To prevent a macro definition from being
1428 # undefined via #undef or recursively expanded use the := operator
1429 # instead of the = operator.
1430
1431 PREDEFINED             = DOXYGEN \
1432                          PRINTF_ATTRIBUTE(x,y)=
1433
1434 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1435 # this tag can be used to specify a list of macro names that should be expanded.
1436 # The macro definition that is found in the sources will be used.
1437 # Use the PREDEFINED tag if you want to use a different macro definition that overrules the definition found in the source code.
1438
1439 EXPAND_AS_DEFINED      =
1440
1441 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1442 # doxygen's preprocessor will remove all references to function-like macros
1443 # that are alone on a line, have an all uppercase name, and do not end with a
1444 # semicolon, because these will confuse the parser if not removed.
1445
1446 SKIP_FUNCTION_MACROS   = YES
1447
1448 #---------------------------------------------------------------------------
1449 # Configuration::additions related to external references
1450 #---------------------------------------------------------------------------
1451
1452 # The TAGFILES option can be used to specify one or more tagfiles.
1453 # Optionally an initial location of the external documentation
1454 # can be added for each tagfile. The format of a tag file without
1455 # this location is as follows:
1456 #
1457 # TAGFILES = file1 file2 ...
1458 # Adding location for the tag files is done as follows:
1459 #
1460 # TAGFILES = file1=loc1 "file2 = loc2" ...
1461 # where "loc1" and "loc2" can be relative or absolute paths or
1462 # URLs. If a location is present for each tag, the installdox tool
1463 # does not have to be run to correct the links.
1464 # Note that each tag file must have a unique name
1465 # (where the name does NOT include the path)
1466 # If a tag file is not located in the directory in which doxygen
1467 # is run, you must also specify the path to the tagfile here.
1468
1469 TAGFILES               =
1470
1471 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1472 # a tag file that is based on the input files it reads.
1473
1474 GENERATE_TAGFILE       =
1475
1476 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1477 # in the class index. If set to NO only the inherited external classes
1478 # will be listed.
1479
1480 ALLEXTERNALS           = NO
1481
1482 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1483 # in the modules index. If set to NO, only the current project's groups will
1484 # be listed.
1485
1486 EXTERNAL_GROUPS        = YES
1487
1488 # The PERL_PATH should be the absolute path and name of the perl script
1489 # interpreter (i.e. the result of `which perl').
1490
1491 PERL_PATH              = /usr/bin/perl
1492
1493 #---------------------------------------------------------------------------
1494 # Configuration options related to the dot tool
1495 #---------------------------------------------------------------------------
1496
1497 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1498 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1499 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1500 # this option also works with HAVE_DOT disabled, but it is recommended to
1501 # install and use dot, since it yields more powerful graphs.
1502
1503 CLASS_DIAGRAMS         = YES
1504
1505 # You can define message sequence charts within doxygen comments using the \msc
1506 # command. Doxygen will then run the mscgen tool (see
1507 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1508 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1509 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1510 # default search path.
1511
1512 MSCGEN_PATH            =
1513
1514 # If set to YES, the inheritance and collaboration graphs will hide
1515 # inheritance and usage relations if the target is undocumented
1516 # or is not a class.
1517
1518 HIDE_UNDOC_RELATIONS   = YES
1519
1520 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1521 # available from the path. This tool is part of Graphviz, a graph visualization
1522 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1523 # have no effect if this option is set to NO (the default)
1524
1525 HAVE_DOT               = NO
1526
1527 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1528 # allowed to run in parallel. When set to 0 (the default) doxygen will
1529 # base this on the number of processors available in the system. You can set it
1530 # explicitly to a value larger than 0 to get control over the balance
1531 # between CPU load and processing speed.
1532
1533 DOT_NUM_THREADS        = 0
1534
1535 # By default doxygen will write a font called Helvetica to the output
1536 # directory and reference it in all dot files that doxygen generates.
1537 # When you want a differently looking font you can specify the font name
1538 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
1539 # which can be done by putting it in a standard location or by setting the
1540 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1541 # containing the font.
1542
1543 DOT_FONTNAME           = FreeSans
1544
1545 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1546 # The default size is 10pt.
1547
1548 DOT_FONTSIZE           = 10
1549
1550 # By default doxygen will tell dot to use the output directory to look for the
1551 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1552 # different font using DOT_FONTNAME you can set the path where dot
1553 # can find it using this tag.
1554
1555 DOT_FONTPATH           =
1556
1557 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1558 # will generate a graph for each documented class showing the direct and
1559 # indirect inheritance relations. Setting this tag to YES will force the
1560 # the CLASS_DIAGRAMS tag to NO.
1561
1562 CLASS_GRAPH            = YES
1563
1564 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1565 # will generate a graph for each documented class showing the direct and
1566 # indirect implementation dependencies (inheritance, containment, and
1567 # class references variables) of the class with other documented classes.
1568
1569 COLLABORATION_GRAPH    = YES
1570
1571 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1572 # will generate a graph for groups, showing the direct groups dependencies
1573
1574 GROUP_GRAPHS           = YES
1575
1576 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1577 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1578 # Language.
1579
1580 UML_LOOK               = NO
1581
1582 # If set to YES, the inheritance and collaboration graphs will show the
1583 # relations between templates and their instances.
1584
1585 TEMPLATE_RELATIONS     = NO
1586
1587 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1588 # tags are set to YES then doxygen will generate a graph for each documented
1589 # file showing the direct and indirect include dependencies of the file with
1590 # other documented files.
1591
1592 INCLUDE_GRAPH          = YES
1593
1594 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1595 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1596 # documented header file showing the documented files that directly or
1597 # indirectly include this file.
1598
1599 INCLUDED_BY_GRAPH      = YES
1600
1601 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1602 # doxygen will generate a call dependency graph for every global function
1603 # or class method. Note that enabling this option will significantly increase
1604 # the time of a run. So in most cases it will be better to enable call graphs
1605 # for selected functions only using the \callgraph command.
1606
1607 CALL_GRAPH             = NO
1608
1609 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1610 # doxygen will generate a caller dependency graph for every global function
1611 # or class method. Note that enabling this option will significantly increase
1612 # the time of a run. So in most cases it will be better to enable caller
1613 # graphs for selected functions only using the \callergraph command.
1614
1615 CALLER_GRAPH           = NO
1616
1617 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1618 # will generate a graphical hierarchy of all classes instead of a textual one.
1619
1620 GRAPHICAL_HIERARCHY    = YES
1621
1622 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1623 # then doxygen will show the dependencies a directory has on other directories
1624 # in a graphical way. The dependency relations are determined by the #include
1625 # relations between the files in the directories.
1626
1627 DIRECTORY_GRAPH        = YES
1628
1629 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1630 # generated by dot. Possible values are png, svg, gif or svg.
1631 # If left blank png will be used.
1632
1633 DOT_IMAGE_FORMAT       = png
1634
1635 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1636 # found. If left blank, it is assumed the dot tool can be found in the path.
1637
1638 DOT_PATH               =
1639
1640 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1641 # contain dot files that are included in the documentation (see the
1642 # \dotfile command).
1643
1644 DOTFILE_DIRS           =
1645
1646 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1647 # contain msc files that are included in the documentation (see the
1648 # \mscfile command).
1649
1650 MSCFILE_DIRS           =
1651
1652 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1653 # nodes that will be shown in the graph. If the number of nodes in a graph
1654 # becomes larger than this value, doxygen will truncate the graph, which is
1655 # visualized by representing a node as a red box. Note that doxygen if the
1656 # number of direct children of the root node in a graph is already larger than
1657 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1658 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1659
1660 DOT_GRAPH_MAX_NODES    = 50
1661
1662 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1663 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1664 # from the root by following a path via at most 3 edges will be shown. Nodes
1665 # that lay further from the root node will be omitted. Note that setting this
1666 # option to 1 or 2 may greatly reduce the computation time needed for large
1667 # code bases. Also note that the size of a graph can be further restricted by
1668 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1669
1670 MAX_DOT_GRAPH_DEPTH    = 0
1671
1672 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1673 # background. This is disabled by default, because dot on Windows does not
1674 # seem to support this out of the box. Warning: Depending on the platform used,
1675 # enabling this option may lead to badly anti-aliased labels on the edges of
1676 # a graph (i.e. they become hard to read).
1677
1678 DOT_TRANSPARENT        = YES
1679
1680 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1681 # files in one run (i.e. multiple -o and -T options on the command line). This
1682 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1683 # support this, this feature is disabled by default.
1684
1685 DOT_MULTI_TARGETS      = NO
1686
1687 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1688 # generate a legend page explaining the meaning of the various boxes and
1689 # arrows in the dot generated graphs.
1690
1691 GENERATE_LEGEND        = YES
1692
1693 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1694 # remove the intermediate dot files that are used to generate
1695 # the various graphs.
1696
1697 DOT_CLEANUP            = YES