Debian Codegraph @

exodus/Doxyfile

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