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.
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.
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, 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 HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
63 # undocumented members of documented classes, files or namespaces.
64 # If set to NO (the default) these members will be included in the
65 # various overviews, but no documentation section is generated.
66 # This option has no effect if EXTRACT_ALL is enabled.
68 HIDE_UNDOC_MEMBERS = YES
70 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
71 # undocumented classes that are normally visible in the class hierarchy.
72 # If set to NO (the default) these class will be included in the various
73 # overviews. This option has no effect if EXTRACT_ALL is enabled.
75 HIDE_UNDOC_CLASSES = YES
77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
78 # include brief member descriptions after the members that are listed in
79 # the file and class documentation (similar to JavaDoc).
80 # Set to NO to disable this.
82 BRIEF_MEMBER_DESC = YES
84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
85 # the brief description of a member or function before the detailed description.
86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
87 # brief descriptions will be completely suppressed.
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
95 ALWAYS_DETAILED_SEC = NO
97 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
98 # path before files name in the file list and in the header files. If set
99 # to NO the shortest path that makes the file name unique will be used.
103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
104 # can be used to strip a user defined part of the path. Stripping is
105 # only done if one of the specified strings matches the left-hand part of
106 # the path. It is allowed to use relative paths in the argument list.
110 # The INTERNAL_DOCS tag determines if documentation
111 # that is typed after a \internal command is included. If the tag is set
112 # to NO (the default) then the documentation will be excluded.
113 # Set it to YES to include the internal documentation.
117 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
118 # doxygen to hide any special comment blocks from generated source code
119 # fragments. Normal C and C++ comments will always remain visible.
121 STRIP_CODE_COMMENTS = YES
123 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
124 # file names in lower case letters. If set to YES upper case letters are also
125 # allowed. This is useful if you have classes or files whose names only differ
126 # in case and if your file system supports case sensitive file names. Windows
127 # users are adviced to set this option to NO.
129 CASE_SENSE_NAMES = NO
131 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
132 # (but less readable) file names. This can be useful is your file systems
133 # doesn't support long names like on DOS, Mac, or CD-ROM.
137 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
138 # will show members with their full class and namespace scopes in the
139 # documentation. If set to YES the scope will be hidden.
141 HIDE_SCOPE_NAMES = NO
143 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
144 # will generate a verbatim copy of the header file for each class for
145 # which an include is specified. Set to NO to disable this.
147 VERBATIM_HEADERS = NO
149 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
150 # will put list of the files that are included by a file in the documentation
153 SHOW_INCLUDE_FILES = NO
155 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
156 # will interpret the first line (until the first dot) of a JavaDoc-style
157 # comment as the brief description. If set to NO, the JavaDoc
158 # comments will behave just like the Qt-style comments (thus requiring an
159 # explict @brief command for a brief description.
161 JAVADOC_AUTOBRIEF = YES
163 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
164 # member inherits the documentation from any documented member that it
169 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
170 # is inserted in the documentation for inline members.
174 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
175 # will sort the (detailed) documentation of file and class members
176 # alphabetically by member name. If set to NO the members will appear in
179 SORT_MEMBER_DOCS = YES
181 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
182 # tag is set to YES, then doxygen will reuse the documentation of the first
183 # member in the group (if any) for the other members of the group. By default
184 # all members of a group must be documented explicitly.
186 DISTRIBUTE_GROUP_DOC = NO
188 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
189 # Doxygen uses this value to replace tabs by spaces in code fragments.
193 # The GENERATE_TODOLIST tag can be used to enable (YES) or
194 # disable (NO) the todo list. This list is created by putting \todo
195 # commands in the documentation.
197 GENERATE_TODOLIST = YES
199 # The GENERATE_TESTLIST tag can be used to enable (YES) or
200 # disable (NO) the test list. This list is created by putting \test
201 # commands in the documentation.
203 GENERATE_TESTLIST = YES
205 # The GENERATE_BUGLIST tag can be used to enable (YES) or
206 # disable (NO) the bug list. This list is created by putting \bug
207 # commands in the documentation.
209 GENERATE_BUGLIST = YES
211 # This tag can be used to specify a number of aliases that acts
212 # as commands in the documentation. An alias has the form "name=value".
213 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
214 # put the command \sideeffect (or @sideeffect) in the documentation, which
215 # will result in a user defined paragraph with heading "Side Effects:".
216 # You can put \n's in the value part of an alias to insert newlines.
220 # The ENABLED_SECTIONS tag can be used to enable conditional
221 # documentation sections, marked by \if sectionname ... \endif.
225 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
226 # the initial value of a variable or define consist of for it to appear in
227 # the documentation. If the initializer consists of more lines than specified
228 # here it will be hidden. Use a value of 0 to hide initializers completely.
229 # The appearance of the initializer of individual variables and defines in the
230 # documentation can be controlled using \showinitializer or \hideinitializer
231 # command in the documentation regardless of this setting.
233 MAX_INITIALIZER_LINES = 30
235 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
236 # only. Doxygen will then generate output that is more tailored for C.
237 # For instance some of the names that are used will be different. The list
238 # of all members will be omitted, etc.
240 OPTIMIZE_OUTPUT_FOR_C = YES
242 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
243 # at the bottom of the documentation of classes and structs. If set to YES the
244 # list will mention the files that were used to generate the documentation.
246 SHOW_USED_FILES = YES
248 #---------------------------------------------------------------------------
249 # configuration options related to warning and progress messages
250 #---------------------------------------------------------------------------
252 # The QUIET tag can be used to turn on/off the messages that are generated
253 # by doxygen. Possible values are YES and NO. If left blank NO is used.
257 # The WARNINGS tag can be used to turn on/off the warning messages that are
258 # generated by doxygen. Possible values are YES and NO. If left blank
263 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
264 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
265 # automatically be disabled.
267 WARN_IF_UNDOCUMENTED = YES
269 # The WARN_FORMAT tag determines the format of the warning messages that
270 # doxygen can produce. The string should contain the $file, $line, and $text
271 # tags, which will be replaced by the file and line number from which the
272 # warning originated and the warning text.
276 # The WARN_LOGFILE tag can be used to specify a file to which warning
277 # and error messages should be written. If left blank the output is written
282 #---------------------------------------------------------------------------
283 # configuration options related to the input files
284 #---------------------------------------------------------------------------
286 # The INPUT tag can be used to specify the files and/or directories that contain
287 # documented source files. You may enter file names like "myfile.cpp" or
288 # directories like "/usr/src/myproject". Separate the files or directories
293 # If the value of the INPUT tag contains directories, you can use the
294 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
295 # and *.h) to filter out the source-files in the directories. If left
296 # blank file matching one of the following patterns are included:
297 # *.c *.cc *.cxx *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
300 FILE_PATTERNS = *.h *.c
302 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
303 # should be searched for input files as well. Possible values are YES and NO.
304 # If left blank NO is used.
308 # The EXCLUDE tag can be used to specify files and/or directories that should
309 # excluded from the INPUT source files. This way you can easily exclude a
310 # subdirectory from a directory tree whose root is specified with the INPUT tag.
314 # If the value of the INPUT tag contains directories, you can use the
315 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
316 # certain files from those directories.
320 # The EXAMPLE_PATH tag can be used to specify one or more files or
321 # directories that contain example code fragments that are included (see
322 # the \include command).
326 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
327 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
328 # and *.h) to filter out the source-files in the directories. If left
329 # blank all files are included.
333 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
334 # searched for input files to be used with the \include or \dontinclude
335 # commands irrespective of the value of the RECURSIVE tag.
336 # Possible values are YES and NO. If left blank NO is used.
338 EXAMPLE_RECURSIVE = NO
340 # The IMAGE_PATH tag can be used to specify one or more files or
341 # directories that contain image that are included in the documentation (see
342 # the \image command).
346 # The INPUT_FILTER tag can be used to specify a program that doxygen should
347 # invoke to filter for each input file. Doxygen will invoke the filter program
348 # by executing (via popen()) the command <filter> <input-file>, where <filter>
349 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
350 # input file. Doxygen will then use the output that the filter program writes
351 # to standard output.
355 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
356 # INPUT_FILTER) will be used to filter the input files when producing source
359 FILTER_SOURCE_FILES = NO
361 #---------------------------------------------------------------------------
362 # configuration options related to source browsing
363 #---------------------------------------------------------------------------
365 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
366 # be generated. Documented entities will be cross-referenced with these sources.
370 # Setting the INLINE_SOURCES tag to YES will include the body
371 # of functions and classes directly in the documentation.
375 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
376 # then for each documented function all documented
377 # functions referencing it will be listed.
379 REFERENCED_BY_RELATION = YES
381 # If the REFERENCES_RELATION tag is set to YES (the default)
382 # then for each documented function all documented entities
383 # called/used by that function will be listed.
385 REFERENCES_RELATION = YES
387 #---------------------------------------------------------------------------
388 # configuration options related to the alphabetical class index
389 #---------------------------------------------------------------------------
391 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
392 # of all compounds will be generated. Enable this if the project
393 # contains a lot of classes, structs, unions or interfaces.
395 ALPHABETICAL_INDEX = NO
397 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
398 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
399 # in which this list will be split (can be a number in the range [1..20])
401 COLS_IN_ALPHA_INDEX = 5
403 # In case all classes in a project start with a common prefix, all
404 # classes will be put under the same header in the alphabetical index.
405 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
406 # should be ignored while generating the index headers.
410 #---------------------------------------------------------------------------
411 # configuration options related to the HTML output
412 #---------------------------------------------------------------------------
414 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
415 # generate HTML output.
419 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
420 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
421 # put in front of it. If left blank `html' will be used as the default path.
425 # The HTML_HEADER tag can be used to specify a personal HTML header for
426 # each generated HTML page. If it is left blank doxygen will generate a
429 HTML_HEADER = doc/header.html
431 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
432 # each generated HTML page. If it is left blank doxygen will generate a
435 HTML_FOOTER = doc/footer.html
437 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
438 # style sheet that is used by each HTML page. It can be used to
439 # fine-tune the look of the HTML output. If the tag is left blank doxygen
440 # will generate a default style sheet
442 HTML_STYLESHEET = doc/trio.css
444 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
445 # files or namespaces will be aligned in HTML using tables. If set to
446 # NO a bullet list will be used.
448 HTML_ALIGN_MEMBERS = YES
450 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
451 # will be generated that can be used as input for tools like the
452 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
453 # of the generated HTML documentation.
455 GENERATE_HTMLHELP = NO
457 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
458 # controls if a separate .chi index file is generated (YES) or that
459 # it should be included in the master .chm file (NO).
463 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
464 # controls whether a binary table of contents is generated (YES) or a
465 # normal table of contents (NO) in the .chm file.
469 # The TOC_EXPAND flag can be set to YES to add extra items for group members
470 # to the contents of the Html help documentation and to the tree view.
474 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
475 # top of each HTML page. The value NO (the default) enables the index and
476 # the value YES disables it.
480 # This tag can be used to set the number of enum values (range [1..20])
481 # that doxygen will group on one line in the generated HTML documentation.
483 ENUM_VALUES_PER_LINE = 4
485 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
486 # generated containing a tree-like index structure (just like the one that
487 # is generated for HTML Help). For this to work a browser that supports
488 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
489 # or Internet explorer 4.0+). Note that for large projects the tree generation
490 # can take a very long time. In such cases it is better to disable this feature.
491 # Windows users are probably better off using the HTML help feature.
493 GENERATE_TREEVIEW = NO
495 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
496 # used to set the initial width (in pixels) of the frame in which the tree
501 #---------------------------------------------------------------------------
502 # configuration options related to the LaTeX output
503 #---------------------------------------------------------------------------
505 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
506 # generate Latex output.
510 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
511 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
512 # put in front of it. If left blank `latex' will be used as the default path.
516 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
517 # LaTeX documents. This may be useful for small projects and may help to
518 # save some trees in general.
522 # The PAPER_TYPE tag can be used to set the paper type that is used
523 # by the printer. Possible values are: a4, a4wide, letter, legal and
524 # executive. If left blank a4wide will be used.
528 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
529 # packages that should be included in the LaTeX output.
533 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
534 # the generated latex document. The header should contain everything until
535 # the first chapter. If it is left blank doxygen will generate a
536 # standard header. Notice: only use this tag if you know what you are doing!
540 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
541 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
542 # contain links (just like the HTML output) instead of page references
543 # This makes the output suitable for online browsing using a pdf viewer.
547 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
548 # plain latex in the generated Makefile. Set this option to YES to get a
549 # higher quality PDF documentation.
553 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
554 # command to the generated LaTeX files. This will instruct LaTeX to keep
555 # running if errors occur, instead of asking the user for help.
556 # This option is also used when generating formulas in HTML.
560 #---------------------------------------------------------------------------
561 # configuration options related to the RTF output
562 #---------------------------------------------------------------------------
564 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
565 # The RTF output is optimised for Word 97 and may not look very pretty with
566 # other RTF readers or editors.
570 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
571 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
572 # put in front of it. If left blank `rtf' will be used as the default path.
576 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
577 # RTF documents. This may be useful for small projects and may help to
578 # save some trees in general.
582 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
583 # will contain hyperlink fields. The RTF file will
584 # contain links (just like the HTML output) instead of page references.
585 # This makes the output suitable for online browsing using WORD or other
586 # programs which support those fields.
587 # Note: wordpad (write) and others do not support links.
591 # Load stylesheet definitions from file. Syntax is similar to doxygen's
592 # config file, i.e. a series of assigments. You only have to provide
593 # replacements, missing definitions are set to their default value.
595 RTF_STYLESHEET_FILE =
597 # Set optional variables used in the generation of an rtf document.
598 # Syntax is similar to doxygen's config file.
600 RTF_EXTENSIONS_FILE =
602 #---------------------------------------------------------------------------
603 # configuration options related to the man page output
604 #---------------------------------------------------------------------------
606 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
611 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
612 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
613 # put in front of it. If left blank `man' will be used as the default path.
617 # The MAN_EXTENSION tag determines the extension that is added to
618 # the generated man pages (default is the subroutine's section .3)
622 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
623 # then it will generate one additional man file for each entity
624 # documented in the real man page(s). These additional files
625 # only source the real man page, but without them the man command
626 # would be unable to find the correct page. The default is NO.
630 #---------------------------------------------------------------------------
631 # configuration options related to the XML output
632 #---------------------------------------------------------------------------
634 # If the GENERATE_XML tag is set to YES Doxygen will
635 # generate an XML file that captures the structure of
636 # the code including all documentation. Note that this
637 # feature is still experimental and incomplete at the
642 #---------------------------------------------------------------------------
643 # Configuration options related to the preprocessor
644 #---------------------------------------------------------------------------
646 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
647 # evaluate all C-preprocessor directives found in the sources and include
650 ENABLE_PREPROCESSING = YES
652 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
653 # names in the source code. If set to NO (the default) only conditional
654 # compilation will be performed. Macro expansion can be done in a controlled
655 # way by setting EXPAND_ONLY_PREDEF to YES.
657 MACRO_EXPANSION = YES
659 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
660 # then the macro expansion is limited to the macros specified with the
661 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
663 EXPAND_ONLY_PREDEF = YES
665 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
666 # in the INCLUDE_PATH (see below) will be search if a #include is found.
668 SEARCH_INCLUDES = YES
670 # The INCLUDE_PATH tag can be used to specify one or more directories that
671 # contain include files that are not input files but should be processed by
676 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
677 # patterns (like *.h and *.hpp) to filter out the header-files in the
678 # directories. If left blank, the patterns specified with FILE_PATTERNS will
681 INCLUDE_FILE_PATTERNS =
683 # The PREDEFINED tag can be used to specify one or more macro names that
684 # are defined before the preprocessor is started (similar to the -D option of
685 # gcc). The argument of the tag is a list of macros of the form: name
686 # or name=definition (no spaces). If the definition and the = are
687 # omitted =1 is assumed.
689 PREDEFINED = __STDC__=1 TRIO_DOCUMENTATION= TRIO_PUBLIC= TRIO_PRIVATE=static TRIO_CONST=const TRIO_VOLATILE=volatile TRIO_SIGNED=signed TRIO_INLINE=inline TRIO_NOARGS=void TRIO_ARGS1(z,a)=(a) TRIO_ARGS2(z,a,b)=(a,b) TRIO_ARGS3(z,a,b,c)=(a,b,c) TRIO_ARGS4(z,a,b,c,d)=(a,b,c,d) TRIO_ARGS5(z,a,b,c,d,e)=(a,b,c,d,e) TRIO_ARGS6(z,a,b,c,d,e,f)=(a,b,c,d,e,f) TRIO_VARGS2(z,a,b)=(a,b) TRIO_VARGS3(z,a,b,c)=(a,b,c) TRIO_VARGS4(z,a,b,c,d)=(a,b,c,d) TRIO_VARGS5(z,a,b,c,d,e)=(a,b,c,d,e)
691 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
692 # this tag can be used to specify a list of macro names that should be expanded.
693 # The macro definition that is found in the sources will be used.
694 # Use the PREDEFINED tag if you want to use a different macro definition.
698 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
699 # doxygen's preprocessor will remove all function-like macros that are alone
700 # on a line and do not end with a semicolon. Such function macros are typically
701 # used for boiler-plate code, and will confuse the parser if not removed.
703 SKIP_FUNCTION_MACROS = YES
705 #---------------------------------------------------------------------------
706 # Configuration::addtions related to external references
707 #---------------------------------------------------------------------------
709 # The TAGFILES tag can be used to specify one or more tagfiles.
713 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
714 # a tag file that is based on the input files it reads.
718 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
719 # in the class index. If set to NO only the inherited external classes
724 # The PERL_PATH should be the absolute path and name of the perl script
725 # interpreter (i.e. the result of `which perl').
729 #---------------------------------------------------------------------------
730 # Configuration options related to the dot tool
731 #---------------------------------------------------------------------------
733 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
734 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
735 # super classes. Setting the tag to NO turns the diagrams off. Note that this
736 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
737 # recommended to install and use dot, since it yield more powerful graphs.
741 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
742 # available from the path. This tool is part of Graphviz, a graph visualization
743 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
744 # have no effect if this option is set to NO (the default)
748 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
749 # will generate a graph for each documented class showing the direct and
750 # indirect inheritance relations. Setting this tag to YES will force the
751 # the CLASS_DIAGRAMS tag to NO.
755 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
756 # will generate a graph for each documented class showing the direct and
757 # indirect implementation dependencies (inheritance, containment, and
758 # class references variables) of the class with other documented classes.
760 COLLABORATION_GRAPH = YES
762 # If set to YES, the inheritance and collaboration graphs will show the
763 # relations between templates and their instances.
765 TEMPLATE_RELATIONS = YES
767 # If set to YES, the inheritance and collaboration graphs will hide
768 # inheritance and usage relations if the target is undocumented
771 HIDE_UNDOC_RELATIONS = YES
773 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
774 # tags are set to YES then doxygen will generate a graph for each documented
775 # file showing the direct and indirect include dependencies of the file with
776 # other documented files.
780 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
781 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
782 # documented header file showing the documented files that directly or
783 # indirectly include this file.
785 INCLUDED_BY_GRAPH = YES
787 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
788 # will graphical hierarchy of all classes instead of a textual one.
790 GRAPHICAL_HIERARCHY = YES
792 # The tag DOT_PATH can be used to specify the path where the dot tool can be
793 # found. If left blank, it is assumed the dot tool can be found on the path.
797 # The DOTFILE_DIRS tag can be used to specify one or more directories that
798 # contain dot files that are included in the documentation (see the
803 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
804 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
805 # this value, doxygen will try to truncate the graph, so that it fits within
806 # the specified constraint. Beware that most browsers cannot cope with very
809 MAX_DOT_GRAPH_WIDTH = 1024
811 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
812 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
813 # this value, doxygen will try to truncate the graph, so that it fits within
814 # the specified constraint. Beware that most browsers cannot cope with very
817 MAX_DOT_GRAPH_HEIGHT = 1024
819 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
820 # generate a legend page explaining the meaning of the various boxes and
821 # arrows in the dot generated graphs.
823 GENERATE_LEGEND = YES
825 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
826 # remove the intermedate dot files that are used to generate
827 # the various graphs.
831 #---------------------------------------------------------------------------
832 # Configuration::addtions related to the search engine
833 #---------------------------------------------------------------------------
835 # The SEARCHENGINE tag specifies whether or not a search engine should be
836 # used. If set to NO the values of all tags below this one will be ignored.
840 # The CGI_NAME tag should be the name of the CGI script that
841 # starts the search engine (doxysearch) with the correct parameters.
842 # A script with this name will be generated by doxygen.
846 # The CGI_URL tag should be the absolute URL to the directory where the
847 # cgi binaries are located. See the documentation of your http daemon for
852 # The DOC_URL tag should be the absolute URL to the directory where the
853 # documentation is located. If left blank the absolute path to the
854 # documentation, with file:// prepended to it, will be used.
858 # The DOC_ABSPATH tag should be the absolute path to the directory where the
859 # documentation is located. If left blank the directory on the local machine
864 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
869 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
870 # documentation generated for other projects. This allows doxysearch to search
871 # the documentation for these projects as well.