diff options
Diffstat (limited to 'src/config.xml')
| -rw-r--r-- | src/config.xml | 176 |
1 files changed, 111 insertions, 65 deletions
diff --git a/src/config.xml b/src/config.xml index a75ff80..0b67283 100644 --- a/src/config.xml +++ b/src/config.xml @@ -49,9 +49,9 @@ The default language is English, other supported languages are: 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. '> <value name='Afrikaans'/> <value name='Arabic'/> @@ -76,6 +76,7 @@ Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. <value name='Japanese-en'/> <value name='Korean'/> <value name='Korean-en'/> + <value name='Latvian'/> <value name='Norwegian'/> <value name='Macedonian'/> <value name='Persian'/> @@ -261,10 +262,10 @@ can mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in case of backward compatibilities issues. ' defval='1'/> <option type='bool' id='AUTOLINK_SUPPORT' docs=' -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. ' defval='1'/> <option type='bool' id='BUILTIN_STL_SUPPORT' docs=' If you use STL classes (i.e. std::string, std::vector, etc.) but do not want @@ -312,11 +313,12 @@ section (for LaTeX and RTF). ' defval='0'/> <option type='bool' id='INLINE_SIMPLE_STRUCTS' docs=' 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).' defval='0'/> +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). +' defval='0'/> <option type='bool' id='TYPEDEF_HIDES_STRUCT' docs=' When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum is documented as struct, union, or enum with the name of the typedef. So @@ -326,30 +328,15 @@ namespace, or class. And the struct will be named TypeS. This can typically be useful for C code in case the coding convention dictates that all compound types are typedef'ed and only the typedef is referenced, never the tag name. ' defval='0'/> - <option type='int' id='SYMBOL_CACHE_SIZE' docs=' -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. -' minval='0' maxval='9' defval='0'/> <option type='int' id='LOOKUP_CACHE_SIZE' docs=' -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. ' minval='0' maxval='9' defval='0'/> </group> <group name='Build' docs='Build related configuration options'> @@ -357,7 +344,7 @@ corresponding to a cache size of 2^16 = 65536 symbols. 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 ' defval='0'/> <option type='bool' id='EXTRACT_PRIVATE' docs=' If the EXTRACT_PRIVATE tag is set to YES all private members of a class @@ -734,8 +721,10 @@ invoke to filter for each input file. Doxygen will invoke the filter program by executing (via popen()) the command <filter> <input-file>, where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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. +to standard output. 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. ' defval=''/> <option type='list' id='FILTER_PATTERNS' format='string' docs=' The FILTER_PATTERNS tag can be used to specify filters on a per file pattern @@ -760,9 +749,9 @@ FILTER_SOURCE_FILES is enabled. ' depends='FILTER_SOURCE_FILES'/> <option type='string' id='USE_MDFILE_AS_MAINPAGE' format='string' docs=' 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. +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. ' defval=''/> </group> <group name='Source Browser' docs='configuration options related to source browsing'> @@ -809,6 +798,18 @@ If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this. ' defval='1'/> + <option type='bool' id='CLANG_ASSISTED_PARSING' setting='USE_LIBCLANG' docs=' +If CLANG_ASSISTED_PARSING is set to YES, then doxygen will use the clang parser +for more acurate parsing at the cost of reduced performance. This can be +particularly helpful with template rich C++ code for which doxygen's built-in +parser lacks the necessairy type information. +' defval='0'/> + <option type='list' id='CLANG_OPTIONS' setting='USE_LIBCLANG' docs=' +If clang assisted parsing is enabled you can provide the compiler with command +line options that you would normally use when invoking the compiler. Note that +the include paths will already be set by doxygen for the files and directories +specified at INPUT and INCLUDE_PATH. +' defval='' depends='CLANG_ASSISTED_PARSING'/> </group> <group name='Index' docs='configuration options related to the alphabetical class index'> <option type='bool' id='ALPHABETICAL_INDEX' docs=' @@ -820,13 +821,13 @@ contains a lot of classes, structs, unions or interfaces. If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in which this list will be split (can be a number in the range [1..20]) -' minval='1' maxval='20' defval='5'/> +' minval='1' maxval='20' defval='5' depends='ALPHABETICAL_INDEX'/> <option type='list' id='IGNORE_PREFIX' format='string' docs=' In case all classes in a project start with a common prefix, all classes will be put under the same header in the alphabetical index. The IGNORE_PREFIX tag can be used to specify one or more prefixes that should be ignored while generating the index headers. -'> +' depends='ALPHABETICAL_INDEX'> </option> </group> <group name='HTML' docs='configuration options related to the HTML output'> @@ -882,7 +883,7 @@ the output directory. 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. ' depends='GENERATE_HTML'/> @@ -907,7 +908,7 @@ the luminance component of the colors in the HTML output. Values below the output darker. The value divided by 100 is the actual gamma applied, so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not change the gamma. -' minval='40' maxval='240' defval='80'/> +' minval='40' maxval='240' defval='80' depends='GENERATE_HTML'/> <option type='bool' id='HTML_TIMESTAMP' docs=' If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML page will contain the date and time when the page was generated. Setting @@ -927,7 +928,7 @@ visible (unless a fully collapsed tree already exceeds this amount). So setting the number of entries 1 will produce a full collapsed tree by default. 0 is a special value representing an infinite number of entries and will result in a full expanded tree by default. -' minval='0' maxval='9999' defval='100'/> +' minval='0' maxval='9999' defval='100' depends='GENERATE_HTML'/> <option type='bool' id='GENERATE_DOCSET' docs=' If the GENERATE_DOCSET tag is set to YES, additional index files will be generated that can be used as input for Apple's Xcode 3 @@ -1111,13 +1112,13 @@ 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. -' defval='0'/> +' defval='0' depends='GENERATE_HTML'/> <option type='enum' id='MATHJAX_FORMAT' defval='HTML-CSS' docs=' When MathJax is enabled you can set the default output format to be used for -thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and +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. -'> +' depends='USE_MATHJAX'> <value name="HTML-CSS"/> <value name="NativeMML"/> <value name="SVG"/> @@ -1131,12 +1132,17 @@ 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. -' defval='http://cdn.mathjax.org/mathjax/latest'/> +' defval='http://cdn.mathjax.org/mathjax/latest' depends='USE_MATHJAX'/> <option type='list' id='MATHJAX_EXTENSIONS' format='string' docs=' The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension names that should be enabled during MathJax rendering. ' depends='USE_MATHJAX'> </option> + <option type='string' id='MATHJAX_CODEFILE' format='string' docs=' +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. +' depends='USE_MATHJAX'> + </option> <option type='bool' id='SEARCHENGINE' docs=' When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript @@ -1161,8 +1167,8 @@ 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. +search engine (doxysearch.cgi) which are based on the open source search +engine library Xapian. See the manual for configuration details. ' defval='0' depends='SEARCHENGINE'/> <option type='string' id='SEARCHENGINE_URL' docs=' The SEARCHENGINE_URL should point to a search engine hosted by a web server @@ -1176,14 +1182,19 @@ 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. ' defval='searchdata.xml' depends='SEARCHENGINE'/> + <option type='string' id='EXTERNAL_SEARCH_ID' docs=' +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. +' defval='' depends='SEARCHENGINE'/> <option type='list' id='EXTRA_SEARCH_MAPPINGS' docs=' -The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through other -doxygen projects that are not otherwise connected via tags files, but are -all added to the same search index. Each project needs to have a tag file set -via GENERATE_TAGFILE. The search mapping then maps the name of the tag file -to a relative location where the documentation can be found, similar to the -TAGFILES option but without actually processing the tag file. -The format is: EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +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 ... ' defval='0' depends='SEARCHENGINE'/> </group> <group name='LaTeX' docs='configuration options related to the LaTeX output'> @@ -1216,10 +1227,9 @@ save some trees in general. <option type='enum' id='PAPER_TYPE' defval='a4' docs=' 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. ' depends='GENERATE_LATEX'> <value name='a4'/> - <value name='a4wide'/> <value name='letter'/> <value name='legal'/> <value name='executive'/> @@ -1241,6 +1251,12 @@ 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! ' defval='' depends='GENERATE_LATEX'/> + <option type='list' id='LATEX_EXTRA_FILES' format='file' docs=' +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. +' depends='GENERATE_LATEX'/> <option type='bool' id='PDF_HYPERLINKS' docs=' 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 @@ -1273,7 +1289,7 @@ such as SOURCE_BROWSER. 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. -' defval='plain'/> +' defval='plain' depends='GENERATE_LATEX'/> </group> <group name='RTF' docs='configuration options related to the RTF output'> <option type='bool' id='GENERATE_RTF' docs=' @@ -1359,6 +1375,17 @@ and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output. ' defval='1' depends='GENERATE_XML'/> </group> + <group name='Docbook' docs='configuration options related to the DOCBOOK output'> + <option type='bool' id='GENERATE_DOCBOOK' docs=' +If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files +that can be used to generate PDF. +' defval='0'/> + <option type='string' id='DOCBOOK_OUTPUT' format='dir' docs=' +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. +' defval='docbook' depends='GENERATE_DOCBOOK'/> + </group> <group name='DEF' docs='configuration options for the AutoGen Definitions output'> <option type='bool' id='GENERATE_AUTOGEN_DEF' docs=' If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will @@ -1368,6 +1395,19 @@ documentation. Note that this feature is still experimental and incomplete at the moment. ' defval='0'/> </group> +<!-- + <group name='Sqlite3' docs='configuration options related to Sqlite3 output'> + <option type='bool' id='GENERATE_SQLITE3' docs=' +If the GENERATE_SQLITE3 tag is set to YES doxygen will generate an +sqlite database with symbols found by doxygen stored in tables. +' defval='0'/> + <option type='string' id='SQLITE3_OUTPUT' format='dir' docs=' +The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be put. +If a relative path is entered the value of OUTPUT_DIRECTORY will be +put in front of it. If left blank sqlite3 will be used as the default path. +' defval='' depends='GENERATE_SQLITE3'/> + </group> +--> <group name='PerlMod' docs='configuration options related to the Perl module output'> <option type='bool' id='GENERATE_PERLMOD' docs=' If the GENERATE_PERLMOD tag is set to YES Doxygen will @@ -1419,7 +1459,7 @@ 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 the preprocessor. -' depends='ENABLE_PREPROCESSING'> +' depends='SEARCH_INCLUDES'> </option> <option type='list' id='INCLUDE_FILE_PATTERNS' format='string' docs=' You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard @@ -1481,6 +1521,11 @@ 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 be listed. ' defval='1'/> + <option type='bool' id='EXTERNAL_PAGES' docs=' +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. +' defval='1'/> <option type='string' id='PERL_PATH' format='dir' docs=' The PERL_PATH should be the absolute path and name of the perl script interpreter (i.e. the result of `which perl'). @@ -1519,7 +1564,7 @@ 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. -' defval='0' minval='0' maxval='32'/> +' defval='0' minval='0' maxval='32' depends='HAVE_DOT'/> <option type='string' id='DOT_FONTNAME' format='string' docs=' 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 @@ -1563,7 +1608,7 @@ 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 -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. ' defval='10' minval='0' maxval='100' depends='HAVE_DOT'/> <option type='bool' id='TEMPLATE_RELATIONS' docs=' @@ -1699,5 +1744,6 @@ the various graphs. <option type='obsolete' id='USE_INLINE_TREES'/> <option type='obsolete' id='SHOW_DIRECTORIES'/> <option type='obsolete' id='HTML_ALIGN_MEMBERS'/> + <option type='obsolete' id='SYMBOL_CACHE_SIZE'/> </group> </doxygenconfig> |