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 = @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 = dox
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.
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 regular Qt-style comments
137 # (thus requiring an explicit @brief command for a brief description.)
139 JAVADOC_AUTOBRIEF = NO
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142 # interpret the first line (until the first dot) of a Qt-style
143 # comment as the brief description. If set to NO, the comments
144 # will behave just like regular Qt-style comments (thus requiring
145 # an explicit \brief command for a brief description.)
149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
151 # comments) as a brief description. This used to be the default behaviour.
152 # The new default is to treat a multi-line C++ comment block as a detailed
153 # description. Set this tag to YES if you prefer the old behaviour instead.
155 MULTILINE_CPP_IS_BRIEF = NO
157 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
158 # member inherits the documentation from any documented member that it
163 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
164 # a new page for each member. If set to NO, the documentation of a member will
165 # be part of the file/class/namespace that contains it.
167 SEPARATE_MEMBER_PAGES = NO
169 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
170 # Doxygen uses this value to replace tabs by spaces in code fragments.
174 # This tag can be used to specify a number of aliases that acts
175 # as commands in the documentation. An alias has the form "name=value".
176 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
177 # put the command \sideeffect (or @sideeffect) in the documentation, which
178 # will result in a user-defined paragraph with heading "Side Effects:".
179 # You can put \n's in the value part of an alias to insert newlines.
183 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
184 # sources only. Doxygen will then generate output that is more tailored for C.
185 # For instance, some of the names that are used will be different. The list
186 # of all members will be omitted, etc.
188 OPTIMIZE_OUTPUT_FOR_C = YES
190 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
191 # sources only. Doxygen will then generate output that is more tailored for Java.
192 # For instance, namespaces will be presented as packages, qualified scopes
193 # will look different, etc.
195 OPTIMIZE_OUTPUT_JAVA = NO
197 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
198 # include (a tag file for) the STL sources as input, then you should
199 # set this tag to YES in order to let doxygen match functions declarations and
200 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
201 # func(std::string) {}). This also make the inheritance and collaboration
202 # diagrams that involve STL classes more complete and accurate.
204 BUILTIN_STL_SUPPORT = NO
206 # If you use Microsoft's C++/CLI language, you should set this option to YES to
207 # enable parsing support.
211 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
212 # tag is set to YES, then doxygen will reuse the documentation of the first
213 # member in the group (if any) for the other members of the group. By default
214 # all members of a group must be documented explicitly.
216 DISTRIBUTE_GROUP_DOC = NO
218 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
219 # the same type (for instance a group of public functions) to be put as a
220 # subgroup of that type (e.g. under the Public Functions section). Set it to
221 # NO to prevent subgrouping. Alternatively, this can be done per class using
222 # the \nosubgrouping command.
226 #---------------------------------------------------------------------------
227 # Build related configuration options
228 #---------------------------------------------------------------------------
230 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
231 # documentation are documented, even if no documentation was available.
232 # Private class members and static file members will be hidden unless
233 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
237 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
238 # will be included in the documentation.
240 EXTRACT_PRIVATE = YES
242 # If the EXTRACT_STATIC tag is set to YES all static members of a file
243 # will be included in the documentation.
247 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
248 # defined locally in source files will be included in the documentation.
249 # If set to NO only classes defined in header files are included.
251 EXTRACT_LOCAL_CLASSES = YES
253 # This flag is only useful for Objective-C code. When set to YES local
254 # methods, which are defined in the implementation section but not in
255 # the interface are included in the documentation.
256 # If set to NO (the default) only methods in the interface are included.
258 EXTRACT_LOCAL_METHODS = NO
260 # If this flag is set to YES, the members of anonymous namespaces will be extracted
261 # and appear in the documentation as a namespace called 'anonymous_namespace{file}',
262 # where file will be replaced with the base name of the file that contains the anonymous
263 # namespace. By default anonymous namespace are hidden.
265 EXTRACT_ANON_NSPACES = NO
267 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
268 # undocumented members of documented classes, files or namespaces.
269 # If set to NO (the default) these members will be included in the
270 # various overviews, but no documentation section is generated.
271 # This option has no effect if EXTRACT_ALL is enabled.
273 HIDE_UNDOC_MEMBERS = NO
275 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
276 # undocumented classes that are normally visible in the class hierarchy.
277 # If set to NO (the default) these classes will be included in the various
278 # overviews. This option has no effect if EXTRACT_ALL is enabled.
280 HIDE_UNDOC_CLASSES = NO
282 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
283 # friend (class|struct|union) declarations.
284 # If set to NO (the default) these declarations will be included in the
287 HIDE_FRIEND_COMPOUNDS = NO
289 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
290 # documentation blocks found inside the body of a function.
291 # If set to NO (the default) these blocks will be appended to the
292 # function's detailed documentation block.
294 HIDE_IN_BODY_DOCS = NO
296 # The INTERNAL_DOCS tag determines if documentation
297 # that is typed after a \internal command is included. If the tag is set
298 # to NO (the default) then the documentation will be excluded.
299 # Set it to YES to include the internal documentation.
303 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
304 # file names in lower-case letters. If set to YES upper-case letters are also
305 # allowed. This is useful if you have classes or files whose names only differ
306 # in case and if your file system supports case sensitive file names. Windows
307 # and Mac users are advised to set this option to NO.
309 CASE_SENSE_NAMES = YES
311 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
312 # will show members with their full class and namespace scopes in the
313 # documentation. If set to YES the scope will be hidden.
315 HIDE_SCOPE_NAMES = NO
317 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
318 # will put a list of the files that are included by a file in the documentation
321 SHOW_INCLUDE_FILES = YES
323 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
324 # is inserted in the documentation for inline members.
328 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
329 # will sort the (detailed) documentation of file and class members
330 # alphabetically by member name. If set to NO the members will appear in
333 SORT_MEMBER_DOCS = YES
335 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
336 # brief documentation of file, namespace and class members alphabetically
337 # by member name. If set to NO (the default) the members will appear in
342 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
343 # sorted by fully-qualified names, including namespaces. If set to
344 # NO (the default), the class list will be sorted only by class name,
345 # not including the namespace part.
346 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
347 # Note: This option applies only to the class list, not to the
350 SORT_BY_SCOPE_NAME = NO
352 # The GENERATE_TODOLIST tag can be used to enable (YES) or
353 # disable (NO) the todo list. This list is created by putting \todo
354 # commands in the documentation.
356 GENERATE_TODOLIST = YES
358 # The GENERATE_TESTLIST tag can be used to enable (YES) or
359 # disable (NO) the test list. This list is created by putting \test
360 # commands in the documentation.
362 GENERATE_TESTLIST = YES
364 # The GENERATE_BUGLIST tag can be used to enable (YES) or
365 # disable (NO) the bug list. This list is created by putting \bug
366 # commands in the documentation.
368 GENERATE_BUGLIST = YES
370 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
371 # disable (NO) the deprecated list. This list is created by putting
372 # \deprecated commands in the documentation.
374 GENERATE_DEPRECATEDLIST= YES
376 # The ENABLED_SECTIONS tag can be used to enable conditional
377 # documentation sections, marked by \if sectionname ... \endif.
381 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
382 # the initial value of a variable or define consists of for it to appear in
383 # the documentation. If the initializer consists of more lines than specified
384 # here it will be hidden. Use a value of 0 to hide initializers completely.
385 # The appearance of the initializer of individual variables and defines in the
386 # documentation can be controlled using \showinitializer or \hideinitializer
387 # command in the documentation regardless of this setting.
389 MAX_INITIALIZER_LINES = 30
391 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
392 # at the bottom of the documentation of classes and structs. If set to YES the
393 # list will mention the files that were used to generate the documentation.
395 SHOW_USED_FILES = YES
397 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
398 # doxygen should invoke to get the current version for each file (typically from the
399 # version control system). Doxygen will invoke the program by executing (via
400 # popen()) the command <command> <input-file>, where <command> is the value of
401 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
402 # provided by doxygen. Whatever the program writes to standard output
403 # is used as the file version. See the manual for examples.
405 FILE_VERSION_FILTER =
407 #---------------------------------------------------------------------------
408 # configuration options related to warning and progress messages
409 #---------------------------------------------------------------------------
411 # The QUIET tag can be used to turn on/off the messages that are generated
412 # by doxygen. Possible values are YES and NO. If left blank NO is used.
416 # The WARNINGS tag can be used to turn on/off the warning messages that are
417 # generated by doxygen. Possible values are YES and NO. If left blank
422 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
423 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
424 # automatically be disabled.
426 WARN_IF_UNDOCUMENTED = YES
428 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
429 # potential errors in the documentation, such as not documenting some
430 # parameters in a documented function, or documenting parameters that
431 # don't exist or using markup commands wrongly.
433 WARN_IF_DOC_ERROR = YES
435 # This WARN_NO_PARAMDOC option can be abled to get warnings for
436 # functions that are documented, but have no documentation for their parameters
437 # or return value. If set to NO (the default) doxygen will only warn about
438 # wrong or incomplete parameter documentation, but not about the absence of
441 WARN_NO_PARAMDOC = NO
443 # The WARN_FORMAT tag determines the format of the warning messages that
444 # doxygen can produce. The string should contain the $file, $line, and $text
445 # tags, which will be replaced by the file and line number from which the
446 # warning originated and the warning text. Optionally the format may contain
447 # $version, which will be replaced by the version of the file (if it could
448 # be obtained via FILE_VERSION_FILTER)
450 WARN_FORMAT = "$file:$line: $text "
452 # The WARN_LOGFILE tag can be used to specify a file to which warning
453 # and error messages should be written. If left blank the output is written
458 #---------------------------------------------------------------------------
459 # configuration options related to the input files
460 #---------------------------------------------------------------------------
462 # The INPUT tag can be used to specify the files and/or directories that contain
463 # documented source files. You may enter file names like "myfile.cpp" or
464 # directories like "/usr/src/myproject". Separate the files or directories
467 INPUT = src ztest include
469 # This tag can be used to specify the character encoding of the source files that
470 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
471 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
472 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
474 INPUT_ENCODING = UTF-8
476 # If the value of the INPUT tag contains directories, you can use the
477 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
478 # and *.h) to filter out the source-files in the directories. If left
479 # blank the following patterns are tested:
480 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
481 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
485 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
486 # should be searched for input files as well. Possible values are YES and NO.
487 # If left blank NO is used.
491 # The EXCLUDE tag can be used to specify files and/or directories that should
492 # excluded from the INPUT source files. This way you can easily exclude a
493 # subdirectory from a directory tree whose root is specified with the INPUT tag.
497 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
498 # directories that are symbolic links (a Unix filesystem feature) are excluded
501 EXCLUDE_SYMLINKS = NO
503 # If the value of the INPUT tag contains directories, you can use the
504 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
505 # certain files from those directories. Note that the wildcards are matched
506 # against the file with absolute path, so to exclude all test directories
507 # for example use the pattern */test/*
511 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
512 # (namespaces, classes, functions, etc.) that should be excluded from the output.
513 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
514 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
518 # The EXAMPLE_PATH tag can be used to specify one or more files or
519 # directories that contain example code fragments that are included (see
520 # the \include command).
524 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
525 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
526 # and *.h) to filter out the source-files in the directories. If left
527 # blank all files are included.
531 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
532 # searched for input files to be used with the \include or \dontinclude
533 # commands irrespective of the value of the RECURSIVE tag.
534 # Possible values are YES and NO. If left blank NO is used.
536 EXAMPLE_RECURSIVE = NO
538 # The IMAGE_PATH tag can be used to specify one or more files or
539 # directories that contain image that are included in the documentation (see
540 # the \image command).
544 # The INPUT_FILTER tag can be used to specify a program that doxygen should
545 # invoke to filter for each input file. Doxygen will invoke the filter program
546 # by executing (via popen()) the command <filter> <input-file>, where <filter>
547 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
548 # input file. Doxygen will then use the output that the filter program writes
549 # to standard output. If FILTER_PATTERNS is specified, this tag will be
554 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
555 # basis. Doxygen will compare the file name with each pattern and apply the
556 # filter if there is a match. The filters are a list of the form:
557 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
558 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
559 # is applied to all files.
563 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
564 # INPUT_FILTER) will be used to filter the input files when producing source
565 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
567 FILTER_SOURCE_FILES = NO
569 #---------------------------------------------------------------------------
570 # configuration options related to source browsing
571 #---------------------------------------------------------------------------
573 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
574 # be generated. Documented entities will be cross-referenced with these sources.
575 # Note: To get rid of all source code in the generated output, make sure also
576 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
577 # then you must also enable this option. If you don't then doxygen will produce
578 # a warning and turn it on anyway
582 # Setting the INLINE_SOURCES tag to YES will include the body
583 # of functions and classes directly in the documentation.
587 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
588 # doxygen to hide any special comment blocks from generated source code
589 # fragments. Normal C and C++ comments will always remain visible.
591 STRIP_CODE_COMMENTS = YES
593 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
594 # then for each documented function all documented
595 # functions referencing it will be listed.
597 REFERENCED_BY_RELATION = YES
599 # If the REFERENCES_RELATION tag is set to YES (the default)
600 # then for each documented function all documented entities
601 # called/used by that function will be listed.
603 REFERENCES_RELATION = YES
605 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
606 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
607 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
608 # link to the source code. Otherwise they will link to the documentstion.
610 REFERENCES_LINK_SOURCE = YES
612 # If the USE_HTAGS tag is set to YES then the references to source code
613 # will point to the HTML generated by the htags(1) tool instead of doxygen
614 # built-in source browser. The htags tool is part of GNU's global source
615 # tagging system (see http://www.gnu.org/software/global/global.html). You
616 # will need version 4.8.6 or higher.
620 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
621 # will generate a verbatim copy of the header file for each class for
622 # which an include is specified. Set to NO to disable this.
624 VERBATIM_HEADERS = YES
626 #---------------------------------------------------------------------------
627 # configuration options related to the alphabetical class index
628 #---------------------------------------------------------------------------
630 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
631 # of all compounds will be generated. Enable this if the project
632 # contains a lot of classes, structs, unions or interfaces.
634 ALPHABETICAL_INDEX = NO
636 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
637 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
638 # in which this list will be split (can be a number in the range [1..20])
640 COLS_IN_ALPHA_INDEX = 5
642 # In case all classes in a project start with a common prefix, all
643 # classes will be put under the same header in the alphabetical index.
644 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
645 # should be ignored while generating the index headers.
649 #---------------------------------------------------------------------------
650 # configuration options related to the HTML output
651 #---------------------------------------------------------------------------
653 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
654 # generate HTML output.
658 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
659 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
660 # put in front of it. If left blank `html' will be used as the default path.
664 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
665 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
666 # doxygen will generate files with .html extension.
668 HTML_FILE_EXTENSION = .html
670 # The HTML_HEADER tag can be used to specify a personal HTML header for
671 # each generated HTML page. If it is left blank doxygen will generate a
676 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
677 # each generated HTML page. If it is left blank doxygen will generate a
682 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
683 # style sheet that is used by each HTML page. It can be used to
684 # fine-tune the look of the HTML output. If the tag is left blank doxygen
685 # will generate a default style sheet. Note that doxygen will try to copy
686 # the style sheet file to the HTML output directory, so don't put your own
687 # stylesheet in the HTML output directory as well, or it will be erased!
691 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
692 # will be generated that can be used as input for tools like the
693 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
694 # of the generated HTML documentation.
696 GENERATE_HTMLHELP = NO
698 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
699 # documentation will contain sections that can be hidden and shown after the
700 # page has loaded. For this to work a browser that supports
701 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
702 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
704 HTML_DYNAMIC_SECTIONS = NO
706 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
707 # be used to specify the file name of the resulting .chm file. You
708 # can add a path in front of the file if the result should not be
709 # written to the html output directory.
713 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
714 # be used to specify the location (absolute path including file name) of
715 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
716 # the HTML help compiler on the generated index.hhp.
720 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
721 # controls if a separate .chi index file is generated (YES) or that
722 # it should be included in the master .chm file (NO).
726 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
727 # controls whether a binary table of contents is generated (YES) or a
728 # normal table of contents (NO) in the .chm file.
732 # The TOC_EXPAND flag can be set to YES to add extra items for group members
733 # to the contents of the HTML help documentation and to the tree view.
737 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
738 # top of each HTML page. The value NO (the default) enables the index and
739 # the value YES disables it.
743 # This tag can be used to set the number of enum values (range [1..20])
744 # that doxygen will group on one line in the generated HTML documentation.
746 ENUM_VALUES_PER_LINE = 4
748 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
749 # generated containing a tree-like index structure (just like the one that
750 # is generated for HTML Help). For this to work a browser that supports
751 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
752 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
753 # probably better off using the HTML help feature.
755 GENERATE_TREEVIEW = NO
757 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
758 # used to set the initial width (in pixels) of the frame in which the tree
763 #---------------------------------------------------------------------------
764 # configuration options related to the LaTeX output
765 #---------------------------------------------------------------------------
767 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
768 # generate Latex output.
772 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
773 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
774 # put in front of it. If left blank `latex' will be used as the default path.
778 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
779 # invoked. If left blank `latex' will be used as the default command name.
781 LATEX_CMD_NAME = latex
783 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
784 # generate index for LaTeX. If left blank `makeindex' will be used as the
785 # default command name.
787 MAKEINDEX_CMD_NAME = makeindex
789 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
790 # LaTeX documents. This may be useful for small projects and may help to
791 # save some trees in general.
795 # The PAPER_TYPE tag can be used to set the paper type that is used
796 # by the printer. Possible values are: a4, a4wide, letter, legal and
797 # executive. If left blank a4wide will be used.
801 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
802 # packages that should be included in the LaTeX output.
806 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
807 # the generated latex document. The header should contain everything until
808 # the first chapter. If it is left blank doxygen will generate a
809 # standard header. Notice: only use this tag if you know what you are doing!
813 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
814 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
815 # contain links (just like the HTML output) instead of page references
816 # This makes the output suitable for online browsing using a pdf viewer.
820 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
821 # plain latex in the generated Makefile. Set this option to YES to get a
822 # higher quality PDF documentation.
826 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
827 # command to the generated LaTeX files. This will instruct LaTeX to keep
828 # running if errors occur, instead of asking the user for help.
829 # This option is also used when generating formulas in HTML.
833 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
834 # include the index chapters (such as File Index, Compound Index, etc.)
837 LATEX_HIDE_INDICES = NO
839 #---------------------------------------------------------------------------
840 # configuration options related to the RTF output
841 #---------------------------------------------------------------------------
843 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
844 # The RTF output is optimized for Word 97 and may not look very pretty with
845 # other RTF readers or editors.
849 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
850 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
851 # put in front of it. If left blank `rtf' will be used as the default path.
855 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
856 # RTF documents. This may be useful for small projects and may help to
857 # save some trees in general.
861 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
862 # will contain hyperlink fields. The RTF file will
863 # contain links (just like the HTML output) instead of page references.
864 # This makes the output suitable for online browsing using WORD or other
865 # programs which support those fields.
866 # Note: wordpad (write) and others do not support links.
870 # Load stylesheet definitions from file. Syntax is similar to doxygen's
871 # config file, i.e. a series of assignments. You only have to provide
872 # replacements, missing definitions are set to their default value.
874 RTF_STYLESHEET_FILE =
876 # Set optional variables used in the generation of an rtf document.
877 # Syntax is similar to doxygen's config file.
879 RTF_EXTENSIONS_FILE =
881 #---------------------------------------------------------------------------
882 # configuration options related to the man page output
883 #---------------------------------------------------------------------------
885 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
890 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
891 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
892 # put in front of it. If left blank `man' will be used as the default path.
896 # The MAN_EXTENSION tag determines the extension that is added to
897 # the generated man pages (default is the subroutine's section .3)
901 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
902 # then it will generate one additional man file for each entity
903 # documented in the real man page(s). These additional files
904 # only source the real man page, but without them the man command
905 # would be unable to find the correct page. The default is NO.
909 #---------------------------------------------------------------------------
910 # configuration options related to the XML output
911 #---------------------------------------------------------------------------
913 # If the GENERATE_XML tag is set to YES Doxygen will
914 # generate an XML file that captures the structure of
915 # the code including all documentation.
919 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
920 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
921 # put in front of it. If left blank `xml' will be used as the default path.
925 # The XML_SCHEMA tag can be used to specify an XML schema,
926 # which can be used by a validating XML parser to check the
927 # syntax of the XML files.
931 # The XML_DTD tag can be used to specify an XML DTD,
932 # which can be used by a validating XML parser to check the
933 # syntax of the XML files.
937 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
938 # dump the program listings (including syntax highlighting
939 # and cross-referencing information) to the XML output. Note that
940 # enabling this will significantly increase the size of the XML output.
942 XML_PROGRAMLISTING = YES
944 #---------------------------------------------------------------------------
945 # configuration options for the AutoGen Definitions output
946 #---------------------------------------------------------------------------
948 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
949 # generate an AutoGen Definitions (see autogen.sf.net) file
950 # that captures the structure of the code including all
951 # documentation. Note that this feature is still experimental
952 # and incomplete at the moment.
954 GENERATE_AUTOGEN_DEF = NO
956 #---------------------------------------------------------------------------
957 # configuration options related to the Perl module output
958 #---------------------------------------------------------------------------
960 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
961 # generate a Perl module file that captures the structure of
962 # the code including all documentation. Note that this
963 # feature is still experimental and incomplete at the
966 GENERATE_PERLMOD = NO
968 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
969 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
970 # to generate PDF and DVI output from the Perl module output.
974 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
975 # nicely formatted so it can be parsed by a human reader. This is useful
976 # if you want to understand what is going on. On the other hand, if this
977 # tag is set to NO the size of the Perl module output will be much smaller
978 # and Perl will parse it just the same.
982 # The names of the make variables in the generated doxyrules.make file
983 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
984 # This is useful so different doxyrules.make files included by the same
985 # Makefile don't overwrite each other's variables.
987 PERLMOD_MAKEVAR_PREFIX =
989 #---------------------------------------------------------------------------
990 # Configuration options related to the preprocessor
991 #---------------------------------------------------------------------------
993 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
994 # evaluate all C-preprocessor directives found in the sources and include
997 ENABLE_PREPROCESSING = YES
999 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1000 # names in the source code. If set to NO (the default) only conditional
1001 # compilation will be performed. Macro expansion can be done in a controlled
1002 # way by setting EXPAND_ONLY_PREDEF to YES.
1004 MACRO_EXPANSION = YES
1006 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1007 # then the macro expansion is limited to the macros specified with the
1008 # PREDEFINED and EXPAND_AS_DEFINED tags.
1010 EXPAND_ONLY_PREDEF = YES
1012 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1013 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1015 SEARCH_INCLUDES = YES
1017 # The INCLUDE_PATH tag can be used to specify one or more directories that
1018 # contain include files that are not input files but should be processed by
1023 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1024 # patterns (like *.h and *.hpp) to filter out the header-files in the
1025 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1028 INCLUDE_FILE_PATTERNS =
1030 # The PREDEFINED tag can be used to specify one or more macro names that
1031 # are defined before the preprocessor is started (similar to the -D option of
1032 # gcc). The argument of the tag is a list of macros of the form: name
1033 # or name=definition (no spaces). If the definition and the = are
1034 # omitted =1 is assumed. To prevent a macro definition from being
1035 # undefined via #undef or recursively expanded use the := operator
1036 # instead of the = operator.
1038 PREDEFINED = "YAZ_BEGIN_CDECL= " \
1041 "YAZ_HAVE_XML2=1 " \
1042 "YAZ_HAVE_XSLT=1 " \
1043 "HAVE_GETADDRINFO=1 "
1045 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1046 # this tag can be used to specify a list of macro names that should be expanded.
1047 # The macro definition that is found in the sources will be used.
1048 # Use the PREDEFINED tag if you want to use a different macro definition.
1050 EXPAND_AS_DEFINED = YAZ_BEGIN_CDECL \
1054 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1055 # doxygen's preprocessor will remove all function-like macros that are alone
1056 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1057 # function macros are typically used for boiler-plate code, and will confuse
1058 # the parser if not removed.
1060 SKIP_FUNCTION_MACROS = YES
1062 #---------------------------------------------------------------------------
1063 # Configuration::additions related to external references
1064 #---------------------------------------------------------------------------
1066 # The TAGFILES option can be used to specify one or more tagfiles.
1067 # Optionally an initial location of the external documentation
1068 # can be added for each tagfile. The format of a tag file without
1069 # this location is as follows:
1070 # TAGFILES = file1 file2 ...
1071 # Adding location for the tag files is done as follows:
1072 # TAGFILES = file1=loc1 "file2 = loc2" ...
1073 # where "loc1" and "loc2" can be relative or absolute paths or
1074 # URLs. If a location is present for each tag, the installdox tool
1075 # does not have to be run to correct the links.
1076 # Note that each tag file must have a unique name
1077 # (where the name does NOT include the path)
1078 # If a tag file is not located in the directory in which doxygen
1079 # is run, you must also specify the path to the tagfile here.
1083 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1084 # a tag file that is based on the input files it reads.
1088 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1089 # in the class index. If set to NO only the inherited external classes
1094 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1095 # in the modules index. If set to NO, only the current project's groups will
1098 EXTERNAL_GROUPS = YES
1100 # The PERL_PATH should be the absolute path and name of the perl script
1101 # interpreter (i.e. the result of `which perl').
1103 PERL_PATH = /usr/bin/perl
1105 #---------------------------------------------------------------------------
1106 # Configuration options related to the dot tool
1107 #---------------------------------------------------------------------------
1109 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1110 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1111 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1112 # this option is superseded by the HAVE_DOT option below. This is only a
1113 # fallback. It is recommended to install and use dot, since it yields more
1116 CLASS_DIAGRAMS = YES
1118 # You can define message sequence charts within doxygen comments using the \msc
1119 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1120 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1121 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1122 # be found in the default search path.
1126 # If set to YES, the inheritance and collaboration graphs will hide
1127 # inheritance and usage relations if the target is undocumented
1128 # or is not a class.
1130 HIDE_UNDOC_RELATIONS = YES
1132 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1133 # available from the path. This tool is part of Graphviz, a graph visualization
1134 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1135 # have no effect if this option is set to NO (the default)
1139 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1140 # will generate a graph for each documented class showing the direct and
1141 # indirect inheritance relations. Setting this tag to YES will force the
1142 # the CLASS_DIAGRAMS tag to NO.
1146 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1147 # will generate a graph for each documented class showing the direct and
1148 # indirect implementation dependencies (inheritance, containment, and
1149 # class references variables) of the class with other documented classes.
1151 COLLABORATION_GRAPH = YES
1153 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1154 # will generate a graph for groups, showing the direct groups dependencies
1158 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1159 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1164 # If set to YES, the inheritance and collaboration graphs will show the
1165 # relations between templates and their instances.
1167 TEMPLATE_RELATIONS = NO
1169 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1170 # tags are set to YES then doxygen will generate a graph for each documented
1171 # file showing the direct and indirect include dependencies of the file with
1172 # other documented files.
1176 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1177 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1178 # documented header file showing the documented files that directly or
1179 # indirectly include this file.
1181 INCLUDED_BY_GRAPH = YES
1183 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1184 # generate a call dependency graph for every global function or class method.
1185 # Note that enabling this option will significantly increase the time of a run.
1186 # So in most cases it will be better to enable call graphs for selected
1187 # functions only using the \callgraph command.
1191 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1192 # generate a caller dependency graph for every global function or class method.
1193 # Note that enabling this option will significantly increase the time of a run.
1194 # So in most cases it will be better to enable caller graphs for selected
1195 # functions only using the \callergraph command.
1199 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1200 # will graphical hierarchy of all classes instead of a textual one.
1202 GRAPHICAL_HIERARCHY = YES
1204 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1205 # then doxygen will show the dependencies a directory has on other directories
1206 # in a graphical way. The dependency relations are determined by the #include
1207 # relations between the files in the directories.
1209 DIRECTORY_GRAPH = YES
1211 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1212 # generated by dot. Possible values are png, jpg, or gif
1213 # If left blank png will be used.
1215 DOT_IMAGE_FORMAT = png
1217 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1218 # found. If left blank, it is assumed the dot tool can be found in the path.
1222 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1223 # contain dot files that are included in the documentation (see the
1224 # \dotfile command).
1228 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1229 # nodes that will be shown in the graph. If the number of nodes in a graph
1230 # becomes larger than this value, doxygen will truncate the graph, which is
1231 # visualized by representing a node as a red box. Note that doxygen if the number
1232 # of direct children of the root node in a graph is already larger than
1233 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1234 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1236 DOT_GRAPH_MAX_NODES = 50
1238 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1239 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1240 # from the root by following a path via at most 3 edges will be shown. Nodes
1241 # that lay further from the root node will be omitted. Note that setting this
1242 # option to 1 or 2 may greatly reduce the computation time needed for large
1243 # code bases. Also note that the size of a graph can be further restricted by
1244 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1246 MAX_DOT_GRAPH_DEPTH = 0
1248 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1249 # background. This is disabled by default, which results in a white background.
1250 # Warning: Depending on the platform used, enabling this option may lead to
1251 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1254 DOT_TRANSPARENT = NO
1256 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1257 # files in one run (i.e. multiple -o and -T options on the command line). This
1258 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1259 # support this, this feature is disabled by default.
1261 DOT_MULTI_TARGETS = NO
1263 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1264 # generate a legend page explaining the meaning of the various boxes and
1265 # arrows in the dot generated graphs.
1267 GENERATE_LEGEND = YES
1269 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1270 # remove the intermediate dot files that are used to generate
1271 # the various graphs.
1275 #---------------------------------------------------------------------------
1276 # Configuration::additions related to the search engine
1277 #---------------------------------------------------------------------------
1279 # The SEARCHENGINE tag specifies whether or not a search engine should be
1280 # used. If set to NO the values of all tags below this one will be ignored.