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.
28 PROJECT_NAME = OpenChange
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 = @PACKAGE_VERSION@
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 = apidocs
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 = English
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"
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91 # Doxygen will generate a detailed section even if there is only a brief
94 ALWAYS_DETAILED_SEC = NO
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97 # inherited members of a class in the documentation of that class as if those
98 # members were ordinary class members. Constructors, destructors and assignment
99 # operators of the base classes will not be shown.
101 INLINE_INHERITED_MEMB = NO
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104 # path before files name in the file list and in the header files. If set
105 # to NO the shortest path that makes the file name unique will be used.
107 FULL_PATH_NAMES = YES
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110 # can be used to strip a user-defined part of the path. Stripping is
111 # only done if one of the specified strings matches the left-hand part of
112 # the path. The tag can be used to show relative paths in the file list.
113 # If left blank the directory from which doxygen is run is used as the
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119 # the path mentioned in the documentation of a class, which tells
120 # the reader which header file to include in order to use a class.
121 # If left blank only the name of the header file containing the class
122 # definition is used. Otherwise one should specify the include paths that
123 # are normally passed to the compiler using the -I flag.
125 STRIP_FROM_INC_PATH =
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128 # (but less readable) file names. This can be useful is your file systems
129 # doesn't support long names like on DOS, Mac, or CD-ROM.
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134 # will interpret the first line (until the first dot) of a JavaDoc-style
135 # comment as the brief description. If set to NO, the JavaDoc
136 # comments will behave just like the Qt-style comments (thus requiring an
137 # explicit @brief command for a brief description.
139 JAVADOC_AUTOBRIEF = YES
141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
142 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
143 # comments) as a brief description. This used to be the default behaviour.
144 # The new default is to treat a multi-line C++ comment block as a detailed
145 # description. Set this tag to YES if you prefer the old behaviour instead.
147 MULTILINE_CPP_IS_BRIEF = NO
149 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
150 # member inherits the documentation from any documented member that it
155 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
156 # a new page for each member. If set to NO, the documentation of a member will
157 # be part of the file/class/namespace that contains it.
159 SEPARATE_MEMBER_PAGES = NO
161 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
162 # Doxygen uses this value to replace tabs by spaces in code fragments.
166 # This tag can be used to specify a number of aliases that acts
167 # as commands in the documentation. An alias has the form "name=value".
168 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
169 # put the command \sideeffect (or @sideeffect) in the documentation, which
170 # will result in a user-defined paragraph with heading "Side Effects:".
171 # You can put \n's in the value part of an alias to insert newlines.
175 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
176 # sources only. Doxygen will then generate output that is more tailored for C.
177 # For instance, some of the names that are used will be different. The list
178 # of all members will be omitted, etc.
180 OPTIMIZE_OUTPUT_FOR_C = YES
182 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
183 # sources only. Doxygen will then generate output that is more tailored for Java.
184 # For instance, namespaces will be presented as packages, qualified scopes
185 # will look different, etc.
187 OPTIMIZE_OUTPUT_JAVA = NO
189 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
190 # include (a tag file for) the STL sources as input, then you should
191 # set this tag to YES in order to let doxygen match functions declarations and
192 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
193 # func(std::string) {}). This also make the inheritance and collaboration
194 # diagrams that involve STL classes more complete and accurate.
196 BUILTIN_STL_SUPPORT = NO
198 # If you use Microsoft's C++/CLI language, you should set this option to YES to
199 # enable parsing support.
203 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
204 # tag is set to YES, then doxygen will reuse the documentation of the first
205 # member in the group (if any) for the other members of the group. By default
206 # all members of a group must be documented explicitly.
208 DISTRIBUTE_GROUP_DOC = NO
210 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
211 # the same type (for instance a group of public functions) to be put as a
212 # subgroup of that type (e.g. under the Public Functions section). Set it to
213 # NO to prevent subgrouping. Alternatively, this can be done per class using
214 # the \nosubgrouping command.
218 #---------------------------------------------------------------------------
219 # Build related configuration options
220 #---------------------------------------------------------------------------
222 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
223 # documentation are documented, even if no documentation was available.
224 # Private class members and static file members will be hidden unless
225 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
229 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
230 # will be included in the documentation.
234 # If the EXTRACT_STATIC tag is set to YES all static members of a file
235 # will be included in the documentation.
239 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
240 # defined locally in source files will be included in the documentation.
241 # If set to NO only classes defined in header files are included.
243 EXTRACT_LOCAL_CLASSES = NO
245 # This flag is only useful for Objective-C code. When set to YES local
246 # methods, which are defined in the implementation section but not in
247 # the interface are included in the documentation.
248 # If set to NO (the default) only methods in the interface are included.
250 EXTRACT_LOCAL_METHODS = NO
252 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
253 # undocumented members of documented classes, files or namespaces.
254 # If set to NO (the default) these members will be included in the
255 # various overviews, but no documentation section is generated.
256 # This option has no effect if EXTRACT_ALL is enabled.
258 HIDE_UNDOC_MEMBERS = YES
260 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
261 # undocumented classes that are normally visible in the class hierarchy.
262 # If set to NO (the default) these classes will be included in the various
263 # overviews. This option has no effect if EXTRACT_ALL is enabled.
265 HIDE_UNDOC_CLASSES = YES
267 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
268 # friend (class|struct|union) declarations.
269 # If set to NO (the default) these declarations will be included in the
272 HIDE_FRIEND_COMPOUNDS = YES
274 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
275 # documentation blocks found inside the body of a function.
276 # If set to NO (the default) these blocks will be appended to the
277 # function's detailed documentation block.
279 HIDE_IN_BODY_DOCS = NO
281 # The INTERNAL_DOCS tag determines if documentation
282 # that is typed after a \internal command is included. If the tag is set
283 # to NO (the default) then the documentation will be excluded.
284 # Set it to YES to include the internal documentation.
288 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
289 # file names in lower-case letters. If set to YES upper-case letters are also
290 # allowed. This is useful if you have classes or files whose names only differ
291 # in case and if your file system supports case sensitive file names. Windows
292 # and Mac users are advised to set this option to NO.
294 CASE_SENSE_NAMES = YES
296 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
297 # will show members with their full class and namespace scopes in the
298 # documentation. If set to YES the scope will be hidden.
300 HIDE_SCOPE_NAMES = NO
302 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
303 # will put a list of the files that are included by a file in the documentation
306 SHOW_INCLUDE_FILES = YES
308 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
309 # is inserted in the documentation for inline members.
313 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
314 # will sort the (detailed) documentation of file and class members
315 # alphabetically by member name. If set to NO the members will appear in
318 SORT_MEMBER_DOCS = YES
320 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
321 # brief documentation of file, namespace and class members alphabetically
322 # by member name. If set to NO (the default) the members will appear in
325 SORT_BRIEF_DOCS = YES
327 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
328 # sorted by fully-qualified names, including namespaces. If set to
329 # NO (the default), the class list will be sorted only by class name,
330 # not including the namespace part.
331 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
332 # Note: This option applies only to the class list, not to the
335 SORT_BY_SCOPE_NAME = NO
337 # The GENERATE_TODOLIST tag can be used to enable (YES) or
338 # disable (NO) the todo list. This list is created by putting \todo
339 # commands in the documentation.
341 GENERATE_TODOLIST = YES
343 # The GENERATE_TESTLIST tag can be used to enable (YES) or
344 # disable (NO) the test list. This list is created by putting \test
345 # commands in the documentation.
347 GENERATE_TESTLIST = YES
349 # The GENERATE_BUGLIST tag can be used to enable (YES) or
350 # disable (NO) the bug list. This list is created by putting \bug
351 # commands in the documentation.
353 GENERATE_BUGLIST = YES
355 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
356 # disable (NO) the deprecated list. This list is created by putting
357 # \deprecated commands in the documentation.
359 GENERATE_DEPRECATEDLIST= YES
361 # The ENABLED_SECTIONS tag can be used to enable conditional
362 # documentation sections, marked by \if sectionname ... \endif.
366 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
367 # the initial value of a variable or define consists of for it to appear in
368 # the documentation. If the initializer consists of more lines than specified
369 # here it will be hidden. Use a value of 0 to hide initializers completely.
370 # The appearance of the initializer of individual variables and defines in the
371 # documentation can be controlled using \showinitializer or \hideinitializer
372 # command in the documentation regardless of this setting.
374 MAX_INITIALIZER_LINES = 30
376 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
377 # at the bottom of the documentation of classes and structs. If set to YES the
378 # list will mention the files that were used to generate the documentation.
380 SHOW_USED_FILES = YES
382 # If the sources in your project are distributed over multiple directories
383 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
384 # in the documentation. The default is NO.
386 SHOW_DIRECTORIES = NO
388 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
389 # doxygen should invoke to get the current version for each file (typically from the
390 # version control system). Doxygen will invoke the program by executing (via
391 # popen()) the command <command> <input-file>, where <command> is the value of
392 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
393 # provided by doxygen. Whatever the program writes to standard output
394 # is used as the file version. See the manual for examples.
396 FILE_VERSION_FILTER =
398 #---------------------------------------------------------------------------
399 # configuration options related to warning and progress messages
400 #---------------------------------------------------------------------------
402 # The QUIET tag can be used to turn on/off the messages that are generated
403 # by doxygen. Possible values are YES and NO. If left blank NO is used.
407 # The WARNINGS tag can be used to turn on/off the warning messages that are
408 # generated by doxygen. Possible values are YES and NO. If left blank
413 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
414 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
415 # automatically be disabled.
417 WARN_IF_UNDOCUMENTED = YES
419 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
420 # potential errors in the documentation, such as not documenting some
421 # parameters in a documented function, or documenting parameters that
422 # don't exist or using markup commands wrongly.
424 WARN_IF_DOC_ERROR = YES
426 # This WARN_NO_PARAMDOC option can be abled to get warnings for
427 # functions that are documented, but have no documentation for their parameters
428 # or return value. If set to NO (the default) doxygen will only warn about
429 # wrong or incomplete parameter documentation, but not about the absence of
432 WARN_NO_PARAMDOC = NO
434 # The WARN_FORMAT tag determines the format of the warning messages that
435 # doxygen can produce. The string should contain the $file, $line, and $text
436 # tags, which will be replaced by the file and line number from which the
437 # warning originated and the warning text. Optionally the format may contain
438 # $version, which will be replaced by the version of the file (if it could
439 # be obtained via FILE_VERSION_FILTER)
441 WARN_FORMAT = "$file:$line: $text"
443 # The WARN_LOGFILE tag can be used to specify a file to which warning
444 # and error messages should be written. If left blank the output is written
449 #---------------------------------------------------------------------------
450 # configuration options related to the input files
451 #---------------------------------------------------------------------------
453 # The INPUT tag can be used to specify the files and/or directories that contain
454 # documented source files. You may enter file names like "myfile.cpp" or
455 # directories like "/usr/src/myproject". Separate the files or directories
460 # This tag can be used to specify the character encoding of the source files that
461 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
462 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
463 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
465 INPUT_ENCODING = UTF-8
467 # If the value of the INPUT tag contains directories, you can use the
468 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
469 # and *.h) to filter out the source-files in the directories. If left
470 # blank the following patterns are tested:
471 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
472 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
474 FILE_PATTERNS = *.doxy
476 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
477 # should be searched for input files as well. Possible values are YES and NO.
478 # If left blank NO is used.
482 # The EXCLUDE tag can be used to specify files and/or directories that should
483 # excluded from the INPUT source files. This way you can easily exclude a
484 # subdirectory from a directory tree whose root is specified with the INPUT tag.
486 EXCLUDE = *_private.h
488 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
489 # directories that are symbolic links (a Unix filesystem feature) are excluded
492 EXCLUDE_SYMLINKS = NO
494 # If the value of the INPUT tag contains directories, you can use the
495 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
496 # certain files from those directories. Note that the wildcards are matched
497 # against the file with absolute path, so to exclude all test directories
498 # for example use the pattern */test/*
500 EXCLUDE_PATTERNS = *.yy.c *_private.h
502 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
503 # (namespaces, classes, functions, etc.) that should be excluded from the output.
504 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
505 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
509 # The EXAMPLE_PATH tag can be used to specify one or more files or
510 # directories that contain example code fragments that are included (see
511 # the \include command).
515 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
516 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
517 # and *.h) to filter out the source-files in the directories. If left
518 # blank all files are included.
522 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
523 # searched for input files to be used with the \include or \dontinclude
524 # commands irrespective of the value of the RECURSIVE tag.
525 # Possible values are YES and NO. If left blank NO is used.
527 EXAMPLE_RECURSIVE = NO
529 # The IMAGE_PATH tag can be used to specify one or more files or
530 # directories that contain image that are included in the documentation (see
531 # the \image command).
533 IMAGE_PATH = doc/doxygen/pictures/
535 # The INPUT_FILTER tag can be used to specify a program that doxygen should
536 # invoke to filter for each input file. Doxygen will invoke the filter program
537 # by executing (via popen()) the command <filter> <input-file>, where <filter>
538 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
539 # input file. Doxygen will then use the output that the filter program writes
540 # to standard output. If FILTER_PATTERNS is specified, this tag will be
543 INPUT_FILTER = "sed \
544 -e 's/.*\<libmapi\/proto_private.h\>//' \
545 -e 's/.*\<gen_ndr\/ndr_exchange.h\>//' \
546 -e 's/.*\<param.h\>//' \
547 -e 's/.*\<core\/error.h\>//' \
548 -e 's/.*\<credentials.h\>//' \
549 -e 's/.*\<ldb.h\>//' \
550 -e 's/.*\<ldb_errors.h\>//' \
551 -e 's/.*\<libmapi\/dlinklist.h\>//' \
552 -e 's/.*\<libmapi\/mapi_nameid.h\>//' \
553 -e 's/.*\<libmapi\/mapi_nameid_private.h\>//' \
554 -e 's/.*\<libocpf\/proto_private.h\>//' \
555 -e 's/.*\<libocpf\/ocpf_api.h\>//' \
556 -e 's/.*\<libocpf\/ocpf.tab.h\>//' \
557 -e 's/.*\<libgen.h\>//' \
558 -e 's/.*\<time.h\>//' \
559 -e 's/.*\<sys\/*\>//' \
562 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
563 # basis. Doxygen will compare the file name with each pattern and apply the
564 # filter if there is a match. The filters are a list of the form:
565 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
566 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
567 # is applied to all files.
571 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
572 # INPUT_FILTER) will be used to filter the input files when producing source
573 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
575 FILTER_SOURCE_FILES = NO
577 #---------------------------------------------------------------------------
578 # configuration options related to source browsing
579 #---------------------------------------------------------------------------
581 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
582 # be generated. Documented entities will be cross-referenced with these sources.
583 # Note: To get rid of all source code in the generated output, make sure also
584 # VERBATIM_HEADERS is set to NO.
588 # Setting the INLINE_SOURCES tag to YES will include the body
589 # of functions and classes directly in the documentation.
593 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
594 # doxygen to hide any special comment blocks from generated source code
595 # fragments. Normal C and C++ comments will always remain visible.
597 STRIP_CODE_COMMENTS = YES
599 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
600 # then for each documented function all documented
601 # functions referencing it will be listed.
603 REFERENCED_BY_RELATION = YES
605 # If the REFERENCES_RELATION tag is set to YES (the default)
606 # then for each documented function all documented entities
607 # called/used by that function will be listed.
609 REFERENCES_RELATION = YES
611 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
612 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
613 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
614 # link to the source code. Otherwise they will link to the documentstion.
616 REFERENCES_LINK_SOURCE = YES
618 # If the USE_HTAGS tag is set to YES then the references to source code
619 # will point to the HTML generated by the htags(1) tool instead of doxygen
620 # built-in source browser. The htags tool is part of GNU's global source
621 # tagging system (see http://www.gnu.org/software/global/global.html). You
622 # will need version 4.8.6 or higher.
626 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
627 # will generate a verbatim copy of the header file for each class for
628 # which an include is specified. Set to NO to disable this.
630 VERBATIM_HEADERS = NO
632 #---------------------------------------------------------------------------
633 # configuration options related to the alphabetical class index
634 #---------------------------------------------------------------------------
636 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
637 # of all compounds will be generated. Enable this if the project
638 # contains a lot of classes, structs, unions or interfaces.
640 ALPHABETICAL_INDEX = NO
642 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
643 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
644 # in which this list will be split (can be a number in the range [1..20])
646 COLS_IN_ALPHA_INDEX = 5
648 # In case all classes in a project start with a common prefix, all
649 # classes will be put under the same header in the alphabetical index.
650 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
651 # should be ignored while generating the index headers.
655 #---------------------------------------------------------------------------
656 # configuration options related to the HTML output
657 #---------------------------------------------------------------------------
659 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
660 # generate HTML output.
664 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
665 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
666 # put in front of it. If left blank `html' will be used as the default path.
668 HTML_OUTPUT = html/overview
670 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
671 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
672 # doxygen will generate files with .html extension.
674 HTML_FILE_EXTENSION = .html
676 # The HTML_HEADER tag can be used to specify a personal HTML header for
677 # each generated HTML page. If it is left blank doxygen will generate a
680 HTML_HEADER = doc/doxygen/header.html
682 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
683 # each generated HTML page. If it is left blank doxygen will generate a
686 HTML_FOOTER = doc/doxygen/footer.html
688 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
689 # style sheet that is used by each HTML page. It can be used to
690 # fine-tune the look of the HTML output. If the tag is left blank doxygen
691 # will generate a default style sheet. Note that doxygen will try to copy
692 # the style sheet file to the HTML output directory, so don't put your own
693 # stylesheet in the HTML output directory as well, or it will be erased!
695 HTML_STYLESHEET = doc/doxygen/apidocs.css
697 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
698 # files or namespaces will be aligned in HTML using tables. If set to
699 # NO a bullet list will be used.
701 HTML_ALIGN_MEMBERS = YES
703 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
704 # will be generated that can be used as input for tools like the
705 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
706 # of the generated HTML documentation.
708 GENERATE_HTMLHELP = NO
710 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
711 # be used to specify the file name of the resulting .chm file. You
712 # can add a path in front of the file if the result should not be
713 # written to the html output directory.
717 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
718 # be used to specify the location (absolute path including file name) of
719 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
720 # the HTML help compiler on the generated index.hhp.
724 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
725 # controls if a separate .chi index file is generated (YES) or that
726 # it should be included in the master .chm file (NO).
730 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
731 # controls whether a binary table of contents is generated (YES) or a
732 # normal table of contents (NO) in the .chm file.
736 # The TOC_EXPAND flag can be set to YES to add extra items for group members
737 # to the contents of the HTML help documentation and to the tree view.
741 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
742 # top of each HTML page. The value NO (the default) enables the index and
743 # the value YES disables it.
747 # This tag can be used to set the number of enum values (range [1..20])
748 # that doxygen will group on one line in the generated HTML documentation.
750 ENUM_VALUES_PER_LINE = 4
752 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
753 # generated containing a tree-like index structure (just like the one that
754 # is generated for HTML Help). For this to work a browser that supports
755 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
756 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
757 # probably better off using the HTML help feature.
759 GENERATE_TREEVIEW = NO
761 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
762 # used to set the initial width (in pixels) of the frame in which the tree
767 #---------------------------------------------------------------------------
768 # configuration options related to the LaTeX output
769 #---------------------------------------------------------------------------
771 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
772 # generate Latex output.
776 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
777 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
778 # put in front of it. If left blank `latex' will be used as the default path.
782 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
783 # invoked. If left blank `latex' will be used as the default command name.
785 LATEX_CMD_NAME = latex
787 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
788 # generate index for LaTeX. If left blank `makeindex' will be used as the
789 # default command name.
791 MAKEINDEX_CMD_NAME = makeindex
793 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
794 # LaTeX documents. This may be useful for small projects and may help to
795 # save some trees in general.
799 # The PAPER_TYPE tag can be used to set the paper type that is used
800 # by the printer. Possible values are: a4, a4wide, letter, legal and
801 # executive. If left blank a4wide will be used.
805 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
806 # packages that should be included in the LaTeX output.
810 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
811 # the generated latex document. The header should contain everything until
812 # the first chapter. If it is left blank doxygen will generate a
813 # standard header. Notice: only use this tag if you know what you are doing!
817 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
818 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
819 # contain links (just like the HTML output) instead of page references
820 # This makes the output suitable for online browsing using a pdf viewer.
824 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
825 # plain latex in the generated Makefile. Set this option to YES to get a
826 # higher quality PDF documentation.
830 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
831 # command to the generated LaTeX files. This will instruct LaTeX to keep
832 # running if errors occur, instead of asking the user for help.
833 # This option is also used when generating formulas in HTML.
837 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
838 # include the index chapters (such as File Index, Compound Index, etc.)
841 LATEX_HIDE_INDICES = NO
843 #---------------------------------------------------------------------------
844 # configuration options related to the RTF output
845 #---------------------------------------------------------------------------
847 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
848 # The RTF output is optimized for Word 97 and may not look very pretty with
849 # other RTF readers or editors.
853 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
854 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
855 # put in front of it. If left blank `rtf' will be used as the default path.
859 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
860 # RTF documents. This may be useful for small projects and may help to
861 # save some trees in general.
865 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
866 # will contain hyperlink fields. The RTF file will
867 # contain links (just like the HTML output) instead of page references.
868 # This makes the output suitable for online browsing using WORD or other
869 # programs which support those fields.
870 # Note: wordpad (write) and others do not support links.
874 # Load stylesheet definitions from file. Syntax is similar to doxygen's
875 # config file, i.e. a series of assignments. You only have to provide
876 # replacements, missing definitions are set to their default value.
878 RTF_STYLESHEET_FILE =
880 # Set optional variables used in the generation of an rtf document.
881 # Syntax is similar to doxygen's config file.
883 RTF_EXTENSIONS_FILE =
885 #---------------------------------------------------------------------------
886 # configuration options related to the man page output
887 #---------------------------------------------------------------------------
889 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
894 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
895 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
896 # put in front of it. If left blank `man' will be used as the default path.
900 # The MAN_EXTENSION tag determines the extension that is added to
901 # the generated man pages (default is the subroutine's section .3)
905 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
906 # then it will generate one additional man file for each entity
907 # documented in the real man page(s). These additional files
908 # only source the real man page, but without them the man command
909 # would be unable to find the correct page. The default is NO.
913 #---------------------------------------------------------------------------
914 # configuration options related to the XML output
915 #---------------------------------------------------------------------------
917 # If the GENERATE_XML tag is set to YES Doxygen will
918 # generate an XML file that captures the structure of
919 # the code including all documentation.
923 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
924 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
925 # put in front of it. If left blank `xml' will be used as the default path.
929 # The XML_SCHEMA tag can be used to specify an XML schema,
930 # which can be used by a validating XML parser to check the
931 # syntax of the XML files.
935 # The XML_DTD tag can be used to specify an XML DTD,
936 # which can be used by a validating XML parser to check the
937 # syntax of the XML files.
941 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
942 # dump the program listings (including syntax highlighting
943 # and cross-referencing information) to the XML output. Note that
944 # enabling this will significantly increase the size of the XML output.
946 XML_PROGRAMLISTING = YES
948 #---------------------------------------------------------------------------
949 # configuration options for the AutoGen Definitions output
950 #---------------------------------------------------------------------------
952 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
953 # generate an AutoGen Definitions (see autogen.sf.net) file
954 # that captures the structure of the code including all
955 # documentation. Note that this feature is still experimental
956 # and incomplete at the moment.
958 GENERATE_AUTOGEN_DEF = NO
960 #---------------------------------------------------------------------------
961 # configuration options related to the Perl module output
962 #---------------------------------------------------------------------------
964 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
965 # generate a Perl module file that captures the structure of
966 # the code including all documentation. Note that this
967 # feature is still experimental and incomplete at the
970 GENERATE_PERLMOD = NO
972 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
973 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
974 # to generate PDF and DVI output from the Perl module output.
978 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
979 # nicely formatted so it can be parsed by a human reader. This is useful
980 # if you want to understand what is going on. On the other hand, if this
981 # tag is set to NO the size of the Perl module output will be much smaller
982 # and Perl will parse it just the same.
986 # The names of the make variables in the generated doxyrules.make file
987 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
988 # This is useful so different doxyrules.make files included by the same
989 # Makefile don't overwrite each other's variables.
991 PERLMOD_MAKEVAR_PREFIX =
993 #---------------------------------------------------------------------------
994 # Configuration options related to the preprocessor
995 #---------------------------------------------------------------------------
997 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
998 # evaluate all C-preprocessor directives found in the sources and include
1001 ENABLE_PREPROCESSING = YES
1003 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1004 # names in the source code. If set to NO (the default) only conditional
1005 # compilation will be performed. Macro expansion can be done in a controlled
1006 # way by setting EXPAND_ONLY_PREDEF to YES.
1008 MACRO_EXPANSION = NO
1010 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1011 # then the macro expansion is limited to the macros specified with the
1012 # PREDEFINED and EXPAND_AS_DEFINED tags.
1014 EXPAND_ONLY_PREDEF = NO
1016 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1017 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1019 SEARCH_INCLUDES = YES
1021 # The INCLUDE_PATH tag can be used to specify one or more directories that
1022 # contain include files that are not input files but should be processed by
1027 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1028 # patterns (like *.h and *.hpp) to filter out the header-files in the
1029 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1032 INCLUDE_FILE_PATTERNS =
1034 # The PREDEFINED tag can be used to specify one or more macro names that
1035 # are defined before the preprocessor is started (similar to the -D option of
1036 # gcc). The argument of the tag is a list of macros of the form: name
1037 # or name=definition (no spaces). If the definition and the = are
1038 # omitted =1 is assumed. To prevent a macro definition from being
1039 # undefined via #undef or recursively expanded use the := operator
1040 # instead of the = operator.
1042 PREDEFINED = _PUBLIC_
1044 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1045 # this tag can be used to specify a list of macro names that should be expanded.
1046 # The macro definition that is found in the sources will be used.
1047 # Use the PREDEFINED tag if you want to use a different macro definition.
1051 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1052 # doxygen's preprocessor will remove all function-like macros that are alone
1053 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1054 # function macros are typically used for boiler-plate code, and will confuse
1055 # the parser if not removed.
1057 SKIP_FUNCTION_MACROS = YES
1059 #---------------------------------------------------------------------------
1060 # Configuration::additions related to external references
1061 #---------------------------------------------------------------------------
1063 # The TAGFILES option can be used to specify one or more tagfiles.
1064 # Optionally an initial location of the external documentation
1065 # can be added for each tagfile. The format of a tag file without
1066 # this location is as follows:
1067 # TAGFILES = file1 file2 ...
1068 # Adding location for the tag files is done as follows:
1069 # TAGFILES = file1=loc1 "file2 = loc2" ...
1070 # where "loc1" and "loc2" can be relative or absolute paths or
1071 # URLs. If a location is present for each tag, the installdox tool
1072 # does not have to be run to correct the links.
1073 # Note that each tag file must have a unique name
1074 # (where the name does NOT include the path)
1075 # If a tag file is not located in the directory in which doxygen
1076 # is run, you must also specify the path to the tagfile here.
1080 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1081 # a tag file that is based on the input files it reads.
1085 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1086 # in the class index. If set to NO only the inherited external classes
1091 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1092 # in the modules index. If set to NO, only the current project's groups will
1095 EXTERNAL_GROUPS = YES
1097 # The PERL_PATH should be the absolute path and name of the perl script
1098 # interpreter (i.e. the result of `which perl').
1100 PERL_PATH = /usr/bin/perl
1102 #---------------------------------------------------------------------------
1103 # Configuration options related to the dot tool
1104 #---------------------------------------------------------------------------
1106 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1107 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1108 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1109 # this option is superseded by the HAVE_DOT option below. This is only a
1110 # fallback. It is recommended to install and use dot, since it yields more
1113 CLASS_DIAGRAMS = YES
1115 # You can define message sequence charts within doxygen comments using the \msc
1116 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1117 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1118 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1119 # be found in the default search path.
1123 # If set to YES, the inheritance and collaboration graphs will hide
1124 # inheritance and usage relations if the target is undocumented
1125 # or is not a class.
1127 HIDE_UNDOC_RELATIONS = YES
1129 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1130 # available from the path. This tool is part of Graphviz, a graph visualization
1131 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1132 # have no effect if this option is set to NO (the default)
1136 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1137 # will generate a graph for each documented class showing the direct and
1138 # indirect inheritance relations. Setting this tag to YES will force the
1139 # the CLASS_DIAGRAMS tag to NO.
1143 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1144 # will generate a graph for each documented class showing the direct and
1145 # indirect implementation dependencies (inheritance, containment, and
1146 # class references variables) of the class with other documented classes.
1148 COLLABORATION_GRAPH = YES
1150 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1151 # will generate a graph for groups, showing the direct groups dependencies
1155 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1156 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1161 # If set to YES, the inheritance and collaboration graphs will show the
1162 # relations between templates and their instances.
1164 TEMPLATE_RELATIONS = NO
1166 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1167 # tags are set to YES then doxygen will generate a graph for each documented
1168 # file showing the direct and indirect include dependencies of the file with
1169 # other documented files.
1173 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1174 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1175 # documented header file showing the documented files that directly or
1176 # indirectly include this file.
1178 INCLUDED_BY_GRAPH = YES
1180 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1181 # generate a call dependency graph for every global function or class method.
1182 # Note that enabling this option will significantly increase the time of a run.
1183 # So in most cases it will be better to enable call graphs for selected
1184 # functions only using the \callgraph command.
1188 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1189 # generate a caller dependency graph for every global function or class method.
1190 # Note that enabling this option will significantly increase the time of a run.
1191 # So in most cases it will be better to enable caller graphs for selected
1192 # functions only using the \callergraph command.
1196 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1197 # will graphical hierarchy of all classes instead of a textual one.
1199 GRAPHICAL_HIERARCHY = YES
1201 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1202 # then doxygen will show the dependencies a directory has on other directories
1203 # in a graphical way. The dependency relations are determined by the #include
1204 # relations between the files in the directories.
1206 DIRECTORY_GRAPH = YES
1208 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1209 # generated by dot. Possible values are png, jpg, or gif
1210 # If left blank png will be used.
1212 DOT_IMAGE_FORMAT = png
1214 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1215 # found. If left blank, it is assumed the dot tool can be found in the path.
1219 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1220 # contain dot files that are included in the documentation (see the
1221 # \dotfile command).
1225 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1226 # nodes that will be shown in the graph. If the number of nodes in a graph
1227 # becomes larger than this value, doxygen will truncate the graph, which is
1228 # visualized by representing a node as a red box. Note that doxygen will always
1229 # show the root nodes and its direct children regardless of this setting.
1231 DOT_GRAPH_MAX_NODES = 50
1233 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1234 # background. This is disabled by default, which results in a white background.
1235 # Warning: Depending on the platform used, enabling this option may lead to
1236 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1239 DOT_TRANSPARENT = NO
1241 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1242 # files in one run (i.e. multiple -o and -T options on the command line). This
1243 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1244 # support this, this feature is disabled by default.
1246 DOT_MULTI_TARGETS = NO
1248 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1249 # generate a legend page explaining the meaning of the various boxes and
1250 # arrows in the dot generated graphs.
1252 GENERATE_LEGEND = YES
1254 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1255 # remove the intermediate dot files that are used to generate
1256 # the various graphs.
1260 #---------------------------------------------------------------------------
1261 # Configuration::additions related to the search engine
1262 #---------------------------------------------------------------------------
1264 # The SEARCHENGINE tag specifies whether or not a search engine should be
1265 # used. If set to NO the values of all tags below this one will be ignored.