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 ### When doxygen is run, the current directory is the top of the
14 ### libstdc++-v3 build directory. Keep this in mind while writing
15 ### relative-path directories.
17 ### Currently this is not really run through autoconf; it just looks that way.
20 #---------------------------------------------------------------------------
21 # General configuration options
22 #---------------------------------------------------------------------------
24 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
25 # by quotes) that should identify the project.
27 PROJECT_NAME = "libstdc++-v3 Source"
29 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
30 # This could be handy for archiving the generated documentation or
31 # if some version control system is used.
35 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
36 # base path where the generated documentation will be put.
37 # If a relative path is entered, it will be relative to the location
38 # where doxygen was started. If left blank the current directory will be used.
40 OUTPUT_DIRECTORY = @outdir@
42 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
43 # documentation generated by doxygen is written. Doxygen will use this
44 # information to generate all constant output in the proper language.
45 # The default language is English, other supported languages are:
46 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
47 # German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
48 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
50 OUTPUT_LANGUAGE = English
52 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
53 # documentation are documented, even if no documentation was available.
54 # Private class members and static file members will be hidden unless
55 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
59 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
60 # will be included in the documentation.
64 # If the EXTRACT_STATIC tag is set to YES all static members of a file
65 # will be included in the documentation.
69 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70 # undocumented members of documented classes, files or namespaces.
71 # If set to NO (the default) these members will be included in the
72 # various overviews, but no documentation section is generated.
73 # This option has no effect if EXTRACT_ALL is enabled.
75 HIDE_UNDOC_MEMBERS = YES
77 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78 # undocumented classes that are normally visible in the class hierarchy.
79 # If set to NO (the default) these class will be included in the various
80 # overviews. This option has no effect if EXTRACT_ALL is enabled.
82 HIDE_UNDOC_CLASSES = YES
84 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
85 # include brief member descriptions after the members that are listed in
86 # the file and class documentation (similar to JavaDoc).
87 # Set to NO to disable this.
89 BRIEF_MEMBER_DESC = YES
91 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
92 # the brief description of a member or function before the detailed description.
93 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
94 # brief descriptions will be completely suppressed.
98 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
99 # Doxygen will generate a detailed section even if there is only a brief
102 ALWAYS_DETAILED_SEC = YES
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. It is allowed to use relative paths in the argument list.
117 # The INTERNAL_DOCS tag determines if documentation
118 # that is typed after a \internal command is included. If the tag is set
119 # to NO (the default) then the documentation will be excluded.
120 # Set it to YES to include the internal documentation.
124 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
125 # doxygen to hide any special comment blocks from generated source code
126 # fragments. Normal C and C++ comments will always remain visible.
128 STRIP_CODE_COMMENTS = YES
130 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
131 # file names in lower case letters. If set to YES upper case letters are also
132 # allowed. This is useful if you have classes or files whose names only differ
133 # in case and if your file system supports case sensitive file names. Windows
134 # users are adviced to set this option to NO.
136 CASE_SENSE_NAMES = NO
138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139 # (but less readable) file names. This can be useful is your file systems
140 # doesn't support long names like on DOS, Mac, or CD-ROM.
144 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
145 # will show members with their full class and namespace scopes in the
146 # documentation. If set to YES the scope will be hidden.
148 HIDE_SCOPE_NAMES = NO
150 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
151 # will generate a verbatim copy of the header file for each class for
152 # which an include is specified. Set to NO to disable this.
154 VERBATIM_HEADERS = NO
156 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
157 # will put list of the files that are included by a file in the documentation
160 SHOW_INCLUDE_FILES = YES
162 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
163 # will interpret the first line (until the first dot) of a JavaDoc-style
164 # comment as the brief description. If set to NO, the JavaDoc
165 # comments will behave just like the Qt-style comments (thus requiring an
166 # explict @brief command for a brief description.
168 JAVADOC_AUTOBRIEF = NO
170 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
171 # member inherits the documentation from any documented member that it
176 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
177 # is inserted in the documentation for inline members.
181 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
182 # will sort the (detailed) documentation of file and class members
183 # alphabetically by member name. If set to NO the members will appear in
186 SORT_MEMBER_DOCS = YES
188 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
189 # tag is set to YES, then doxygen will reuse the documentation of the first
190 # member in the group (if any) for the other members of the group. By default
191 # all members of a group must be documented explicitly.
193 DISTRIBUTE_GROUP_DOC = YES
195 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
196 # Doxygen uses this value to replace tabs by spaces in code fragments.
200 # The GENERATE_TODOLIST tag can be used to enable (YES) or
201 # disable (NO) the todo list. This list is created by putting \todo
202 # commands in the documentation.
204 GENERATE_TODOLIST = YES
206 # The GENERATE_TESTLIST tag can be used to enable (YES) or
207 # disable (NO) the test list. This list is created by putting \test
208 # commands in the documentation.
210 GENERATE_TESTLIST = NO
212 # The GENERATE_BUGLIST tag can be used to enable (YES) or
213 # disable (NO) the bug list. This list is created by putting \bug
214 # commands in the documentation.
216 GENERATE_BUGLIST = YES
218 # This tag can be used to specify a number of aliases that acts
219 # as commands in the documentation. An alias has the form "name=value".
220 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
221 # put the command \sideeffect (or @sideeffect) in the documentation, which
222 # will result in a user defined paragraph with heading "Side Effects:".
223 # You can put \n's in the value part of an alias to insert newlines.
225 ALIASES = "doctodo=@todo\nDoc me! See docs/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more."
227 # The ENABLED_SECTIONS tag can be used to enable conditional
228 # documentation sections, marked by \if sectionname ... \endif.
230 ENABLED_SECTIONS = @enabled_sections@
232 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
233 # the initial value of a variable or define consist of for it to appear in
234 # the documentation. If the initializer consists of more lines than specified
235 # here it will be hidden. Use a value of 0 to hide initializers completely.
236 # The appearance of the initializer of individual variables and defines in the
237 # documentation can be controlled using \showinitializer or \hideinitializer
238 # command in the documentation regardless of this setting.
240 MAX_INITIALIZER_LINES = 30
242 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
243 # only. Doxygen will then generate output that is more tailored for C.
244 # For instance some of the names that are used will be different. The list
245 # of all members will be omitted, etc.
247 OPTIMIZE_OUTPUT_FOR_C = NO
249 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
250 # at the bottom of the documentation of classes and structs. If set to YES the
251 # list will mention the files that were used to generate the documentation.
253 SHOW_USED_FILES = YES
255 #---------------------------------------------------------------------------
256 # configuration options related to warning and progress messages
257 #---------------------------------------------------------------------------
259 # The QUIET tag can be used to turn on/off the messages that are generated
260 # by doxygen. Possible values are YES and NO. If left blank NO is used.
264 # The WARNINGS tag can be used to turn on/off the warning messages that are
265 # generated by doxygen. Possible values are YES and NO. If left blank
270 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
271 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
272 # automatically be disabled.
274 WARN_IF_UNDOCUMENTED = NO
276 # The WARN_FORMAT tag determines the format of the warning messages that
277 # doxygen can produce. The string should contain the $file, $line, and $text
278 # tags, which will be replaced by the file and line number from which the
279 # warning originated and the warning text.
281 WARN_FORMAT = "$file:$line: $text"
283 # The WARN_LOGFILE tag can be used to specify a file to which warning
284 # and error messages should be written. If left blank the output is written
289 #---------------------------------------------------------------------------
290 # configuration options related to the input files
291 #---------------------------------------------------------------------------
293 # The INPUT tag can be used to specify the files and/or directories that contain
294 # documented source files. You may enter file names like "myfile.cpp" or
295 # directories like "/usr/src/myproject". Separate the files or directories
298 INPUT = @srcdir@/docs/doxygen/doxygroups.cc \
300 @srcdir@/libsupc++/exception \
301 @srcdir@/libsupc++/new \
302 @srcdir@/libsupc++/typeinfo \
307 # If the value of the INPUT tag contains directories, you can use the
308 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
309 # and *.h) to filter out the source-files in the directories. If left
310 # blank file matching one of the following patterns are included:
311 # *.c *.cc *.cxx *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
316 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
317 # should be searched for input files as well. Possible values are YES and NO.
318 # If left blank NO is used.
322 # The EXCLUDE tag can be used to specify files and/or directories that should
323 # excluded from the INPUT source files. This way you can easily exclude a
324 # subdirectory from a directory tree whose root is specified with the INPUT tag.
328 # If the value of the INPUT tag contains directories, you can use the
329 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
330 # certain files from those directories.
332 EXCLUDE_PATTERNS = CVS \
335 # The EXAMPLE_PATH tag can be used to specify one or more files or
336 # directories that contain example code fragments that are included (see
337 # the \include command).
341 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
342 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
343 # and *.h) to filter out the source-files in the directories. If left
344 # blank all files are included.
348 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
349 # searched for input files to be used with the \include or \dontinclude
350 # commands irrespective of the value of the RECURSIVE tag.
351 # Possible values are YES and NO. If left blank NO is used.
353 EXAMPLE_RECURSIVE = NO
355 # The IMAGE_PATH tag can be used to specify one or more files or
356 # directories that contain image that are included in the documentation (see
357 # the \image command).
361 # The INPUT_FILTER tag can be used to specify a program that doxygen should
362 # invoke to filter for each input file. Doxygen will invoke the filter program
363 # by executing (via popen()) the command <filter> <input-file>, where <filter>
364 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
365 # input file. Doxygen will then use the output that the filter program writes
366 # to standard output.
370 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
371 # INPUT_FILTER) will be used to filter the input files when producing source
374 FILTER_SOURCE_FILES = NO
376 #---------------------------------------------------------------------------
377 # configuration options related to source browsing
378 #---------------------------------------------------------------------------
380 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
381 # be generated. Documented entities will be cross-referenced with these sources.
385 # Setting the INLINE_SOURCES tag to YES will include the body
386 # of functions and classes directly in the documentation.
390 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
391 # then for each documented function all documented
392 # functions referencing it will be listed.
394 REFERENCED_BY_RELATION = YES
396 # If the REFERENCES_RELATION tag is set to YES (the default)
397 # then for each documented function all documented entities
398 # called/used by that function will be listed.
400 REFERENCES_RELATION = YES
402 #---------------------------------------------------------------------------
403 # configuration options related to the alphabetical class index
404 #---------------------------------------------------------------------------
406 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
407 # of all compounds will be generated. Enable this if the project
408 # contains a lot of classes, structs, unions or interfaces.
410 ALPHABETICAL_INDEX = YES
412 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
413 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
414 # in which this list will be split (can be a number in the range [1..20])
416 COLS_IN_ALPHA_INDEX = 5
418 # In case all classes in a project start with a common prefix, all
419 # classes will be put under the same header in the alphabetical index.
420 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
421 # should be ignored while generating the index headers.
425 #---------------------------------------------------------------------------
426 # configuration options related to the HTML output
427 #---------------------------------------------------------------------------
429 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
430 # generate HTML output.
432 GENERATE_HTML = @do_html@
434 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
435 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
436 # put in front of it. If left blank `html' will be used as the default path.
438 HTML_OUTPUT = @html_output_dir@
440 # The HTML_HEADER tag can be used to specify a personal HTML header for
441 # each generated HTML page. If it is left blank doxygen will generate a
446 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
447 # each generated HTML page. If it is left blank doxygen will generate a
452 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
453 # style sheet that is used by each HTML page. It can be used to
454 # fine-tune the look of the HTML output. If the tag is left blank doxygen
455 # will generate a default style sheet
457 HTML_STYLESHEET = @srcdir@/docs/doxygen/style.css
459 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
460 # files or namespaces will be aligned in HTML using tables. If set to
461 # NO a bullet list will be used.
463 HTML_ALIGN_MEMBERS = YES
465 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
466 # will be generated that can be used as input for tools like the
467 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
468 # of the generated HTML documentation.
470 GENERATE_HTMLHELP = NO
472 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
473 # controls if a separate .chi index file is generated (YES) or that
474 # it should be included in the master .chm file (NO).
478 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
479 # controls whether a binary table of contents is generated (YES) or a
480 # normal table of contents (NO) in the .chm file.
484 # The TOC_EXPAND flag can be set to YES to add extra items for group members
485 # to the contents of the Html help documentation and to the tree view.
489 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
490 # top of each HTML page. The value NO (the default) enables the index and
491 # the value YES disables it.
495 # This tag can be used to set the number of enum values (range [1..20])
496 # that doxygen will group on one line in the generated HTML documentation.
498 ENUM_VALUES_PER_LINE = 4
500 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
501 # generated containing a tree-like index structure (just like the one that
502 # is generated for HTML Help). For this to work a browser that supports
503 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
504 # or Internet explorer 4.0+). Note that for large projects the tree generation
505 # can take a very long time. In such cases it is better to disable this feature.
506 # Windows users are probably better off using the HTML help feature.
508 GENERATE_TREEVIEW = NO
510 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
511 # used to set the initial width (in pixels) of the frame in which the tree
516 #---------------------------------------------------------------------------
517 # configuration options related to the LaTeX output
518 #---------------------------------------------------------------------------
520 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
521 # generate Latex output.
525 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
526 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
527 # put in front of it. If left blank `latex' will be used as the default path.
531 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
532 # LaTeX documents. This may be useful for small projects and may help to
533 # save some trees in general.
537 # The PAPER_TYPE tag can be used to set the paper type that is used
538 # by the printer. Possible values are: a4, a4wide, letter, legal and
539 # executive. If left blank a4wide will be used.
543 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
544 # packages that should be included in the LaTeX output.
548 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
549 # the generated latex document. The header should contain everything until
550 # the first chapter. If it is left blank doxygen will generate a
551 # standard header. Notice: only use this tag if you know what you are doing!
555 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
556 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
557 # contain links (just like the HTML output) instead of page references
558 # This makes the output suitable for online browsing using a pdf viewer.
562 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
563 # plain latex in the generated Makefile. Set this option to YES to get a
564 # higher quality PDF documentation.
568 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
569 # command to the generated LaTeX files. This will instruct LaTeX to keep
570 # running if errors occur, instead of asking the user for help.
571 # This option is also used when generating formulas in HTML.
575 #---------------------------------------------------------------------------
576 # configuration options related to the RTF output
577 #---------------------------------------------------------------------------
579 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
580 # The RTF output is optimised for Word 97 and may not look very pretty with
581 # other RTF readers or editors.
585 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
586 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
587 # put in front of it. If left blank `rtf' will be used as the default path.
591 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
592 # RTF documents. This may be useful for small projects and may help to
593 # save some trees in general.
597 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
598 # will contain hyperlink fields. The RTF file will
599 # contain links (just like the HTML output) instead of page references.
600 # This makes the output suitable for online browsing using WORD or other
601 # programs which support those fields.
602 # Note: wordpad (write) and others do not support links.
606 # Load stylesheet definitions from file. Syntax is similar to doxygen's
607 # config file, i.e. a series of assigments. You only have to provide
608 # replacements, missing definitions are set to their default value.
610 RTF_STYLESHEET_FILE =
612 # Set optional variables used in the generation of an rtf document.
613 # Syntax is similar to doxygen's config file.
615 RTF_EXTENSIONS_FILE =
617 #---------------------------------------------------------------------------
618 # configuration options related to the man page output
619 #---------------------------------------------------------------------------
621 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
624 GENERATE_MAN = @do_man@
626 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
627 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
628 # put in front of it. If left blank `man' will be used as the default path.
632 # The MAN_EXTENSION tag determines the extension that is added to
633 # the generated man pages (default is the subroutine's section .3)
637 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
638 # then it will generate one additional man file for each entity
639 # documented in the real man page(s). These additional files
640 # only source the real man page, but without them the man command
641 # would be unable to find the correct page. The default is NO.
645 #---------------------------------------------------------------------------
646 # configuration options related to the XML output
647 #---------------------------------------------------------------------------
649 # If the GENERATE_XML tag is set to YES Doxygen will
650 # generate an XML file that captures the structure of
651 # the code including all documentation. Note that this
652 # feature is still experimental and incomplete at the
657 #---------------------------------------------------------------------------
658 # Configuration options related to the preprocessor
659 #---------------------------------------------------------------------------
661 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
662 # evaluate all C-preprocessor directives found in the sources and include
665 ENABLE_PREPROCESSING = YES
667 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
668 # names in the source code. If set to NO (the default) only conditional
669 # compilation will be performed. Macro expansion can be done in a controlled
670 # way by setting EXPAND_ONLY_PREDEF to YES.
674 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
675 # then the macro expansion is limited to the macros specified with the
676 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
678 EXPAND_ONLY_PREDEF = NO
680 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
681 # in the INCLUDE_PATH (see below) will be search if a #include is found.
683 SEARCH_INCLUDES = YES
685 # The INCLUDE_PATH tag can be used to specify one or more directories that
686 # contain include files that are not input files but should be processed by
691 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
692 # patterns (like *.h and *.hpp) to filter out the header-files in the
693 # directories. If left blank, the patterns specified with FILE_PATTERNS will
696 INCLUDE_FILE_PATTERNS =
698 # The PREDEFINED tag can be used to specify one or more macro names that
699 # are defined before the preprocessor is started (similar to the -D option of
700 # gcc). The argument of the tag is a list of macros of the form: name
701 # or name=definition (no spaces). If the definition and the = are
702 # omitted =1 is assumed.
704 PREDEFINED = _GLIBCPP_DEPRECATED
706 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
707 # this tag can be used to specify a list of macro names that should be expanded.
708 # The macro definition that is found in the sources will be used.
709 # Use the PREDEFINED tag if you want to use a different macro definition.
713 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
714 # doxygen's preprocessor will remove all function-like macros that are alone
715 # on a line and do not end with a semicolon. Such function macros are typically
716 # used for boiler-plate code, and will confuse the parser if not removed.
718 SKIP_FUNCTION_MACROS = YES
720 #---------------------------------------------------------------------------
721 # Configuration::addtions related to external references
722 #---------------------------------------------------------------------------
724 # The TAGFILES tag can be used to specify one or more tagfiles.
728 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
729 # a tag file that is based on the input files it reads.
733 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
734 # in the class index. If set to NO only the inherited external classes
739 # The PERL_PATH should be the absolute path and name of the perl script
740 # interpreter (i.e. the result of `which perl').
742 PERL_PATH = /usr/bin/perl
744 #---------------------------------------------------------------------------
745 # Configuration options related to the dot tool
746 #---------------------------------------------------------------------------
748 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
749 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
750 # super classes. Setting the tag to NO turns the diagrams off. Note that this
751 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
752 # recommended to install and use dot, since it yield more powerful graphs.
756 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
757 # available from the path. This tool is part of Graphviz, a graph visualization
758 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
759 # have no effect if this option is set to NO (the default)
763 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
764 # will generate a graph for each documented class showing the direct and
765 # indirect inheritance relations. Setting this tag to YES will force the
766 # the CLASS_DIAGRAMS tag to NO.
770 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
771 # will generate a graph for each documented class showing the direct and
772 # indirect implementation dependencies (inheritance, containment, and
773 # class references variables) of the class with other documented classes.
775 COLLABORATION_GRAPH = YES
777 # If set to YES, the inheritance and collaboration graphs will show the
778 # relations between templates and their instances.
780 TEMPLATE_RELATIONS = YES
782 # If set to YES, the inheritance and collaboration graphs will hide
783 # inheritance and usage relations if the target is undocumented
786 HIDE_UNDOC_RELATIONS = YES
788 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
789 # tags are set to YES then doxygen will generate a graph for each documented
790 # file showing the direct and indirect include dependencies of the file with
791 # other documented files.
795 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
796 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
797 # documented header file showing the documented files that directly or
798 # indirectly include this file.
800 INCLUDED_BY_GRAPH = YES
802 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
803 # will graphical hierarchy of all classes instead of a textual one.
805 GRAPHICAL_HIERARCHY = YES
807 # The tag DOT_PATH can be used to specify the path where the dot tool can be
808 # found. If left blank, it is assumed the dot tool can be found on the path.
812 # The DOTFILE_DIRS tag can be used to specify one or more directories that
813 # contain dot files that are included in the documentation (see the
818 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
819 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
820 # this value, doxygen will try to truncate the graph, so that it fits within
821 # the specified constraint. Beware that most browsers cannot cope with very
824 MAX_DOT_GRAPH_WIDTH = 1024
826 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
827 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
828 # this value, doxygen will try to truncate the graph, so that it fits within
829 # the specified constraint. Beware that most browsers cannot cope with very
832 MAX_DOT_GRAPH_HEIGHT = 1024
834 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
835 # generate a legend page explaining the meaning of the various boxes and
836 # arrows in the dot generated graphs.
838 GENERATE_LEGEND = YES
840 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
841 # remove the intermedate dot files that are used to generate
842 # the various graphs.
846 #---------------------------------------------------------------------------
847 # Configuration::addtions related to the search engine
848 #---------------------------------------------------------------------------
850 # The SEARCHENGINE tag specifies whether or not a search engine should be
851 # used. If set to NO the values of all tags below this one will be ignored.
855 # The CGI_NAME tag should be the name of the CGI script that
856 # starts the search engine (doxysearch) with the correct parameters.
857 # A script with this name will be generated by doxygen.
859 CGI_NAME = search.cgi
861 # The CGI_URL tag should be the absolute URL to the directory where the
862 # cgi binaries are located. See the documentation of your http daemon for
867 # The DOC_URL tag should be the absolute URL to the directory where the
868 # documentation is located. If left blank the absolute path to the
869 # documentation, with file:// prepended to it, will be used.
873 # The DOC_ABSPATH tag should be the absolute path to the directory where the
874 # documentation is located. If left blank the directory on the local machine
879 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
882 BIN_ABSPATH = /usr/local/bin/
884 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
885 # documentation generated for other projects. This allows doxysearch to search
886 # the documentation for these projects as well.