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 = Fiasco Microkernel
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.
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 = docs
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, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40 # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
43 OUTPUT_LANGUAGE = English
45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46 # documentation are documented, even if no documentation was available.
47 # Private class members and static file members will be hidden unless
48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53 # will be included in the documentation.
57 # If the EXTRACT_STATIC tag is set to YES all static members of a file
58 # will be included in the documentation.
62 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63 # defined locally in source files will be included in the documentation.
64 # If set to NO only classes defined in header files are included.
66 EXTRACT_LOCAL_CLASSES = YES
68 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69 # undocumented members of documented classes, files or namespaces.
70 # If set to NO (the default) these members will be included in the
71 # various overviews, but no documentation section is generated.
72 # This option has no effect if EXTRACT_ALL is enabled.
74 HIDE_UNDOC_MEMBERS = NO
76 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77 # undocumented classes that are normally visible in the class hierarchy.
78 # If set to NO (the default) these class will be included in the various
79 # overviews. This option has no effect if EXTRACT_ALL is enabled.
81 HIDE_UNDOC_CLASSES = NO
83 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84 # include brief member descriptions after the members that are listed in
85 # the file and class documentation (similar to JavaDoc).
86 # Set to NO to disable this.
88 BRIEF_MEMBER_DESC = YES
90 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91 # the brief description of a member or function before the detailed description.
92 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93 # brief descriptions will be completely suppressed.
97 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98 # Doxygen will generate a detailed section even if there is only a brief
101 ALWAYS_DETAILED_SEC = NO
103 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104 # members of a class in the documentation of that class as if those members were
105 # ordinary class members. Constructors, destructors and assignment operators of
106 # the base classes will not be shown.
108 INLINE_INHERITED_MEMB = NO
110 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111 # path before files name in the file list and in the header files. If set
112 # to NO the shortest path that makes the file name unique will be used.
116 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117 # can be used to strip a user defined part of the path. Stripping is
118 # only done if one of the specified strings matches the left-hand part of
119 # the path. It is allowed to use relative paths in the argument list.
123 # The INTERNAL_DOCS tag determines if documentation
124 # that is typed after a \internal command is included. If the tag is set
125 # to NO (the default) then the documentation will be excluded.
126 # Set it to YES to include the internal documentation.
130 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131 # doxygen to hide any special comment blocks from generated source code
132 # fragments. Normal C and C++ comments will always remain visible.
134 STRIP_CODE_COMMENTS = YES
136 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137 # file names in lower case letters. If set to YES upper case letters are also
138 # allowed. This is useful if you have classes or files whose names only differ
139 # in case and if your file system supports case sensitive file names. Windows
140 # users are adviced to set this option to NO.
142 CASE_SENSE_NAMES = YES
144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145 # (but less readable) file names. This can be useful is your file systems
146 # doesn't support long names like on DOS, Mac, or CD-ROM.
150 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
151 # will show members with their full class and namespace scopes in the
152 # documentation. If set to YES the scope will be hidden.
154 HIDE_SCOPE_NAMES = NO
156 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
157 # will generate a verbatim copy of the header file for each class for
158 # which an include is specified. Set to NO to disable this.
160 VERBATIM_HEADERS = YES
162 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
163 # will put list of the files that are included by a file in the documentation
166 SHOW_INCLUDE_FILES = YES
168 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169 # will interpret the first line (until the first dot) of a JavaDoc-style
170 # comment as the brief description. If set to NO, the JavaDoc
171 # comments will behave just like the Qt-style comments (thus requiring an
172 # explict @brief command for a brief description.
174 #JAVADOC_AUTOBRIEF = NO
175 JAVADOC_AUTOBRIEF = YES
177 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
178 # member inherits the documentation from any documented member that it
183 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
184 # is inserted in the documentation for inline members.
188 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
189 # will sort the (detailed) documentation of file and class members
190 # alphabetically by member name. If set to NO the members will appear in
193 SORT_MEMBER_DOCS = YES
195 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
196 # tag is set to YES, then doxygen will reuse the documentation of the first
197 # member in the group (if any) for the other members of the group. By default
198 # all members of a group must be documented explicitly.
200 DISTRIBUTE_GROUP_DOC = NO
202 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
203 # Doxygen uses this value to replace tabs by spaces in code fragments.
207 # The GENERATE_TODOLIST tag can be used to enable (YES) or
208 # disable (NO) the todo list. This list is created by putting \todo
209 # commands in the documentation.
211 GENERATE_TODOLIST = YES
213 # The GENERATE_TESTLIST tag can be used to enable (YES) or
214 # disable (NO) the test list. This list is created by putting \test
215 # commands in the documentation.
217 GENERATE_TESTLIST = YES
219 # The GENERATE_BUGLIST tag can be used to enable (YES) or
220 # disable (NO) the bug list. This list is created by putting \bug
221 # commands in the documentation.
223 GENERATE_BUGLIST = YES
225 # This tag can be used to specify a number of aliases that acts
226 # as commands in the documentation. An alias has the form "name=value".
227 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
228 # put the command \sideeffect (or @sideeffect) in the documentation, which
229 # will result in a user defined paragraph with heading "Side Effects:".
230 # You can put \n's in the value part of an alias to insert newlines.
234 # The ENABLED_SECTIONS tag can be used to enable conditional
235 # documentation sections, marked by \if sectionname ... \endif.
239 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
240 # the initial value of a variable or define consist of for it to appear in
241 # the documentation. If the initializer consists of more lines than specified
242 # here it will be hidden. Use a value of 0 to hide initializers completely.
243 # The appearance of the initializer of individual variables and defines in the
244 # documentation can be controlled using \showinitializer or \hideinitializer
245 # command in the documentation regardless of this setting.
247 MAX_INITIALIZER_LINES = 30
249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
250 # only. Doxygen will then generate output that is more tailored for C.
251 # For instance some of the names that are used will be different. The list
252 # of all members will be omitted, etc.
254 OPTIMIZE_OUTPUT_FOR_C = NO
256 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
257 # only. Doxygen will then generate output that is more tailored for Java.
258 # For instance namespaces will be presented as packages, qualified scopes
259 # will look different, etc.
261 OPTIMIZE_OUTPUT_JAVA = NO
263 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
264 # at the bottom of the documentation of classes and structs. If set to YES the
265 # list will mention the files that were used to generate the documentation.
267 SHOW_USED_FILES = YES
269 #---------------------------------------------------------------------------
270 # configuration options related to warning and progress messages
271 #---------------------------------------------------------------------------
273 # The QUIET tag can be used to turn on/off the messages that are generated
274 # by doxygen. Possible values are YES and NO. If left blank NO is used.
278 # The WARNINGS tag can be used to turn on/off the warning messages that are
279 # generated by doxygen. Possible values are YES and NO. If left blank
284 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
285 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
286 # automatically be disabled.
288 WARN_IF_UNDOCUMENTED = YES
290 # The WARN_FORMAT tag determines the format of the warning messages that
291 # doxygen can produce. The string should contain the $file, $line, and $text
292 # tags, which will be replaced by the file and line number from which the
293 # warning originated and the warning text.
295 WARN_FORMAT = "$file:$line: $text"
297 # The WARN_LOGFILE tag can be used to specify a file to which warning
298 # and error messages should be written. If left blank the output is written
303 #---------------------------------------------------------------------------
304 # configuration options related to the input files
305 #---------------------------------------------------------------------------
307 # The INPUT tag can be used to specify the files and/or directories that contain
308 # documented source files. You may enter file names like "myfile.cpp" or
309 # directories like "/usr/src/myproject". Separate the files or directories
314 # If the value of the INPUT tag contains directories, you can use the
315 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
316 # and *.h) to filter out the source-files in the directories. If left
317 # blank the following patterns are tested:
318 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
321 FILE_PATTERNS = *.h *.cc
323 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
324 # should be searched for input files as well. Possible values are YES and NO.
325 # If left blank NO is used.
329 # The EXCLUDE tag can be used to specify files and/or directories that should
330 # excluded from the INPUT source files. This way you can easily exclude a
331 # subdirectory from a directory tree whose root is specified with the INPUT tag.
335 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
336 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
338 EXCLUDE_SYMLINKS = NO
340 # If the value of the INPUT tag contains directories, you can use the
341 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
342 # certain files from those directories.
346 # The EXAMPLE_PATH tag can be used to specify one or more files or
347 # directories that contain example code fragments that are included (see
348 # the \include command).
352 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
353 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
354 # and *.h) to filter out the source-files in the directories. If left
355 # blank all files are included.
359 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
360 # searched for input files to be used with the \include or \dontinclude
361 # commands irrespective of the value of the RECURSIVE tag.
362 # Possible values are YES and NO. If left blank NO is used.
364 EXAMPLE_RECURSIVE = NO
366 # The IMAGE_PATH tag can be used to specify one or more files or
367 # directories that contain image that are included in the documentation (see
368 # the \image command).
372 # The INPUT_FILTER tag can be used to specify a program that doxygen should
373 # invoke to filter for each input file. Doxygen will invoke the filter program
374 # by executing (via popen()) the command <filter> <input-file>, where <filter>
375 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
376 # input file. Doxygen will then use the output that the filter program writes
377 # to standard output.
381 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
382 # INPUT_FILTER) will be used to filter the input files when producing source
385 FILTER_SOURCE_FILES = NO
387 #---------------------------------------------------------------------------
388 # configuration options related to source browsing
389 #---------------------------------------------------------------------------
391 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
392 # be generated. Documented entities will be cross-referenced with these sources.
396 # Setting the INLINE_SOURCES tag to YES will include the body
397 # of functions and classes directly in the documentation.
401 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
402 # then for each documented function all documented
403 # functions referencing it will be listed.
405 REFERENCED_BY_RELATION = YES
407 # If the REFERENCES_RELATION tag is set to YES (the default)
408 # then for each documented function all documented entities
409 # called/used by that function will be listed.
411 REFERENCES_RELATION = YES
413 #---------------------------------------------------------------------------
414 # configuration options related to the alphabetical class index
415 #---------------------------------------------------------------------------
417 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
418 # of all compounds will be generated. Enable this if the project
419 # contains a lot of classes, structs, unions or interfaces.
421 ALPHABETICAL_INDEX = NO
423 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
424 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
425 # in which this list will be split (can be a number in the range [1..20])
427 COLS_IN_ALPHA_INDEX = 5
429 # In case all classes in a project start with a common prefix, all
430 # classes will be put under the same header in the alphabetical index.
431 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
432 # should be ignored while generating the index headers.
436 #---------------------------------------------------------------------------
437 # configuration options related to the HTML output
438 #---------------------------------------------------------------------------
440 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
441 # generate HTML output.
445 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
446 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
447 # put in front of it. If left blank `html' will be used as the default path.
451 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
452 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
453 # doxygen will generate files with .html extension.
455 HTML_FILE_EXTENSION = .html
457 # The HTML_HEADER tag can be used to specify a personal HTML header for
458 # each generated HTML page. If it is left blank doxygen will generate a
463 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
464 # each generated HTML page. If it is left blank doxygen will generate a
469 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
470 # style sheet that is used by each HTML page. It can be used to
471 # fine-tune the look of the HTML output. If the tag is left blank doxygen
472 # will generate a default style sheet
476 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
477 # files or namespaces will be aligned in HTML using tables. If set to
478 # NO a bullet list will be used.
480 HTML_ALIGN_MEMBERS = YES
482 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
483 # will be generated that can be used as input for tools like the
484 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
485 # of the generated HTML documentation.
487 GENERATE_HTMLHELP = NO
489 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
490 # controls if a separate .chi index file is generated (YES) or that
491 # it should be included in the master .chm file (NO).
495 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
496 # controls whether a binary table of contents is generated (YES) or a
497 # normal table of contents (NO) in the .chm file.
501 # The TOC_EXPAND flag can be set to YES to add extra items for group members
502 # to the contents of the Html help documentation and to the tree view.
506 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
507 # top of each HTML page. The value NO (the default) enables the index and
508 # the value YES disables it.
512 # This tag can be used to set the number of enum values (range [1..20])
513 # that doxygen will group on one line in the generated HTML documentation.
515 ENUM_VALUES_PER_LINE = 4
517 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
518 # generated containing a tree-like index structure (just like the one that
519 # is generated for HTML Help). For this to work a browser that supports
520 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
521 # or Internet explorer 4.0+). Note that for large projects the tree generation
522 # can take a very long time. In such cases it is better to disable this feature.
523 # Windows users are probably better off using the HTML help feature.
525 GENERATE_TREEVIEW = NO
527 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
528 # used to set the initial width (in pixels) of the frame in which the tree
533 #---------------------------------------------------------------------------
534 # configuration options related to the LaTeX output
535 #---------------------------------------------------------------------------
537 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
538 # generate Latex output.
542 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
543 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
544 # put in front of it. If left blank `latex' will be used as the default path.
548 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
550 LATEX_CMD_NAME = latex
552 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
553 # generate index for LaTeX. If left blank `makeindex' will be used as the
554 # default command name.
556 MAKEINDEX_CMD_NAME = makeindex
558 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
559 # LaTeX documents. This may be useful for small projects and may help to
560 # save some trees in general.
564 # The PAPER_TYPE tag can be used to set the paper type that is used
565 # by the printer. Possible values are: a4, a4wide, letter, legal and
566 # executive. If left blank a4wide will be used.
570 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
571 # packages that should be included in the LaTeX output.
575 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
576 # the generated latex document. The header should contain everything until
577 # the first chapter. If it is left blank doxygen will generate a
578 # standard header. Notice: only use this tag if you know what you are doing!
582 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
583 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
584 # contain links (just like the HTML output) instead of page references
585 # This makes the output suitable for online browsing using a pdf viewer.
589 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
590 # plain latex in the generated Makefile. Set this option to YES to get a
591 # higher quality PDF documentation.
595 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
596 # command to the generated LaTeX files. This will instruct LaTeX to keep
597 # running if errors occur, instead of asking the user for help.
598 # This option is also used when generating formulas in HTML.
602 #---------------------------------------------------------------------------
603 # configuration options related to the RTF output
604 #---------------------------------------------------------------------------
606 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
607 # The RTF output is optimised for Word 97 and may not look very pretty with
608 # other RTF readers or editors.
612 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
613 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
614 # put in front of it. If left blank `rtf' will be used as the default path.
618 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
619 # RTF documents. This may be useful for small projects and may help to
620 # save some trees in general.
624 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
625 # will contain hyperlink fields. The RTF file will
626 # contain links (just like the HTML output) instead of page references.
627 # This makes the output suitable for online browsing using WORD or other
628 # programs which support those fields.
629 # Note: wordpad (write) and others do not support links.
633 # Load stylesheet definitions from file. Syntax is similar to doxygen's
634 # config file, i.e. a series of assigments. You only have to provide
635 # replacements, missing definitions are set to their default value.
637 RTF_STYLESHEET_FILE =
639 # Set optional variables used in the generation of an rtf document.
640 # Syntax is similar to doxygen's config file.
642 RTF_EXTENSIONS_FILE =
644 #---------------------------------------------------------------------------
645 # configuration options related to the man page output
646 #---------------------------------------------------------------------------
648 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
653 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
654 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
655 # put in front of it. If left blank `man' will be used as the default path.
659 # The MAN_EXTENSION tag determines the extension that is added to
660 # the generated man pages (default is the subroutine's section .3)
664 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
665 # then it will generate one additional man file for each entity
666 # documented in the real man page(s). These additional files
667 # only source the real man page, but without them the man command
668 # would be unable to find the correct page. The default is NO.
672 #---------------------------------------------------------------------------
673 # configuration options related to the XML output
674 #---------------------------------------------------------------------------
676 # If the GENERATE_XML tag is set to YES Doxygen will
677 # generate an XML file that captures the structure of
678 # the code including all documentation. Note that this
679 # feature is still experimental and incomplete at the
684 #---------------------------------------------------------------------------
685 # configuration options for the AutoGen Definitions output
686 #---------------------------------------------------------------------------
688 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
689 # generate an AutoGen Definitions (see autogen.sf.net) file
690 # that captures the structure of the code including all
691 # documentation. Note that this feature is still experimental
692 # and incomplete at the moment.
694 GENERATE_AUTOGEN_DEF = NO
696 #---------------------------------------------------------------------------
697 # Configuration options related to the preprocessor
698 #---------------------------------------------------------------------------
700 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
701 # evaluate all C-preprocessor directives found in the sources and include
704 ENABLE_PREPROCESSING = YES
706 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
707 # names in the source code. If set to NO (the default) only conditional
708 # compilation will be performed. Macro expansion can be done in a controlled
709 # way by setting EXPAND_ONLY_PREDEF to YES.
713 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
714 # then the macro expansion is limited to the macros specified with the
715 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
717 EXPAND_ONLY_PREDEF = NO
719 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
720 # in the INCLUDE_PATH (see below) will be search if a #include is found.
722 SEARCH_INCLUDES = YES
724 # The INCLUDE_PATH tag can be used to specify one or more directories that
725 # contain include files that are not input files but should be processed by
730 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
731 # patterns (like *.h and *.hpp) to filter out the header-files in the
732 # directories. If left blank, the patterns specified with FILE_PATTERNS will
735 INCLUDE_FILE_PATTERNS =
737 # The PREDEFINED tag can be used to specify one or more macro names that
738 # are defined before the preprocessor is started (similar to the -D option of
739 # gcc). The argument of the tag is a list of macros of the form: name
740 # or name=definition (no spaces). If the definition and the = are
741 # omitted =1 is assumed.
745 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
746 # this tag can be used to specify a list of macro names that should be expanded.
747 # The macro definition that is found in the sources will be used.
748 # Use the PREDEFINED tag if you want to use a different macro definition.
752 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
753 # doxygen's preprocessor will remove all function-like macros that are alone
754 # on a line and do not end with a semicolon. Such function macros are typically
755 # used for boiler-plate code, and will confuse the parser if not removed.
757 SKIP_FUNCTION_MACROS = YES
759 #---------------------------------------------------------------------------
760 # Configuration::addtions related to external references
761 #---------------------------------------------------------------------------
763 # The TAGFILES tag can be used to specify one or more tagfiles.
767 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
768 # a tag file that is based on the input files it reads.
772 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
773 # in the class index. If set to NO only the inherited external classes
778 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
779 # in the modules index. If set to NO, only the current project's groups will
782 EXTERNAL_GROUPS = YES
784 # The PERL_PATH should be the absolute path and name of the perl script
785 # interpreter (i.e. the result of `which perl').
787 PERL_PATH = /usr/bin/perl
789 #---------------------------------------------------------------------------
790 # Configuration options related to the dot tool
791 #---------------------------------------------------------------------------
793 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
794 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
795 # super classes. Setting the tag to NO turns the diagrams off. Note that this
796 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
797 # recommended to install and use dot, since it yield more powerful graphs.
801 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
802 # available from the path. This tool is part of Graphviz, a graph visualization
803 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
804 # have no effect if this option is set to NO (the default)
808 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
809 # will generate a graph for each documented class showing the direct and
810 # indirect inheritance relations. Setting this tag to YES will force the
811 # the CLASS_DIAGRAMS tag to NO.
815 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
816 # will generate a graph for each documented class showing the direct and
817 # indirect implementation dependencies (inheritance, containment, and
818 # class references variables) of the class with other documented classes.
820 COLLABORATION_GRAPH = YES
822 # If set to YES, the inheritance and collaboration graphs will show the
823 # relations between templates and their instances.
825 TEMPLATE_RELATIONS = YES
827 # If set to YES, the inheritance and collaboration graphs will hide
828 # inheritance and usage relations if the target is undocumented
831 HIDE_UNDOC_RELATIONS = YES
833 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
834 # tags are set to YES then doxygen will generate a graph for each documented
835 # file showing the direct and indirect include dependencies of the file with
836 # other documented files.
840 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
841 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
842 # documented header file showing the documented files that directly or
843 # indirectly include this file.
845 INCLUDED_BY_GRAPH = YES
847 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
848 # will graphical hierarchy of all classes instead of a textual one.
850 GRAPHICAL_HIERARCHY = YES
852 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
853 # generated by dot. Possible values are png, jpg, or gif
854 # If left blank png will be used.
856 DOT_IMAGE_FORMAT = png
858 # The tag DOT_PATH can be used to specify the path where the dot tool can be
859 # found. If left blank, it is assumed the dot tool can be found on the path.
863 # The DOTFILE_DIRS tag can be used to specify one or more directories that
864 # contain dot files that are included in the documentation (see the
869 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
870 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
871 # this value, doxygen will try to truncate the graph, so that it fits within
872 # the specified constraint. Beware that most browsers cannot cope with very
875 MAX_DOT_GRAPH_WIDTH = 1024
877 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
878 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
879 # this value, doxygen will try to truncate the graph, so that it fits within
880 # the specified constraint. Beware that most browsers cannot cope with very
883 MAX_DOT_GRAPH_HEIGHT = 1024
885 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
886 # generate a legend page explaining the meaning of the various boxes and
887 # arrows in the dot generated graphs.
889 GENERATE_LEGEND = YES
891 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
892 # remove the intermedate dot files that are used to generate
893 # the various graphs.
897 #---------------------------------------------------------------------------
898 # Configuration::addtions related to the search engine
899 #---------------------------------------------------------------------------
901 # The SEARCHENGINE tag specifies whether or not a search engine should be
902 # used. If set to NO the values of all tags below this one will be ignored.
906 # The CGI_NAME tag should be the name of the CGI script that
907 # starts the search engine (doxysearch) with the correct parameters.
908 # A script with this name will be generated by doxygen.
910 CGI_NAME = search.cgi
912 # The CGI_URL tag should be the absolute URL to the directory where the
913 # cgi binaries are located. See the documentation of your http daemon for
918 # The DOC_URL tag should be the absolute URL to the directory where the
919 # documentation is located. If left blank the absolute path to the
920 # documentation, with file:// prepended to it, will be used.
924 # The DOC_ABSPATH tag should be the absolute path to the directory where the
925 # documentation is located. If left blank the directory on the local machine
930 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
933 BIN_ABSPATH = /usr/local/bin/
935 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
936 # documentation generated for other projects. This allows doxysearch to search
937 # the documentation for these projects as well.