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
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 that
18 # follow. The default is UTF-8 which is also the encoding used for all text before
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
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.
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 = 2.4.0
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.
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.
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, Finnish, French, German, Greek, Hungarian,
58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62 OUTPUT_LANGUAGE = French
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
67 # Set to NO to disable this.
69 BRIEF_MEMBER_DESC = YES
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # brief descriptions will be completely suppressed.
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
86 # "represents" "a" "an" "the"
88 ABBREVIATE_BRIEF = "The $name class " \
100 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
101 # Doxygen will generate a detailed section even if there is only a brief
104 ALWAYS_DETAILED_SEC = NO
106 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
107 # inherited members of a class in the documentation of that class as if those
108 # members were ordinary class members. Constructors, destructors and assignment
109 # operators of the base classes will not be shown.
111 INLINE_INHERITED_MEMB = NO
113 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
114 # path before files name in the file list and in the header files. If set
115 # to NO the shortest path that makes the file name unique will be used.
117 FULL_PATH_NAMES = YES
119 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
120 # can be used to strip a user-defined part of the path. Stripping is
121 # only done if one of the specified strings matches the left-hand part of
122 # the path. The tag can be used to show relative paths in the file list.
123 # If left blank the directory from which doxygen is run is used as the
126 STRIP_FROM_PATH = /home/piccaf/Projets/hkl/git/src/
128 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
129 # the path mentioned in the documentation of a class, which tells
130 # the reader which header file to include in order to use a class.
131 # If left blank only the name of the header file containing the class
132 # definition is used. Otherwise one should specify the include paths that
133 # are normally passed to the compiler using the -I flag.
135 STRIP_FROM_INC_PATH =
137 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
138 # (but less readable) file names. This can be useful is your file systems
139 # doesn't support long names like on DOS, Mac, or CD-ROM.
143 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
144 # will interpret the first line (until the first dot) of a JavaDoc-style
145 # comment as the brief description. If set to NO, the JavaDoc
146 # comments will behave just like regular Qt-style comments
147 # (thus requiring an explicit @brief command for a brief description.)
149 JAVADOC_AUTOBRIEF = NO
151 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
152 # interpret the first line (until the first dot) of a Qt-style
153 # comment as the brief description. If set to NO, the comments
154 # will behave just like regular Qt-style comments (thus requiring
155 # an explicit \brief command for a brief description.)
159 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
160 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
161 # comments) as a brief description. This used to be the default behaviour.
162 # The new default is to treat a multi-line C++ comment block as a detailed
163 # description. Set this tag to YES if you prefer the old behaviour instead.
165 MULTILINE_CPP_IS_BRIEF = NO
167 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
168 # will output the detailed description near the top, like JavaDoc.
169 # If set to NO, the detailed description appears after the member
174 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175 # member inherits the documentation from any documented member that it
180 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181 # a new page for each member. If set to NO, the documentation of a member will
182 # be part of the file/class/namespace that contains it.
184 SEPARATE_MEMBER_PAGES = NO
186 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
187 # Doxygen uses this value to replace tabs by spaces in code fragments.
191 # This tag can be used to specify a number of aliases that acts
192 # as commands in the documentation. An alias has the form "name=value".
193 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
194 # put the command \sideeffect (or @sideeffect) in the documentation, which
195 # will result in a user-defined paragraph with heading "Side Effects:".
196 # You can put \n's in the value part of an alias to insert newlines.
200 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
201 # sources only. Doxygen will then generate output that is more tailored for C.
202 # For instance, some of the names that are used will be different. The list
203 # of all members will be omitted, etc.
205 OPTIMIZE_OUTPUT_FOR_C = NO
207 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
208 # sources only. Doxygen will then generate output that is more tailored for Java.
209 # For instance, namespaces will be presented as packages, qualified scopes
210 # will look different, etc.
212 OPTIMIZE_OUTPUT_JAVA = NO
214 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
215 # include (a tag file for) the STL sources as input, then you should
216 # set this tag to YES in order to let doxygen match functions declarations and
217 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
218 # func(std::string) {}). This also make the inheritance and collaboration
219 # diagrams that involve STL classes more complete and accurate.
221 BUILTIN_STL_SUPPORT = YES
223 # If you use Microsoft's C++/CLI language, you should set this option to YES to
224 # enable parsing support.
228 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
229 # tag is set to YES, then doxygen will reuse the documentation of the first
230 # member in the group (if any) for the other members of the group. By default
231 # all members of a group must be documented explicitly.
233 DISTRIBUTE_GROUP_DOC = NO
235 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
236 # the same type (for instance a group of public functions) to be put as a
237 # subgroup of that type (e.g. under the Public Functions section). Set it to
238 # NO to prevent subgrouping. Alternatively, this can be done per class using
239 # the \nosubgrouping command.
243 #---------------------------------------------------------------------------
244 # Build related configuration options
245 #---------------------------------------------------------------------------
247 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
248 # documentation are documented, even if no documentation was available.
249 # Private class members and static file members will be hidden unless
250 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
254 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
255 # will be included in the documentation.
257 EXTRACT_PRIVATE = YES
259 # If the EXTRACT_STATIC tag is set to YES all static members of a file
260 # will be included in the documentation.
264 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
265 # defined locally in source files will be included in the documentation.
266 # If set to NO only classes defined in header files are included.
268 EXTRACT_LOCAL_CLASSES = YES
270 # This flag is only useful for Objective-C code. When set to YES local
271 # methods, which are defined in the implementation section but not in
272 # the interface are included in the documentation.
273 # If set to NO (the default) only methods in the interface are included.
275 EXTRACT_LOCAL_METHODS = NO
277 # If this flag is set to YES, the members of anonymous namespaces will be extracted
278 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
279 # where file will be replaced with the base name of the file that contains the anonymous
280 # namespace. By default anonymous namespace are hidden.
282 EXTRACT_ANON_NSPACES = NO
284 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
285 # undocumented members of documented classes, files or namespaces.
286 # If set to NO (the default) these members will be included in the
287 # various overviews, but no documentation section is generated.
288 # This option has no effect if EXTRACT_ALL is enabled.
290 HIDE_UNDOC_MEMBERS = YES
292 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
293 # undocumented classes that are normally visible in the class hierarchy.
294 # If set to NO (the default) these classes will be included in the various
295 # overviews. This option has no effect if EXTRACT_ALL is enabled.
297 HIDE_UNDOC_CLASSES = YES
299 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
300 # friend (class|struct|union) declarations.
301 # If set to NO (the default) these declarations will be included in the
304 HIDE_FRIEND_COMPOUNDS = NO
306 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
307 # documentation blocks found inside the body of a function.
308 # If set to NO (the default) these blocks will be appended to the
309 # function's detailed documentation block.
311 HIDE_IN_BODY_DOCS = NO
313 # The INTERNAL_DOCS tag determines if documentation
314 # that is typed after a \internal command is included. If the tag is set
315 # to NO (the default) then the documentation will be excluded.
316 # Set it to YES to include the internal documentation.
320 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
321 # file names in lower-case letters. If set to YES upper-case letters are also
322 # allowed. This is useful if you have classes or files whose names only differ
323 # in case and if your file system supports case sensitive file names. Windows
324 # and Mac users are advised to set this option to NO.
326 CASE_SENSE_NAMES = YES
328 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
329 # will show members with their full class and namespace scopes in the
330 # documentation. If set to YES the scope will be hidden.
332 HIDE_SCOPE_NAMES = NO
334 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
335 # will put a list of the files that are included by a file in the documentation
338 SHOW_INCLUDE_FILES = YES
340 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
341 # is inserted in the documentation for inline members.
345 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
346 # will sort the (detailed) documentation of file and class members
347 # alphabetically by member name. If set to NO the members will appear in
350 SORT_MEMBER_DOCS = YES
352 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
353 # brief documentation of file, namespace and class members alphabetically
354 # by member name. If set to NO (the default) the members will appear in
357 SORT_BRIEF_DOCS = YES
359 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
360 # sorted by fully-qualified names, including namespaces. If set to
361 # NO (the default), the class list will be sorted only by class name,
362 # not including the namespace part.
363 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
364 # Note: This option applies only to the class list, not to the
367 SORT_BY_SCOPE_NAME = NO
369 # The GENERATE_TODOLIST tag can be used to enable (YES) or
370 # disable (NO) the todo list. This list is created by putting \todo
371 # commands in the documentation.
373 GENERATE_TODOLIST = YES
375 # The GENERATE_TESTLIST tag can be used to enable (YES) or
376 # disable (NO) the test list. This list is created by putting \test
377 # commands in the documentation.
379 GENERATE_TESTLIST = YES
381 # The GENERATE_BUGLIST tag can be used to enable (YES) or
382 # disable (NO) the bug list. This list is created by putting \bug
383 # commands in the documentation.
385 GENERATE_BUGLIST = YES
387 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
388 # disable (NO) the deprecated list. This list is created by putting
389 # \deprecated commands in the documentation.
391 GENERATE_DEPRECATEDLIST= YES
393 # The ENABLED_SECTIONS tag can be used to enable conditional
394 # documentation sections, marked by \if sectionname ... \endif.
398 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
399 # the initial value of a variable or define consists of for it to appear in
400 # the documentation. If the initializer consists of more lines than specified
401 # here it will be hidden. Use a value of 0 to hide initializers completely.
402 # The appearance of the initializer of individual variables and defines in the
403 # documentation can be controlled using \showinitializer or \hideinitializer
404 # command in the documentation regardless of this setting.
406 MAX_INITIALIZER_LINES = 30
408 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
409 # at the bottom of the documentation of classes and structs. If set to YES the
410 # list will mention the files that were used to generate the documentation.
412 SHOW_USED_FILES = YES
414 # If the sources in your project are distributed over multiple directories
415 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
416 # in the documentation. The default is NO.
418 SHOW_DIRECTORIES = YES
420 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
421 # doxygen should invoke to get the current version for each file (typically from the
422 # version control system). Doxygen will invoke the program by executing (via
423 # popen()) the command <command> <input-file>, where <command> is the value of
424 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
425 # provided by doxygen. Whatever the program writes to standard output
426 # is used as the file version. See the manual for examples.
428 FILE_VERSION_FILTER =
430 #---------------------------------------------------------------------------
431 # configuration options related to warning and progress messages
432 #---------------------------------------------------------------------------
434 # The QUIET tag can be used to turn on/off the messages that are generated
435 # by doxygen. Possible values are YES and NO. If left blank NO is used.
439 # The WARNINGS tag can be used to turn on/off the warning messages that are
440 # generated by doxygen. Possible values are YES and NO. If left blank
445 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
446 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
447 # automatically be disabled.
449 WARN_IF_UNDOCUMENTED = YES
451 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
452 # potential errors in the documentation, such as not documenting some
453 # parameters in a documented function, or documenting parameters that
454 # don't exist or using markup commands wrongly.
456 WARN_IF_DOC_ERROR = YES
458 # This WARN_NO_PARAMDOC option can be abled to get warnings for
459 # functions that are documented, but have no documentation for their parameters
460 # or return value. If set to NO (the default) doxygen will only warn about
461 # wrong or incomplete parameter documentation, but not about the absence of
464 WARN_NO_PARAMDOC = NO
466 # The WARN_FORMAT tag determines the format of the warning messages that
467 # doxygen can produce. The string should contain the $file, $line, and $text
468 # tags, which will be replaced by the file and line number from which the
469 # warning originated and the warning text. Optionally the format may contain
470 # $version, which will be replaced by the version of the file (if it could
471 # be obtained via FILE_VERSION_FILTER)
473 WARN_FORMAT = "$file:$line: $text "
475 # The WARN_LOGFILE tag can be used to specify a file to which warning
476 # and error messages should be written. If left blank the output is written
481 #---------------------------------------------------------------------------
482 # configuration options related to the input files
483 #---------------------------------------------------------------------------
485 # The INPUT tag can be used to specify the files and/or directories that contain
486 # documented source files. You may enter file names like "myfile.cpp" or
487 # directories like "/usr/src/myproject". Separate the files or directories
490 INPUT = ../include/hkl \
493 # This tag can be used to specify the character encoding of the source files that
494 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
495 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
496 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
498 INPUT_ENCODING = UTF-8
500 # If the value of the INPUT tag contains directories, you can use the
501 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
502 # and *.h) to filter out the source-files in the directories. If left
503 # blank the following patterns are tested:
504 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
505 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
507 FILE_PATTERNS = *.c \
546 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
547 # should be searched for input files as well. Possible values are YES and NO.
548 # If left blank NO is used.
552 # The EXCLUDE tag can be used to specify files and/or directories that should
553 # excluded from the INPUT source files. This way you can easily exclude a
554 # subdirectory from a directory tree whose root is specified with the INPUT tag.
558 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
559 # directories that are symbolic links (a Unix filesystem feature) are excluded
562 EXCLUDE_SYMLINKS = NO
564 # If the value of the INPUT tag contains directories, you can use the
565 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
566 # certain files from those directories. Note that the wildcards are matched
567 # against the file with absolute path, so to exclude all test directories
568 # for example use the pattern */test/*
572 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
573 # (namespaces, classes, functions, etc.) that should be excluded from the output.
574 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
575 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
579 # The EXAMPLE_PATH tag can be used to specify one or more files or
580 # directories that contain example code fragments that are included (see
581 # the \include command).
585 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
586 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
587 # and *.h) to filter out the source-files in the directories. If left
588 # blank all files are included.
592 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
593 # searched for input files to be used with the \include or \dontinclude
594 # commands irrespective of the value of the RECURSIVE tag.
595 # Possible values are YES and NO. If left blank NO is used.
597 EXAMPLE_RECURSIVE = NO
599 # The IMAGE_PATH tag can be used to specify one or more files or
600 # directories that contain image that are included in the documentation (see
601 # the \image command).
605 # The INPUT_FILTER tag can be used to specify a program that doxygen should
606 # invoke to filter for each input file. Doxygen will invoke the filter program
607 # by executing (via popen()) the command <filter> <input-file>, where <filter>
608 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
609 # input file. Doxygen will then use the output that the filter program writes
610 # to standard output. If FILTER_PATTERNS is specified, this tag will be
615 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
616 # basis. Doxygen will compare the file name with each pattern and apply the
617 # filter if there is a match. The filters are a list of the form:
618 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
619 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
620 # is applied to all files.
624 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
625 # INPUT_FILTER) will be used to filter the input files when producing source
626 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
628 FILTER_SOURCE_FILES = NO
630 #---------------------------------------------------------------------------
631 # configuration options related to source browsing
632 #---------------------------------------------------------------------------
634 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
635 # be generated. Documented entities will be cross-referenced with these sources.
636 # Note: To get rid of all source code in the generated output, make sure also
637 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
638 # then you must also enable this option. If you don't then doxygen will produce
639 # a warning and turn it on anyway
643 # Setting the INLINE_SOURCES tag to YES will include the body
644 # of functions and classes directly in the documentation.
648 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
649 # doxygen to hide any special comment blocks from generated source code
650 # fragments. Normal C and C++ comments will always remain visible.
652 STRIP_CODE_COMMENTS = YES
654 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
655 # then for each documented function all documented
656 # functions referencing it will be listed.
658 REFERENCED_BY_RELATION = YES
660 # If the REFERENCES_RELATION tag is set to YES (the default)
661 # then for each documented function all documented entities
662 # called/used by that function will be listed.
664 REFERENCES_RELATION = YES
666 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
667 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
668 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
669 # link to the source code. Otherwise they will link to the documentstion.
671 REFERENCES_LINK_SOURCE = YES
673 # If the USE_HTAGS tag is set to YES then the references to source code
674 # will point to the HTML generated by the htags(1) tool instead of doxygen
675 # built-in source browser. The htags tool is part of GNU's global source
676 # tagging system (see http://www.gnu.org/software/global/global.html). You
677 # will need version 4.8.6 or higher.
681 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
682 # will generate a verbatim copy of the header file for each class for
683 # which an include is specified. Set to NO to disable this.
685 VERBATIM_HEADERS = YES
687 #---------------------------------------------------------------------------
688 # configuration options related to the alphabetical class index
689 #---------------------------------------------------------------------------
691 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
692 # of all compounds will be generated. Enable this if the project
693 # contains a lot of classes, structs, unions or interfaces.
695 ALPHABETICAL_INDEX = NO
697 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
698 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
699 # in which this list will be split (can be a number in the range [1..20])
701 COLS_IN_ALPHA_INDEX = 5
703 # In case all classes in a project start with a common prefix, all
704 # classes will be put under the same header in the alphabetical index.
705 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
706 # should be ignored while generating the index headers.
710 #---------------------------------------------------------------------------
711 # configuration options related to the HTML output
712 #---------------------------------------------------------------------------
714 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
715 # generate HTML output.
719 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
720 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
721 # put in front of it. If left blank `html' will be used as the default path.
725 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
726 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
727 # doxygen will generate files with .html extension.
729 HTML_FILE_EXTENSION = .html
731 # The HTML_HEADER tag can be used to specify a personal HTML header for
732 # each generated HTML page. If it is left blank doxygen will generate a
737 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
738 # each generated HTML page. If it is left blank doxygen will generate a
743 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
744 # style sheet that is used by each HTML page. It can be used to
745 # fine-tune the look of the HTML output. If the tag is left blank doxygen
746 # will generate a default style sheet. Note that doxygen will try to copy
747 # the style sheet file to the HTML output directory, so don't put your own
748 # stylesheet in the HTML output directory as well, or it will be erased!
752 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
753 # files or namespaces will be aligned in HTML using tables. If set to
754 # NO a bullet list will be used.
756 HTML_ALIGN_MEMBERS = YES
758 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
759 # will be generated that can be used as input for tools like the
760 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
761 # of the generated HTML documentation.
763 GENERATE_HTMLHELP = NO
765 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
766 # documentation will contain sections that can be hidden and shown after the
767 # page has loaded. For this to work a browser that supports
768 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
769 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
771 HTML_DYNAMIC_SECTIONS = NO
773 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
774 # be used to specify the file name of the resulting .chm file. You
775 # can add a path in front of the file if the result should not be
776 # written to the html output directory.
780 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
781 # be used to specify the location (absolute path including file name) of
782 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
783 # the HTML help compiler on the generated index.hhp.
787 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
788 # controls if a separate .chi index file is generated (YES) or that
789 # it should be included in the master .chm file (NO).
793 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
794 # controls whether a binary table of contents is generated (YES) or a
795 # normal table of contents (NO) in the .chm file.
799 # The TOC_EXPAND flag can be set to YES to add extra items for group members
800 # to the contents of the HTML help documentation and to the tree view.
804 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
805 # top of each HTML page. The value NO (the default) enables the index and
806 # the value YES disables it.
810 # This tag can be used to set the number of enum values (range [1..20])
811 # that doxygen will group on one line in the generated HTML documentation.
813 ENUM_VALUES_PER_LINE = 4
815 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
816 # generated containing a tree-like index structure (just like the one that
817 # is generated for HTML Help). For this to work a browser that supports
818 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
819 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
820 # probably better off using the HTML help feature.
822 GENERATE_TREEVIEW = YES
824 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
825 # used to set the initial width (in pixels) of the frame in which the tree
830 #---------------------------------------------------------------------------
831 # configuration options related to the LaTeX output
832 #---------------------------------------------------------------------------
834 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
835 # generate Latex output.
839 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
840 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
841 # put in front of it. If left blank `latex' will be used as the default path.
845 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
846 # invoked. If left blank `latex' will be used as the default command name.
848 LATEX_CMD_NAME = latex
850 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
851 # generate index for LaTeX. If left blank `makeindex' will be used as the
852 # default command name.
854 MAKEINDEX_CMD_NAME = makeindex
856 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
857 # LaTeX documents. This may be useful for small projects and may help to
858 # save some trees in general.
862 # The PAPER_TYPE tag can be used to set the paper type that is used
863 # by the printer. Possible values are: a4, a4wide, letter, legal and
864 # executive. If left blank a4wide will be used.
868 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
869 # packages that should be included in the LaTeX output.
871 EXTRA_PACKAGES = amsmath
873 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
874 # the generated latex document. The header should contain everything until
875 # the first chapter. If it is left blank doxygen will generate a
876 # standard header. Notice: only use this tag if you know what you are doing!
880 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
881 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
882 # contain links (just like the HTML output) instead of page references
883 # This makes the output suitable for online browsing using a pdf viewer.
887 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
888 # plain latex in the generated Makefile. Set this option to YES to get a
889 # higher quality PDF documentation.
893 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
894 # command to the generated LaTeX files. This will instruct LaTeX to keep
895 # running if errors occur, instead of asking the user for help.
896 # This option is also used when generating formulas in HTML.
900 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
901 # include the index chapters (such as File Index, Compound Index, etc.)
904 LATEX_HIDE_INDICES = NO
906 #---------------------------------------------------------------------------
907 # configuration options related to the RTF output
908 #---------------------------------------------------------------------------
910 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
911 # The RTF output is optimized for Word 97 and may not look very pretty with
912 # other RTF readers or editors.
916 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
917 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
918 # put in front of it. If left blank `rtf' will be used as the default path.
922 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
923 # RTF documents. This may be useful for small projects and may help to
924 # save some trees in general.
928 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
929 # will contain hyperlink fields. The RTF file will
930 # contain links (just like the HTML output) instead of page references.
931 # This makes the output suitable for online browsing using WORD or other
932 # programs which support those fields.
933 # Note: wordpad (write) and others do not support links.
937 # Load stylesheet definitions from file. Syntax is similar to doxygen's
938 # config file, i.e. a series of assignments. You only have to provide
939 # replacements, missing definitions are set to their default value.
941 RTF_STYLESHEET_FILE =
943 # Set optional variables used in the generation of an rtf document.
944 # Syntax is similar to doxygen's config file.
946 RTF_EXTENSIONS_FILE =
948 #---------------------------------------------------------------------------
949 # configuration options related to the man page output
950 #---------------------------------------------------------------------------
952 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
957 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
958 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
959 # put in front of it. If left blank `man' will be used as the default path.
963 # The MAN_EXTENSION tag determines the extension that is added to
964 # the generated man pages (default is the subroutine's section .3)
968 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
969 # then it will generate one additional man file for each entity
970 # documented in the real man page(s). These additional files
971 # only source the real man page, but without them the man command
972 # would be unable to find the correct page. The default is NO.
976 #---------------------------------------------------------------------------
977 # configuration options related to the XML output
978 #---------------------------------------------------------------------------
980 # If the GENERATE_XML tag is set to YES Doxygen will
981 # generate an XML file that captures the structure of
982 # the code including all documentation.
986 # The XML_OUTPUT tag is used to specify where the XML pages 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 `xml' will be used as the default path.
992 # The XML_SCHEMA tag can be used to specify an XML schema,
993 # which can be used by a validating XML parser to check the
994 # syntax of the XML files.
998 # The XML_DTD tag can be used to specify an XML DTD,
999 # which can be used by a validating XML parser to check the
1000 # syntax of the XML files.
1004 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1005 # dump the program listings (including syntax highlighting
1006 # and cross-referencing information) to the XML output. Note that
1007 # enabling this will significantly increase the size of the XML output.
1009 XML_PROGRAMLISTING = YES
1011 #---------------------------------------------------------------------------
1012 # configuration options for the AutoGen Definitions output
1013 #---------------------------------------------------------------------------
1015 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1016 # generate an AutoGen Definitions (see autogen.sf.net) file
1017 # that captures the structure of the code including all
1018 # documentation. Note that this feature is still experimental
1019 # and incomplete at the moment.
1021 GENERATE_AUTOGEN_DEF = NO
1023 #---------------------------------------------------------------------------
1024 # configuration options related to the Perl module output
1025 #---------------------------------------------------------------------------
1027 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1028 # generate a Perl module file that captures the structure of
1029 # the code including all documentation. Note that this
1030 # feature is still experimental and incomplete at the
1033 GENERATE_PERLMOD = NO
1035 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1036 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1037 # to generate PDF and DVI output from the Perl module output.
1041 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1042 # nicely formatted so it can be parsed by a human reader. This is useful
1043 # if you want to understand what is going on. On the other hand, if this
1044 # tag is set to NO the size of the Perl module output will be much smaller
1045 # and Perl will parse it just the same.
1047 PERLMOD_PRETTY = YES
1049 # The names of the make variables in the generated doxyrules.make file
1050 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1051 # This is useful so different doxyrules.make files included by the same
1052 # Makefile don't overwrite each other's variables.
1054 PERLMOD_MAKEVAR_PREFIX =
1056 #---------------------------------------------------------------------------
1057 # Configuration options related to the preprocessor
1058 #---------------------------------------------------------------------------
1060 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1061 # evaluate all C-preprocessor directives found in the sources and include
1064 ENABLE_PREPROCESSING = YES
1066 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1067 # names in the source code. If set to NO (the default) only conditional
1068 # compilation will be performed. Macro expansion can be done in a controlled
1069 # way by setting EXPAND_ONLY_PREDEF to YES.
1071 MACRO_EXPANSION = NO
1073 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1074 # then the macro expansion is limited to the macros specified with the
1075 # PREDEFINED and EXPAND_AS_DEFINED tags.
1077 EXPAND_ONLY_PREDEF = NO
1079 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1080 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1082 SEARCH_INCLUDES = YES
1084 # The INCLUDE_PATH tag can be used to specify one or more directories that
1085 # contain include files that are not input files but should be processed by
1090 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1091 # patterns (like *.h and *.hpp) to filter out the header-files in the
1092 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1095 INCLUDE_FILE_PATTERNS =
1097 # The PREDEFINED tag can be used to specify one or more macro names that
1098 # are defined before the preprocessor is started (similar to the -D option of
1099 # gcc). The argument of the tag is a list of macros of the form: name
1100 # or name=definition (no spaces). If the definition and the = are
1101 # omitted =1 is assumed. To prevent a macro definition from being
1102 # undefined via #undef or recursively expanded use the := operator
1103 # instead of the = operator.
1107 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1108 # this tag can be used to specify a list of macro names that should be expanded.
1109 # The macro definition that is found in the sources will be used.
1110 # Use the PREDEFINED tag if you want to use a different macro definition.
1114 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1115 # doxygen's preprocessor will remove all function-like macros that are alone
1116 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1117 # function macros are typically used for boiler-plate code, and will confuse
1118 # the parser if not removed.
1120 SKIP_FUNCTION_MACROS = YES
1122 #---------------------------------------------------------------------------
1123 # Configuration::additions related to external references
1124 #---------------------------------------------------------------------------
1126 # The TAGFILES option can be used to specify one or more tagfiles.
1127 # Optionally an initial location of the external documentation
1128 # can be added for each tagfile. The format of a tag file without
1129 # this location is as follows:
1130 # TAGFILES = file1 file2 ...
1131 # Adding location for the tag files is done as follows:
1132 # TAGFILES = file1=loc1 "file2 = loc2" ...
1133 # where "loc1" and "loc2" can be relative or absolute paths or
1134 # URLs. If a location is present for each tag, the installdox tool
1135 # does not have to be run to correct the links.
1136 # Note that each tag file must have a unique name
1137 # (where the name does NOT include the path)
1138 # If a tag file is not located in the directory in which doxygen
1139 # is run, you must also specify the path to the tagfile here.
1143 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1144 # a tag file that is based on the input files it reads.
1148 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1149 # in the class index. If set to NO only the inherited external classes
1154 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1155 # in the modules index. If set to NO, only the current project's groups will
1158 EXTERNAL_GROUPS = YES
1160 # The PERL_PATH should be the absolute path and name of the perl script
1161 # interpreter (i.e. the result of `which perl').
1163 PERL_PATH = /usr/bin/perl
1165 #---------------------------------------------------------------------------
1166 # Configuration options related to the dot tool
1167 #---------------------------------------------------------------------------
1169 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1170 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1171 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1172 # this option is superseded by the HAVE_DOT option below. This is only a
1173 # fallback. It is recommended to install and use dot, since it yields more
1178 # You can define message sequence charts within doxygen comments using the \msc
1179 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1180 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1181 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1182 # be found in the default search path.
1186 # If set to YES, the inheritance and collaboration graphs will hide
1187 # inheritance and usage relations if the target is undocumented
1188 # or is not a class.
1190 HIDE_UNDOC_RELATIONS = YES
1192 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1193 # available from the path. This tool is part of Graphviz, a graph visualization
1194 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1195 # have no effect if this option is set to NO (the default)
1199 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1200 # will generate a graph for each documented class showing the direct and
1201 # indirect inheritance relations. Setting this tag to YES will force the
1202 # the CLASS_DIAGRAMS tag to NO.
1206 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1207 # will generate a graph for each documented class showing the direct and
1208 # indirect implementation dependencies (inheritance, containment, and
1209 # class references variables) of the class with other documented classes.
1211 COLLABORATION_GRAPH = NO
1213 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1214 # will generate a graph for groups, showing the direct groups dependencies
1218 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1219 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1224 # If set to YES, the inheritance and collaboration graphs will show the
1225 # relations between templates and their instances.
1227 TEMPLATE_RELATIONS = YES
1229 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1230 # tags are set to YES then doxygen will generate a graph for each documented
1231 # file showing the direct and indirect include dependencies of the file with
1232 # other documented files.
1236 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1237 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1238 # documented header file showing the documented files that directly or
1239 # indirectly include this file.
1241 INCLUDED_BY_GRAPH = NO
1243 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1244 # generate a call dependency graph for every global function or class method.
1245 # Note that enabling this option will significantly increase the time of a run.
1246 # So in most cases it will be better to enable call graphs for selected
1247 # functions only using the \callgraph command.
1251 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1252 # generate a caller dependency graph for every global function or class method.
1253 # Note that enabling this option will significantly increase the time of a run.
1254 # So in most cases it will be better to enable caller graphs for selected
1255 # functions only using the \callergraph command.
1259 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1260 # will graphical hierarchy of all classes instead of a textual one.
1262 GRAPHICAL_HIERARCHY = NO
1264 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1265 # then doxygen will show the dependencies a directory has on other directories
1266 # in a graphical way. The dependency relations are determined by the #include
1267 # relations between the files in the directories.
1269 DIRECTORY_GRAPH = NO
1271 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1272 # generated by dot. Possible values are png, jpg, or gif
1273 # If left blank png will be used.
1275 DOT_IMAGE_FORMAT = png
1277 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1278 # found. If left blank, it is assumed the dot tool can be found in the path.
1282 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1283 # contain dot files that are included in the documentation (see the
1284 # \dotfile command).
1288 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1289 # nodes that will be shown in the graph. If the number of nodes in a graph
1290 # becomes larger than this value, doxygen will truncate the graph, which is
1291 # visualized by representing a node as a red box. Note that doxygen if the number
1292 # of direct children of the root node in a graph is already larger than
1293 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1294 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1296 DOT_GRAPH_MAX_NODES = 50
1298 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1299 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1300 # from the root by following a path via at most 3 edges will be shown. Nodes
1301 # that lay further from the root node will be omitted. Note that setting this
1302 # option to 1 or 2 may greatly reduce the computation time needed for large
1303 # code bases. Also note that the size of a graph can be further restricted by
1304 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1306 MAX_DOT_GRAPH_DEPTH = 1000
1308 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1309 # background. This is disabled by default, which results in a white background.
1310 # Warning: Depending on the platform used, enabling this option may lead to
1311 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1314 DOT_TRANSPARENT = NO
1316 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1317 # files in one run (i.e. multiple -o and -T options on the command line). This
1318 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1319 # support this, this feature is disabled by default.
1321 DOT_MULTI_TARGETS = YES
1323 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1324 # generate a legend page explaining the meaning of the various boxes and
1325 # arrows in the dot generated graphs.
1327 GENERATE_LEGEND = YES
1329 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1330 # remove the intermediate dot files that are used to generate
1331 # the various graphs.
1335 #---------------------------------------------------------------------------
1336 # Configuration::additions related to the search engine
1337 #---------------------------------------------------------------------------
1339 # The SEARCHENGINE tag specifies whether or not a search engine should be
1340 # used. If set to NO the values of all tags below this one will be ignored.