Debian Codegraph @

docs/dime.doxygen.in

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