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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = @PACKAGE@
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
26 PROJECT_NUMBER = @VERSION@
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
33 OUTPUT_DIRECTORY = dox
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of source
39 # files, where putting all generated files in the same directory would otherwise
40 # cause performance problems for the file system.
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are:
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52 # Swedish, and Ukrainian.
54 OUTPUT_LANGUAGE = English
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 # include brief member descriptions after the members that are listed in
58 # the file and class documentation (similar to JavaDoc).
59 # Set to NO to disable this.
61 BRIEF_MEMBER_DESC = YES
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64 # the brief description of a member or function before the detailed description.
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66 # brief descriptions will be completely suppressed.
70 # This tag implements a quasi-intelligent brief description abbreviator
71 # that is used to form the text in various listings. Each string
72 # in this list, if found as the leading text of the brief description, will be
73 # stripped from the text and the result after processing the whole list, is used
74 # as the annotated text. Otherwise, the brief description is used as-is. If left
75 # blank, the following values are used ("$name" is automatically replaced with the
76 # name of the entity): "The $name class" "The $name widget" "The $name file"
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82 # Doxygen will generate a detailed section even if there is only a brief
85 ALWAYS_DETAILED_SEC = NO
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show
88 # all inherited members of a class in the documentation of that class
89 # as if those members were ordinary class members. Constructors,
90 # destructors and assignment operators of the base classes will not be
93 INLINE_INHERITED_MEMB = NO
95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96 # path before files name in the file list and in the header files. If set
97 # to NO the shortest path that makes the file name unique will be used.
101 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102 # can be used to strip a user-defined part of the path. Stripping is
103 # only done if one of the specified strings matches the left-hand part of
104 # the path. The tag can be used to show relative paths in the file list.
105 # If left blank the directory from which doxygen is run is used as the
110 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
111 # the path mentioned in the documentation of a class, which tells
112 # the reader which header file to include in order to use a class.
113 # If left blank only the name of the header file containing the class
114 # definition is used. Otherwise one should specify the include paths that
115 # are normally passed to the compiler using the -I flag.
117 STRIP_FROM_INC_PATH =
119 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
120 # (but less readable) file names. This can be useful is your file systems
121 # doesn't support long names like on DOS, Mac, or CD-ROM.
125 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
126 # will interpret the first line (until the first dot) of a JavaDoc-style
127 # comment as the brief description. If set to NO, the JavaDoc
128 # comments will behave just like the Qt-style comments (thus requiring an
129 # explicit @brief command for a brief description.
131 JAVADOC_AUTOBRIEF = NO
133 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
134 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
135 # comments) as a brief description. This used to be the default behaviour.
136 # The new default is to treat a multi-line C++ comment block as a detailed
137 # description. Set this tag to YES if you prefer the old behaviour instead.
139 MULTILINE_CPP_IS_BRIEF = NO
141 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
142 # member inherits the documentation from any documented member that it
147 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
148 # tag is set to YES, then doxygen will reuse the documentation of the first
149 # member in the group (if any) for the other members of the group. By default
150 # all members of a group must be documented explicitly.
152 DISTRIBUTE_GROUP_DOC = NO
154 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
155 # Doxygen uses this value to replace tabs by spaces in code fragments.
159 # This tag can be used to specify a number of aliases that acts
160 # as commands in the documentation. An alias has the form "name=value".
161 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
162 # put the command \sideeffect (or @sideeffect) in the documentation, which
163 # will result in a user-defined paragraph with heading "Side Effects:".
164 # You can put \n's in the value part of an alias to insert newlines.
168 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
169 # only. Doxygen will then generate output that is more tailored for C.
170 # For instance, some of the names that are used will be different. The list
171 # of all members will be omitted, etc.
173 OPTIMIZE_OUTPUT_FOR_C = NO
175 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
176 # only. Doxygen will then generate output that is more tailored for Java.
177 # For instance, namespaces will be presented as packages, qualified scopes
178 # will look different, etc.
180 OPTIMIZE_OUTPUT_JAVA = NO
182 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
183 # the same type (for instance a group of public functions) to be put as a
184 # subgroup of that type (e.g. under the Public Functions section). Set it to
185 # NO to prevent subgrouping. Alternatively, this can be done per class using
186 # the \nosubgrouping command.
190 #---------------------------------------------------------------------------
191 # Build related configuration options
192 #---------------------------------------------------------------------------
194 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
195 # documentation are documented, even if no documentation was available.
196 # Private class members and static file members will be hidden unless
197 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
201 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
202 # will be included in the documentation.
204 EXTRACT_PRIVATE = YES
206 # If the EXTRACT_STATIC tag is set to YES all static members of a file
207 # will be included in the documentation.
211 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
212 # defined locally in source files will be included in the documentation.
213 # If set to NO only classes defined in header files are included.
215 EXTRACT_LOCAL_CLASSES = YES
217 # This flag is only useful for Objective-C code. When set to YES local
218 # methods, which are defined in the implementation section but not in
219 # the interface are included in the documentation.
220 # If set to NO (the default) only methods in the interface are included.
222 EXTRACT_LOCAL_METHODS = YES
224 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
225 # undocumented members of documented classes, files or namespaces.
226 # If set to NO (the default) these members will be included in the
227 # various overviews, but no documentation section is generated.
228 # This option has no effect if EXTRACT_ALL is enabled.
230 HIDE_UNDOC_MEMBERS = NO
232 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
233 # undocumented classes that are normally visible in the class hierarchy.
234 # If set to NO (the default) these classes will be included in the various
235 # overviews. This option has no effect if EXTRACT_ALL is enabled.
237 HIDE_UNDOC_CLASSES = NO
239 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
240 # friend (class|struct|union) declarations.
241 # If set to NO (the default) these declarations will be included in the
244 HIDE_FRIEND_COMPOUNDS = NO
246 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
247 # documentation blocks found inside the body of a function.
248 # If set to NO (the default) these blocks will be appended to the
249 # function's detailed documentation block.
251 HIDE_IN_BODY_DOCS = NO
253 # The INTERNAL_DOCS tag determines if documentation
254 # that is typed after a \internal command is included. If the tag is set
255 # to NO (the default) then the documentation will be excluded.
256 # Set it to YES to include the internal documentation.
260 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
261 # file names in lower-case letters. If set to YES upper-case letters are also
262 # allowed. This is useful if you have classes or files whose names only differ
263 # in case and if your file system supports case sensitive file names. Windows
264 # and Mac users are advised to set this option to NO.
266 CASE_SENSE_NAMES = YES
268 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
269 # will show members with their full class and namespace scopes in the
270 # documentation. If set to YES the scope will be hidden.
272 HIDE_SCOPE_NAMES = NO
274 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
275 # will put a list of the files that are included by a file in the documentation
278 SHOW_INCLUDE_FILES = YES
280 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
281 # is inserted in the documentation for inline members.
285 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
286 # will sort the (detailed) documentation of file and class members
287 # alphabetically by member name. If set to NO the members will appear in
290 SORT_MEMBER_DOCS = YES
292 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
293 # brief documentation of file, namespace and class members alphabetically
294 # by member name. If set to NO (the default) the members will appear in
299 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
300 # sorted by fully-qualified names, including namespaces. If set to
301 # NO (the default), the class list will be sorted only by class name,
302 # not including the namespace part.
303 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
304 # Note: This option applies only to the class list, not to the
307 SORT_BY_SCOPE_NAME = NO
309 # The GENERATE_TODOLIST tag can be used to enable (YES) or
310 # disable (NO) the todo list. This list is created by putting \todo
311 # commands in the documentation.
313 GENERATE_TODOLIST = YES
315 # The GENERATE_TESTLIST tag can be used to enable (YES) or
316 # disable (NO) the test list. This list is created by putting \test
317 # commands in the documentation.
319 GENERATE_TESTLIST = YES
321 # The GENERATE_BUGLIST tag can be used to enable (YES) or
322 # disable (NO) the bug list. This list is created by putting \bug
323 # commands in the documentation.
325 GENERATE_BUGLIST = YES
327 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
328 # disable (NO) the deprecated list. This list is created by putting
329 # \deprecated commands in the documentation.
331 GENERATE_DEPRECATEDLIST= YES
333 # The ENABLED_SECTIONS tag can be used to enable conditional
334 # documentation sections, marked by \if sectionname ... \endif.
338 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
339 # the initial value of a variable or define consists of for it to appear in
340 # the documentation. If the initializer consists of more lines than specified
341 # here it will be hidden. Use a value of 0 to hide initializers completely.
342 # The appearance of the initializer of individual variables and defines in the
343 # documentation can be controlled using \showinitializer or \hideinitializer
344 # command in the documentation regardless of this setting.
346 MAX_INITIALIZER_LINES = 30
348 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
349 # at the bottom of the documentation of classes and structs. If set to YES the
350 # list will mention the files that were used to generate the documentation.
352 SHOW_USED_FILES = YES
354 #---------------------------------------------------------------------------
355 # configuration options related to warning and progress messages
356 #---------------------------------------------------------------------------
358 # The QUIET tag can be used to turn on/off the messages that are generated
359 # by doxygen. Possible values are YES and NO. If left blank NO is used.
363 # The WARNINGS tag can be used to turn on/off the warning messages that are
364 # generated by doxygen. Possible values are YES and NO. If left blank
369 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
370 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
371 # automatically be disabled.
373 WARN_IF_UNDOCUMENTED = YES
375 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
376 # potential errors in the documentation, such as not documenting some
377 # parameters in a documented function, or documenting parameters that
378 # don't exist or using markup commands wrongly.
380 WARN_IF_DOC_ERROR = YES
382 # The WARN_FORMAT tag determines the format of the warning messages that
383 # doxygen can produce. The string should contain the $file, $line, and $text
384 # tags, which will be replaced by the file and line number from which the
385 # warning originated and the warning text.
387 WARN_FORMAT = "$file:$line: $text"
389 # The WARN_LOGFILE tag can be used to specify a file to which warning
390 # and error messages should be written. If left blank the output is written
395 #---------------------------------------------------------------------------
396 # configuration options related to the input files
397 #---------------------------------------------------------------------------
399 # The INPUT tag can be used to specify the files and/or directories that contain
400 # documented source files. You may enter file names like "myfile.cpp" or
401 # directories like "/usr/src/myproject". Separate the files or directories
406 # If the value of the INPUT tag contains directories, you can use the
407 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
408 # and *.h) to filter out the source-files in the directories. If left
409 # blank the following patterns are tested:
410 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
411 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
415 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
416 # should be searched for input files as well. Possible values are YES and NO.
417 # If left blank NO is used.
421 # The EXCLUDE tag can be used to specify files and/or directories that should
422 # excluded from the INPUT source files. This way you can easily exclude a
423 # subdirectory from a directory tree whose root is specified with the INPUT tag.
427 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
428 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
430 EXCLUDE_SYMLINKS = NO
432 # If the value of the INPUT tag contains directories, you can use the
433 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
434 # certain files from those directories.
436 EXCLUDE_PATTERNS = ex_*.cpp test_*.cpp
438 # The EXAMPLE_PATH tag can be used to specify one or more files or
439 # directories that contain example code fragments that are included (see
440 # the \include command).
444 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
445 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
446 # and *.h) to filter out the source-files in the directories. If left
447 # blank all files are included.
451 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
452 # searched for input files to be used with the \include or \dontinclude
453 # commands irrespective of the value of the RECURSIVE tag.
454 # Possible values are YES and NO. If left blank NO is used.
456 EXAMPLE_RECURSIVE = NO
458 # The IMAGE_PATH tag can be used to specify one or more files or
459 # directories that contain image that are included in the documentation (see
460 # the \image command).
464 # The INPUT_FILTER tag can be used to specify a program that doxygen should
465 # invoke to filter for each input file. Doxygen will invoke the filter program
466 # by executing (via popen()) the command <filter> <input-file>, where <filter>
467 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
468 # input file. Doxygen will then use the output that the filter program writes
469 # to standard output. If FILTER_PATTERNS is specified, this tag will be
474 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
475 # basis. Doxygen will compare the file name with each pattern and apply the
476 # filter if there is a match. The filters are a list of the form:
477 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
478 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
479 # is applied to all files.
483 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
484 # INPUT_FILTER) will be used to filter the input files when producing source
485 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
487 FILTER_SOURCE_FILES = NO
489 #---------------------------------------------------------------------------
490 # configuration options related to source browsing
491 #---------------------------------------------------------------------------
493 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
494 # be generated. Documented entities will be cross-referenced with these sources.
495 # Note: To get rid of all source code in the generated output, make sure also
496 # VERBATIM_HEADERS is set to NO.
500 # Setting the INLINE_SOURCES tag to YES will include the body
501 # of functions and classes directly in the documentation.
505 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
506 # doxygen to hide any special comment blocks from generated source code
507 # fragments. Normal C and C++ comments will always remain visible.
509 STRIP_CODE_COMMENTS = YES
511 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
512 # then for each documented function all documented
513 # functions referencing it will be listed.
515 REFERENCED_BY_RELATION = YES
517 # If the REFERENCES_RELATION tag is set to YES (the default)
518 # then for each documented function all documented entities
519 # called/used by that function will be listed.
521 REFERENCES_RELATION = YES
523 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
524 # will generate a verbatim copy of the header file for each class for
525 # which an include is specified. Set to NO to disable this.
527 VERBATIM_HEADERS = YES
529 #---------------------------------------------------------------------------
530 # configuration options related to the alphabetical class index
531 #---------------------------------------------------------------------------
533 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
534 # of all compounds will be generated. Enable this if the project
535 # contains a lot of classes, structs, unions or interfaces.
537 ALPHABETICAL_INDEX = YES
539 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
540 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
541 # in which this list will be split (can be a number in the range [1..20])
543 COLS_IN_ALPHA_INDEX = 5
545 # In case all classes in a project start with a common prefix, all
546 # classes will be put under the same header in the alphabetical index.
547 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
548 # should be ignored while generating the index headers.
552 #---------------------------------------------------------------------------
553 # configuration options related to the HTML output
554 #---------------------------------------------------------------------------
556 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
557 # generate HTML output.
561 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
562 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
563 # put in front of it. If left blank `html' will be used as the default path.
567 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
568 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
569 # doxygen will generate files with .html extension.
571 HTML_FILE_EXTENSION = .html
573 # The HTML_HEADER tag can be used to specify a personal HTML header for
574 # each generated HTML page. If it is left blank doxygen will generate a
579 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
580 # each generated HTML page. If it is left blank doxygen will generate a
585 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
586 # style sheet that is used by each HTML page. It can be used to
587 # fine-tune the look of the HTML output. If the tag is left blank doxygen
588 # will generate a default style sheet. Note that doxygen will try to copy
589 # the style sheet file to the HTML output directory, so don't put your own
590 # stylesheet in the HTML output directory as well, or it will be erased!
594 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
595 # files or namespaces will be aligned in HTML using tables. If set to
596 # NO a bullet list will be used.
598 HTML_ALIGN_MEMBERS = YES
600 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
601 # will be generated that can be used as input for tools like the
602 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
603 # of the generated HTML documentation.
605 GENERATE_HTMLHELP = NO
607 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
608 # be used to specify the file name of the resulting .chm file. You
609 # can add a path in front of the file if the result should not be
610 # written to the html output directory.
614 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
615 # be used to specify the location (absolute path including file name) of
616 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
617 # the HTML help compiler on the generated index.hhp.
621 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
622 # controls if a separate .chi index file is generated (YES) or that
623 # it should be included in the master .chm file (NO).
627 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
628 # controls whether a binary table of contents is generated (YES) or a
629 # normal table of contents (NO) in the .chm file.
633 # The TOC_EXPAND flag can be set to YES to add extra items for group members
634 # to the contents of the HTML help documentation and to the tree view.
638 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
639 # top of each HTML page. The value NO (the default) enables the index and
640 # the value YES disables it.
644 # This tag can be used to set the number of enum values (range [1..20])
645 # that doxygen will group on one line in the generated HTML documentation.
647 ENUM_VALUES_PER_LINE = 4
649 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
650 # generated containing a tree-like index structure (just like the one that
651 # is generated for HTML Help). For this to work a browser that supports
652 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
653 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
654 # probably better off using the HTML help feature.
656 GENERATE_TREEVIEW = NO
658 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
659 # used to set the initial width (in pixels) of the frame in which the tree
664 #---------------------------------------------------------------------------
665 # configuration options related to the LaTeX output
666 #---------------------------------------------------------------------------
668 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
669 # generate Latex output.
673 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
674 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
675 # put in front of it. If left blank `latex' will be used as the default path.
679 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
680 # invoked. If left blank `latex' will be used as the default command name.
682 LATEX_CMD_NAME = latex
684 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
685 # generate index for LaTeX. If left blank `makeindex' will be used as the
686 # default command name.
688 MAKEINDEX_CMD_NAME = makeindex
690 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
691 # LaTeX documents. This may be useful for small projects and may help to
692 # save some trees in general.
696 # The PAPER_TYPE tag can be used to set the paper type that is used
697 # by the printer. Possible values are: a4, a4wide, letter, legal and
698 # executive. If left blank a4wide will be used.
702 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
703 # packages that should be included in the LaTeX output.
707 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
708 # the generated latex document. The header should contain everything until
709 # the first chapter. If it is left blank doxygen will generate a
710 # standard header. Notice: only use this tag if you know what you are doing!
714 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
715 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
716 # contain links (just like the HTML output) instead of page references
717 # This makes the output suitable for online browsing using a pdf viewer.
721 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
722 # plain latex in the generated Makefile. Set this option to YES to get a
723 # higher quality PDF documentation.
727 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
728 # command to the generated LaTeX files. This will instruct LaTeX to keep
729 # running if errors occur, instead of asking the user for help.
730 # This option is also used when generating formulas in HTML.
734 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
735 # include the index chapters (such as File Index, Compound Index, etc.)
738 LATEX_HIDE_INDICES = NO
740 #---------------------------------------------------------------------------
741 # configuration options related to the RTF output
742 #---------------------------------------------------------------------------
744 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
745 # The RTF output is optimized for Word 97 and may not look very pretty with
746 # other RTF readers or editors.
750 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
751 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
752 # put in front of it. If left blank `rtf' will be used as the default path.
756 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
757 # RTF documents. This may be useful for small projects and may help to
758 # save some trees in general.
762 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
763 # will contain hyperlink fields. The RTF file will
764 # contain links (just like the HTML output) instead of page references.
765 # This makes the output suitable for online browsing using WORD or other
766 # programs which support those fields.
767 # Note: wordpad (write) and others do not support links.
771 # Load stylesheet definitions from file. Syntax is similar to doxygen's
772 # config file, i.e. a series of assignments. You only have to provide
773 # replacements, missing definitions are set to their default value.
775 RTF_STYLESHEET_FILE =
777 # Set optional variables used in the generation of an rtf document.
778 # Syntax is similar to doxygen's config file.
780 RTF_EXTENSIONS_FILE =
782 #---------------------------------------------------------------------------
783 # configuration options related to the man page output
784 #---------------------------------------------------------------------------
786 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
791 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
792 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
793 # put in front of it. If left blank `man' will be used as the default path.
797 # The MAN_EXTENSION tag determines the extension that is added to
798 # the generated man pages (default is the subroutine's section .3)
802 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
803 # then it will generate one additional man file for each entity
804 # documented in the real man page(s). These additional files
805 # only source the real man page, but without them the man command
806 # would be unable to find the correct page. The default is NO.
810 #---------------------------------------------------------------------------
811 # configuration options related to the XML output
812 #---------------------------------------------------------------------------
814 # If the GENERATE_XML tag is set to YES Doxygen will
815 # generate an XML file that captures the structure of
816 # the code including all documentation.
820 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
821 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
822 # put in front of it. If left blank `xml' will be used as the default path.
826 # The XML_SCHEMA tag can be used to specify an XML schema,
827 # which can be used by a validating XML parser to check the
828 # syntax of the XML files.
832 # The XML_DTD tag can be used to specify an XML DTD,
833 # which can be used by a validating XML parser to check the
834 # syntax of the XML files.
838 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
839 # dump the program listings (including syntax highlighting
840 # and cross-referencing information) to the XML output. Note that
841 # enabling this will significantly increase the size of the XML output.
843 XML_PROGRAMLISTING = YES
845 #---------------------------------------------------------------------------
846 # configuration options for the AutoGen Definitions output
847 #---------------------------------------------------------------------------
849 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
850 # generate an AutoGen Definitions (see autogen.sf.net) file
851 # that captures the structure of the code including all
852 # documentation. Note that this feature is still experimental
853 # and incomplete at the moment.
855 GENERATE_AUTOGEN_DEF = NO
857 #---------------------------------------------------------------------------
858 # configuration options related to the Perl module output
859 #---------------------------------------------------------------------------
861 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
862 # generate a Perl module file that captures the structure of
863 # the code including all documentation. Note that this
864 # feature is still experimental and incomplete at the
867 GENERATE_PERLMOD = NO
869 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
870 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
871 # to generate PDF and DVI output from the Perl module output.
875 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
876 # nicely formatted so it can be parsed by a human reader. This is useful
877 # if you want to understand what is going on. On the other hand, if this
878 # tag is set to NO the size of the Perl module output will be much smaller
879 # and Perl will parse it just the same.
883 # The names of the make variables in the generated doxyrules.make file
884 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
885 # This is useful so different doxyrules.make files included by the same
886 # Makefile don't overwrite each other's variables.
888 PERLMOD_MAKEVAR_PREFIX =
890 #---------------------------------------------------------------------------
891 # Configuration options related to the preprocessor
892 #---------------------------------------------------------------------------
894 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
895 # evaluate all C-preprocessor directives found in the sources and include
898 ENABLE_PREPROCESSING = YES
900 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
901 # names in the source code. If set to NO (the default) only conditional
902 # compilation will be performed. Macro expansion can be done in a controlled
903 # way by setting EXPAND_ONLY_PREDEF to YES.
905 MACRO_EXPANSION = YES
907 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
908 # then the macro expansion is limited to the macros specified with the
909 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
911 EXPAND_ONLY_PREDEF = YES
913 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
914 # in the INCLUDE_PATH (see below) will be search if a #include is found.
916 SEARCH_INCLUDES = YES
918 # The INCLUDE_PATH tag can be used to specify one or more directories that
919 # contain include files that are not input files but should be processed by
924 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
925 # patterns (like *.h and *.hpp) to filter out the header-files in the
926 # directories. If left blank, the patterns specified with FILE_PATTERNS will
929 INCLUDE_FILE_PATTERNS =
931 # The PREDEFINED tag can be used to specify one or more macro names that
932 # are defined before the preprocessor is started (similar to the -D option of
933 # gcc). The argument of the tag is a list of macros of the form: name
934 # or name=definition (no spaces). If the definition and the = are
935 # omitted =1 is assumed.
937 PREDEFINED = "YAZ_BEGIN_CDECL= " "YAZ_END_CDECL=" "YAZ_EXPORT="
939 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
940 # this tag can be used to specify a list of macro names that should be expanded.
941 # The macro definition that is found in the sources will be used.
942 # Use the PREDEFINED tag if you want to use a different macro definition.
944 EXPAND_AS_DEFINED = YAZ_BEGIN_CDECL YAZ_END_CDECL YAZ_EXPORT
946 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
947 # doxygen's preprocessor will remove all function-like macros that are alone
948 # on a line, have an all uppercase name, and do not end with a semicolon. Such
949 # function macros are typically used for boiler-plate code, and will confuse the
950 # parser if not removed.
952 SKIP_FUNCTION_MACROS = YES
954 #---------------------------------------------------------------------------
955 # Configuration::additions related to external references
956 #---------------------------------------------------------------------------
958 # The TAGFILES option can be used to specify one or more tagfiles.
959 # Optionally an initial location of the external documentation
960 # can be added for each tagfile. The format of a tag file without
961 # this location is as follows:
962 # TAGFILES = file1 file2 ...
963 # Adding location for the tag files is done as follows:
964 # TAGFILES = file1=loc1 "file2 = loc2" ...
965 # where "loc1" and "loc2" can be relative or absolute paths or
966 # URLs. If a location is present for each tag, the installdox tool
967 # does not have to be run to correct the links.
968 # Note that each tag file must have a unique name
969 # (where the name does NOT include the path)
970 # If a tag file is not located in the directory in which doxygen
971 # is run, you must also specify the path to the tagfile here.
975 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
976 # a tag file that is based on the input files it reads.
980 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
981 # in the class index. If set to NO only the inherited external classes
986 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
987 # in the modules index. If set to NO, only the current project's groups will
990 EXTERNAL_GROUPS = YES
992 # The PERL_PATH should be the absolute path and name of the perl script
993 # interpreter (i.e. the result of `which perl').
995 PERL_PATH = /usr/bin/perl
997 #---------------------------------------------------------------------------
998 # Configuration options related to the dot tool
999 #---------------------------------------------------------------------------
1001 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1002 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1003 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1004 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1005 # recommended to install and use dot, since it yields more powerful graphs.
1007 CLASS_DIAGRAMS = YES
1009 # If set to YES, the inheritance and collaboration graphs will hide
1010 # inheritance and usage relations if the target is undocumented
1011 # or is not a class.
1013 HIDE_UNDOC_RELATIONS = YES
1015 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1016 # available from the path. This tool is part of Graphviz, a graph visualization
1017 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1018 # have no effect if this option is set to NO (the default)
1022 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1023 # will generate a graph for each documented class showing the direct and
1024 # indirect inheritance relations. Setting this tag to YES will force the
1025 # the CLASS_DIAGRAMS tag to NO.
1029 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1030 # will generate a graph for each documented class showing the direct and
1031 # indirect implementation dependencies (inheritance, containment, and
1032 # class references variables) of the class with other documented classes.
1034 COLLABORATION_GRAPH = YES
1036 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1037 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1042 # If set to YES, the inheritance and collaboration graphs will show the
1043 # relations between templates and their instances.
1045 TEMPLATE_RELATIONS = YES
1047 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1048 # tags are set to YES then doxygen will generate a graph for each documented
1049 # file showing the direct and indirect include dependencies of the file with
1050 # other documented files.
1054 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1055 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1056 # documented header file showing the documented files that directly or
1057 # indirectly include this file.
1059 INCLUDED_BY_GRAPH = YES
1061 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1062 # generate a call dependency graph for every global function or class method.
1063 # Note that enabling this option will significantly increase the time of a run.
1064 # So in most cases it will be better to enable call graphs for selected
1065 # functions only using the \callgraph command.
1069 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1070 # will graphical hierarchy of all classes instead of a textual one.
1072 GRAPHICAL_HIERARCHY = YES
1074 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1075 # generated by dot. Possible values are png, jpg, or gif
1076 # If left blank png will be used.
1078 DOT_IMAGE_FORMAT = png
1080 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1081 # found. If left blank, it is assumed the dot tool can be found on the path.
1085 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1086 # contain dot files that are included in the documentation (see the
1087 # \dotfile command).
1091 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1092 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1093 # from the root by following a path via at most 3 edges will be shown. Nodes that
1094 # lay further from the root node will be omitted. Note that setting this option to
1095 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1096 # note that a graph may be further truncated if the graph's image dimensions are
1097 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1098 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1100 MAX_DOT_GRAPH_DEPTH = 0
1102 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1103 # generate a legend page explaining the meaning of the various boxes and
1104 # arrows in the dot generated graphs.
1106 GENERATE_LEGEND = YES
1108 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1109 # remove the intermediate dot files that are used to generate
1110 # the various graphs.
1114 #---------------------------------------------------------------------------
1115 # Configuration::additions related to the search engine
1116 #---------------------------------------------------------------------------
1118 # The SEARCHENGINE tag specifies whether or not a search engine should be
1119 # used. If set to NO the values of all tags below this one will be ignored.