3 # This file describes the settings to be used by doxygen for a project
5 # All text after a hash (#) is considered a comment and will be ignored
7 # TAG = value [value, ...]
8 # For lists items can also be appended using:
9 # TAG += value [value, ...]
10 # Values that contain spaces should be placed between quotes (" ")
12 #---------------------------------------------------------------------------
13 # General configuration options
14 #---------------------------------------------------------------------------
16 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
17 # by quotes) that should identify the project.
19 PROJECT_NAME = @PACKAGE@
21 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
22 # This could be handy for archiving the generated documentation or
23 # if some version control system is used.
25 PROJECT_NUMBER = @VERSION@
27 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
28 # base path where the generated documentation will be put.
29 # If a relative path is entered, it will be relative to the location
30 # where doxygen was started. If left blank the current directory will be used.
32 OUTPUT_DIRECTORY = @WITH_APIDOCS_TARGET@
34 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
35 # documentation generated by doxygen is written. Doxygen will use this
36 # information to generate all constant output in the proper language.
37 # The default language is English, other supported languages are:
38 # Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,
39 # Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian,
40 # Polish, Portuguese, Brazilian and Slovene.
42 OUTPUT_LANGUAGE = English
44 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
45 # documentation are documented, even if no documentation was available.
46 # Private class members and static file members will be hidden unless
47 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
51 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
52 # will be included in the documentation.
56 # If the EXTRACT_STATIC tag is set to YES all static members of a file
57 # will be included in the documentation.
61 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
62 # undocumented members of documented classes, files or namespaces.
63 # If set to NO (the default) these members will be included in the
64 # various overviews, but no documentation section is generated.
65 # This option has no effect if EXTRACT_ALL is enabled.
67 HIDE_UNDOC_MEMBERS = NO
69 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
70 # undocumented classes that are normally visible in the class hierarchy.
71 # If set to NO (the default) these class will be included in the various
72 # overviews. This option has no effect if EXTRACT_ALL is enabled.
74 HIDE_UNDOC_CLASSES = NO
76 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
77 # include brief member descriptions after the members that are listed in
78 # the file and class documentation (similar to JavaDoc).
79 # Set to NO to disable this.
81 BRIEF_MEMBER_DESC = YES
83 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
84 # the brief description of a member or function before the detailed description.
85 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86 # brief descriptions will be completely suppressed.
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 FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
97 # path before files name in the file list and in the header files. If set
98 # to NO the shortest path that makes the file name unique will be used.
100 FULL_PATH_NAMES = YES
102 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
103 # can be used to strip a user defined part of the path. Stripping is
104 # only done if one of the specified strings matches the left-hand part of
105 # the path. It is allowed to use relative paths in the argument list.
107 STRIP_FROM_PATH = @TOP_SOURCEDIR@/
109 # The INTERNAL_DOCS tag determines if documentation
110 # that is typed after a \internal command is included. If the tag is set
111 # to NO (the default) then the documentation will be excluded.
112 # Set it to YES to include the internal documentation.
116 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
117 # generate a class diagram (in Html and LaTeX) for classes with base or
118 # super classes. Setting the tag to NO turns the diagrams off.
122 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
123 # be generated. Documented entities will be cross-referenced with these sources.
127 # Setting the INLINE_SOURCES tag to YES will include the body
128 # of functions and classes directly in the documentation.
132 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
133 # doxygen to hide any special comment blocks from generated source code
134 # fragments. Normal C and C++ comments will always remain visible.
136 STRIP_CODE_COMMENTS = YES
138 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
139 # file names in lower case letters. If set to YES upper case letters are also
140 # allowed. This is useful if you have classes or files whose names only differ
141 # in case and if your file system supports case sensitive file names. Windows
142 # users are adviced to set this option to NO.
144 CASE_SENSE_NAMES = YES
146 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
147 # (but less readable) file names. This can be useful is your file systems
148 # doesn't support long names like on DOS, Mac, or CD-ROM.
152 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
153 # will show members with their full class and namespace scopes in the
154 # documentation. If set to YES the scope will be hidden.
156 HIDE_SCOPE_NAMES = NO
158 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
159 # will generate a verbatim copy of the header file for each class for
160 # which an include is specified. Set to NO to disable this.
162 VERBATIM_HEADERS = YES
164 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
165 # will put list of the files that are included by a file in the documentation
168 SHOW_INCLUDE_FILES = YES
170 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
171 # will interpret the first line (until the first dot) of a JavaDoc-style
172 # comment as the brief description. If set to NO, the JavaDoc
173 # comments will behave just like the Qt-style comments (thus requiring an
174 # explict @brief command for a brief description.
176 JAVADOC_AUTOBRIEF = YES
178 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
179 # member inherits the documentation from any documented member that it
184 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
185 # is inserted in the documentation for inline members.
189 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
190 # will sort the (detailed) documentation of file and class members
191 # alphabetically by member name. If set to NO the members will appear in
194 SORT_MEMBER_DOCS = YES
196 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
197 # tag is set to YES, then doxygen will reuse the documentation of the first
198 # member in the group (if any) for the other members of the group. By default
199 # all members of a group must be documented explicitly.
201 DISTRIBUTE_GROUP_DOC = NO
203 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
204 # Doxygen uses this value to replace tabs by spaces in code fragments.
208 # The ENABLED_SECTIONS tag can be used to enable conditional
209 # documentation sections, marked by \if sectionname ... \endif.
213 # The GENERATE_TODOLIST tag can be used to enable (YES) or
214 # disable (NO) the todo list. This list is created by putting \todo
215 # commands in the documentation.
217 GENERATE_TODOLIST = YES
219 # The GENERATE_TESTLIST tag can be used to enable (YES) or
220 # disable (NO) the test list. This list is created by putting \test
221 # commands in the documentation.
223 GENERATE_TESTLIST = YES
225 # The GENERATE_BUGLIST tag can be used to enable (YES) or
226 # disable (NO) the bug list. This list is created by putting \bug
227 # commands in the documentation.
229 GENERATE_BUGLIST = YES
231 # This tag can be used to specify a number of aliases that acts
232 # as commands in the documentation. An alias has the form "name=value".
233 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
234 # put the command \sideeffect (or @sideeffect) in the documentation, which
235 # will result in a user defined paragraph with heading "Side Effects:".
236 # You can put \n's in the value part of an alias to insert newlines.
240 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
241 # the initial value of a variable or define consist of for it to appear in
242 # the documentation. If the initializer consists of more lines than specified
243 # here it will be hidden. Use a value of 0 to hide initializers completely.
244 # The appearance of the initializer of individual variables and defines in the
245 # documentation can be controlled using \showinitializer or \hideinitializer
246 # command in the documentation regardless of this setting.
248 MAX_INITIALIZER_LINES = 30
250 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
251 # only. Doxygen will then generate output that is more tailored for C.
252 # For instance some of the names that are used will be different. The list
253 # of all members will be omitted, etc.
255 OPTIMIZE_OUTPUT_FOR_C = YES
257 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
258 # at the bottom of the documentation of classes and structs. If set to YES the
259 # list will mention the files that were used to generate the documentation.
261 SHOW_USED_FILES = YES
263 #---------------------------------------------------------------------------
264 # configuration options related to warning and progress messages
265 #---------------------------------------------------------------------------
267 # The QUIET tag can be used to turn on/off the messages that are generated
268 # by doxygen. Possible values are YES and NO. If left blank NO is used.
272 # The WARNINGS tag can be used to turn on/off the warning messages that are
273 # generated by doxygen. Possible values are YES and NO. If left blank
278 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
279 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
280 # automatically be disabled.
282 WARN_IF_UNDOCUMENTED = YES
284 # The WARN_FORMAT tag determines the format of the warning messages that
285 # doxygen can produce. The string should contain the $file, $line, and $text
286 # tags, which will be replaced by the file and line number from which the
287 # warning originated and the warning text.
289 WARN_FORMAT = "$file:$line: $text"
291 # The WARN_LOGFILE tag can be used to specify a file to which warning
292 # and error messages should be written. If left blank the output is written
297 #---------------------------------------------------------------------------
298 # configuration options related to the input files
299 #---------------------------------------------------------------------------
301 # The INPUT tag can be used to specify the files and/or directories that contain
302 # documented source files. You may enter file names like "myfile.cpp" or
303 # directories like "/usr/src/myproject". Separate the files or directories
314 ./rpmpopt-@VERSION@ \
320 ./build/expression.c \
327 ./build/parseBuildInstallClean.c \
328 ./build/parseChangelog.c \
329 ./build/parseDescription.c \
330 ./build/parseFiles.c \
331 ./build/parsePreamble.c \
332 ./build/parsePrep.c \
333 ./build/parseReqs.c \
334 ./build/parseScript.c \
335 ./build/parseSpec.c \
340 ./doc/manual/builddependencies \
341 ./doc/manual/buildroot \
342 ./doc/manual/conditionalbuilds \
343 ./doc/manual/dependencies \
344 ./doc/manual/format \
345 ./doc/manual/hregions \
346 ./doc/manual/macros \
347 ./doc/manual/multiplebuilds \
348 ./doc/manual/queryformat \
349 ./doc/manual/signatures \
350 ./doc/manual/relocatable \
352 ./doc/manual/triggers \
378 ./lib/rpmchecksig.c \
391 ./lib/transaction.c \
413 ./rpmio/rpmio_internal.h \
414 ./rpmio/rpmio_api.c \
416 ./rpmio/rpmmalloc.c \
417 ./rpmio/rpmmessages.h \
420 ./rpmio/strcasecmp.c \
429 ./popt/poptconfig.c \
435 ./python/rpmmodule.c \
441 ./tools/rpmarchive.c \
442 ./tools/rpmchecksig.c \
443 ./tools/rpmheader.c \
444 ./tools/rpminject.c \
446 ./tools/rpmsignature.c
448 # If the value of the INPUT tag contains directories, you can use the
449 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
450 # and *.h) to filter out the source-files in the directories. If left
451 # blank all files are included.
453 FILE_PATTERNS = *.c *.h
455 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
456 # should be searched for input files as well. Possible values are YES and NO.
457 # If left blank NO is used.
461 # The EXCLUDE tag can be used to specify files and/or directories that should
462 # excluded from the INPUT source files. This way you can easily exclude a
463 # subdirectory from a directory tree whose root is specified with the INPUT tag.
467 # If the value of the INPUT tag contains directories, you can use the
468 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
469 # certain files from those directories.
473 # The EXAMPLE_PATH tag can be used to specify one or more files or
474 # directories that contain example code fragments that are included (see
475 # the \include command).
477 EXAMPLE_PATH = @TOP_SOURCEDIR@/doc/manual
479 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
480 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
481 # and *.h) to filter out the source-files in the directories. If left
482 # blank all files are included.
486 # The IMAGE_PATH tag can be used to specify one or more files or
487 # directories that contain image that are included in the documentation (see
488 # the \image command).
492 # The INPUT_FILTER tag can be used to specify a program that doxygen should
493 # invoke to filter for each input file. Doxygen will invoke the filter program
494 # by executing (via popen()) the command <filter> <input-file>, where <filter>
495 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
496 # input file. Doxygen will then use the output that the filter program writes
497 # to standard output.
501 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
502 # INPUT_FILTER) will be used to filter the input files when producing source
505 FILTER_SOURCE_FILES = NO
507 #---------------------------------------------------------------------------
508 # configuration options related to the alphabetical class index
509 #---------------------------------------------------------------------------
511 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
512 # of all compounds will be generated. Enable this if the project
513 # contains a lot of classes, structs, unions or interfaces.
515 ALPHABETICAL_INDEX = NO
517 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
518 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
519 # in which this list will be split (can be a number in the range [1..20])
521 COLS_IN_ALPHA_INDEX = 5
523 # In case all classes in a project start with a common prefix, all
524 # classes will be put under the same header in the alphabetical index.
525 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
526 # should be ignored while generating the index headers.
530 #---------------------------------------------------------------------------
531 # configuration options related to the HTML output
532 #---------------------------------------------------------------------------
534 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
535 # generate HTML output.
539 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
540 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
541 # put in front of it. If left blank `html' will be used as the default path.
545 # The HTML_HEADER tag can be used to specify a personal HTML header for
546 # each generated HTML page. If it is left blank doxygen will generate a
551 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
552 # each generated HTML page. If it is left blank doxygen will generate a
557 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
558 # style sheet that is used by each HTML page. It can be used to
559 # fine-tune the look of the HTML output. If the tag is left blank doxygen
560 # will generate a default style sheet
564 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
565 # files or namespaces will be aligned in HTML using tables. If set to
566 # NO a bullet list will be used.
568 HTML_ALIGN_MEMBERS = YES
570 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
571 # will be generated that can be used as input for tools like the
572 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
573 # of the generated HTML documentation.
575 GENERATE_HTMLHELP = NO
577 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
578 # controls if a separate .chi index file is generated (YES) or that
579 # it should be included in the master .chm file (NO).
583 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
584 # controls whether a binary table of contents is generated (YES) or a
585 # normal table of contents (NO) in the .chm file.
589 # The TOC_EXPAND flag can be set YES to add extra items for group members
590 # to the contents of the Html help documentation and to the tree view.
594 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
595 # top of each HTML page. The value NO (the default) enables the index and
596 # the value YES disables it.
600 # This tag can be used to set the number of enum values (range [1..20])
601 # that doxygen will group on one line in the generated HTML documentation.
603 ENUM_VALUES_PER_LINE = 4
605 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
606 # generated containing a tree-like index structure (just like the one that
607 # is generated for HTML Help). For this to work a browser that supports
608 # JavaScript and frames is required (for instance Netscape 4.0+
609 # or Internet explorer 4.0+).
611 GENERATE_TREEVIEW = NO
613 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
614 # used to set the initial width (in pixels) of the frame in which the tree
619 #---------------------------------------------------------------------------
620 # configuration options related to the LaTeX output
621 #---------------------------------------------------------------------------
623 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
624 # generate Latex output.
628 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
629 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
630 # put in front of it. If left blank `latex' will be used as the default path.
634 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
635 # LaTeX documents. This may be useful for small projects and may help to
636 # save some trees in general.
640 # The PAPER_TYPE tag can be used to set the paper type that is used
641 # by the printer. Possible values are: a4, a4wide, letter, legal and
642 # executive. If left blank a4wide will be used.
646 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
647 # packages that should be included in the LaTeX output.
651 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
652 # the generated latex document. The header should contain everything until
653 # the first chapter. If it is left blank doxygen will generate a
654 # standard header. Notice: only use this tag if you know what you are doing!
658 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
659 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
660 # contain links (just like the HTML output) instead of page references
661 # This makes the output suitable for online browsing using a pdf viewer.
665 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
666 # plain latex in the generated Makefile. Set this option to YES to get a
667 # higher quality PDF documentation.
671 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
672 # command to the generated LaTeX files. This will instruct LaTeX to keep
673 # running if errors occur, instead of asking the user for help.
674 # This option is also used when generating formulas in HTML.
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 a 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 #---------------------------------------------------------------------------
741 # Configuration options related to the preprocessor
742 #---------------------------------------------------------------------------
744 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
745 # evaluate all C-preprocessor directives found in the sources and include
748 ENABLE_PREPROCESSING = YES
750 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
751 # names in the source code. If set to NO (the default) only conditional
752 # compilation will be performed. Macro expansion can be done in a controlled
753 # way by setting EXPAND_ONLY_PREDEF to YES.
755 MACRO_EXPANSION = YES
757 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
758 # then the macro expansion is limited to the macros specified with the
759 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
761 EXPAND_ONLY_PREDEF = NO
763 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
764 # in the INCLUDE_PATH (see below) will be search if a #include is found.
766 SEARCH_INCLUDES = YES
768 # The INCLUDE_PATH tag can be used to specify one or more directories that
769 # contain include files that are not input files but should be processed by
774 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
775 # patterns (like *.h and *.hpp) to filter out the header-files in the
776 # directories. If left blank, the patterns specified with FILE_PATTERNS will
779 INCLUDE_FILE_PATTERNS =
781 # The PREDEFINED tag can be used to specify one or more macro names that
782 # are defined before the preprocessor is started (similar to the -D option of
783 # gcc). The argument of the tag is a list of macros of the form: name
784 # or name=definition (no spaces). If the definition and the = are
785 # omitted =1 is assumed.
789 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
790 # this tag can be used to specify a list of macro names that should be expanded.
791 # The macro definition that is found in the sources will be used.
792 # Use the PREDEFINED tag if you want to use a different macro definition.
796 #---------------------------------------------------------------------------
797 # Configuration::addtions related to external references
798 #---------------------------------------------------------------------------
800 # The TAGFILES tag can be used to specify one or more tagfiles.
804 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
805 # a tag file that is based on the input files it reads.
807 GENERATE_TAGFILE = Doxytags
809 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
810 # in the class index. If set to NO only the inherited external classes
815 # The PERL_PATH should be the absolute path and name of the perl script
816 # interpreter (i.e. the result of `which perl').
818 PERL_PATH = /usr/bin/perl
820 #---------------------------------------------------------------------------
821 # Configuration options related to the dot tool
822 #---------------------------------------------------------------------------
824 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
825 # available from the path. This tool is part of Graphviz, a graph visualization
826 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
827 # have no effect if this option is set to NO (the default)
831 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
832 # will generate a graph for each documented class showing the direct and
833 # indirect inheritance relations. Setting this tag to YES will force the
834 # the CLASS_DIAGRAMS tag to NO.
838 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
839 # will generate a graph for each documented class showing the direct and
840 # indirect implementation dependencies (inheritance, containment, and
841 # class references variables) of the class with other documented classes.
843 COLLABORATION_GRAPH = YES
845 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to
846 # YES then doxygen will generate a graph for each documented file showing
847 # the direct and indirect include dependencies of the file with other
852 # If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to
853 # YES then doxygen will generate a graph for each documented header file showing
854 # the documented files that directly or indirectly include this file
856 INCLUDED_BY_GRAPH = YES
858 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
859 # will graphical hierarchy of all classes instead of a textual one.
861 GRAPHICAL_HIERARCHY = YES
863 # The tag DOT_PATH can be used to specify the path where the dot tool can be
864 # found. If left blank, it is assumed the dot tool can be found on the path.
868 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
869 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
870 # this value, doxygen will try to truncate the graph, so that it fits within
871 # the specified constraint. Beware that most browsers cannot cope with very
874 MAX_DOT_GRAPH_WIDTH = 1024
876 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
877 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
878 # this value, doxygen will try to truncate the graph, so that it fits within
879 # the specified constraint. Beware that most browsers cannot cope with very
882 MAX_DOT_GRAPH_HEIGHT = 1024
884 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
885 # generate a legend page explaining the meaning of the various boxes and
886 # arrows in the dot generated graphs.
888 GENERATE_LEGEND = YES
890 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
891 # remove the intermedate dot files that are used to generate
892 # the various graphs.
896 #---------------------------------------------------------------------------
897 # Configuration::addtions related to the search engine
898 #---------------------------------------------------------------------------
900 # The SEARCHENGINE tag specifies whether or not a search engine should be
901 # used. If set to NO the values of all tags below this one will be ignored.
905 # The CGI_NAME tag should be the name of the CGI script that
906 # starts the search engine (doxysearch) with the correct parameters.
907 # A script with this name will be generated by doxygen.
909 CGI_NAME = search.cgi
911 # The CGI_URL tag should be the absolute URL to the directory where the
912 # cgi binaries are located. See the documentation of your http daemon for
917 # The DOC_URL tag should be the absolute URL to the directory where the
918 # documentation is located. If left blank the absolute path to the
919 # documentation, with file:// prepended to it, will be used.
923 # The DOC_ABSPATH tag should be the absolute path to the directory where the
924 # documentation is located. If left blank the directory on the local machine
929 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
932 BIN_ABSPATH = /usr/local/bin/
934 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
935 # documentation generated for other projects. This allows doxysearch to search
936 # the documentation for these projects as well.