aboutsummaryrefslogtreecommitdiff log msg author committer range
path: root/doc
diff options
 context: 12345678910152025303540 space: includeignore mode: unifiedssdiffstat only
Diffstat (limited to 'doc')
-rw-r--r--doc/doxy.config.in190
1 files changed, 136 insertions, 54 deletions
 diff --git a/doc/doxy.config.in b/doc/doxy.config.inindex 9810518f..276a2611 100644--- a/doc/doxy.config.in+++ b/doc/doxy.config.in@@ -1,8 +1,10 @@-# Doxyfile 1.8.2+# Doxyfile 1.8.4 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. #+# All text after a double hash (##) is considered a comment and is placed+# in front of the TAG it is preceding . # All text after a hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...]@@ -70,9 +72,9 @@ CREATE_SUBDIRS = NO # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.+# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,+# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,+# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English @@ -262,10 +264,10 @@ EXTENSION_MAPPING = MARKDOWN_SUPPORT = YES -# When enabled doxygen tries to link words that correspond to documented classes,-# or namespaces to their corresponding documentation. Such a link can be-# prevented in individual cases by by putting a % sign in front of the word or-# globally by setting AUTOLINK_SUPPORT to NO.+# When enabled doxygen tries to link words that correspond to documented+# classes, or namespaces to their corresponding documentation. Such a link can+# be prevented in individual cases by by putting a % sign in front of the word+# or globally by setting AUTOLINK_SUPPORT to NO. AUTOLINK_SUPPORT = YES @@ -289,7 +291,12 @@ CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO.+# For Microsoft's IDL there are propget and propput attributes to indicate+# getter and setter methods for a property. Setting this option to YES (the+# default) will make doxygen replace the get and set methods by a property in+# the documentation. This will only work if the methods are indeed getting or+# setting a simple type. If this is not the case, or you want to show the+# methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES @@ -316,11 +323,11 @@ SUBGROUPING = YES INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and-# unions with only public data fields will be shown inline in the documentation-# of the scope in which they are defined (i.e. file, namespace, or group-# documentation), provided this scope is documented. If set to NO (the default),-# structs, classes, and unions are shown on a separate page (for HTML and Man-# pages) or section (for LaTeX and RTF).+# unions with only public data fields or simple typedef fields will be shown+# inline in the documentation of the scope in which they are defined (i.e. file,+# namespace, or group documentation), provided this scope is documented. If set+# to NO (the default), structs, classes, and unions are shown on a separate+# page (for HTML and Man pages) or section (for LaTeX and RTF). INLINE_SIMPLE_STRUCTS = NO @@ -334,30 +341,14 @@ INLINE_SIMPLE_STRUCTS = NO TYPEDEF_HIDES_STRUCT = YES -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to-# determine which symbols to keep in memory and which to flush to disk.-# When the cache is full, less often used symbols will be written to disk.-# For small to medium size projects (<1000 input files) the default value is-# probably good enough. For larger projects a too small cache size can cause-# doxygen to be busy swapping symbols to and from disk most of the time-# causing a significant performance penalty.-# If the system has enough physical memory increasing the cache will improve the-# performance by keeping more symbols in memory. Note that the value works on-# a logarithmic scale so increasing the size by one will roughly double the-# memory usage. The cache size is given by this formula:-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,-# corresponding to a cache size of 2^16 = 65536 symbols.--SYMBOL_CACHE_SIZE = 0--# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given-# their name and scope. Since this can be an expensive process and often the-# same symbol appear multiple times in the code, doxygen keeps a cache of-# pre-resolved symbols. If the cache is too small doxygen will become slower.-# If the cache is too large, memory is wasted. The cache size is given by this-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,-# corresponding to a cache size of 2^16 = 65536 symbols.+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This+# cache is used to resolve symbols given their name and scope. Since this can+# be an expensive process and often the same symbol appear multiple times in+# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too+# small doxygen will become slower. If the cache is too large, memory is wasted.+# The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid+# range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536+# symbols. LOOKUP_CACHE_SIZE = 0 @@ -368,7 +359,7 @@ LOOKUP_CACHE_SIZE = 0 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES+# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO @@ -549,7 +540,8 @@ GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional-# documentation sections, marked by \if sectionname ... \endif.+# documentation sections, marked by \if section-label ... \endif+# and \cond section-label ... \endcond blocks. ENABLED_SECTIONS = @@ -607,7 +599,8 @@ LAYOUT_FILE = # requires the bibtex tool to be installed. See also # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this-# feature you need bibtex and perl available in the search path.+# feature you need bibtex and perl available in the search path. Do not use+# file names with spaces, bibtex cannot handle them. CITE_BIB_FILES = @@ -776,8 +769,10 @@ IMAGE_PATH = # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output.-# If FILTER_PATTERNS is specified, this tag will be-# ignored.+# If FILTER_PATTERNS is specified, this tag will be ignored.+# Note that the filter must not add or remove lines; it is applied before the+# code is scanned, but not when the output code is generated. If lines are added+# or removed, the anchors will not be placed correctly. INPUT_FILTER = @@ -806,6 +801,13 @@ FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = +# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that+# is part of the input, its contents will be placed on the main page+# (index.html). This can be useful if you have a project on for instance GitHub+# and want reuse the introduction page also for the doxygen output.++USE_MDFILE_AS_MAINPAGE =+ #--------------------------------------------------------------------------- # configuration options related to source browsing #---------------------------------------------------------------------------@@ -947,7 +949,7 @@ HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these+# \$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that # the files will be copied as-is; there are no commands or markers available. @@ -1215,6 +1217,13 @@ FORMULA_TRANSPARENT = YES 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@@ -1232,6 +1241,11 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 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@@ -1243,15 +1257,55 @@ MATHJAX_EXTENSIONS = SEARCHENGINE = NO # When the SERVER_BASED_SEARCH tag is enabled the search engine will be-# implemented using a PHP enabled web server instead of at the web client-# using Javascript. Doxygen will generate the search PHP script and index-# file to put on the web server. The advantage of the server-# based approach is that it scales better to large projects and allows-# full text search. The disadvantages are that it is more difficult to setup-# and does not have live searching capabilities.+# 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. SERVER_BASED_SEARCH = NO +# 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 #---------------------------------------------------------------------------@@ -1259,7 +1313,7 @@ SERVER_BASED_SEARCH = NO # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = @DOXYFILE_LATEX@+GENERATE_LATEX = NO # 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@@ -1289,7 +1343,7 @@ COMPACT_LATEX = NO # 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 a4wide will be used.+# executive. If left blank a4 will be used. PAPER_TYPE = a4 @@ -1312,6 +1366,13 @@ LATEX_HEADER = 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@@ -1457,6 +1518,21 @@ XML_DTD = 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 #--------------------------------------------------------------------------- @@ -1605,6 +1681,12 @@ ALLEXTERNALS = YES EXTERNAL_GROUPS = YES +# 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'). @@ -1659,7 +1741,7 @@ DOT_NUM_THREADS = 0 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the # directory containing the font. -DOT_FONTNAME = FreeSans+DOT_FONTNAME = # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt.@@ -1701,7 +1783,7 @@ UML_LOOK = NO # 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-# managable. Set this to 0 for no limit. Note that the threshold may be+# 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