Skip to content
Snippets Groups Projects
Doxyfile 79.6 KiB
Newer Older
  • Learn to ignore specific revisions
  • # To create a documentation set, doxygen will generate a Makefile in the
    # HTML output directory. Running make will produce the docset in that
    # directory and running "make install" will install the docset in
    # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    # it at startup.
    # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
    
    # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
    # feed. A documentation feed provides an umbrella under which multiple
    # documentation sets from a single provider (such as a company or product suite)
    
    # can be grouped.
    
    DOCSET_FEEDNAME        = "Doxygen generated docs"
    
    
    # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
    # should uniquely identify the documentation set bundle. This should be a
    # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
    
    # will append .docset to the name.
    
    DOCSET_BUNDLE_ID       = org.doxygen.Project
    
    
    # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
    # identify the documentation publisher. This should be a reverse domain-name
    # style string, e.g. com.mycompany.MyDocSet.documentation.
    
    
    DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
    
    # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
    
    DOCSET_PUBLISHER_NAME  = Publisher
    
    
    # If the GENERATE_HTMLHELP tag is set to YES, additional index files
    # will be generated that can be used as input for tools like the
    # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
    
    # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    # be used to specify the file name of the resulting .chm file. You
    # can add a path in front of the file if the result should not be
    
    # written to the html output directory.
    
    
    CHM_FILE               = blender.chm
    
    # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
    # be used to specify the location (absolute path including file name) of
    # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
    
    # the HTML help compiler on the generated index.hhp.
    
    
    HHC_LOCATION           = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
    
    # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
    # controls if a separate .chi index file is generated (YES) or that
    
    # it should be included in the master .chm file (NO).
    
    GENERATE_CHI           = NO
    
    
    # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
    # is used to encode HtmlHelp index (hhk), content (hhc) and project file
    
    # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
    # controls whether a binary table of contents is generated (YES) or a
    
    # normal table of contents (NO) in the .chm file.
    
    BINARY_TOC             = NO
    
    
    # The TOC_EXPAND flag can be set to YES to add extra items for group members
    
    # to the contents of the HTML help documentation and to the tree view.
    
    # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
    # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
    # that can be used as input for Qt's qhelpgenerator to generate a
    
    # Qt Compressed Help (.qch) of the generated HTML documentation.
    
    GENERATE_QHP           = NO
    
    
    # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
    # be used to specify the file name of the resulting .qch file.
    
    # The path specified is relative to the HTML output folder.
    
    
    # The QHP_NAMESPACE tag specifies the namespace to use when generating
    # Qt Help Project output. For more information please see
    
    # http://doc.trolltech.com/qthelpproject.html#namespace
    
    QHP_NAMESPACE          = org.doxygen.Project
    
    
    # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
    # Qt Help Project output. For more information please see
    
    # http://doc.trolltech.com/qthelpproject.html#virtual-folders
    
    QHP_VIRTUAL_FOLDER     = doc
    
    
    # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
    # add. For more information please see
    
    # http://doc.trolltech.com/qthelpproject.html#custom-filters
    
    
    # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
    # custom filter to add. For more information please see
    # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
    
    # Qt Help Project / Custom Filters</a>.
    
    
    # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
    # project's
    # filter section matches.
    # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
    
    # Qt Help Project / Filter Attributes</a>.
    
    
    # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
    # be used to specify the location of Qt's qhelpgenerator.
    # If non-empty doxygen will try to run qhelpgenerator on the generated
    
    # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
    #  will be generated, which together with the HTML files, form an Eclipse help
    # plugin. To install this plugin and make it available under the help contents
    # menu in Eclipse, the contents of the directory containing the HTML and XML
    # files needs to be copied into the plugins directory of eclipse. The name of
    # the directory within the plugins directory should be the same as
    # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
    
    # the help appears.
    
    GENERATE_ECLIPSEHELP   = NO
    
    
    # A unique identifier for the eclipse help plugin. When installing the plugin
    # the directory name containing the HTML and XML files should also have
    
    # this name.
    
    ECLIPSE_DOC_ID         = org.doxygen.Project
    
    
    # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
    # at top of each HTML page. The value NO (the default) enables the index and
    # the value YES disables it. Since the tabs have the same information as the
    # navigation tree you can set this option to NO if you already set
    # GENERATE_TREEVIEW to YES.
    
    # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
    # structure should be generated to display hierarchical information.
    # If the tag value is set to YES, a side panel will be generated
    # containing a tree-like index structure (just like the one that
    # is generated for HTML Help). For this to work a browser that supports
    # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    
    # Windows users are probably better off using the HTML help feature.
    
    # Since the tree basically has the same information as the tab index you
    # could consider to set DISABLE_INDEX to NO when enabling this option.
    
    # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
    # (range [0,1..20]) that doxygen will group on one line in the generated HTML
    # documentation. Note that a value of 0 will completely suppress the enum
    # values from appearing in the overview section.
    
    # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
    # used to set the initial width (in pixels) of the frame in which the tree
    
    TREEVIEW_WIDTH         = 246
    
    # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
    
    # links to external symbols imported via tag files in a separate window.
    
    EXT_LINKS_IN_WINDOW    = NO
    
    
    # Use this tag to change the font size of Latex formulas included
    # as images in the HTML documentation. The default is 10. Note that
    # when you change the font size after a successful doxygen run you need
    # to manually remove any form_*.png images from the HTML output directory
    
    # to force them to be regenerated.
    
    FORMULA_FONTSIZE       = 10
    
    
    # Use the FORMULA_TRANPARENT tag to determine whether or not the images
    # generated for formulas are transparent PNGs. Transparent PNGs are
    # not supported properly for IE 6.0, but are supported on all modern browsers.
    # Note that when changing this option you need to delete any form_*.png files
    
    # in the HTML output before the changes have effect.
    
    FORMULA_TRANSPARENT    = YES
    
    
    # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
    # (see http://www.mathjax.org) which uses client side Javascript for the
    # rendering instead of using prerendered bitmaps. Use this if you do not
    # have LaTeX installed or if you want to formulas look prettier in the HTML
    # output. When enabled you may also need to install MathJax separately and
    
    # configure the path to it using the MATHJAX_RELPATH option.
    
    USE_MATHJAX            = NO
    
    
    # When MathJax is enabled you can set the default output format to be used for
    # the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
    # SVG. The default value is HTML-CSS, which is slower, but has the best
    # compatibility.
    
    MATHJAX_FORMAT         = HTML-CSS
    
    # When MathJax is enabled you need to specify the location relative to the
    # HTML output directory using the MATHJAX_RELPATH option. The destination
    # directory should contain the MathJax.js script. For instance, if the mathjax
    # directory is located at the same level as the HTML output directory, then
    # MATHJAX_RELPATH should be ../mathjax. The default value points to
    # the MathJax Content Delivery Network so you can quickly see the result without
    # installing MathJax.
    # However, it is strongly recommended to install a local
    # copy of MathJax from http://www.mathjax.org before deployment.
    
    
    MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
    
    
    # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
    # names that should be enabled during MathJax rendering.
    
    MATHJAX_EXTENSIONS     =
    
    # The MATHJAX_CODEFILE tag can be used to specify a file with javascript
    # pieces of code that will be used on startup of the MathJax code.
    
    MATHJAX_CODEFILE       =
    
    # When the SEARCHENGINE tag is enabled doxygen will generate a search box
    # for the HTML output. The underlying search engine uses javascript
    # and DHTML and should work on any modern browser. Note that when using
    # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
    # (GENERATE_DOCSET) there is already a search function so this one should
    # typically be disabled. For large projects the javascript based search engine
    
    # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
    
    SEARCHENGINE           = NO
    
    
    # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    # implemented using a web server instead of a web client using Javascript.
    # There are two flavours of web server based search depending on the
    # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
    # searching and an index file used by the script. When EXTERNAL_SEARCH is
    # enabled the indexing and searching needs to be provided by external tools.
    # See the manual for details.
    
    # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
    # script for searching. Instead the search results are written to an XML file
    # which needs to be processed by an external indexer. Doxygen will invoke an
    # external search engine pointed to by the SEARCHENGINE_URL option to obtain
    # the search results. Doxygen ships with an example indexer (doxyindexer) and
    # search engine (doxysearch.cgi) which are based on the open source search
    # engine library Xapian. See the manual for configuration details.
    
    EXTERNAL_SEARCH        = NO
    
    # The SEARCHENGINE_URL should point to a search engine hosted by a web server
    # which will returned the search results when EXTERNAL_SEARCH is enabled.
    # Doxygen ships with an example search engine (doxysearch) which is based on
    # the open source search engine library Xapian. See the manual for configuration
    # details.
    
    SEARCHENGINE_URL       =
    
    # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
    # search data is written to a file for indexing by an external tool. With the
    # SEARCHDATA_FILE tag the name of this file can be specified.
    
    SEARCHDATA_FILE        = searchdata.xml
    
    # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
    # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
    # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
    # projects and redirect the results back to the right project.
    
    EXTERNAL_SEARCH_ID     =
    
    # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
    # projects other than the one defined by this configuration file, but that are
    # all added to the same external search index. Each project needs to have a
    # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
    # of to a relative location where the documentation can be found.
    # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
    
    EXTRA_SEARCH_MAPPINGS  =
    
    
    #---------------------------------------------------------------------------
    # configuration options related to the LaTeX output
    #---------------------------------------------------------------------------
    
    
    # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
    
    # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
    # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    
    # put in front of it. If left blank `latex' will be used as the default path.
    
    LATEX_OUTPUT           = latex
    
    
    # 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.
    # Note that when enabling USE_PDFLATEX this option is only used for
    # generating bitmaps for formulas in the HTML output, but not in the
    
    # Makefile that is written to the output directory.
    
    # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
    # generate index for LaTeX. If left blank `makeindex' will be used as the
    
    # default command name.
    
    MAKEINDEX_CMD_NAME     = makeindex
    
    
    # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
    # LaTeX documents. This may be useful for small projects and may help to
    
    # The PAPER_TYPE tag can be used to set the paper type that is used
    # by the printer. Possible values are: a4, letter, legal and
    # executive. If left blank a4 will be used.
    
    # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
    
    # packages that should be included in the LaTeX output.
    
    
    # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
    # the generated latex document. The header should contain everything until
    # the first chapter. If it is left blank doxygen will generate a
    
    # standard header. Notice: only use this tag if you know what you are doing!
    
    
    LATEX_HEADER           =
    
    # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
    # the generated latex document. The footer should contain everything after
    # the last chapter. If it is left blank doxygen will generate a
    # standard footer. Notice: only use this tag if you know what you are doing!
    
    LATEX_FOOTER           =
    
    # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
    # or other source files which should be copied to the LaTeX output directory.
    # Note that the files will be copied as-is; there are no commands or markers
    # available.
    
    LATEX_EXTRA_FILES      =
    
    # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    # is prepared for conversion to pdf (using ps2pdf). The pdf file will
    # contain links (just like the HTML output) instead of page references
    
    # This makes the output suitable for online browsing using a pdf viewer.
    
    PDF_HYPERLINKS         = NO
    
    
    # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
    # plain latex in the generated Makefile. Set this option to YES to get a
    
    # higher quality PDF documentation.
    
    USE_PDFLATEX           = NO
    
    
    # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
    # command to the generated LaTeX files. This will instruct LaTeX to keep
    # running if errors occur, instead of asking the user for help.
    
    # This option is also used when generating formulas in HTML.
    
    LATEX_BATCHMODE        = NO
    
    
    # If LATEX_HIDE_INDICES is set to YES then doxygen will not
    # include the index chapters (such as File Index, Compound Index, etc.)
    
    # If LATEX_SOURCE_CODE is set to YES then doxygen will include
    # source code with syntax highlighting in the LaTeX output.
    # Note that which sources are shown also depends on other settings
    
    # such as SOURCE_BROWSER.
    
    LATEX_SOURCE_CODE      = NO
    
    
    # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
    # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
    # http://en.wikipedia.org/wiki/BibTeX for more info.
    
    LATEX_BIB_STYLE        = plain
    
    
    #---------------------------------------------------------------------------
    # configuration options related to the RTF output
    #---------------------------------------------------------------------------
    
    
    # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
    # The RTF output is optimized for Word 97 and may not look very pretty with
    
    # other RTF readers or editors.
    
    GENERATE_RTF           = NO
    
    
    # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
    # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    
    # put in front of it. If left blank `rtf' will be used as the default path.
    
    RTF_OUTPUT             = rtf
    
    
    # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
    # RTF documents. This may be useful for small projects and may help to
    
    # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
    # will contain hyperlink fields. The RTF file will
    # contain links (just like the HTML output) instead of page references.
    # This makes the output suitable for online browsing using WORD or other
    # programs which support those fields.
    
    # Note: wordpad (write) and others do not support links.
    
    RTF_HYPERLINKS         = NO
    
    
    # Load style sheet definitions from file. Syntax is similar to doxygen's
    # config file, i.e. a series of assignments. You only have to provide
    
    # replacements, missing definitions are set to their default value.
    
    
    # Set optional variables used in the generation of an rtf document.
    
    # Syntax is similar to doxygen's config file.
    
    
    
    #---------------------------------------------------------------------------
    # configuration options related to the man page output
    #---------------------------------------------------------------------------
    
    
    # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
    
    # The MAN_OUTPUT tag is used to specify where the man pages will be put.
    # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    
    # put in front of it. If left blank `man' will be used as the default path.
    
    MAN_OUTPUT             = man
    
    
    # The MAN_EXTENSION tag determines the extension that is added to
    
    # the generated man pages (default is the subroutine's section .3)
    
    MAN_EXTENSION          = .3
    
    
    # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
    # then it will generate one additional man file for each entity
    # documented in the real man page(s). These additional files
    # only source the real man page, but without them the man command
    
    # would be unable to find the correct page. The default is NO.
    
    MAN_LINKS              = NO
    
    #---------------------------------------------------------------------------
    # configuration options related to the XML output
    #---------------------------------------------------------------------------
    
    
    # If the GENERATE_XML tag is set to YES Doxygen will
    # generate an XML file that captures the structure of
    
    # the code including all documentation.
    
    # The XML_OUTPUT tag is used to specify where the XML pages will be put.
    # If a relative path is entered the value of OUTPUT_DIRECTORY will be
    
    # put in front of it. If left blank `xml' will be used as the default path.
    
    XML_OUTPUT             = xml
    
    
    # The XML_SCHEMA tag can be used to specify an XML schema,
    # which can be used by a validating XML parser to check the
    
    # The XML_DTD tag can be used to specify an XML DTD,
    # which can be used by a validating XML parser to check the
    
    # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
    # dump the program listings (including syntax highlighting
    # and cross-referencing information) to the XML output. Note that
    
    # enabling this will significantly increase the size of the XML output.
    
    XML_PROGRAMLISTING     = YES
    
    
    #---------------------------------------------------------------------------
    # configuration options related to the DOCBOOK output
    #---------------------------------------------------------------------------
    
    # If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
    # that can be used to generate PDF.
    
    GENERATE_DOCBOOK       = NO
    
    # The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
    # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
    # front of it. If left blank docbook will be used as the default path.
    
    DOCBOOK_OUTPUT         = docbook
    
    
    #---------------------------------------------------------------------------
    # configuration options for the AutoGen Definitions output
    #---------------------------------------------------------------------------
    
    
    # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
    # generate an AutoGen Definitions (see autogen.sf.net) file
    # that captures the structure of the code including all
    # documentation. Note that this feature is still experimental
    
    # and incomplete at the moment.
    
    GENERATE_AUTOGEN_DEF   = NO
    
    #---------------------------------------------------------------------------
    
    # configuration options related to the Perl module output
    #---------------------------------------------------------------------------
    
    
    # If the GENERATE_PERLMOD tag is set to YES Doxygen will
    # generate a Perl module file that captures the structure of
    # the code including all documentation. Note that this
    # feature is still experimental and incomplete at the
    
    # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
    # the necessary Makefile rules, Perl scripts and LaTeX code to be able
    
    # to generate PDF and DVI output from the Perl module output.
    
    PERLMOD_LATEX          = NO
    
    
    # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
    # nicely formatted so it can be parsed by a human reader.
    # This is useful
    # if you want to understand what is going on.
    # On the other hand, if this
    # tag is set to NO the size of the Perl module output will be much smaller
    
    # and Perl will parse it just the same.
    
    PERLMOD_PRETTY         = YES
    
    
    # The names of the make variables in the generated doxyrules.make file
    # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
    # This is useful so different doxyrules.make files included by the same
    
    # Makefile don't overwrite each other's variables.
    
    
    
    #---------------------------------------------------------------------------
    # Configuration options related to the preprocessor
    
    #---------------------------------------------------------------------------
    
    
    # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
    # evaluate all C-preprocessor directives found in the sources and include
    
    # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
    # names in the source code. If set to NO (the default) only conditional
    # compilation will be performed. Macro expansion can be done in a controlled
    
    # way by setting EXPAND_ONLY_PREDEF to YES.
    
    MACRO_EXPANSION        = NO
    
    
    # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
    # then the macro expansion is limited to the macros specified with the
    
    # PREDEFINED and EXPAND_AS_DEFINED tags.
    
    # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    # pointed to by INCLUDE_PATH will be searched when a #include is found.
    
    # The INCLUDE_PATH tag can be used to specify one or more directories that
    # contain include files that are not input files but should be processed by
    
    INCLUDE_PATH           = ../../source/blender/nodes \
                             ../../source/blender/editors/include
    
    # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
    # patterns (like *.h and *.hpp) to filter out the header-files in the
    # directories. If left blank, the patterns specified with FILE_PATTERNS will
    
    # The PREDEFINED tag can be used to specify one or more macro names that
    # are defined before the preprocessor is started (similar to the -D option of
    # gcc). The argument of the tag is a list of macros of the form: name
    # or name=definition (no spaces). If the definition and the = are
    # omitted =1 is assumed. To prevent a macro definition from being
    # undefined via #undef or recursively expanded use the := operator
    
    PREDEFINED             = BUILD_DATE
    
    # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
    # this tag can be used to specify a list of macro names that should be expanded.
    # The macro definition that is found in the sources will be used.
    
    # Use the PREDEFINED tag if you want to use a different macro definition that
    # overrules the definition found in the source code.
    
    # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    # doxygen's preprocessor will remove all references to function-like macros
    # that are alone on a line, have an all uppercase name, and do not end with a
    
    # semicolon, because these will confuse the parser if not removed.
    
    
    SKIP_FUNCTION_MACROS   = YES
    
    #---------------------------------------------------------------------------
    
    # Configuration::additions related to external references
    
    #---------------------------------------------------------------------------
    
    
    # The TAGFILES option can be used to specify one or more tagfiles. For each
    # tag file the location of the external documentation should be added. The
    # format of a tag file without this location is as follows:
    #
    # TAGFILES = file1 file2 ...
    # Adding location for the tag files is done as follows:
    #
    # TAGFILES = file1=loc1 "file2 = loc2" ...
    # where "loc1" and "loc2" can be relative or absolute paths
    # or URLs. Note that each tag file must have a unique name (where the name does
    # NOT include the path). If a tag file is not located in the directory in which
    # doxygen is run, you must also specify the path to the tagfile here.
    
    TAGFILES               =
    
    # When a file name is specified after GENERATE_TAGFILE, doxygen will create
    
    # a tag file that is based on the input files it reads.
    
    
    # If the ALLEXTERNALS tag is set to YES all external classes will be listed
    # in the class index. If set to NO only the inherited external classes
    
    # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
    # in the modules index. If set to NO, only the current project's groups will
    
    # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
    # in the related pages index. If set to NO, only the current project's
    # pages will be listed.
    
    EXTERNAL_PAGES         = YES
    
    # The PERL_PATH should be the absolute path and name of the perl script
    
    # interpreter (i.e. the result of `which perl').
    
    PERL_PATH              = /usr/bin/perl
    
    #---------------------------------------------------------------------------
    
    # Configuration options related to the dot tool
    
    #---------------------------------------------------------------------------
    
    
    # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
    # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    # or super classes. Setting the tag to NO turns the diagrams off. Note that
    # this option also works with HAVE_DOT disabled, but it is recommended to
    
    # install and use dot, since it yields more powerful graphs.
    
    CLASS_DIAGRAMS         = NO
    
    
    # You can define message sequence charts within doxygen comments using the \msc
    # command. Doxygen will then run the mscgen tool (see
    # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
    # documentation. The MSCGEN_PATH tag allows you to specify the directory where
    # the mscgen tool resides. If left empty the tool is assumed to be found in the
    
    # If set to YES, the inheritance and collaboration graphs will hide
    # inheritance and usage relations if the target is undocumented
    
    # or is not a class.
    
    HIDE_UNDOC_RELATIONS   = YES
    
    # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
    # available from the path. This tool is part of Graphviz, a graph visualization
    # toolkit from AT&T and Lucent Bell Labs. The other options in this section
    
    # have no effect if this option is set to NO (the default)
    
    
    # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
    # allowed to run in parallel. When set to 0 (the default) doxygen will
    # base this on the number of processors available in the system. You can set it
    # explicitly to a value larger than 0 to get control over the balance
    
    # between CPU load and processing speed.
    
    DOT_NUM_THREADS        = 0
    
    
    # By default doxygen will use the Helvetica font for all dot files that
    # doxygen generates. When you want a differently looking font you can specify
    # the font name using DOT_FONTNAME. You need to make sure dot is able to find
    # the font, which can be done by putting it in a standard location or by setting
    # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
    # directory containing the font.
    
    # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
    
    # The default size is 10pt.
    
    DOT_FONTSIZE           = 10
    
    
    # By default doxygen will tell dot to use the Helvetica font.
    # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
    # set the path where dot can find it.
    
    # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
    # will generate a graph for each documented class showing the direct and
    # indirect inheritance relations. Setting this tag to YES will force the
    # CLASS_DIAGRAMS tag to NO.
    
    # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
    # will generate a graph for each documented class showing the direct and
    # indirect implementation dependencies (inheritance, containment, and
    
    # class references variables) of the class with other documented classes.
    
    
    # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
    
    # will generate a graph for groups, showing the direct groups dependencies
    
    GROUP_GRAPHS           = YES
    
    
    # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
    # collaboration diagrams in a style similar to the OMG's Unified Modeling
    
    # If the UML_LOOK tag is enabled, the fields and methods are shown inside
    # the class node. If there are many fields or methods and many nodes the
    # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
    # threshold limits the number of items for each type to make the size more
    # manageable. Set this to 0 for no limit. Note that the threshold may be
    # exceeded by 50% before the limit is enforced.
    
    UML_LIMIT_NUM_FIELDS   = 10
    
    # If set to YES, the inheritance and collaboration graphs will show the
    
    # relations between templates and their instances.
    
    TEMPLATE_RELATIONS     = YES
    
    
    # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
    # tags are set to YES then doxygen will generate a graph for each documented
    # file showing the direct and indirect include dependencies of the file with
    
    # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
    # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
    # documented header file showing the documented files that directly or
    
    # If the CALL_GRAPH and HAVE_DOT options are set to YES then
    # doxygen will generate a call dependency graph for every global function
    # or class method. Note that enabling this option will significantly increase
    # the time of a run. So in most cases it will be better to enable call graphs
    
    # for selected functions only using the \callgraph command.
    
    CALL_GRAPH             = NO
    
    
    # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
    # doxygen will generate a caller dependency graph for every global function
    # or class method. Note that enabling this option will significantly increase
    # the time of a run. So in most cases it will be better to enable caller
    
    # graphs for selected functions only using the \callergraph command.
    
    CALLER_GRAPH           = NO
    
    # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    
    # will generate a graphical hierarchy of all classes instead of a textual one.
    
    # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
    # then doxygen will show the dependencies a directory has on other directories
    # in a graphical way. The dependency relations are determined by the #include
    
    # relations between the files in the directories.
    
    DIRECTORY_GRAPH        = YES
    
    
    # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    # generated by dot. Possible values are svg, png, jpg, or gif.
    # If left blank png will be used. If you choose svg you need to set
    # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    # visible in IE 9+ (other browsers do not have this requirement).
    
    # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
    # enable generation of interactive SVG images that allow zooming and panning.
    # Note that this requires a modern browser other than Internet Explorer.
    # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
    # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
    # visible. Older versions of IE do not have SVG support.
    
    INTERACTIVE_SVG        = NO
    
    # The tag DOT_PATH can be used to specify the path where the dot tool can be
    
    # found. If left blank, it is assumed the dot tool can be found in the path.
    
    # The DOTFILE_DIRS tag can be used to specify one or more directories that
    # contain dot files that are included in the documentation (see the
    
    # The MSCFILE_DIRS tag can be used to specify one or more directories that
    # contain msc files that are included in the documentation (see the
    
    # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
    # nodes that will be shown in the graph. If the number of nodes in a graph
    # becomes larger than this value, doxygen will truncate the graph, which is
    # visualized by representing a node as a red box. Note that doxygen if the
    # number of direct children of the root node in a graph is already larger than
    # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
    
    # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
    
    # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    # graphs generated by dot. A depth value of 3 means that only nodes reachable
    # from the root by following a path via at most 3 edges will be shown. Nodes
    # that lay further from the root node will be omitted. Note that setting this
    # option to 1 or 2 may greatly reduce the computation time needed for large
    # code bases. Also note that the size of a graph can be further restricted by
    
    # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    
    MAX_DOT_GRAPH_DEPTH    = 0
    
    
    # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
    # background. This is disabled by default, because dot on Windows does not
    # seem to support this out of the box. Warning: Depending on the platform used,
    # enabling this option may lead to badly anti-aliased labels on the edges of
    
    # a graph (i.e. they become hard to read).
    
    DOT_TRANSPARENT        = NO
    
    
    # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
    # files in one run (i.e. multiple -o and -T options on the command line). This
    # makes dot run faster, but since only newer versions of dot (>1.8.10)
    
    # support this, this feature is disabled by default.
    
    DOT_MULTI_TARGETS      = YES
    
    # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
    # generate a legend page explaining the meaning of the various boxes and
    
    # arrows in the dot generated graphs.
    
    GENERATE_LEGEND        = YES
    
    
    # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
    # remove the intermediate dot files that are used to generate