ARM ADI-V5: cleanup CID/PID addressing
[openocd/dnglaze.git] / Doxyfile.in
blob658f66710cc7c1b56f45322a392ffc6458f85002
1 # Doxyfile 1.5.8
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
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           = OpenOCD
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         =
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       = doxygen
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, 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.
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  = YES
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      = YES
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               = 4
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
219 EXTENSION_MAPPING      = 
221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222 # to include (a tag file for) the STL sources as input, then you should
223 # set this tag to YES in order to let doxygen match functions declarations and
224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225 # func(std::string) {}). This also make the inheritance and collaboration
226 # diagrams that involve STL classes more complete and accurate.
228 BUILTIN_STL_SUPPORT    = NO
230 # If you use Microsoft's C++/CLI language, you should set this option to YES to
231 # enable parsing support.
233 CPP_CLI_SUPPORT        = NO
235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236 # Doxygen will parse them like normal C++ but will assume all classes use public
237 # instead of private inheritance when no explicit protection keyword is present.
239 SIP_SUPPORT            = NO
241 # For Microsoft's IDL there are propget and propput attributes to indicate getter 
242 # and setter methods for a property. Setting this option to YES (the default) 
243 # will make doxygen to replace the get and set methods by a property in the 
244 # documentation. This will only work if the methods are indeed getting or 
245 # setting a simple type. If this is not the case, or you want to show the 
246 # methods anyway, you should set this option to NO.
248 IDL_PROPERTY_SUPPORT   = NO
250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251 # tag is set to YES, then doxygen will reuse the documentation of the first
252 # member in the group (if any) for the other members of the group. By default
253 # all members of a group must be documented explicitly.
255 DISTRIBUTE_GROUP_DOC   = NO
257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258 # the same type (for instance a group of public functions) to be put as a
259 # subgroup of that type (e.g. under the Public Functions section). Set it to
260 # NO to prevent subgrouping. Alternatively, this can be done per class using
261 # the \nosubgrouping command.
263 SUBGROUPING            = YES
265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266 # is documented as struct, union, or enum with the name of the typedef. So
267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268 # with name TypeT. When disabled the typedef will appear as a member of a file,
269 # namespace, or class. And the struct will be named TypeS. This can typically
270 # be useful for C code in case the coding convention dictates that all compound
271 # types are typedef'ed and only the typedef is referenced, never the tag name.
273 TYPEDEF_HIDES_STRUCT   = NO
275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
276 # determine which symbols to keep in memory and which to flush to disk. 
277 # When the cache is full, less often used symbols will be written to disk. 
278 # For small to medium size projects (<1000 input files) the default value is 
279 # probably good enough. For larger projects a too small cache size can cause 
280 # doxygen to be busy swapping symbols to and from disk most of the time 
281 # causing a significant performance penality. 
282 # If the system has enough physical memory increasing the cache will improve the 
283 # performance by keeping more symbols in memory. Note that the value works on 
284 # a logarithmic scale so increasing the size by one will rougly double the 
285 # memory usage. The cache size is given by this formula: 
286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
287 # corresponding to a cache size of 2^16 = 65536 symbols
289 SYMBOL_CACHE_SIZE      = 0
291 #---------------------------------------------------------------------------
292 # Build related configuration options
293 #---------------------------------------------------------------------------
295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296 # documentation are documented, even if no documentation was available.
297 # Private class members and static file members will be hidden unless
298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
300 EXTRACT_ALL            = YES
302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303 # will be included in the documentation.
305 EXTRACT_PRIVATE        = NO
307 # If the EXTRACT_STATIC tag is set to YES all static members of a file
308 # will be included in the documentation.
310 EXTRACT_STATIC         = NO
312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313 # defined locally in source files will be included in the documentation.
314 # If set to NO only classes defined in header files are included.
316 EXTRACT_LOCAL_CLASSES  = NO
318 # This flag is only useful for Objective-C code. When set to YES local
319 # methods, which are defined in the implementation section but not in
320 # the interface are included in the documentation.
321 # If set to NO (the default) only methods in the interface are included.
323 EXTRACT_LOCAL_METHODS  = NO
325 # If this flag is set to YES, the members of anonymous namespaces will be
326 # extracted and appear in the documentation as a namespace called
327 # 'anonymous_namespace{file}', where file will be replaced with the base
328 # name of the file that contains the anonymous namespace. By default
329 # anonymous namespace are hidden.
331 EXTRACT_ANON_NSPACES   = NO
333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334 # undocumented members of documented classes, files or namespaces.
335 # If set to NO (the default) these members will be included in the
336 # various overviews, but no documentation section is generated.
337 # This option has no effect if EXTRACT_ALL is enabled.
339 HIDE_UNDOC_MEMBERS     = NO
341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342 # undocumented classes that are normally visible in the class hierarchy.
343 # If set to NO (the default) these classes will be included in the various
344 # overviews. This option has no effect if EXTRACT_ALL is enabled.
346 HIDE_UNDOC_CLASSES     = NO
348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349 # friend (class|struct|union) declarations.
350 # If set to NO (the default) these declarations will be included in the
351 # documentation.
353 HIDE_FRIEND_COMPOUNDS  = NO
355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356 # documentation blocks found inside the body of a function.
357 # If set to NO (the default) these blocks will be appended to the
358 # function's detailed documentation block.
360 HIDE_IN_BODY_DOCS      = NO
362 # The INTERNAL_DOCS tag determines if documentation
363 # that is typed after a \internal command is included. If the tag is set
364 # to NO (the default) then the documentation will be excluded.
365 # Set it to YES to include the internal documentation.
367 INTERNAL_DOCS          = NO
369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370 # file names in lower-case letters. If set to YES upper-case letters are also
371 # allowed. This is useful if you have classes or files whose names only differ
372 # in case and if your file system supports case sensitive file names. Windows
373 # and Mac users are advised to set this option to NO.
375 CASE_SENSE_NAMES       = YES
377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378 # will show members with their full class and namespace scopes in the
379 # documentation. If set to YES the scope will be hidden.
381 HIDE_SCOPE_NAMES       = NO
383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384 # will put a list of the files that are included by a file in the documentation
385 # of that file.
387 SHOW_INCLUDE_FILES     = NO
389 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
390 # is inserted in the documentation for inline members.
392 INLINE_INFO            = YES
394 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
395 # will sort the (detailed) documentation of file and class members
396 # alphabetically by member name. If set to NO the members will appear in
397 # declaration order.
399 SORT_MEMBER_DOCS       = YES
401 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402 # brief documentation of file, namespace and class members alphabetically
403 # by member name. If set to NO (the default) the members will appear in
404 # declaration order.
406 SORT_BRIEF_DOCS        = YES
408 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
409 # hierarchy of group names into alphabetical order. If set to NO (the default)
410 # the group names will appear in their defined order.
412 SORT_GROUP_NAMES       = NO
414 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
415 # sorted by fully-qualified names, including namespaces. If set to
416 # NO (the default), the class list will be sorted only by class name,
417 # not including the namespace part.
418 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
419 # Note: This option applies only to the class list, not to the
420 # alphabetical list.
422 SORT_BY_SCOPE_NAME     = NO
424 # The GENERATE_TODOLIST tag can be used to enable (YES) or
425 # disable (NO) the todo list. This list is created by putting \todo
426 # commands in the documentation.
428 GENERATE_TODOLIST      = YES
430 # The GENERATE_TESTLIST tag can be used to enable (YES) or
431 # disable (NO) the test list. This list is created by putting \test
432 # commands in the documentation.
434 GENERATE_TESTLIST      = YES
436 # The GENERATE_BUGLIST tag can be used to enable (YES) or
437 # disable (NO) the bug list. This list is created by putting \bug
438 # commands in the documentation.
440 GENERATE_BUGLIST       = YES
442 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
443 # disable (NO) the deprecated list. This list is created by putting
444 # \deprecated commands in the documentation.
446 GENERATE_DEPRECATEDLIST= YES
448 # The ENABLED_SECTIONS tag can be used to enable conditional
449 # documentation sections, marked by \if sectionname ... \endif.
451 ENABLED_SECTIONS       =
453 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
454 # the initial value of a variable or define consists of for it to appear in
455 # the documentation. If the initializer consists of more lines than specified
456 # here it will be hidden. Use a value of 0 to hide initializers completely.
457 # The appearance of the initializer of individual variables and defines in the
458 # documentation can be controlled using \showinitializer or \hideinitializer
459 # command in the documentation regardless of this setting.
461 MAX_INITIALIZER_LINES  = 30
463 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
464 # at the bottom of the documentation of classes and structs. If set to YES the
465 # list will mention the files that were used to generate the documentation.
467 SHOW_USED_FILES        = YES
469 # If the sources in your project are distributed over multiple directories
470 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
471 # in the documentation. The default is NO.
473 SHOW_DIRECTORIES       = YES
475 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
476 # This will remove the Files entry from the Quick Index and from the 
477 # Folder Tree View (if specified). The default is YES.
479 SHOW_FILES             = YES
481 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
482 # Namespaces page. 
483 # This will remove the Namespaces entry from the Quick Index 
484 # and from the Folder Tree View (if specified). The default is YES.
486 SHOW_NAMESPACES        = YES
488 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
489 # doxygen should invoke to get the current version for each file (typically from
490 # the version control system). Doxygen will invoke the program by executing (via
491 # popen()) the command <command> <input-file>, where <command> is the value of
492 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
493 # provided by doxygen. Whatever the program writes to standard output
494 # is used as the file version. See the manual for examples.
496 FILE_VERSION_FILTER    =
498 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 
499 # doxygen. The layout file controls the global structure of the generated output files 
500 # in an output format independent way. The create the layout file that represents 
501 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 
502 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 
503 # of the layout file.
505 LAYOUT_FILE            = 
507 #---------------------------------------------------------------------------
508 # configuration options related to warning and progress messages
509 #---------------------------------------------------------------------------
511 # The QUIET tag can be used to turn on/off the messages that are generated
512 # by doxygen. Possible values are YES and NO. If left blank NO is used.
514 QUIET                  = NO
516 # The WARNINGS tag can be used to turn on/off the warning messages that are
517 # generated by doxygen. Possible values are YES and NO. If left blank
518 # NO is used.
520 WARNINGS               = YES
522 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
523 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
524 # automatically be disabled.
526 WARN_IF_UNDOCUMENTED   = YES
528 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
529 # potential errors in the documentation, such as not documenting some
530 # parameters in a documented function, or documenting parameters that
531 # don't exist or using markup commands wrongly.
533 WARN_IF_DOC_ERROR      = YES
535 # This WARN_NO_PARAMDOC option can be abled to get warnings for
536 # functions that are documented, but have no documentation for their parameters
537 # or return value. If set to NO (the default) doxygen will only warn about
538 # wrong or incomplete parameter documentation, but not about the absence of
539 # documentation.
541 WARN_NO_PARAMDOC       = NO
543 # The WARN_FORMAT tag determines the format of the warning messages that
544 # doxygen can produce. The string should contain the $file, $line, and $text
545 # tags, which will be replaced by the file and line number from which the
546 # warning originated and the warning text. Optionally the format may contain
547 # $version, which will be replaced by the version of the file (if it could
548 # be obtained via FILE_VERSION_FILTER)
550 WARN_FORMAT            = "$file:$line: $text   "
552 # The WARN_LOGFILE tag can be used to specify a file to which warning
553 # and error messages should be written. If left blank the output is written
554 # to stderr.
556 WARN_LOGFILE           =
558 #---------------------------------------------------------------------------
559 # configuration options related to the input files
560 #---------------------------------------------------------------------------
562 # The INPUT tag can be used to specify the files and/or directories that contain
563 # documented source files. You may enter file names like "myfile.cpp" or
564 # directories like "/usr/src/myproject". Separate the files or directories
565 # with spaces.
567 INPUT                  = @srcdir@/doc/manual \
568                          @srcdir@/TODO \
569                          @srcdir@/BUGS \
570                          @srcdir@/PATCHES.txt \
571                          @srcdir@/src \
572                          @builddir@/config.h
574 # This tag can be used to specify the character encoding of the source files
575 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
576 # also the default input encoding. Doxygen uses libiconv (or the iconv built
577 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
578 # the list of possible encodings.
580 INPUT_ENCODING         = UTF-8
582 # If the value of the INPUT tag contains directories, you can use the
583 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
584 # and *.h) to filter out the source-files in the directories. If left
585 # blank the following patterns are tested:
586 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
587 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
589 FILE_PATTERNS          = *.h \
590                          *.c \
591                          *.txt
593 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
594 # should be searched for input files as well. Possible values are YES and NO.
595 # If left blank NO is used.
597 RECURSIVE              = YES
599 # The EXCLUDE tag can be used to specify files and/or directories that should
600 # excluded from the INPUT source files. This way you can easily exclude a
601 # subdirectory from a directory tree whose root is specified with the INPUT tag.
603 EXCLUDE                =
605 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
606 # directories that are symbolic links (a Unix filesystem feature) are excluded
607 # from the input.
609 EXCLUDE_SYMLINKS       = NO
611 # If the value of the INPUT tag contains directories, you can use the
612 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
613 # certain files from those directories. Note that the wildcards are matched
614 # against the file with absolute path, so to exclude all test directories
615 # for example use the pattern */test/*
617 EXCLUDE_PATTERNS       =
619 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
620 # (namespaces, classes, functions, etc.) that should be excluded from the
621 # output. The symbol name can be a fully qualified name, a word, or if the
622 # wildcard * is used, a substring. Examples: ANamespace, AClass,
623 # AClass::ANamespace, ANamespace::*Test
625 EXCLUDE_SYMBOLS        =
627 # The EXAMPLE_PATH tag can be used to specify one or more files or
628 # directories that contain example code fragments that are included (see
629 # the \include command).
631 EXAMPLE_PATH           =
633 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
634 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
635 # and *.h) to filter out the source-files in the directories. If left
636 # blank all files are included.
638 EXAMPLE_PATTERNS       =
640 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
641 # searched for input files to be used with the \include or \dontinclude
642 # commands irrespective of the value of the RECURSIVE tag.
643 # Possible values are YES and NO. If left blank NO is used.
645 EXAMPLE_RECURSIVE      = NO
647 # The IMAGE_PATH tag can be used to specify one or more files or
648 # directories that contain image that are included in the documentation (see
649 # the \image command).
651 IMAGE_PATH             =
653 # The INPUT_FILTER tag can be used to specify a program that doxygen should
654 # invoke to filter for each input file. Doxygen will invoke the filter program
655 # by executing (via popen()) the command <filter> <input-file>, where <filter>
656 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
657 # input file. Doxygen will then use the output that the filter program writes
658 # to standard output. 
659 # If FILTER_PATTERNS is specified, this tag will be 
660 # ignored.
662 INPUT_FILTER           =
664 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
665 # basis. 
666 # Doxygen will compare the file name with each pattern and apply the 
667 # filter if there is a match. 
668 # The filters are a list of the form: 
669 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
670 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
671 # is applied to all files.
673 FILTER_PATTERNS        =
675 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
676 # INPUT_FILTER) will be used to filter the input files when producing source
677 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
679 FILTER_SOURCE_FILES    = NO
681 #---------------------------------------------------------------------------
682 # configuration options related to source browsing
683 #---------------------------------------------------------------------------
685 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
686 # be generated. Documented entities will be cross-referenced with these sources.
687 # Note: To get rid of all source code in the generated output, make sure also
688 # VERBATIM_HEADERS is set to NO.
690 SOURCE_BROWSER         = YES
692 # Setting the INLINE_SOURCES tag to YES will include the body
693 # of functions and classes directly in the documentation.
695 INLINE_SOURCES         = NO
697 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
698 # doxygen to hide any special comment blocks from generated source code
699 # fragments. Normal C and C++ comments will always remain visible.
701 STRIP_CODE_COMMENTS    = YES
703 # If the REFERENCED_BY_RELATION tag is set to YES 
704 # then for each documented function all documented
705 # functions referencing it will be listed.
707 REFERENCED_BY_RELATION = YES
709 # If the REFERENCES_RELATION tag is set to YES 
710 # then for each documented function all documented entities
711 # called/used by that function will be listed.
713 REFERENCES_RELATION    = YES
715 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
716 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
717 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
718 # link to the source code. 
719 # Otherwise they will link to the documentation.
721 REFERENCES_LINK_SOURCE = YES
723 # If the USE_HTAGS tag is set to YES then the references to source code
724 # will point to the HTML generated by the htags(1) tool instead of doxygen
725 # built-in source browser. The htags tool is part of GNU's global source
726 # tagging system (see http://www.gnu.org/software/global/global.html). You
727 # will need version 4.8.6 or higher.
729 USE_HTAGS              = NO
731 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
732 # will generate a verbatim copy of the header file for each class for
733 # which an include is specified. Set to NO to disable this.
735 VERBATIM_HEADERS       = YES
737 #---------------------------------------------------------------------------
738 # configuration options related to the alphabetical class index
739 #---------------------------------------------------------------------------
741 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
742 # of all compounds will be generated. Enable this if the project
743 # contains a lot of classes, structs, unions or interfaces.
745 ALPHABETICAL_INDEX     = YES
747 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
748 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
749 # in which this list will be split (can be a number in the range [1..20])
751 COLS_IN_ALPHA_INDEX    = 5
753 # In case all classes in a project start with a common prefix, all
754 # classes will be put under the same header in the alphabetical index.
755 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
756 # should be ignored while generating the index headers.
758 IGNORE_PREFIX          =
760 #---------------------------------------------------------------------------
761 # configuration options related to the HTML output
762 #---------------------------------------------------------------------------
764 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
765 # generate HTML output.
767 GENERATE_HTML          = @doxygen_as_html@
769 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
770 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
771 # put in front of it. If left blank `html' will be used as the default path.
773 HTML_OUTPUT            = html
775 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
776 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
777 # doxygen will generate files with .html extension.
779 HTML_FILE_EXTENSION    = .html
781 # The HTML_HEADER tag can be used to specify a personal HTML header for
782 # each generated HTML page. If it is left blank doxygen will generate a
783 # standard header.
785 HTML_HEADER            =
787 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
788 # each generated HTML page. If it is left blank doxygen will generate a
789 # standard footer.
791 HTML_FOOTER            =
793 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
794 # style sheet that is used by each HTML page. It can be used to
795 # fine-tune the look of the HTML output. If the tag is left blank doxygen
796 # will generate a default style sheet. Note that doxygen will try to copy
797 # the style sheet file to the HTML output directory, so don't put your own
798 # stylesheet in the HTML output directory as well, or it will be erased!
800 HTML_STYLESHEET        =
802 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
803 # files or namespaces will be aligned in HTML using tables. If set to
804 # NO a bullet list will be used.
806 HTML_ALIGN_MEMBERS     = YES
808 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
809 # documentation will contain sections that can be hidden and shown after the 
810 # page has loaded. For this to work a browser that supports 
811 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
812 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
814 HTML_DYNAMIC_SECTIONS  = NO
816 # If the GENERATE_DOCSET tag is set to YES, additional index files
817 # will be generated that can be used as input for Apple's Xcode 3
818 # integrated development environment, introduced with OSX 10.5 (Leopard).
819 # To create a documentation set, doxygen will generate a Makefile in the
820 # HTML output directory. Running make will produce the docset in that
821 # directory and running "make install" will install the docset in
822 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
823 # it at startup.
824 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
826 GENERATE_DOCSET        = NO
828 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
829 # feed. A documentation feed provides an umbrella under which multiple
830 # documentation sets from a single provider (such as a company or product suite)
831 # can be grouped.
833 DOCSET_FEEDNAME        = "Doxygen generated docs"
835 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
836 # should uniquely identify the documentation set bundle. This should be a
837 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
838 # will append .docset to the name.
840 DOCSET_BUNDLE_ID       = org.doxygen.Project
842 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
843 # will be generated that can be used as input for tools like the 
844 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
845 # of the generated HTML documentation.
847 GENERATE_HTMLHELP      = NO
849 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
850 # be used to specify the file name of the resulting .chm file. You
851 # can add a path in front of the file if the result should not be
852 # written to the html output directory.
854 CHM_FILE               =
856 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
857 # be used to specify the location (absolute path including file name) of
858 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
859 # the HTML help compiler on the generated index.hhp.
861 HHC_LOCATION           =
863 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
864 # controls if a separate .chi index file is generated (YES) or that
865 # it should be included in the master .chm file (NO).
867 GENERATE_CHI           = NO
869 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
870 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 
871 # content.
873 CHM_INDEX_ENCODING     = 
875 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
876 # controls whether a binary table of contents is generated (YES) or a
877 # normal table of contents (NO) in the .chm file.
879 BINARY_TOC             = NO
881 # The TOC_EXPAND flag can be set to YES to add extra items for group members
882 # to the contents of the HTML help documentation and to the tree view.
884 TOC_EXPAND             = NO
886 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 
887 # are set, an additional index file will be generated that can be used as input for 
888 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 
889 # HTML documentation.
891 GENERATE_QHP           = NO
893 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
894 # be used to specify the file name of the resulting .qch file. 
895 # The path specified is relative to the HTML output folder.
897 QCH_FILE               = 
899 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
900 # Qt Help Project output. For more information please see 
901 # http://doc.trolltech.com/qthelpproject.html#namespace
903 QHP_NAMESPACE          = 
905 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
906 # Qt Help Project output. For more information please see 
907 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
909 QHP_VIRTUAL_FOLDER     = doc
911 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 
912 # For more information please see 
913 # http://doc.trolltech.com/qthelpproject.html#custom-filters
915 QHP_CUST_FILTER_NAME   = 
917 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 
918 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
920 QHP_CUST_FILTER_ATTRS  = 
922 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 
923 # filter section matches. 
924 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
926 QHP_SECT_FILTER_ATTRS  = 
928 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
929 # be used to specify the location of Qt's qhelpgenerator. 
930 # If non-empty doxygen will try to run qhelpgenerator on the generated 
931 # .qhp file.
933 QHG_LOCATION           = 
935 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
936 # top of each HTML page. The value NO (the default) enables the index and
937 # the value YES disables it.
939 DISABLE_INDEX          = NO
941 # This tag can be used to set the number of enum values (range [1..20])
942 # that doxygen will group on one line in the generated HTML documentation.
944 ENUM_VALUES_PER_LINE   = 4
946 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
947 # structure should be generated to display hierarchical information. 
948 # If the tag value is set to FRAME, a side panel will be generated 
949 # containing a tree-like index structure (just like the one that 
950 # is generated for HTML Help). For this to work a browser that supports
951 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
952 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
953 # probably better off using the HTML help feature. Other possible values 
954 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, 
955 # and Class Hierarchy pages using a tree view instead of an ordered list; 
956 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 
957 # disables this behavior completely. For backwards compatibility with previous 
958 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 
959 # respectively.
961 GENERATE_TREEVIEW      = YES
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 #---------------------------------------------------------------------------
978 # configuration options related to the LaTeX output
979 #---------------------------------------------------------------------------
981 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
982 # generate Latex output.
984 GENERATE_LATEX         = @doxygen_as_pdf@
986 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
987 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
988 # put in front of it. If left blank `latex' will be used as the default path.
990 LATEX_OUTPUT           = latex
992 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
993 # invoked. If left blank `latex' will be used as the default command name.
995 LATEX_CMD_NAME         = pdflatex
997 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
998 # generate index for LaTeX. If left blank `makeindex' will be used as the
999 # default command name.
1001 MAKEINDEX_CMD_NAME     = makeindex
1003 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1004 # LaTeX documents. This may be useful for small projects and may help to
1005 # save some trees in general.
1007 COMPACT_LATEX          = YES
1009 # The PAPER_TYPE tag can be used to set the paper type that is used
1010 # by the printer. Possible values are: a4, a4wide, letter, legal and
1011 # executive. If left blank a4wide will be used.
1013 PAPER_TYPE             = a4wide
1015 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1016 # packages that should be included in the LaTeX output.
1018 EXTRA_PACKAGES         =
1020 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1021 # the generated latex document. The header should contain everything until
1022 # the first chapter. If it is left blank doxygen will generate a
1023 # standard header. Notice: only use this tag if you know what you are doing!
1025 LATEX_HEADER           =
1027 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1028 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1029 # contain links (just like the HTML output) instead of page references
1030 # This makes the output suitable for online browsing using a pdf viewer.
1032 PDF_HYPERLINKS         = YES
1034 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1035 # plain latex in the generated Makefile. Set this option to YES to get a
1036 # higher quality PDF documentation.
1038 USE_PDFLATEX           = YES
1040 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1041 # command to the generated LaTeX files. This will instruct LaTeX to keep
1042 # running if errors occur, instead of asking the user for help.
1043 # This option is also used when generating formulas in HTML.
1045 LATEX_BATCHMODE        = YES
1047 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1048 # include the index chapters (such as File Index, Compound Index, etc.)
1049 # in the output.
1051 LATEX_HIDE_INDICES     = NO
1053 #---------------------------------------------------------------------------
1054 # configuration options related to the RTF output
1055 #---------------------------------------------------------------------------
1057 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1058 # The RTF output is optimized for Word 97 and may not look very pretty with
1059 # other RTF readers or editors.
1061 GENERATE_RTF           = NO
1063 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1064 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1065 # put in front of it. If left blank `rtf' will be used as the default path.
1067 RTF_OUTPUT             = rtf
1069 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1070 # RTF documents. This may be useful for small projects and may help to
1071 # save some trees in general.
1073 COMPACT_RTF            = NO
1075 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1076 # will contain hyperlink fields. The RTF file will
1077 # contain links (just like the HTML output) instead of page references.
1078 # This makes the output suitable for online browsing using WORD or other
1079 # programs which support those fields.
1080 # Note: wordpad (write) and others do not support links.
1082 RTF_HYPERLINKS         = NO
1084 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1085 # config file, i.e. a series of assignments. You only have to provide
1086 # replacements, missing definitions are set to their default value.
1088 RTF_STYLESHEET_FILE    =
1090 # Set optional variables used in the generation of an rtf document.
1091 # Syntax is similar to doxygen's config file.
1093 RTF_EXTENSIONS_FILE    =
1095 #---------------------------------------------------------------------------
1096 # configuration options related to the man page output
1097 #---------------------------------------------------------------------------
1099 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1100 # generate man pages
1102 GENERATE_MAN           = NO
1104 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1105 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1106 # put in front of it. If left blank `man' will be used as the default path.
1108 MAN_OUTPUT             = man
1110 # The MAN_EXTENSION tag determines the extension that is added to
1111 # the generated man pages (default is the subroutine's section .3)
1113 MAN_EXTENSION          = .3
1115 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1116 # then it will generate one additional man file for each entity
1117 # documented in the real man page(s). These additional files
1118 # only source the real man page, but without them the man command
1119 # would be unable to find the correct page. The default is NO.
1121 MAN_LINKS              = NO
1123 #---------------------------------------------------------------------------
1124 # configuration options related to the XML output
1125 #---------------------------------------------------------------------------
1127 # If the GENERATE_XML tag is set to YES Doxygen will
1128 # generate an XML file that captures the structure of
1129 # the code including all documentation.
1131 GENERATE_XML           = NO
1133 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1134 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1135 # put in front of it. If left blank `xml' will be used as the default path.
1137 XML_OUTPUT             = xml
1139 # The XML_SCHEMA tag can be used to specify an XML schema,
1140 # which can be used by a validating XML parser to check the
1141 # syntax of the XML files.
1143 XML_SCHEMA             =
1145 # The XML_DTD tag can be used to specify an XML DTD,
1146 # which can be used by a validating XML parser to check the
1147 # syntax of the XML files.
1149 XML_DTD                =
1151 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1152 # dump the program listings (including syntax highlighting
1153 # and cross-referencing information) to the XML output. Note that
1154 # enabling this will significantly increase the size of the XML output.
1156 XML_PROGRAMLISTING     = YES
1158 #---------------------------------------------------------------------------
1159 # configuration options for the AutoGen Definitions output
1160 #---------------------------------------------------------------------------
1162 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1163 # generate an AutoGen Definitions (see autogen.sf.net) file
1164 # that captures the structure of the code including all
1165 # documentation. Note that this feature is still experimental
1166 # and incomplete at the moment.
1168 GENERATE_AUTOGEN_DEF   = NO
1170 #---------------------------------------------------------------------------
1171 # configuration options related to the Perl module output
1172 #---------------------------------------------------------------------------
1174 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1175 # generate a Perl module file that captures the structure of
1176 # the code including all documentation. Note that this
1177 # feature is still experimental and incomplete at the
1178 # moment.
1180 GENERATE_PERLMOD       = NO
1182 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1183 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1184 # to generate PDF and DVI output from the Perl module output.
1186 PERLMOD_LATEX          = NO
1188 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1189 # nicely formatted so it can be parsed by a human reader. 
1190 # This is useful 
1191 # if you want to understand what is going on. 
1192 # On the other hand, if this 
1193 # tag is set to NO the size of the Perl module output will be much smaller
1194 # and Perl will parse it just the same.
1196 PERLMOD_PRETTY         = YES
1198 # The names of the make variables in the generated doxyrules.make file
1199 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1200 # This is useful so different doxyrules.make files included by the same
1201 # Makefile don't overwrite each other's variables.
1203 PERLMOD_MAKEVAR_PREFIX =
1205 #---------------------------------------------------------------------------
1206 # Configuration options related to the preprocessor
1207 #---------------------------------------------------------------------------
1209 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1210 # evaluate all C-preprocessor directives found in the sources and include
1211 # files.
1213 ENABLE_PREPROCESSING   = YES
1215 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1216 # names in the source code. If set to NO (the default) only conditional
1217 # compilation will be performed. Macro expansion can be done in a controlled
1218 # way by setting EXPAND_ONLY_PREDEF to YES.
1220 MACRO_EXPANSION        = NO
1222 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1223 # then the macro expansion is limited to the macros specified with the
1224 # PREDEFINED and EXPAND_AS_DEFINED tags.
1226 EXPAND_ONLY_PREDEF     = NO
1228 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1229 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1231 SEARCH_INCLUDES        = YES
1233 # The INCLUDE_PATH tag can be used to specify one or more directories that
1234 # contain include files that are not input files but should be processed by
1235 # the preprocessor.
1237 INCLUDE_PATH           =
1239 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1240 # patterns (like *.h and *.hpp) to filter out the header-files in the
1241 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1242 # be used.
1244 INCLUDE_FILE_PATTERNS  = *.h
1246 # The PREDEFINED tag can be used to specify one or more macro names that
1247 # are defined before the preprocessor is started (similar to the -D option of
1248 # gcc). The argument of the tag is a list of macros of the form: name
1249 # or name=definition (no spaces). If the definition and the = are
1250 # omitted =1 is assumed. To prevent a macro definition from being
1251 # undefined via #undef or recursively expanded use the := operator
1252 # instead of the = operator.
1254 PREDEFINED             = HAVE_CONFIG_H
1256 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1257 # this tag can be used to specify a list of macro names that should be expanded.
1258 # The macro definition that is found in the sources will be used.
1259 # Use the PREDEFINED tag if you want to use a different macro definition.
1261 EXPAND_AS_DEFINED      =
1263 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1264 # doxygen's preprocessor will remove all function-like macros that are alone
1265 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1266 # function macros are typically used for boiler-plate code, and will confuse
1267 # the parser if not removed.
1269 SKIP_FUNCTION_MACROS   = YES
1271 #---------------------------------------------------------------------------
1272 # Configuration::additions related to external references
1273 #---------------------------------------------------------------------------
1275 # The TAGFILES option can be used to specify one or more tagfiles.
1276 # Optionally an initial location of the external documentation
1277 # can be added for each tagfile. The format of a tag file without
1278 # this location is as follows:
1279 #  
1280 #   TAGFILES = file1 file2 ...
1281 # Adding location for the tag files is done as follows:
1282 #  
1283 #   TAGFILES = file1=loc1 "file2 = loc2" ...
1284 # where "loc1" and "loc2" can be relative or absolute paths or
1285 # URLs. If a location is present for each tag, the installdox tool
1286 # does not have to be run to correct the links.
1287 # Note that each tag file must have a unique name
1288 # (where the name does NOT include the path)
1289 # If a tag file is not located in the directory in which doxygen
1290 # is run, you must also specify the path to the tagfile here.
1292 TAGFILES               =
1294 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1295 # a tag file that is based on the input files it reads.
1297 GENERATE_TAGFILE       =
1299 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1300 # in the class index. If set to NO only the inherited external classes
1301 # will be listed.
1303 ALLEXTERNALS           = NO
1305 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1306 # in the modules index. If set to NO, only the current project's groups will
1307 # be listed.
1309 EXTERNAL_GROUPS        = YES
1311 # The PERL_PATH should be the absolute path and name of the perl script
1312 # interpreter (i.e. the result of `which perl').
1314 PERL_PATH              = /usr/bin/perl
1316 #---------------------------------------------------------------------------
1317 # Configuration options related to the dot tool
1318 #---------------------------------------------------------------------------
1320 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1321 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1322 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1323 # this option is superseded by the HAVE_DOT option below. This is only a
1324 # fallback. It is recommended to install and use dot, since it yields more
1325 # powerful graphs.
1327 CLASS_DIAGRAMS         = YES
1329 # You can define message sequence charts within doxygen comments using the \msc
1330 # command. Doxygen will then run the mscgen tool (see
1331 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1332 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1333 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1334 # default search path.
1336 MSCGEN_PATH            =
1338 # If set to YES, the inheritance and collaboration graphs will hide
1339 # inheritance and usage relations if the target is undocumented
1340 # or is not a class.
1342 HIDE_UNDOC_RELATIONS   = YES
1344 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1345 # available from the path. This tool is part of Graphviz, a graph visualization
1346 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1347 # have no effect if this option is set to NO (the default)
1349 HAVE_DOT               = YES
1351 # By default doxygen will write a font called FreeSans.ttf to the output 
1352 # directory and reference it in all dot files that doxygen generates. This 
1353 # font does not include all possible unicode characters however, so when you need 
1354 # these (or just want a differently looking font) you can specify the font name 
1355 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
1356 # which can be done by putting it in a standard location or by setting the 
1357 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1358 # containing the font.
1360 DOT_FONTNAME           = FreeSans
1362 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
1363 # The default size is 10pt.
1365 DOT_FONTSIZE           = 10
1367 # By default doxygen will tell dot to use the output directory to look for the 
1368 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1369 # different font using DOT_FONTNAME you can set the path where dot 
1370 # can find it using this tag.
1372 DOT_FONTPATH           = 
1374 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1375 # will generate a graph for each documented class showing the direct and
1376 # indirect inheritance relations. Setting this tag to YES will force the
1377 # the CLASS_DIAGRAMS tag to NO.
1379 CLASS_GRAPH            = YES
1381 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1382 # will generate a graph for each documented class showing the direct and
1383 # indirect implementation dependencies (inheritance, containment, and
1384 # class references variables) of the class with other documented classes.
1386 COLLABORATION_GRAPH    = YES
1388 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1389 # will generate a graph for groups, showing the direct groups dependencies
1391 GROUP_GRAPHS           = YES
1393 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1394 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1395 # Language.
1397 UML_LOOK               = NO
1399 # If set to YES, the inheritance and collaboration graphs will show the
1400 # relations between templates and their instances.
1402 TEMPLATE_RELATIONS     = YES
1404 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1405 # tags are set to YES then doxygen will generate a graph for each documented
1406 # file showing the direct and indirect include dependencies of the file with
1407 # other documented files.
1409 INCLUDE_GRAPH          = YES
1411 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1412 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1413 # documented header file showing the documented files that directly or
1414 # indirectly include this file.
1416 INCLUDED_BY_GRAPH      = YES
1418 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1419 # doxygen will generate a call dependency graph for every global function
1420 # or class method. Note that enabling this option will significantly increase
1421 # the time of a run. So in most cases it will be better to enable call graphs
1422 # for selected functions only using the \callgraph command.
1424 CALL_GRAPH             = NO
1426 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1427 # doxygen will generate a caller dependency graph for every global function
1428 # or class method. Note that enabling this option will significantly increase
1429 # the time of a run. So in most cases it will be better to enable caller
1430 # graphs for selected functions only using the \callergraph command.
1432 CALLER_GRAPH           = NO
1434 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1435 # will graphical hierarchy of all classes instead of a textual one.
1437 GRAPHICAL_HIERARCHY    = YES
1439 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1440 # then doxygen will show the dependencies a directory has on other directories
1441 # in a graphical way. The dependency relations are determined by the #include
1442 # relations between the files in the directories.
1444 DIRECTORY_GRAPH        = YES
1446 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1447 # generated by dot. Possible values are png, jpg, or gif
1448 # If left blank png will be used.
1450 DOT_IMAGE_FORMAT       = png
1452 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1453 # found. If left blank, it is assumed the dot tool can be found in the path.
1455 DOT_PATH               =
1457 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1458 # contain dot files that are included in the documentation (see the
1459 # \dotfile command).
1461 DOTFILE_DIRS           =
1463 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1464 # nodes that will be shown in the graph. If the number of nodes in a graph
1465 # becomes larger than this value, doxygen will truncate the graph, which is
1466 # visualized by representing a node as a red box. Note that doxygen if the
1467 # number of direct children of the root node in a graph is already larger than
1468 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1469 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1471 DOT_GRAPH_MAX_NODES    = 50
1473 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1474 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1475 # from the root by following a path via at most 3 edges will be shown. Nodes
1476 # that lay further from the root node will be omitted. Note that setting this
1477 # option to 1 or 2 may greatly reduce the computation time needed for large
1478 # code bases. Also note that the size of a graph can be further restricted by
1479 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1481 MAX_DOT_GRAPH_DEPTH    = 0
1483 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1484 # background. This is disabled by default, because dot on Windows does not 
1485 # seem to support this out of the box. Warning: Depending on the platform used, 
1486 # enabling this option may lead to badly anti-aliased labels on the edges of 
1487 # a graph (i.e. they become hard to read).
1489 DOT_TRANSPARENT        = NO
1491 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1492 # files in one run (i.e. multiple -o and -T options on the command line). This
1493 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1494 # support this, this feature is disabled by default.
1496 DOT_MULTI_TARGETS      = NO
1498 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1499 # generate a legend page explaining the meaning of the various boxes and
1500 # arrows in the dot generated graphs.
1502 GENERATE_LEGEND        = YES
1504 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1505 # remove the intermediate dot files that are used to generate
1506 # the various graphs.
1508 DOT_CLEANUP            = YES
1510 #---------------------------------------------------------------------------
1511 # Options related to the search engine
1512 #---------------------------------------------------------------------------
1514 # The SEARCHENGINE tag specifies whether or not a search engine should be
1515 # used. If set to NO the values of all tags below this one will be ignored.
1517 SEARCHENGINE           = NO