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 # General 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 = "Gedcom Parser Library"
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 = "Release @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 = @top_srcdir@/doc
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
44 OUTPUT_LANGUAGE = English
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows enconding, (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for the
52 # all platforms other than Windows).
54 USE_WINDOWS_ENCODING = NO
56 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
57 # documentation are documented, even if no documentation was available.
58 # Private class members and static file members will be hidden unless
59 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
63 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
64 # will be included in the documentation.
68 # If the EXTRACT_STATIC tag is set to YES all static members of a file
69 # will be included in the documentation.
73 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
74 # defined locally in source files will be included in the documentation.
75 # If set to NO only classes defined in header files are included.
77 EXTRACT_LOCAL_CLASSES = YES
79 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
80 # undocumented members of documented classes, files or namespaces.
81 # If set to NO (the default) these members will be included in the
82 # various overviews, but no documentation section is generated.
83 # This option has no effect if EXTRACT_ALL is enabled.
85 HIDE_UNDOC_MEMBERS = NO
87 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
88 # undocumented classes that are normally visible in the class hierarchy.
89 # If set to NO (the default) these class will be included in the various
90 # overviews. This option has no effect if EXTRACT_ALL is enabled.
92 HIDE_UNDOC_CLASSES = NO
94 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
95 # friend (class|struct|union) declarations.
96 # If set to NO (the default) these declarations will be included in the
99 HIDE_FRIEND_COMPOUNDS = NO
101 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
102 # documentation blocks found inside the body of a function.
103 # If set to NO (the default) these blocks will be appended to the
104 # function's detailed documentation block.
106 HIDE_IN_BODY_DOCS = NO
108 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
109 # include brief member descriptions after the members that are listed in
110 # the file and class documentation (similar to JavaDoc).
111 # Set to NO to disable this.
113 BRIEF_MEMBER_DESC = YES
115 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
116 # the brief description of a member or function before the detailed description.
117 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
118 # brief descriptions will be completely suppressed.
122 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
123 # Doxygen will generate a detailed section even if there is only a brief
126 ALWAYS_DETAILED_SEC = NO
128 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
129 # members of a class in the documentation of that class as if those members were
130 # ordinary class members. Constructors, destructors and assignment operators of
131 # the base classes will not be shown.
133 INLINE_INHERITED_MEMB = NO
135 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
136 # path before files name in the file list and in the header files. If set
137 # to NO the shortest path that makes the file name unique will be used.
141 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
142 # can be used to strip a user defined part of the path. Stripping is
143 # only done if one of the specified strings matches the left-hand part of
144 # the path. It is allowed to use relative paths in the argument list.
148 # The INTERNAL_DOCS tag determines if documentation
149 # that is typed after a \internal command is included. If the tag is set
150 # to NO (the default) then the documentation will be excluded.
151 # Set it to YES to include the internal documentation.
155 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
156 # file names in lower case letters. If set to YES upper case letters are also
157 # allowed. This is useful if you have classes or files whose names only differ
158 # in case and if your file system supports case sensitive file names. Windows
159 # users are adviced to set this option to NO.
161 CASE_SENSE_NAMES = YES
163 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
164 # (but less readable) file names. This can be useful is your file systems
165 # doesn't support long names like on DOS, Mac, or CD-ROM.
169 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
170 # will show members with their full class and namespace scopes in the
171 # documentation. If set to YES the scope will be hidden.
173 HIDE_SCOPE_NAMES = NO
175 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
176 # will generate a verbatim copy of the header file for each class for
177 # which an include is specified. Set to NO to disable this.
179 VERBATIM_HEADERS = NO
181 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
182 # will put list of the files that are included by a file in the documentation
185 SHOW_INCLUDE_FILES = NO
187 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
188 # will interpret the first line (until the first dot) of a JavaDoc-style
189 # comment as the brief description. If set to NO, the JavaDoc
190 # comments will behave just like the Qt-style comments (thus requiring an
191 # explict @brief command for a brief description.
193 JAVADOC_AUTOBRIEF = NO
195 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
196 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
197 # comments) as a brief description. This used to be the default behaviour.
198 # The new default is to treat a multi-line C++ comment block as a detailed
199 # description. Set this tag to YES if you prefer the old behaviour instead.
201 MULTILINE_CPP_IS_BRIEF = NO
203 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
204 # will output the detailed description near the top, like JavaDoc.
205 # If set to NO, the detailed description appears after the member
210 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
211 # member inherits the documentation from any documented member that it
216 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
217 # is inserted in the documentation for inline members.
221 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
222 # will sort the (detailed) documentation of file and class members
223 # alphabetically by member name. If set to NO the members will appear in
226 SORT_MEMBER_DOCS = NO
228 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
229 # tag is set to YES, then doxygen will reuse the documentation of the first
230 # member in the group (if any) for the other members of the group. By default
231 # all members of a group must be documented explicitly.
233 DISTRIBUTE_GROUP_DOC = NO
235 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
236 # Doxygen uses this value to replace tabs by spaces in code fragments.
240 # The GENERATE_TODOLIST tag can be used to enable (YES) or
241 # disable (NO) the todo list. This list is created by putting \todo
242 # commands in the documentation.
244 GENERATE_TODOLIST = YES
246 # The GENERATE_TESTLIST tag can be used to enable (YES) or
247 # disable (NO) the test list. This list is created by putting \test
248 # commands in the documentation.
250 GENERATE_TESTLIST = YES
252 # The GENERATE_BUGLIST tag can be used to enable (YES) or
253 # disable (NO) the bug list. This list is created by putting \bug
254 # commands in the documentation.
256 GENERATE_BUGLIST = YES
258 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
259 # disable (NO) the deprecated list. This list is created by putting
260 # \deprecated commands in the documentation.
262 GENERATE_DEPRECATEDLIST= YES
264 # This tag can be used to specify a number of aliases that acts
265 # as commands in the documentation. An alias has the form "name=value".
266 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
267 # put the command \sideeffect (or @sideeffect) in the documentation, which
268 # will result in a user defined paragraph with heading "Side Effects:".
269 # You can put \n's in the value part of an alias to insert newlines.
273 # The ENABLED_SECTIONS tag can be used to enable conditional
274 # documentation sections, marked by \if sectionname ... \endif.
278 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
279 # the initial value of a variable or define consist of for it to appear in
280 # the documentation. If the initializer consists of more lines than specified
281 # here it will be hidden. Use a value of 0 to hide initializers completely.
282 # The appearance of the initializer of individual variables and defines in the
283 # documentation can be controlled using \showinitializer or \hideinitializer
284 # command in the documentation regardless of this setting.
286 MAX_INITIALIZER_LINES = 30
288 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
289 # only. Doxygen will then generate output that is more tailored for C.
290 # For instance some of the names that are used will be different. The list
291 # of all members will be omitted, etc.
293 OPTIMIZE_OUTPUT_FOR_C = NO
295 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
296 # only. Doxygen will then generate output that is more tailored for Java.
297 # For instance namespaces will be presented as packages, qualified scopes
298 # will look different, etc.
300 OPTIMIZE_OUTPUT_JAVA = NO
302 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
303 # at the bottom of the documentation of classes and structs. If set to YES the
304 # list will mention the files that were used to generate the documentation.
308 #---------------------------------------------------------------------------
309 # configuration options related to warning and progress messages
310 #---------------------------------------------------------------------------
312 # The QUIET tag can be used to turn on/off the messages that are generated
313 # by doxygen. Possible values are YES and NO. If left blank NO is used.
317 # The WARNINGS tag can be used to turn on/off the warning messages that are
318 # generated by doxygen. Possible values are YES and NO. If left blank
323 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
324 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
325 # automatically be disabled.
327 WARN_IF_UNDOCUMENTED = YES
329 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
330 # potential errors in the documentation, such as not documenting some
331 # parameters in a documented function, or documenting parameters that
332 # don't exist or using markup commands wrongly.
334 WARN_IF_DOC_ERROR = YES
336 # The WARN_FORMAT tag determines the format of the warning messages that
337 # doxygen can produce. The string should contain the $file, $line, and $text
338 # tags, which will be replaced by the file and line number from which the
339 # warning originated and the warning text.
341 WARN_FORMAT = "$file:$line: $text"
343 # The WARN_LOGFILE tag can be used to specify a file to which warning
344 # and error messages should be written. If left blank the output is written
349 #---------------------------------------------------------------------------
350 # configuration options related to the input files
351 #---------------------------------------------------------------------------
353 # The INPUT tag can be used to specify the files and/or directories that contain
354 # documented source files. You may enter file names like "myfile.cpp" or
355 # directories like "/usr/src/myproject". Separate the files or directories
359 @top_srcdir@/include \
362 # If the value of the INPUT tag contains directories, you can use the
363 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
364 # and *.h) to filter out the source-files in the directories. If left
365 # blank the following patterns are tested:
366 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
369 FILE_PATTERNS = *.h.in \
373 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
374 # should be searched for input files as well. Possible values are YES and NO.
375 # If left blank NO is used.
379 # The EXCLUDE tag can be used to specify files and/or directories that should
380 # excluded from the INPUT source files. This way you can easily exclude a
381 # subdirectory from a directory tree whose root is specified with the INPUT tag.
385 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
386 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
388 EXCLUDE_SYMLINKS = NO
390 # If the value of the INPUT tag contains directories, you can use the
391 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
392 # certain files from those directories.
396 # The EXAMPLE_PATH tag can be used to specify one or more files or
397 # directories that contain example code fragments that are included (see
398 # the \include command).
402 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
403 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
404 # and *.h) to filter out the source-files in the directories. If left
405 # blank all files are included.
409 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
410 # searched for input files to be used with the \include or \dontinclude
411 # commands irrespective of the value of the RECURSIVE tag.
412 # Possible values are YES and NO. If left blank NO is used.
414 EXAMPLE_RECURSIVE = NO
416 # The IMAGE_PATH tag can be used to specify one or more files or
417 # directories that contain image that are included in the documentation (see
418 # the \image command).
422 # The INPUT_FILTER tag can be used to specify a program that doxygen should
423 # invoke to filter for each input file. Doxygen will invoke the filter program
424 # by executing (via popen()) the command <filter> <input-file>, where <filter>
425 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
426 # input file. Doxygen will then use the output that the filter program writes
427 # to standard output.
431 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
432 # INPUT_FILTER) will be used to filter the input files when producing source
433 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
435 FILTER_SOURCE_FILES = NO
437 #---------------------------------------------------------------------------
438 # configuration options related to source browsing
439 #---------------------------------------------------------------------------
441 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
442 # be generated. Documented entities will be cross-referenced with these sources.
446 # Setting the INLINE_SOURCES tag to YES will include the body
447 # of functions and classes directly in the documentation.
451 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
452 # doxygen to hide any special comment blocks from generated source code
453 # fragments. Normal C and C++ comments will always remain visible.
455 STRIP_CODE_COMMENTS = YES
457 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
458 # then for each documented function all documented
459 # functions referencing it will be listed.
461 REFERENCED_BY_RELATION = YES
463 # If the REFERENCES_RELATION tag is set to YES (the default)
464 # then for each documented function all documented entities
465 # called/used by that function will be listed.
467 REFERENCES_RELATION = YES
469 #---------------------------------------------------------------------------
470 # configuration options related to the alphabetical class index
471 #---------------------------------------------------------------------------
473 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
474 # of all compounds will be generated. Enable this if the project
475 # contains a lot of classes, structs, unions or interfaces.
477 ALPHABETICAL_INDEX = NO
479 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
480 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
481 # in which this list will be split (can be a number in the range [1..20])
483 COLS_IN_ALPHA_INDEX = 5
485 # In case all classes in a project start with a common prefix, all
486 # classes will be put under the same header in the alphabetical index.
487 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
488 # should be ignored while generating the index headers.
492 #---------------------------------------------------------------------------
493 # configuration options related to the HTML output
494 #---------------------------------------------------------------------------
496 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
497 # generate HTML output.
501 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
502 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
503 # put in front of it. If left blank `html' will be used as the default path.
507 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
508 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
509 # doxygen will generate files with .html extension.
511 HTML_FILE_EXTENSION = .html
513 # The HTML_HEADER tag can be used to specify a personal HTML header for
514 # each generated HTML page. If it is left blank doxygen will generate a
519 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
520 # each generated HTML page. If it is left blank doxygen will generate a
523 HTML_FOOTER = myfooter.html
525 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
526 # style sheet that is used by each HTML page. It can be used to
527 # fine-tune the look of the HTML output. If the tag is left blank doxygen
528 # will generate a default style sheet
532 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
533 # files or namespaces will be aligned in HTML using tables. If set to
534 # NO a bullet list will be used.
536 HTML_ALIGN_MEMBERS = NO
538 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
539 # will be generated that can be used as input for tools like the
540 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
541 # of the generated HTML documentation.
543 GENERATE_HTMLHELP = NO
545 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
546 # be used to specify the file name of the resulting .chm file. You
547 # can add a path in front of the file if the result should not be
548 # written to the html output dir.
552 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
553 # be used to specify the location (absolute path including file name) of
554 # the HTML help compiler (hhc.exe). If non empty doxygen will try to run
555 # the html help compiler on the generated index.hhp.
559 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
560 # controls if a separate .chi index file is generated (YES) or that
561 # it should be included in the master .chm file (NO).
565 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
566 # controls whether a binary table of contents is generated (YES) or a
567 # normal table of contents (NO) in the .chm file.
571 # The TOC_EXPAND flag can be set to YES to add extra items for group members
572 # to the contents of the Html help documentation and to the tree view.
576 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
577 # top of each HTML page. The value NO (the default) enables the index and
578 # the value YES disables it.
582 # This tag can be used to set the number of enum values (range [1..20])
583 # that doxygen will group on one line in the generated HTML documentation.
585 ENUM_VALUES_PER_LINE = 4
587 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
588 # generated containing a tree-like index structure (just like the one that
589 # is generated for HTML Help). For this to work a browser that supports
590 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
591 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
592 # probably better off using the HTML help feature.
594 GENERATE_TREEVIEW = NO
596 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
597 # used to set the initial width (in pixels) of the frame in which the tree
602 #---------------------------------------------------------------------------
603 # configuration options related to the LaTeX output
604 #---------------------------------------------------------------------------
606 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
607 # generate Latex output.
611 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
612 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
613 # put in front of it. If left blank `latex' will be used as the default path.
617 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
618 # invoked. If left blank `latex' will be used as the default command name.
620 LATEX_CMD_NAME = latex
622 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
623 # generate index for LaTeX. If left blank `makeindex' will be used as the
624 # default command name.
626 MAKEINDEX_CMD_NAME = makeindex
628 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
629 # LaTeX documents. This may be useful for small projects and may help to
630 # save some trees in general.
634 # The PAPER_TYPE tag can be used to set the paper type that is used
635 # by the printer. Possible values are: a4, a4wide, letter, legal and
636 # executive. If left blank a4wide will be used.
640 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
641 # packages that should be included in the LaTeX output.
645 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
646 # the generated latex document. The header should contain everything until
647 # the first chapter. If it is left blank doxygen will generate a
648 # standard header. Notice: only use this tag if you know what you are doing!
652 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
653 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
654 # contain links (just like the HTML output) instead of page references
655 # This makes the output suitable for online browsing using a pdf viewer.
659 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
660 # plain latex in the generated Makefile. Set this option to YES to get a
661 # higher quality PDF documentation.
665 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
666 # command to the generated LaTeX files. This will instruct LaTeX to keep
667 # running if errors occur, instead of asking the user for help.
668 # This option is also used when generating formulas in HTML.
672 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
673 # include the index chapters (such as File Index, Compound Index, etc.)
676 LATEX_HIDE_INDICES = NO
678 #---------------------------------------------------------------------------
679 # configuration options related to the RTF output
680 #---------------------------------------------------------------------------
682 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
683 # The RTF output is optimised for Word 97 and may not look very pretty with
684 # other RTF readers or editors.
688 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
689 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
690 # put in front of it. If left blank `rtf' will be used as the default path.
694 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
695 # RTF documents. This may be useful for small projects and may help to
696 # save some trees in general.
700 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
701 # will contain hyperlink fields. The RTF file will
702 # contain links (just like the HTML output) instead of page references.
703 # This makes the output suitable for online browsing using WORD or other
704 # programs which support those fields.
705 # Note: wordpad (write) and others do not support links.
709 # Load stylesheet definitions from file. Syntax is similar to doxygen's
710 # config file, i.e. a series of assigments. You only have to provide
711 # replacements, missing definitions are set to their default value.
713 RTF_STYLESHEET_FILE =
715 # Set optional variables used in the generation of an rtf document.
716 # Syntax is similar to doxygen's config file.
718 RTF_EXTENSIONS_FILE =
720 #---------------------------------------------------------------------------
721 # configuration options related to the man page output
722 #---------------------------------------------------------------------------
724 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
729 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
730 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
731 # put in front of it. If left blank `man' will be used as the default path.
735 # The MAN_EXTENSION tag determines the extension that is added to
736 # the generated man pages (default is the subroutine's section .3)
740 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
741 # then it will generate one additional man file for each entity
742 # documented in the real man page(s). These additional files
743 # only source the real man page, but without them the man command
744 # would be unable to find the correct page. The default is NO.
748 #---------------------------------------------------------------------------
749 # configuration options related to the XML output
750 #---------------------------------------------------------------------------
752 # If the GENERATE_XML tag is set to YES Doxygen will
753 # generate an XML file that captures the structure of
754 # the code including all documentation. Note that this
755 # feature is still experimental and incomplete at the
760 # The XML_SCHEMA tag can be used to specify an XML schema,
761 # which can be used by a validating XML parser to check the
762 # syntax of the XML files.
766 # The XML_DTD tag can be used to specify an XML DTD,
767 # which can be used by a validating XML parser to check the
768 # syntax of the XML files.
772 #---------------------------------------------------------------------------
773 # configuration options for the AutoGen Definitions output
774 #---------------------------------------------------------------------------
776 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
777 # generate an AutoGen Definitions (see autogen.sf.net) file
778 # that captures the structure of the code including all
779 # documentation. Note that this feature is still experimental
780 # and incomplete at the moment.
782 GENERATE_AUTOGEN_DEF = NO
784 #---------------------------------------------------------------------------
785 # configuration options related to the Perl module output
786 #---------------------------------------------------------------------------
788 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
789 # generate a Perl module file that captures the structure of
790 # the code including all documentation. Note that this
791 # feature is still experimental and incomplete at the
794 GENERATE_PERLMOD = NO
796 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
797 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
798 # to generate PDF and DVI output from the Perl module output.
802 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
803 # nicely formatted so it can be parsed by a human reader. This is useful
804 # if you want to understand what is going on. On the other hand, if this
805 # tag is set to NO the size of the Perl module output will be much smaller
806 # and Perl will parse it just the same.
810 # The names of the make variables in the generated doxyrules.make file
811 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
812 # This is useful so different doxyrules.make files included by the same
813 # Makefile don't overwrite each other's variables.
815 PERLMOD_MAKEVAR_PREFIX =
817 #---------------------------------------------------------------------------
818 # Configuration options related to the preprocessor
819 #---------------------------------------------------------------------------
821 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
822 # evaluate all C-preprocessor directives found in the sources and include
825 ENABLE_PREPROCESSING = YES
827 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
828 # names in the source code. If set to NO (the default) only conditional
829 # compilation will be performed. Macro expansion can be done in a controlled
830 # way by setting EXPAND_ONLY_PREDEF to YES.
834 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
835 # then the macro expansion is limited to the macros specified with the
836 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
838 EXPAND_ONLY_PREDEF = NO
840 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
841 # in the INCLUDE_PATH (see below) will be search if a #include is found.
843 SEARCH_INCLUDES = YES
845 # The INCLUDE_PATH tag can be used to specify one or more directories that
846 # contain include files that are not input files but should be processed by
851 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
852 # patterns (like *.h and *.hpp) to filter out the header-files in the
853 # directories. If left blank, the patterns specified with FILE_PATTERNS will
856 INCLUDE_FILE_PATTERNS =
858 # The PREDEFINED tag can be used to specify one or more macro names that
859 # are defined before the preprocessor is started (similar to the -D option of
860 # gcc). The argument of the tag is a list of macros of the form: name
861 # or name=definition (no spaces). If the definition and the = are
862 # omitted =1 is assumed.
866 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
867 # this tag can be used to specify a list of macro names that should be expanded.
868 # The macro definition that is found in the sources will be used.
869 # Use the PREDEFINED tag if you want to use a different macro definition.
873 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
874 # doxygen's preprocessor will remove all function-like macros that are alone
875 # on a line, have an all uppercase name, and do not end with a semicolon. Such
876 # function macros are typically used for boiler-plate code, and will confuse the
877 # parser if not removed.
879 SKIP_FUNCTION_MACROS = YES
881 #---------------------------------------------------------------------------
882 # Configuration::addtions related to external references
883 #---------------------------------------------------------------------------
885 # The TAGFILES option can be used to specify one or more tagfiles.
886 # Optionally an initial location of the external documentation
887 # can be added for each tagfile. The format of a tag file without
888 # this location is as follows:
889 # TAGFILES = file1 file2 ...
890 # Adding location for the tag files is done as follows:
891 # TAGFILES = file1=loc1 "file2 = loc2" ...
892 # where "loc1" and "loc2" can be relative or absolute paths or
893 # URLs. If a location is present for each tag, the installdox tool
894 # does not have to be run to correct the links.
895 # Note that each tag file must have a unique name
896 # (where the name does NOT include the path)
897 # If a tag file is not located in the directory in which doxygen
898 # is run, you must also specify the path to the tagfile here.
902 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
903 # a tag file that is based on the input files it reads.
907 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
908 # in the class index. If set to NO only the inherited external classes
913 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
914 # in the modules index. If set to NO, only the current project's groups will
917 EXTERNAL_GROUPS = YES
919 # The PERL_PATH should be the absolute path and name of the perl script
920 # interpreter (i.e. the result of `which perl').
922 PERL_PATH = /usr/bin/perl
924 #---------------------------------------------------------------------------
925 # Configuration options related to the dot tool
926 #---------------------------------------------------------------------------
928 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
929 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
930 # super classes. Setting the tag to NO turns the diagrams off. Note that this
931 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
932 # recommended to install and use dot, since it yield more powerful graphs.
936 # If set to YES, the inheritance and collaboration graphs will hide
937 # inheritance and usage relations if the target is undocumented
940 HIDE_UNDOC_RELATIONS = YES
942 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
943 # available from the path. This tool is part of Graphviz, a graph visualization
944 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
945 # have no effect if this option is set to NO (the default)
949 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
950 # will generate a graph for each documented class showing the direct and
951 # indirect inheritance relations. Setting this tag to YES will force the
952 # the CLASS_DIAGRAMS tag to NO.
956 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
957 # will generate a graph for each documented class showing the direct and
958 # indirect implementation dependencies (inheritance, containment, and
959 # class references variables) of the class with other documented classes.
961 COLLABORATION_GRAPH = YES
963 # If set to YES, the inheritance and collaboration graphs will show the
964 # relations between templates and their instances.
966 TEMPLATE_RELATIONS = YES
968 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
969 # tags are set to YES then doxygen will generate a graph for each documented
970 # file showing the direct and indirect include dependencies of the file with
971 # other documented files.
975 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
976 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
977 # documented header file showing the documented files that directly or
978 # indirectly include this file.
980 INCLUDED_BY_GRAPH = YES
982 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
983 # will graphical hierarchy of all classes instead of a textual one.
985 GRAPHICAL_HIERARCHY = YES
987 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
988 # generated by dot. Possible values are png, jpg, or gif
989 # If left blank png will be used.
991 DOT_IMAGE_FORMAT = png
993 # The tag DOT_PATH can be used to specify the path where the dot tool can be
994 # found. If left blank, it is assumed the dot tool can be found on the path.
998 # The DOTFILE_DIRS tag can be used to specify one or more directories that
999 # contain dot files that are included in the documentation (see the
1000 # \dotfile command).
1004 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1005 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1006 # this value, doxygen will try to truncate the graph, so that it fits within
1007 # the specified constraint. Beware that most browsers cannot cope with very
1010 MAX_DOT_GRAPH_WIDTH = 1024
1012 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1013 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1014 # this value, doxygen will try to truncate the graph, so that it fits within
1015 # the specified constraint. Beware that most browsers cannot cope with very
1018 MAX_DOT_GRAPH_HEIGHT = 1024
1020 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1021 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1022 # from the root by following a path via at most 3 edges will be shown. Nodes that
1023 # lay further from the root node will be omitted. Note that setting this option to
1024 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1025 # note that a graph may be further truncated if the graph's image dimensions are
1026 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1027 # If 0 is used fot the depth value (the default), the graph is not depth constraint.
1029 MAX_DOT_GRAPH_DEPTH = 0
1031 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1032 # generate a legend page explaining the meaning of the various boxes and
1033 # arrows in the dot generated graphs.
1035 GENERATE_LEGEND = YES
1037 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1038 # remove the intermedate dot files that are used to generate
1039 # the various graphs.
1043 #---------------------------------------------------------------------------
1044 # Configuration::addtions related to the search engine
1045 #---------------------------------------------------------------------------
1047 # The SEARCHENGINE tag specifies whether or not a search engine should be
1048 # used. If set to NO the values of all tags below this one will be ignored.
1052 # The CGI_NAME tag should be the name of the CGI script that
1053 # starts the search engine (doxysearch) with the correct parameters.
1054 # A script with this name will be generated by doxygen.
1056 CGI_NAME = search.cgi
1058 # The CGI_URL tag should be the absolute URL to the directory where the
1059 # cgi binaries are located. See the documentation of your http daemon for
1064 # The DOC_URL tag should be the absolute URL to the directory where the
1065 # documentation is located. If left blank the absolute path to the
1066 # documentation, with file:// prepended to it, will be used.
1070 # The DOC_ABSPATH tag should be the absolute path to the directory where the
1071 # documentation is located. If left blank the directory on the local machine
1076 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1079 BIN_ABSPATH = /usr/local/bin/
1081 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
1082 # documentation generated for other projects. This allows doxysearch to search
1083 # the documentation for these projects as well.