1 # Doxyfile 1.6.1
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
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.
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME = "EDMA3 Resource Manager"
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.
34 PROJECT_NUMBER = 02.11.01
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.
41 OUTPUT_DIRECTORY = .
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.
50 CREATE_SUBDIRS = NO
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, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63 OUTPUT_LANGUAGE = English
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.
70 BRIEF_MEMBER_DESC = YES
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.
77 REPEAT_BRIEF = YES
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"
89 ABBREVIATE_BRIEF =
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.
95 ALWAYS_DETAILED_SEC = NO
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.
102 INLINE_INHERITED_MEMB = NO
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.
108 FULL_PATH_NAMES = NO
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.
117 STRIP_FROM_PATH =
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.
126 STRIP_FROM_INC_PATH =
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.
132 SHORT_NAMES = NO
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.)
140 JAVADOC_AUTOBRIEF = NO
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.)
148 QT_AUTOBRIEF = NO
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.
156 MULTILINE_CPP_IS_BRIEF = NO
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.
162 INHERIT_DOCS = YES
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.
168 SEPARATE_MEMBER_PAGES = NO
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.
173 TAB_SIZE = 8
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.
182 ALIASES =
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.
189 OPTIMIZE_OUTPUT_FOR_C = YES
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.
196 OPTIMIZE_OUTPUT_JAVA = NO
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.
202 OPTIMIZE_FOR_FORTRAN = NO
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.
208 OPTIMIZE_OUTPUT_VHDL = NO
210 # Doxygen selects the parser to use depending on the extension of the files it parses.
211 # With this tag you can assign which parser to use for a given extension.
212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
213 # The format is ext=language, where ext is a file extension, and language is one of
214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set
218 # FILE_PATTERNS otherwise the files are not read by doxygen.
220 EXTENSION_MAPPING =
222 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223 # to include (a tag file for) the STL sources as input, then you should
224 # set this tag to YES in order to let doxygen match functions declarations and
225 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226 # func(std::string) {}). This also make the inheritance and collaboration
227 # diagrams that involve STL classes more complete and accurate.
229 BUILTIN_STL_SUPPORT = NO
231 # If you use Microsoft's C++/CLI language, you should set this option to YES to
232 # enable parsing support.
234 CPP_CLI_SUPPORT = NO
236 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237 # Doxygen will parse them like normal C++ but will assume all classes use public
238 # instead of private inheritance when no explicit protection keyword is present.
240 SIP_SUPPORT = NO
242 # For Microsoft's IDL there are propget and propput attributes to indicate getter
243 # and setter methods for a property. Setting this option to YES (the default)
244 # will make doxygen to replace the get and set methods by a property in the
245 # documentation. This will only work if the methods are indeed getting or
246 # setting a simple type. If this is not the case, or you want to show the
247 # methods anyway, you should set this option to NO.
249 IDL_PROPERTY_SUPPORT = YES
251 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
252 # tag is set to YES, then doxygen will reuse the documentation of the first
253 # member in the group (if any) for the other members of the group. By default
254 # all members of a group must be documented explicitly.
256 DISTRIBUTE_GROUP_DOC = NO
258 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259 # the same type (for instance a group of public functions) to be put as a
260 # subgroup of that type (e.g. under the Public Functions section). Set it to
261 # NO to prevent subgrouping. Alternatively, this can be done per class using
262 # the \nosubgrouping command.
264 SUBGROUPING = YES
266 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267 # is documented as struct, union, or enum with the name of the typedef. So
268 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
269 # with name TypeT. When disabled the typedef will appear as a member of a file,
270 # namespace, or class. And the struct will be named TypeS. This can typically
271 # be useful for C code in case the coding convention dictates that all compound
272 # types are typedef'ed and only the typedef is referenced, never the tag name.
274 TYPEDEF_HIDES_STRUCT = NO
276 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277 # determine which symbols to keep in memory and which to flush to disk.
278 # When the cache is full, less often used symbols will be written to disk.
279 # For small to medium size projects (<1000 input files) the default value is
280 # probably good enough. For larger projects a too small cache size can cause
281 # doxygen to be busy swapping symbols to and from disk most of the time
282 # causing a significant performance penality.
283 # If the system has enough physical memory increasing the cache will improve the
284 # performance by keeping more symbols in memory. Note that the value works on
285 # a logarithmic scale so increasing the size by one will rougly double the
286 # memory usage. The cache size is given by this formula:
287 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288 # corresponding to a cache size of 2^16 = 65536 symbols
290 SYMBOL_CACHE_SIZE = 0
292 #---------------------------------------------------------------------------
293 # Build related configuration options
294 #---------------------------------------------------------------------------
296 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297 # documentation are documented, even if no documentation was available.
298 # Private class members and static file members will be hidden unless
299 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
301 EXTRACT_ALL = NO
303 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
304 # will be included in the documentation.
306 EXTRACT_PRIVATE = NO
308 # If the EXTRACT_STATIC tag is set to YES all static members of a file
309 # will be included in the documentation.
311 EXTRACT_STATIC = YES
313 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314 # defined locally in source files will be included in the documentation.
315 # If set to NO only classes defined in header files are included.
317 EXTRACT_LOCAL_CLASSES = YES
319 # This flag is only useful for Objective-C code. When set to YES local
320 # methods, which are defined in the implementation section but not in
321 # the interface are included in the documentation.
322 # If set to NO (the default) only methods in the interface are included.
324 EXTRACT_LOCAL_METHODS = NO
326 # If this flag is set to YES, the members of anonymous namespaces will be
327 # extracted and appear in the documentation as a namespace called
328 # 'anonymous_namespace{file}', where file will be replaced with the base
329 # name of the file that contains the anonymous namespace. By default
330 # anonymous namespace are hidden.
332 EXTRACT_ANON_NSPACES = NO
334 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335 # undocumented members of documented classes, files or namespaces.
336 # If set to NO (the default) these members will be included in the
337 # various overviews, but no documentation section is generated.
338 # This option has no effect if EXTRACT_ALL is enabled.
340 HIDE_UNDOC_MEMBERS = YES
342 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343 # undocumented classes that are normally visible in the class hierarchy.
344 # If set to NO (the default) these classes will be included in the various
345 # overviews. This option has no effect if EXTRACT_ALL is enabled.
347 HIDE_UNDOC_CLASSES = YES
349 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350 # friend (class|struct|union) declarations.
351 # If set to NO (the default) these declarations will be included in the
352 # documentation.
354 HIDE_FRIEND_COMPOUNDS = NO
356 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357 # documentation blocks found inside the body of a function.
358 # If set to NO (the default) these blocks will be appended to the
359 # function's detailed documentation block.
361 HIDE_IN_BODY_DOCS = YES
363 # The INTERNAL_DOCS tag determines if documentation
364 # that is typed after a \internal command is included. If the tag is set
365 # to NO (the default) then the documentation will be excluded.
366 # Set it to YES to include the internal documentation.
368 INTERNAL_DOCS = NO
370 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
371 # file names in lower-case letters. If set to YES upper-case letters are also
372 # allowed. This is useful if you have classes or files whose names only differ
373 # in case and if your file system supports case sensitive file names. Windows
374 # and Mac users are advised to set this option to NO.
376 CASE_SENSE_NAMES = NO
378 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379 # will show members with their full class and namespace scopes in the
380 # documentation. If set to YES the scope will be hidden.
382 HIDE_SCOPE_NAMES = NO
384 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
385 # will put a list of the files that are included by a file in the documentation
386 # of that file.
388 SHOW_INCLUDE_FILES = YES
390 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
391 # is inserted in the documentation for inline members.
393 INLINE_INFO = YES
395 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
396 # will sort the (detailed) documentation of file and class members
397 # alphabetically by member name. If set to NO the members will appear in
398 # declaration order.
400 SORT_MEMBER_DOCS = NO
402 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
403 # brief documentation of file, namespace and class members alphabetically
404 # by member name. If set to NO (the default) the members will appear in
405 # declaration order.
407 SORT_BRIEF_DOCS = NO
409 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
410 # will sort the (brief and detailed) documentation of class members so that
411 # constructors and destructors are listed first. If set to NO (the default)
412 # the constructors will appear in the respective orders defined by
413 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
414 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
415 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
417 SORT_MEMBERS_CTORS_1ST = NO
419 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
420 # hierarchy of group names into alphabetical order. If set to NO (the default)
421 # the group names will appear in their defined order.
423 SORT_GROUP_NAMES = NO
425 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
426 # sorted by fully-qualified names, including namespaces. If set to
427 # NO (the default), the class list will be sorted only by class name,
428 # not including the namespace part.
429 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
430 # Note: This option applies only to the class list, not to the
431 # alphabetical list.
433 SORT_BY_SCOPE_NAME = NO
435 # The GENERATE_TODOLIST tag can be used to enable (YES) or
436 # disable (NO) the todo list. This list is created by putting \todo
437 # commands in the documentation.
439 GENERATE_TODOLIST = YES
441 # The GENERATE_TESTLIST tag can be used to enable (YES) or
442 # disable (NO) the test list. This list is created by putting \test
443 # commands in the documentation.
445 GENERATE_TESTLIST = YES
447 # The GENERATE_BUGLIST tag can be used to enable (YES) or
448 # disable (NO) the bug list. This list is created by putting \bug
449 # commands in the documentation.
451 GENERATE_BUGLIST = YES
453 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
454 # disable (NO) the deprecated list. This list is created by putting
455 # \deprecated commands in the documentation.
457 GENERATE_DEPRECATEDLIST= YES
459 # The ENABLED_SECTIONS tag can be used to enable conditional
460 # documentation sections, marked by \if sectionname ... \endif.
462 ENABLED_SECTIONS =
464 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
465 # the initial value of a variable or define consists of for it to appear in
466 # the documentation. If the initializer consists of more lines than specified
467 # here it will be hidden. Use a value of 0 to hide initializers completely.
468 # The appearance of the initializer of individual variables and defines in the
469 # documentation can be controlled using \showinitializer or \hideinitializer
470 # command in the documentation regardless of this setting.
472 MAX_INITIALIZER_LINES = 30
474 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
475 # at the bottom of the documentation of classes and structs. If set to YES the
476 # list will mention the files that were used to generate the documentation.
478 SHOW_USED_FILES = YES
480 # If the sources in your project are distributed over multiple directories
481 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
482 # in the documentation. The default is NO.
484 SHOW_DIRECTORIES = NO
486 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
487 # This will remove the Files entry from the Quick Index and from the
488 # Folder Tree View (if specified). The default is YES.
490 SHOW_FILES = YES
492 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
493 # Namespaces page. This will remove the Namespaces entry from the Quick Index
494 # and from the Folder Tree View (if specified). The default is YES.
496 SHOW_NAMESPACES = YES
498 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
499 # doxygen should invoke to get the current version for each file (typically from
500 # the version control system). Doxygen will invoke the program by executing (via
501 # popen()) the command <command> <input-file>, where <command> is the value of
502 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
503 # provided by doxygen. Whatever the program writes to standard output
504 # is used as the file version. See the manual for examples.
506 FILE_VERSION_FILTER =
508 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
509 # doxygen. The layout file controls the global structure of the generated output files
510 # in an output format independent way. The create the layout file that represents
511 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
512 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
513 # of the layout file.
515 LAYOUT_FILE =
517 #---------------------------------------------------------------------------
518 # configuration options related to warning and progress messages
519 #---------------------------------------------------------------------------
521 # The QUIET tag can be used to turn on/off the messages that are generated
522 # by doxygen. Possible values are YES and NO. If left blank NO is used.
524 QUIET = NO
526 # The WARNINGS tag can be used to turn on/off the warning messages that are
527 # generated by doxygen. Possible values are YES and NO. If left blank
528 # NO is used.
530 WARNINGS = YES
532 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
533 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
534 # automatically be disabled.
536 WARN_IF_UNDOCUMENTED = YES
538 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
539 # potential errors in the documentation, such as not documenting some
540 # parameters in a documented function, or documenting parameters that
541 # don't exist or using markup commands wrongly.
543 WARN_IF_DOC_ERROR = YES
545 # This WARN_NO_PARAMDOC option can be abled to get warnings for
546 # functions that are documented, but have no documentation for their parameters
547 # or return value. If set to NO (the default) doxygen will only warn about
548 # wrong or incomplete parameter documentation, but not about the absence of
549 # documentation.
551 WARN_NO_PARAMDOC = NO
553 # The WARN_FORMAT tag determines the format of the warning messages that
554 # doxygen can produce. The string should contain the $file, $line, and $text
555 # tags, which will be replaced by the file and line number from which the
556 # warning originated and the warning text. Optionally the format may contain
557 # $version, which will be replaced by the version of the file (if it could
558 # be obtained via FILE_VERSION_FILTER)
560 WARN_FORMAT = "$file:$line: $text"
562 # The WARN_LOGFILE tag can be used to specify a file to which warning
563 # and error messages should be written. If left blank the output is written
564 # to stderr.
566 WARN_LOGFILE =
568 #---------------------------------------------------------------------------
569 # configuration options related to the input files
570 #---------------------------------------------------------------------------
572 # The INPUT tag can be used to specify the files and/or directories that contain
573 # documented source files. You may enter file names like "myfile.cpp" or
574 # directories like "/usr/src/myproject". Separate the files or directories
575 # with spaces.
577 INPUT = ..\edma3_common.h \
578 ..\edma3_rm.h \
579 ..\src\
581 # This tag can be used to specify the character encoding of the source files
582 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
583 # also the default input encoding. Doxygen uses libiconv (or the iconv built
584 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
585 # the list of possible encodings.
587 INPUT_ENCODING = UTF-8
589 # If the value of the INPUT tag contains directories, you can use the
590 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
591 # and *.h) to filter out the source-files in the directories. If left
592 # blank the following patterns are tested:
593 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
594 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
596 FILE_PATTERNS = *.c \
597 *.h
599 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
600 # should be searched for input files as well. Possible values are YES and NO.
601 # If left blank NO is used.
603 RECURSIVE = YES
605 # The EXCLUDE tag can be used to specify files and/or directories that should
606 # excluded from the INPUT source files. This way you can easily exclude a
607 # subdirectory from a directory tree whose root is specified with the INPUT tag.
609 EXCLUDE =
611 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
612 # directories that are symbolic links (a Unix filesystem feature) are excluded
613 # from the input.
615 EXCLUDE_SYMLINKS = NO
617 # If the value of the INPUT tag contains directories, you can use the
618 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
619 # certain files from those directories. Note that the wildcards are matched
620 # against the file with absolute path, so to exclude all test directories
621 # for example use the pattern */test/*
623 EXCLUDE_PATTERNS =
625 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
626 # (namespaces, classes, functions, etc.) that should be excluded from the
627 # output. The symbol name can be a fully qualified name, a word, or if the
628 # wildcard * is used, a substring. Examples: ANamespace, AClass,
629 # AClass::ANamespace, ANamespace::*Test
631 EXCLUDE_SYMBOLS =
633 # The EXAMPLE_PATH tag can be used to specify one or more files or
634 # directories that contain example code fragments that are included (see
635 # the \include command).
637 EXAMPLE_PATH =
639 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
640 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
641 # and *.h) to filter out the source-files in the directories. If left
642 # blank all files are included.
644 EXAMPLE_PATTERNS =
646 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
647 # searched for input files to be used with the \include or \dontinclude
648 # commands irrespective of the value of the RECURSIVE tag.
649 # Possible values are YES and NO. If left blank NO is used.
651 EXAMPLE_RECURSIVE = NO
653 # The IMAGE_PATH tag can be used to specify one or more files or
654 # directories that contain image that are included in the documentation (see
655 # the \image command).
657 IMAGE_PATH =
659 # The INPUT_FILTER tag can be used to specify a program that doxygen should
660 # invoke to filter for each input file. Doxygen will invoke the filter program
661 # by executing (via popen()) the command <filter> <input-file>, where <filter>
662 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
663 # input file. Doxygen will then use the output that the filter program writes
664 # to standard output. If FILTER_PATTERNS is specified, this tag will be
665 # ignored.
667 INPUT_FILTER =
669 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
670 # basis. Doxygen will compare the file name with each pattern and apply the
671 # filter if there is a match. The filters are a list of the form:
672 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
673 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
674 # is applied to all files.
676 FILTER_PATTERNS =
678 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
679 # INPUT_FILTER) will be used to filter the input files when producing source
680 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
682 FILTER_SOURCE_FILES = NO
684 #---------------------------------------------------------------------------
685 # configuration options related to source browsing
686 #---------------------------------------------------------------------------
688 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
689 # be generated. Documented entities will be cross-referenced with these sources.
690 # Note: To get rid of all source code in the generated output, make sure also
691 # VERBATIM_HEADERS is set to NO.
693 SOURCE_BROWSER = NO
695 # Setting the INLINE_SOURCES tag to YES will include the body
696 # of functions and classes directly in the documentation.
698 INLINE_SOURCES = NO
700 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
701 # doxygen to hide any special comment blocks from generated source code
702 # fragments. Normal C and C++ comments will always remain visible.
704 STRIP_CODE_COMMENTS = YES
706 # If the REFERENCED_BY_RELATION tag is set to YES
707 # then for each documented function all documented
708 # functions referencing it will be listed.
710 REFERENCED_BY_RELATION = NO
712 # If the REFERENCES_RELATION tag is set to YES
713 # then for each documented function all documented entities
714 # called/used by that function will be listed.
716 REFERENCES_RELATION = NO
718 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
719 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
720 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
721 # link to the source code. Otherwise they will link to the documentation.
723 REFERENCES_LINK_SOURCE = YES
725 # If the USE_HTAGS tag is set to YES then the references to source code
726 # will point to the HTML generated by the htags(1) tool instead of doxygen
727 # built-in source browser. The htags tool is part of GNU's global source
728 # tagging system (see http://www.gnu.org/software/global/global.html). You
729 # will need version 4.8.6 or higher.
731 USE_HTAGS = NO
733 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
734 # will generate a verbatim copy of the header file for each class for
735 # which an include is specified. Set to NO to disable this.
737 VERBATIM_HEADERS = NO
739 #---------------------------------------------------------------------------
740 # configuration options related to the alphabetical class index
741 #---------------------------------------------------------------------------
743 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
744 # of all compounds will be generated. Enable this if the project
745 # contains a lot of classes, structs, unions or interfaces.
747 ALPHABETICAL_INDEX = YES
749 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
750 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
751 # in which this list will be split (can be a number in the range [1..20])
753 COLS_IN_ALPHA_INDEX = 4
755 # In case all classes in a project start with a common prefix, all
756 # classes will be put under the same header in the alphabetical index.
757 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
758 # should be ignored while generating the index headers.
760 IGNORE_PREFIX =
762 #---------------------------------------------------------------------------
763 # configuration options related to the HTML output
764 #---------------------------------------------------------------------------
766 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
767 # generate HTML output.
769 GENERATE_HTML = YES
771 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
772 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
773 # put in front of it. If left blank `html' will be used as the default path.
775 HTML_OUTPUT = html
777 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
778 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
779 # doxygen will generate files with .html extension.
781 HTML_FILE_EXTENSION = .html
783 # The HTML_HEADER tag can be used to specify a personal HTML header for
784 # each generated HTML page. If it is left blank doxygen will generate a
785 # standard header.
787 HTML_HEADER =
789 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
790 # each generated HTML page. If it is left blank doxygen will generate a
791 # standard footer.
793 HTML_FOOTER =
795 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
796 # style sheet that is used by each HTML page. It can be used to
797 # fine-tune the look of the HTML output. If the tag is left blank doxygen
798 # will generate a default style sheet. Note that doxygen will try to copy
799 # the style sheet file to the HTML output directory, so don't put your own
800 # stylesheet in the HTML output directory as well, or it will be erased!
802 HTML_STYLESHEET =
804 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
805 # files or namespaces will be aligned in HTML using tables. If set to
806 # NO a bullet list will be used.
808 HTML_ALIGN_MEMBERS = YES
810 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
811 # documentation will contain sections that can be hidden and shown after the
812 # page has loaded. For this to work a browser that supports
813 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
814 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
816 HTML_DYNAMIC_SECTIONS = NO
818 # If the GENERATE_DOCSET tag is set to YES, additional index files
819 # will be generated that can be used as input for Apple's Xcode 3
820 # integrated development environment, introduced with OSX 10.5 (Leopard).
821 # To create a documentation set, doxygen will generate a Makefile in the
822 # HTML output directory. Running make will produce the docset in that
823 # directory and running "make install" will install the docset in
824 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
825 # it at startup.
826 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
828 GENERATE_DOCSET = NO
830 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
831 # feed. A documentation feed provides an umbrella under which multiple
832 # documentation sets from a single provider (such as a company or product suite)
833 # can be grouped.
835 DOCSET_FEEDNAME = "Doxygen generated docs"
837 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
838 # should uniquely identify the documentation set bundle. This should be a
839 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
840 # will append .docset to the name.
842 DOCSET_BUNDLE_ID = org.doxygen.Project
844 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
845 # will be generated that can be used as input for tools like the
846 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
847 # of the generated HTML documentation.
849 GENERATE_HTMLHELP = YES
851 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
852 # be used to specify the file name of the resulting .chm file. You
853 # can add a path in front of the file if the result should not be
854 # written to the html output directory.
856 CHM_FILE = ..\EDMA3_Resource_Manager.chm
858 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
859 # be used to specify the location (absolute path including file name) of
860 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
861 # the HTML help compiler on the generated index.hhp.
863 HHC_LOCATION = "C:\Program Files\HTML Help Workshop\hhc.exe"
865 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
866 # controls if a separate .chi index file is generated (YES) or that
867 # it should be included in the master .chm file (NO).
869 GENERATE_CHI = NO
871 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
872 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
873 # content.
875 CHM_INDEX_ENCODING =
877 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
878 # controls whether a binary table of contents is generated (YES) or a
879 # normal table of contents (NO) in the .chm file.
881 BINARY_TOC = NO
883 # The TOC_EXPAND flag can be set to YES to add extra items for group members
884 # to the contents of the HTML help documentation and to the tree view.
886 TOC_EXPAND = NO
888 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
889 # are set, an additional index file will be generated that can be used as input for
890 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
891 # HTML documentation.
893 GENERATE_QHP = NO
895 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
896 # be used to specify the file name of the resulting .qch file.
897 # The path specified is relative to the HTML output folder.
899 QCH_FILE =
901 # The QHP_NAMESPACE tag specifies the namespace to use when generating
902 # Qt Help Project output. For more information please see
903 # http://doc.trolltech.com/qthelpproject.html#namespace
905 QHP_NAMESPACE =
907 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
908 # Qt Help Project output. For more information please see
909 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
911 QHP_VIRTUAL_FOLDER = doc
913 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
914 # For more information please see
915 # http://doc.trolltech.com/qthelpproject.html#custom-filters
917 QHP_CUST_FILTER_NAME =
919 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
920 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
922 QHP_CUST_FILTER_ATTRS =
924 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
925 # filter section matches.
926 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
928 QHP_SECT_FILTER_ATTRS =
930 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
931 # be used to specify the location of Qt's qhelpgenerator.
932 # If non-empty doxygen will try to run qhelpgenerator on the generated
933 # .qhp file.
935 QHG_LOCATION =
937 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
938 # top of each HTML page. The value NO (the default) enables the index and
939 # the value YES disables it.
941 DISABLE_INDEX = NO
943 # This tag can be used to set the number of enum values (range [1..20])
944 # that doxygen will group on one line in the generated HTML documentation.
946 ENUM_VALUES_PER_LINE = 1
948 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
949 # structure should be generated to display hierarchical information.
950 # If the tag value is set to YES, a side panel will be generated
951 # containing a tree-like index structure (just like the one that
952 # is generated for HTML Help). For this to work a browser that supports
953 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
954 # Windows users are probably better off using the HTML help feature.
956 GENERATE_TREEVIEW = NO
958 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
959 # and Class Hierarchy pages using a tree view instead of an ordered list.
961 USE_INLINE_TREES = NO
963 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
964 # used to set the initial width (in pixels) of the frame in which the tree
965 # is shown.
967 TREEVIEW_WIDTH = 250
969 # Use this tag to change the font size of Latex formulas included
970 # as images in the HTML documentation. The default is 10. Note that
971 # when you change the font size after a successful doxygen run you need
972 # to manually remove any form_*.png images from the HTML output directory
973 # to force them to be regenerated.
975 FORMULA_FONTSIZE = 10
977 # When the SEARCHENGINE tag is enable doxygen will generate a search box
978 # for the HTML output. The underlying search engine uses javascript
979 # and DHTML and should work on any modern browser. Note that when using
980 # HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
981 # there is already a search function so this one should typically
982 # be disabled.
984 SEARCHENGINE = NO
986 #---------------------------------------------------------------------------
987 # configuration options related to the LaTeX output
988 #---------------------------------------------------------------------------
990 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
991 # generate Latex output.
993 GENERATE_LATEX = NO
995 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
996 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
997 # put in front of it. If left blank `latex' will be used as the default path.
999 LATEX_OUTPUT = latex
1001 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1002 # invoked. If left blank `latex' will be used as the default command name.
1004 LATEX_CMD_NAME = latex
1006 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1007 # generate index for LaTeX. If left blank `makeindex' will be used as the
1008 # default command name.
1010 MAKEINDEX_CMD_NAME = makeindex
1012 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1013 # LaTeX documents. This may be useful for small projects and may help to
1014 # save some trees in general.
1016 COMPACT_LATEX = NO
1018 # The PAPER_TYPE tag can be used to set the paper type that is used
1019 # by the printer. Possible values are: a4, a4wide, letter, legal and
1020 # executive. If left blank a4wide will be used.
1022 PAPER_TYPE = a4wide
1024 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1025 # packages that should be included in the LaTeX output.
1027 EXTRA_PACKAGES =
1029 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1030 # the generated latex document. The header should contain everything until
1031 # the first chapter. If it is left blank doxygen will generate a
1032 # standard header. Notice: only use this tag if you know what you are doing!
1034 LATEX_HEADER =
1036 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1037 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1038 # contain links (just like the HTML output) instead of page references
1039 # This makes the output suitable for online browsing using a pdf viewer.
1041 PDF_HYPERLINKS = NO
1043 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1044 # plain latex in the generated Makefile. Set this option to YES to get a
1045 # higher quality PDF documentation.
1047 USE_PDFLATEX = NO
1049 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1050 # command to the generated LaTeX files. This will instruct LaTeX to keep
1051 # running if errors occur, instead of asking the user for help.
1052 # This option is also used when generating formulas in HTML.
1054 LATEX_BATCHMODE = NO
1056 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1057 # include the index chapters (such as File Index, Compound Index, etc.)
1058 # in the output.
1060 LATEX_HIDE_INDICES = NO
1062 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1063 # source code with syntax highlighting in the LaTeX output.
1064 # Note that which sources are shown also depends on other settings
1065 # such as SOURCE_BROWSER.
1067 LATEX_SOURCE_CODE = NO
1069 #---------------------------------------------------------------------------
1070 # configuration options related to the RTF output
1071 #---------------------------------------------------------------------------
1073 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1074 # The RTF output is optimized for Word 97 and may not look very pretty with
1075 # other RTF readers or editors.
1077 GENERATE_RTF = NO
1079 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1080 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1081 # put in front of it. If left blank `rtf' will be used as the default path.
1083 RTF_OUTPUT = rtf
1085 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1086 # RTF documents. This may be useful for small projects and may help to
1087 # save some trees in general.
1089 COMPACT_RTF = NO
1091 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1092 # will contain hyperlink fields. The RTF file will
1093 # contain links (just like the HTML output) instead of page references.
1094 # This makes the output suitable for online browsing using WORD or other
1095 # programs which support those fields.
1096 # Note: wordpad (write) and others do not support links.
1098 RTF_HYPERLINKS = NO
1100 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1101 # config file, i.e. a series of assignments. You only have to provide
1102 # replacements, missing definitions are set to their default value.
1104 RTF_STYLESHEET_FILE =
1106 # Set optional variables used in the generation of an rtf document.
1107 # Syntax is similar to doxygen's config file.
1109 RTF_EXTENSIONS_FILE =
1111 #---------------------------------------------------------------------------
1112 # configuration options related to the man page output
1113 #---------------------------------------------------------------------------
1115 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1116 # generate man pages
1118 GENERATE_MAN = NO
1120 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1121 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1122 # put in front of it. If left blank `man' will be used as the default path.
1124 MAN_OUTPUT = man
1126 # The MAN_EXTENSION tag determines the extension that is added to
1127 # the generated man pages (default is the subroutine's section .3)
1129 MAN_EXTENSION = .3
1131 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1132 # then it will generate one additional man file for each entity
1133 # documented in the real man page(s). These additional files
1134 # only source the real man page, but without them the man command
1135 # would be unable to find the correct page. The default is NO.
1137 MAN_LINKS = NO
1139 #---------------------------------------------------------------------------
1140 # configuration options related to the XML output
1141 #---------------------------------------------------------------------------
1143 # If the GENERATE_XML tag is set to YES Doxygen will
1144 # generate an XML file that captures the structure of
1145 # the code including all documentation.
1147 GENERATE_XML = NO
1149 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1150 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1151 # put in front of it. If left blank `xml' will be used as the default path.
1153 XML_OUTPUT = xml
1155 # The XML_SCHEMA tag can be used to specify an XML schema,
1156 # which can be used by a validating XML parser to check the
1157 # syntax of the XML files.
1159 XML_SCHEMA =
1161 # The XML_DTD tag can be used to specify an XML DTD,
1162 # which can be used by a validating XML parser to check the
1163 # syntax of the XML files.
1165 XML_DTD =
1167 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1168 # dump the program listings (including syntax highlighting
1169 # and cross-referencing information) to the XML output. Note that
1170 # enabling this will significantly increase the size of the XML output.
1172 XML_PROGRAMLISTING = YES
1174 #---------------------------------------------------------------------------
1175 # configuration options for the AutoGen Definitions output
1176 #---------------------------------------------------------------------------
1178 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1179 # generate an AutoGen Definitions (see autogen.sf.net) file
1180 # that captures the structure of the code including all
1181 # documentation. Note that this feature is still experimental
1182 # and incomplete at the moment.
1184 GENERATE_AUTOGEN_DEF = NO
1186 #---------------------------------------------------------------------------
1187 # configuration options related to the Perl module output
1188 #---------------------------------------------------------------------------
1190 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1191 # generate a Perl module file that captures the structure of
1192 # the code including all documentation. Note that this
1193 # feature is still experimental and incomplete at the
1194 # moment.
1196 GENERATE_PERLMOD = NO
1198 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1199 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1200 # to generate PDF and DVI output from the Perl module output.
1202 PERLMOD_LATEX = NO
1204 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1205 # nicely formatted so it can be parsed by a human reader. This is useful
1206 # if you want to understand what is going on. On the other hand, if this
1207 # tag is set to NO the size of the Perl module output will be much smaller
1208 # and Perl will parse it just the same.
1210 PERLMOD_PRETTY = YES
1212 # The names of the make variables in the generated doxyrules.make file
1213 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1214 # This is useful so different doxyrules.make files included by the same
1215 # Makefile don't overwrite each other's variables.
1217 PERLMOD_MAKEVAR_PREFIX =
1219 #---------------------------------------------------------------------------
1220 # Configuration options related to the preprocessor
1221 #---------------------------------------------------------------------------
1223 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1224 # evaluate all C-preprocessor directives found in the sources and include
1225 # files.
1227 ENABLE_PREPROCESSING = YES
1229 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1230 # names in the source code. If set to NO (the default) only conditional
1231 # compilation will be performed. Macro expansion can be done in a controlled
1232 # way by setting EXPAND_ONLY_PREDEF to YES.
1234 MACRO_EXPANSION = NO
1236 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1237 # then the macro expansion is limited to the macros specified with the
1238 # PREDEFINED and EXPAND_AS_DEFINED tags.
1240 EXPAND_ONLY_PREDEF = NO
1242 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1243 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1245 SEARCH_INCLUDES = YES
1247 # The INCLUDE_PATH tag can be used to specify one or more directories that
1248 # contain include files that are not input files but should be processed by
1249 # the preprocessor.
1251 INCLUDE_PATH =
1253 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1254 # patterns (like *.h and *.hpp) to filter out the header-files in the
1255 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1256 # be used.
1258 INCLUDE_FILE_PATTERNS =
1260 # The PREDEFINED tag can be used to specify one or more macro names that
1261 # are defined before the preprocessor is started (similar to the -D option of
1262 # gcc). The argument of the tag is a list of macros of the form: name
1263 # or name=definition (no spaces). If the definition and the = are
1264 # omitted =1 is assumed. To prevent a macro definition from being
1265 # undefined via #undef or recursively expanded use the := operator
1266 # instead of the = operator.
1268 PREDEFINED =
1270 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1271 # this tag can be used to specify a list of macro names that should be expanded.
1272 # The macro definition that is found in the sources will be used.
1273 # Use the PREDEFINED tag if you want to use a different macro definition.
1275 EXPAND_AS_DEFINED =
1277 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1278 # doxygen's preprocessor will remove all function-like macros that are alone
1279 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1280 # function macros are typically used for boiler-plate code, and will confuse
1281 # the parser if not removed.
1283 SKIP_FUNCTION_MACROS = YES
1285 #---------------------------------------------------------------------------
1286 # Configuration::additions related to external references
1287 #---------------------------------------------------------------------------
1289 # The TAGFILES option can be used to specify one or more tagfiles.
1290 # Optionally an initial location of the external documentation
1291 # can be added for each tagfile. The format of a tag file without
1292 # this location is as follows:
1293 # TAGFILES = file1 file2 ...
1294 # Adding location for the tag files is done as follows:
1295 # TAGFILES = file1=loc1 "file2 = loc2" ...
1296 # where "loc1" and "loc2" can be relative or absolute paths or
1297 # URLs. If a location is present for each tag, the installdox tool
1298 # does not have to be run to correct the links.
1299 # Note that each tag file must have a unique name
1300 # (where the name does NOT include the path)
1301 # If a tag file is not located in the directory in which doxygen
1302 # is run, you must also specify the path to the tagfile here.
1304 TAGFILES =
1306 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1307 # a tag file that is based on the input files it reads.
1309 GENERATE_TAGFILE =
1311 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1312 # in the class index. If set to NO only the inherited external classes
1313 # will be listed.
1315 ALLEXTERNALS = NO
1317 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1318 # in the modules index. If set to NO, only the current project's groups will
1319 # be listed.
1321 EXTERNAL_GROUPS = YES
1323 # The PERL_PATH should be the absolute path and name of the perl script
1324 # interpreter (i.e. the result of `which perl').
1326 PERL_PATH = /usr/bin/perl
1328 #---------------------------------------------------------------------------
1329 # Configuration options related to the dot tool
1330 #---------------------------------------------------------------------------
1332 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1333 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1334 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1335 # this option is superseded by the HAVE_DOT option below. This is only a
1336 # fallback. It is recommended to install and use dot, since it yields more
1337 # powerful graphs.
1339 CLASS_DIAGRAMS = NO
1341 # You can define message sequence charts within doxygen comments using the \msc
1342 # command. Doxygen will then run the mscgen tool (see
1343 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1344 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1345 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1346 # default search path.
1348 MSCGEN_PATH =
1350 # If set to YES, the inheritance and collaboration graphs will hide
1351 # inheritance and usage relations if the target is undocumented
1352 # or is not a class.
1354 HIDE_UNDOC_RELATIONS = YES
1356 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1357 # available from the path. This tool is part of Graphviz, a graph visualization
1358 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1359 # have no effect if this option is set to NO (the default)
1361 HAVE_DOT = NO
1363 # By default doxygen will write a font called FreeSans.ttf to the output
1364 # directory and reference it in all dot files that doxygen generates. This
1365 # font does not include all possible unicode characters however, so when you need
1366 # these (or just want a differently looking font) you can specify the font name
1367 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1368 # which can be done by putting it in a standard location or by setting the
1369 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1370 # containing the font.
1372 DOT_FONTNAME = FreeSans
1374 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1375 # The default size is 10pt.
1377 DOT_FONTSIZE = 10
1379 # By default doxygen will tell dot to use the output directory to look for the
1380 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1381 # different font using DOT_FONTNAME you can set the path where dot
1382 # can find it using this tag.
1384 DOT_FONTPATH =
1386 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1387 # will generate a graph for each documented class showing the direct and
1388 # indirect inheritance relations. Setting this tag to YES will force the
1389 # the CLASS_DIAGRAMS tag to NO.
1391 CLASS_GRAPH = YES
1393 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1394 # will generate a graph for each documented class showing the direct and
1395 # indirect implementation dependencies (inheritance, containment, and
1396 # class references variables) of the class with other documented classes.
1398 COLLABORATION_GRAPH = YES
1400 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1401 # will generate a graph for groups, showing the direct groups dependencies
1403 GROUP_GRAPHS = YES
1405 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1406 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1407 # Language.
1409 UML_LOOK = NO
1411 # If set to YES, the inheritance and collaboration graphs will show the
1412 # relations between templates and their instances.
1414 TEMPLATE_RELATIONS = NO
1416 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1417 # tags are set to YES then doxygen will generate a graph for each documented
1418 # file showing the direct and indirect include dependencies of the file with
1419 # other documented files.
1421 INCLUDE_GRAPH = YES
1423 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1424 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1425 # documented header file showing the documented files that directly or
1426 # indirectly include this file.
1428 INCLUDED_BY_GRAPH = YES
1430 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1431 # doxygen will generate a call dependency graph for every global function
1432 # or class method. Note that enabling this option will significantly increase
1433 # the time of a run. So in most cases it will be better to enable call graphs
1434 # for selected functions only using the \callgraph command.
1436 CALL_GRAPH = NO
1438 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1439 # doxygen will generate a caller dependency graph for every global function
1440 # or class method. Note that enabling this option will significantly increase
1441 # the time of a run. So in most cases it will be better to enable caller
1442 # graphs for selected functions only using the \callergraph command.
1444 CALLER_GRAPH = NO
1446 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1447 # will graphical hierarchy of all classes instead of a textual one.
1449 GRAPHICAL_HIERARCHY = YES
1451 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1452 # then doxygen will show the dependencies a directory has on other directories
1453 # in a graphical way. The dependency relations are determined by the #include
1454 # relations between the files in the directories.
1456 DIRECTORY_GRAPH = YES
1458 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1459 # generated by dot. Possible values are png, jpg, or gif
1460 # If left blank png will be used.
1462 DOT_IMAGE_FORMAT = png
1464 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1465 # found. If left blank, it is assumed the dot tool can be found in the path.
1467 DOT_PATH =
1469 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1470 # contain dot files that are included in the documentation (see the
1471 # \dotfile command).
1473 DOTFILE_DIRS =
1475 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1476 # nodes that will be shown in the graph. If the number of nodes in a graph
1477 # becomes larger than this value, doxygen will truncate the graph, which is
1478 # visualized by representing a node as a red box. Note that doxygen if the
1479 # number of direct children of the root node in a graph is already larger than
1480 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1481 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1483 DOT_GRAPH_MAX_NODES = 50
1485 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1486 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1487 # from the root by following a path via at most 3 edges will be shown. Nodes
1488 # that lay further from the root node will be omitted. Note that setting this
1489 # option to 1 or 2 may greatly reduce the computation time needed for large
1490 # code bases. Also note that the size of a graph can be further restricted by
1491 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1493 MAX_DOT_GRAPH_DEPTH = 0
1495 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1496 # background. This is disabled by default, because dot on Windows does not
1497 # seem to support this out of the box. Warning: Depending on the platform used,
1498 # enabling this option may lead to badly anti-aliased labels on the edges of
1499 # a graph (i.e. they become hard to read).
1501 DOT_TRANSPARENT = NO
1503 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1504 # files in one run (i.e. multiple -o and -T options on the command line). This
1505 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1506 # support this, this feature is disabled by default.
1508 DOT_MULTI_TARGETS = NO
1510 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1511 # generate a legend page explaining the meaning of the various boxes and
1512 # arrows in the dot generated graphs.
1514 GENERATE_LEGEND = YES
1516 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1517 # remove the intermediate dot files that are used to generate
1518 # the various graphs.
1520 DOT_CLEANUP = YES