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 # Project related configuration options
15 #---------------------------------------------------------------------------
17 DOXYFILE_ENCODING = UTF-8
18 PROJECT_NAME = SLP-Developer Library
20 OUTPUT_DIRECTORY = ./doxygen_output
22 OUTPUT_LANGUAGE = English
23 BRIEF_MEMBER_DESC = YES
26 ALWAYS_DETAILED_SEC = YES
27 INLINE_INHERITED_MEMB = NO
32 JAVADOC_AUTOBRIEF = NO
33 MULTILINE_CPP_IS_BRIEF = NO
36 SEPARATE_MEMBER_PAGES = YES
39 OPTIMIZE_OUTPUT_FOR_C = NO
40 OPTIMIZE_OUTPUT_JAVA = NO
41 BUILTIN_STL_SUPPORT = NO
43 DISTRIBUTE_GROUP_DOC = NO
46 #---------------------------------------------------------------------------
47 # Build related configuration options
48 #---------------------------------------------------------------------------
53 EXTRACT_LOCAL_CLASSES = NO
54 EXTRACT_LOCAL_METHODS = YES
55 HIDE_UNDOC_MEMBERS = YES
56 HIDE_UNDOC_CLASSES = YES
57 HIDE_FRIEND_COMPOUNDS = YES
58 HIDE_IN_BODY_DOCS = NO
60 CASE_SENSE_NAMES = YES
62 SHOW_INCLUDE_FILES = YES
64 SORT_MEMBER_DOCS = YES
66 SORT_BY_SCOPE_NAME = YES
67 SORT_GROUP_NAMES = YES
68 GENERATE_TODOLIST = NO
71 HTML DYNAMIC SECTIONS = YES
72 GENERATE_TESTLIST = NO
74 GENERATE_DEPRECATEDLIST= NO
76 MAX_INITIALIZER_LINES = 30
81 #---------------------------------------------------------------------------
82 # configuration options related to warning and progress messages
83 #---------------------------------------------------------------------------
85 # The QUIET tag can be used to turn on/off the messages that are generated
86 # by doxygen. Possible values are YES and NO. If left blank NO is used.
90 # The WARNINGS tag can be used to turn on/off the warning messages that are
91 # generated by doxygen. Possible values are YES and NO. If left blank
96 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
97 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
98 # automatically be disabled.
100 WARN_IF_UNDOCUMENTED = YES
102 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
103 # potential errors in the documentation, such as not documenting some
104 # parameters in a documented function, or documenting parameters that
105 # don't exist or using markup commands wrongly.
107 WARN_IF_DOC_ERROR = YES
109 # This WARN_NO_PARAMDOC option can be abled to get warnings for
110 # functions that are documented, but have no documentation for their parameters
111 # or return value. If set to NO (the default) doxygen will only warn about
112 # wrong or incomplete parameter documentation, but not about the absence of
115 WARN_NO_PARAMDOC = NO
117 # The WARN_FORMAT tag determines the format of the warning messages that
118 # doxygen can produce. The string should contain the $file, $line, and $text
119 # tags, which will be replaced by the file and line number from which the
120 # warning originated and the warning text. Optionally the format may contain
121 # $version, which will be replaced by the version of the file (if it could
122 # be obtained via FILE_VERSION_FILTER)
124 WARN_FORMAT = "$file:$line: $text"
126 # The WARN_LOGFILE tag can be used to specify a file to which warning
127 # and error messages should be written. If left blank the output is written
132 #---------------------------------------------------------------------------
133 # configuration options related to the input files
134 #---------------------------------------------------------------------------
136 # The INPUT tag can be used to specify the files and/or directories that contain
137 # documented source files. You may enter file names like "myfile.cpp" or
138 # directories like "/usr/src/myproject". Separate the files or directories
143 # This tag can be used to specify the character encoding of the source files that
144 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
145 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
146 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
148 INPUT_ENCODING = UTF-8
149 FILE_PATTERNS = *.h \
153 EXCLUDE_SYMLINKS = NO
154 EXCLUDE_PATTERNS = */test/* \
165 EXAMPLE_RECURSIVE = NO
166 IMAGE_PATH = ../image
169 FILTER_SOURCE_FILES = NO
171 #---------------------------------------------------------------------------
172 # configuration options related to source browsing
173 #---------------------------------------------------------------------------
175 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
176 # be generated. Documented entities will be cross-referenced with these sources.
177 # Note: To get rid of all source code in the generated output, make sure also
178 # VERBATIM_HEADERS is set to NO.
182 # Setting the INLINE_SOURCES tag to YES will include the body
183 # of functions and classes directly in the documentation.
187 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
188 # doxygen to hide any special comment blocks from generated source code
189 # fragments. Normal C and C++ comments will always remain visible.
191 STRIP_CODE_COMMENTS = YES
193 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
194 # then for each documented function all documented
195 # functions referencing it will be listed.
197 REFERENCED_BY_RELATION = YES
199 # If the REFERENCES_RELATION tag is set to YES (the default)
200 # then for each documented function all documented entities
201 # called/used by that function will be listed.
203 REFERENCES_RELATION = YES
205 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
206 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
207 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
208 # link to the source code. Otherwise they will link to the documentstion.
210 REFERENCES_LINK_SOURCE = YES
212 # If the USE_HTAGS tag is set to YES then the references to source code
213 # will point to the HTML generated by the htags(1) tool instead of doxygen
214 # built-in source browser. The htags tool is part of GNU's global source
215 # tagging system (see http://www.gnu.org/software/global/global.html). You
216 # will need version 4.8.6 or higher.
220 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
221 # will generate a verbatim copy of the header file for each class for
222 # which an include is specified. Set to NO to disable this.
224 VERBATIM_HEADERS = YES
226 #---------------------------------------------------------------------------
227 # configuration options related to the alphabetical class index
228 #---------------------------------------------------------------------------
230 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
231 # of all compounds will be generated. Enable this if the project
232 # contains a lot of classes, structs, unions or interfaces.
234 ALPHABETICAL_INDEX = YES
235 COLS_IN_ALPHA_INDEX = 10
238 #---------------------------------------------------------------------------
239 # configuration options related to the HTML output
240 #---------------------------------------------------------------------------
242 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
243 # generate HTML output.
247 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
248 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
249 # put in front of it. If left blank `html' will be used as the default path.
253 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
254 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
255 # doxygen will generate files with .html extension.
257 HTML_FILE_EXTENSION = .html
259 # The HTML_HEADER tag can be used to specify a personal HTML header for
260 # each generated HTML page. If it is left blank doxygen will generate a
265 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
266 # each generated HTML page. If it is left blank doxygen will generate a
271 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
272 # style sheet that is used by each HTML page. It can be used to
273 # fine-tune the look of the HTML output. If the tag is left blank doxygen
274 # will generate a default style sheet. Note that doxygen will try to copy
275 # the style sheet file to the HTML output directory, so don't put your own
276 # stylesheet in the HTML output directory as well, or it will be erased!
278 HTML_STYLESHEET =./slp_doxy.css
280 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
281 # files or namespaces will be aligned in HTML using tables. If set to
282 # NO a bullet list will be used.
284 HTML_ALIGN_MEMBERS = YES
286 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
287 # will be generated that can be used as input for tools like the
288 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
289 # of the generated HTML documentation.
291 GENERATE_HTMLHELP = YES
293 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
294 # be used to specify the file name of the resulting .chm file. You
295 # can add a path in front of the file if the result should not be
296 # written to the html output directory.
300 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
301 # be used to specify the location (absolute path including file name) of
302 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
303 # the HTML help compiler on the generated index.hhp.
307 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
308 # controls if a separate .chi index file is generated (YES) or that
309 # it should be included in the master .chm file (NO).
313 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
314 # controls whether a binary table of contents is generated (YES) or a
315 # normal table of contents (NO) in the .chm file.
319 # The TOC_EXPAND flag can be set to YES to add extra items for group members
320 # to the contents of the HTML help documentation and to the tree view.
324 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
325 # top of each HTML page. The value NO (the default) enables the index and
326 # the value YES disables it.
330 # This tag can be used to set the number of enum values (range [1..20])
331 # that doxygen will group on one line in the generated HTML documentation.
333 ENUM_VALUES_PER_LINE = 4
335 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
336 # generated containing a tree-like index structure (just like the one that
337 # is generated for HTML Help). For this to work a browser that supports
338 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
339 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
340 # probably better off using the HTML help feature.
342 GENERATE_TREEVIEW = YES
344 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
345 # used to set the initial width (in pixels) of the frame in which the tree
350 #---------------------------------------------------------------------------
351 # configuration options related to the LaTeX output
352 #---------------------------------------------------------------------------
354 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
355 # generate Latex output.
359 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
360 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
361 # put in front of it. If left blank `latex' will be used as the default path.
365 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
366 # invoked. If left blank `latex' will be used as the default command name.
368 LATEX_CMD_NAME = latex
370 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
371 # generate index for LaTeX. If left blank `makeindex' will be used as the
372 # default command name.
374 MAKEINDEX_CMD_NAME = makeindex
376 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
377 # LaTeX documents. This may be useful for small projects and may help to
378 # save some trees in general.
382 # The PAPER_TYPE tag can be used to set the paper type that is used
383 # by the printer. Possible values are: a4, a4wide, letter, legal and
384 # executive. If left blank a4wide will be used.
388 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
389 # packages that should be included in the LaTeX output.
393 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
394 # the generated latex document. The header should contain everything until
395 # the first chapter. If it is left blank doxygen will generate a
396 # standard header. Notice: only use this tag if you know what you are doing!
400 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
401 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
402 # contain links (just like the HTML output) instead of page references
403 # This makes the output suitable for online browsing using a pdf viewer.
407 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
408 # plain latex in the generated Makefile. Set this option to YES to get a
409 # higher quality PDF documentation.
413 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
414 # command to the generated LaTeX files. This will instruct LaTeX to keep
415 # running if errors occur, instead of asking the user for help.
416 # This option is also used when generating formulas in HTML.
420 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
421 # include the index chapters (such as File Index, Compound Index, etc.)
424 LATEX_HIDE_INDICES = NO
426 #---------------------------------------------------------------------------
427 # configuration options related to the RTF output
428 #---------------------------------------------------------------------------
430 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
431 # The RTF output is optimized for Word 97 and may not look very pretty with
432 # other RTF readers or editors.
436 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
437 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
438 # put in front of it. If left blank `rtf' will be used as the default path.
442 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
443 # RTF documents. This may be useful for small projects and may help to
444 # save some trees in general.
448 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
449 # will contain hyperlink fields. The RTF file will
450 # contain links (just like the HTML output) instead of page references.
451 # This makes the output suitable for online browsing using WORD or other
452 # programs which support those fields.
453 # Note: wordpad (write) and others do not support links.
457 # Load stylesheet definitions from file. Syntax is similar to doxygen's
458 # config file, i.e. a series of assignments. You only have to provide
459 # replacements, missing definitions are set to their default value.
461 RTF_STYLESHEET_FILE =
463 # Set optional variables used in the generation of an rtf document.
464 # Syntax is similar to doxygen's config file.
466 RTF_EXTENSIONS_FILE =
468 #---------------------------------------------------------------------------
469 # configuration options related to the man page output
470 #---------------------------------------------------------------------------
472 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
477 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
478 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
479 # put in front of it. If left blank `man' will be used as the default path.
483 # The MAN_EXTENSION tag determines the extension that is added to
484 # the generated man pages (default is the subroutine's section .3)
488 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
489 # then it will generate one additional man file for each entity
490 # documented in the real man page(s). These additional files
491 # only source the real man page, but without them the man command
492 # would be unable to find the correct page. The default is NO.
496 #---------------------------------------------------------------------------
497 # configuration options related to the XML output
498 #---------------------------------------------------------------------------
500 # If the GENERATE_XML tag is set to YES Doxygen will
501 # generate an XML file that captures the structure of
502 # the code including all documentation.
506 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
507 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
508 # put in front of it. If left blank `xml' will be used as the default path.
512 # The XML_SCHEMA tag can be used to specify an XML schema,
513 # which can be used by a validating XML parser to check the
514 # syntax of the XML files.
518 # The XML_DTD tag can be used to specify an XML DTD,
519 # which can be used by a validating XML parser to check the
520 # syntax of the XML files.
524 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
525 # dump the program listings (including syntax highlighting
526 # and cross-referencing information) to the XML output. Note that
527 # enabling this will significantly increase the size of the XML output.
529 XML_PROGRAMLISTING = YES
531 #---------------------------------------------------------------------------
532 # configuration options for the AutoGen Definitions output
533 #---------------------------------------------------------------------------
535 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
536 # generate an AutoGen Definitions (see autogen.sf.net) file
537 # that captures the structure of the code including all
538 # documentation. Note that this feature is still experimental
539 # and incomplete at the moment.
541 GENERATE_AUTOGEN_DEF = NO
543 #---------------------------------------------------------------------------
544 # configuration options related to the Perl module output
545 #---------------------------------------------------------------------------
547 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
548 # generate a Perl module file that captures the structure of
549 # the code including all documentation. Note that this
550 # feature is still experimental and incomplete at the
553 GENERATE_PERLMOD = NO
555 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
556 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
557 # to generate PDF and DVI output from the Perl module output.
561 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
562 # nicely formatted so it can be parsed by a human reader. This is useful
563 # if you want to understand what is going on. On the other hand, if this
564 # tag is set to NO the size of the Perl module output will be much smaller
565 # and Perl will parse it just the same.
569 # The names of the make variables in the generated doxyrules.make file
570 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
571 # This is useful so different doxyrules.make files included by the same
572 # Makefile don't overwrite each other's variables.
574 PERLMOD_MAKEVAR_PREFIX =
576 #---------------------------------------------------------------------------
577 # Configuration options related to the preprocessor
578 #---------------------------------------------------------------------------
580 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
581 # evaluate all C-preprocessor directives found in the sources and include
584 ENABLE_PREPROCESSING = YES
586 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
587 # names in the source code. If set to NO (the default) only conditional
588 # compilation will be performed. Macro expansion can be done in a controlled
589 # way by setting EXPAND_ONLY_PREDEF to YES.
593 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
594 # then the macro expansion is limited to the macros specified with the
595 # PREDEFINED and EXPAND_AS_DEFINED tags.
597 EXPAND_ONLY_PREDEF = NO
599 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
600 # in the INCLUDE_PATH (see below) will be search if a #include is found.
602 SEARCH_INCLUDES = YES
604 # The INCLUDE_PATH tag can be used to specify one or more directories that
605 # contain include files that are not input files but should be processed by
610 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
611 # patterns (like *.h and *.hpp) to filter out the header-files in the
612 # directories. If left blank, the patterns specified with FILE_PATTERNS will
615 INCLUDE_FILE_PATTERNS =
617 # The PREDEFINED tag can be used to specify one or more macro names that
618 # are defined before the preprocessor is started (similar to the -D option of
619 # gcc). The argument of the tag is a list of macros of the form: name
620 # or name=definition (no spaces). If the definition and the = are
621 # omitted =1 is assumed. To prevent a macro definition from being
622 # undefined via #undef or recursively expanded use the := operator
623 # instead of the = operator.
627 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
628 # this tag can be used to specify a list of macro names that should be expanded.
629 # The macro definition that is found in the sources will be used.
630 # Use the PREDEFINED tag if you want to use a different macro definition.
634 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
635 # doxygen's preprocessor will remove all function-like macros that are alone
636 # on a line, have an all uppercase name, and do not end with a semicolon. Such
637 # function macros are typically used for boiler-plate code, and will confuse
638 # the parser if not removed.
640 SKIP_FUNCTION_MACROS = YES
642 #---------------------------------------------------------------------------
643 # Configuration::additions related to external references
644 #---------------------------------------------------------------------------
646 # The TAGFILES option can be used to specify one or more tagfiles.
647 # Optionally an initial location of the external documentation
648 # can be added for each tagfile. The format of a tag file without
649 # this location is as follows:
650 # TAGFILES = file1 file2 ...
651 # Adding location for the tag files is done as follows:
652 # TAGFILES = file1=loc1 "file2 = loc2" ...
653 # where "loc1" and "loc2" can be relative or absolute paths or
654 # URLs. If a location is present for each tag, the installdox tool
655 # does not have to be run to correct the links.
656 # Note that each tag file must have a unique name
657 # (where the name does NOT include the path)
658 # If a tag file is not located in the directory in which doxygen
659 # is run, you must also specify the path to the tagfile here.
663 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
664 # a tag file that is based on the input files it reads.
668 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
669 # in the class index. If set to NO only the inherited external classes
674 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
675 # in the modules index. If set to NO, only the current project's groups will
678 EXTERNAL_GROUPS = YES
680 # The PERL_PATH should be the absolute path and name of the perl script
681 # interpreter (i.e. the result of `which perl').
683 PERL_PATH = /usr/bin/perl
685 #---------------------------------------------------------------------------
686 # Configuration options related to the dot tool
687 #---------------------------------------------------------------------------
689 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
690 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
691 # or super classes. Setting the tag to NO turns the diagrams off. Note that
692 # this option is superseded by the HAVE_DOT option below. This is only a
693 # fallback. It is recommended to install and use dot, since it yields more
698 # You can define message sequence charts within doxygen comments using the \msc
699 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
700 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
701 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
702 # be found in the default search path.
706 # If set to YES, the inheritance and collaboration graphs will hide
707 # inheritance and usage relations if the target is undocumented
710 HIDE_UNDOC_RELATIONS = YES
712 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
713 # available from the path. This tool is part of Graphviz, a graph visualization
714 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
715 # have no effect if this option is set to NO (the default)
719 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
720 # will generate a graph for each documented class showing the direct and
721 # indirect inheritance relations. Setting this tag to YES will force the
722 # the CLASS_DIAGRAMS tag to NO.
726 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
727 # will generate a graph for each documented class showing the direct and
728 # indirect implementation dependencies (inheritance, containment, and
729 # class references variables) of the class with other documented classes.
731 COLLABORATION_GRAPH = NO
733 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
734 # will generate a graph for groups, showing the direct groups dependencies
738 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
739 # collaboration diagrams in a style similar to the OMG's Unified Modeling
744 # If set to YES, the inheritance and collaboration graphs will show the
745 # relations between templates and their instances.
747 TEMPLATE_RELATIONS = NO
749 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
750 # tags are set to YES then doxygen will generate a graph for each documented
751 # file showing the direct and indirect include dependencies of the file with
752 # other documented files.
756 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
757 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
758 # documented header file showing the documented files that directly or
759 # indirectly include this file.
761 INCLUDED_BY_GRAPH = NO
763 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
764 # generate a call dependency graph for every global function or class method.
765 # Note that enabling this option will significantly increase the time of a run.
766 # So in most cases it will be better to enable call graphs for selected
767 # functions only using the \callgraph command.
771 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
772 # generate a caller dependency graph for every global function or class method.
773 # Note that enabling this option will significantly increase the time of a run.
774 # So in most cases it will be better to enable caller graphs for selected
775 # functions only using the \callergraph command.
779 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
780 # will graphical hierarchy of all classes instead of a textual one.
782 GRAPHICAL_HIERARCHY = NO
784 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
785 # then doxygen will show the dependencies a directory has on other directories
786 # in a graphical way. The dependency relations are determined by the #include
787 # relations between the files in the directories.
791 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
792 # generated by dot. Possible values are png, jpg, or gif
793 # If left blank png will be used.
795 DOT_IMAGE_FORMAT = jpg
797 # The tag DOT_PATH can be used to specify the path where the dot tool can be
798 # found. If left blank, it is assumed the dot tool can be found in the path.
802 # The DOTFILE_DIRS tag can be used to specify one or more directories that
803 # contain dot files that are included in the documentation (see the
808 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
809 # nodes that will be shown in the graph. If the number of nodes in a graph
810 # becomes larger than this value, doxygen will truncate the graph, which is
811 # visualized by representing a node as a red box. Note that doxygen will always
812 # show the root nodes and its direct children regardless of this setting.
814 DOT_GRAPH_MAX_NODES = 50
816 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
817 # background. This is disabled by default, which results in a white background.
818 # Warning: Depending on the platform used, enabling this option may lead to
819 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
824 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
825 # files in one run (i.e. multiple -o and -T options on the command line). This
826 # makes dot run faster, but since only newer versions of dot (>1.8.10)
827 # support this, this feature is disabled by default.
829 DOT_MULTI_TARGETS = NO
831 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
832 # generate a legend page explaining the meaning of the various boxes and
833 # arrows in the dot generated graphs.
837 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
838 # remove the intermediate dot files that are used to generate
839 # the various graphs.
843 #---------------------------------------------------------------------------
844 # Configuration::additions related to the search engine
845 #---------------------------------------------------------------------------
847 # The SEARCHENGINE tag specifies whether or not a search engine should be
848 # used. If set to NO the values of all tags below this one will be ignored.