summaryrefslogtreecommitdiffstats
path: root/src/config.xml
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2013-01-20 13:31:30 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-01-20 13:31:30 (GMT)
commitdcd4714c4413348d02eb7224dafee5d06be43dfb (patch)
tree3872f0367bbee22883a702d1d2f799c9a9c2e8ac /src/config.xml
parent775ab3be95c02dd805aadc73ffbe3c18877c12a4 (diff)
downloadDoxygen-dcd4714c4413348d02eb7224dafee5d06be43dfb.zip
Doxygen-dcd4714c4413348d02eb7224dafee5d06be43dfb.tar.gz
Doxygen-dcd4714c4413348d02eb7224dafee5d06be43dfb.tar.bz2
Release-1.8.3.1
Diffstat (limited to 'src/config.xml')
-rw-r--r--src/config.xml19
1 files changed, 12 insertions, 7 deletions
diff --git a/src/config.xml b/src/config.xml
index a75ff80..26496c9 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -1176,14 +1176,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='' dependes='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'>