Imported Upstream version 1.8.3upstream/1.8.3

1 files changed, 61 insertions, 13 deletions

diff --git a/src/config.xml b/src/config.xml
index e0caa16..a75ff80 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -284,11 +284,11 @@ Doxygen will parse them like normal C++ but will assume all classes use public
 instead of private inheritance when no explicit protection keyword is present. 
 ' defval='0'/>
     <option type='bool' id='IDL_PROPERTY_SUPPORT' docs='
-For Microsoft&apos;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
+For Microsoft&apos;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.
 ' defval='1'/>
     <option type='bool' id='DISTRIBUTE_GROUP_DOC' docs='
@@ -510,7 +510,8 @@ disable (NO) the deprecated list. This list is created by putting
 ' defval='1'/>
     <option type='list' id='ENABLED_SECTIONS' format='string' docs='
 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. 
 '>
     </option>
     <option type='int' id='MAX_INITIALIZER_LINES' docs='
@@ -561,7 +562,8 @@ containing the references data. This must be a list of .bib files. The
 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.
 ' defval=''/>
   </group>
   <group name='Messages' docs='configuration options related to warning and progress messages'>
@@ -756,6 +758,12 @@ and it is also possible to disable source filtering for a specific pattern
 using *.ext= (so without naming a filter). This option only has effect when 
 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.
+' defval=''/>
   </group>
   <group name='Source Browser' docs='configuration options related to source browsing'>
     <option type='bool' id='SOURCE_BROWSER' docs='
@@ -1104,6 +1112,16 @@ 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'/> 
+    <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 
+SVG. The default value is HTML-CSS, which is slower, but has the best 
+compatibility. 
+'>
+      <value name="HTML-CSS"/>
+      <value name="NativeMML"/>
+      <value name="SVG"/>
+    </option>   
     <option type='string' id='MATHJAX_RELPATH' docs=' 
 When MathJax is enabled you need to specify the location relative to the 
 HTML output directory using the MATHJAX_RELPATH option. The destination 
@@ -1130,12 +1148,42 @@ can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
 ' defval='1' depends='GENERATE_HTML'/>
     <option type='bool' id='SERVER_BASED_SEARCH' docs='
 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. 
+' defval='0' depends='SEARCHENGINE'/>
+    <option type='bool' id='EXTERNAL_SEARCH' docs='
+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. 
+' 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 
+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. 
+' defval='' depends='SEARCHENGINE'/>
+    <option type='string' id='SEARCHDATA_FILE' format='file' docs='
+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='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 ... 
 ' defval='0' depends='SEARCHENGINE'/>
   </group>
   <group name='LaTeX' docs='configuration options related to the LaTeX output'>