Changes between Version 72 and Version 73 of DoxygenPlugin

Timestamp:

Feb 12, 2016, 1:50:54 PM (8 years ago)

Author:

Committo-Ergo-Sum

Comment:

--

DoxygenPlugin

@@ -149 +149 @@
 || `index`      || Default index page to pick in the generated documentation. || main.html ||
 || `wiki_index` || Wiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option. ||   ||
-|| `encoding`   || Default encoding used by the generated documentation files. ''(Since 0.10)''. || utf-8 (iso-8859-1 in versions <= 0.11) ||
+|| `encoding`   || Default encoding used by the generated documentation files. ''(Since 0.10)''. || utf-8 (iso-8859-1 in versions <= 0.11)||
 || `ext`        || Space separated list of extensions for doxygen managed files. ''(deprecated after version 0.11)'' || htm html png ||
 || `source_ext` || Space separated list of source files extensions.  ''(deprecated after version 0.11)''  || idl odl java cs py php php4 inc phtml m cpp cxx c hpp hxx h ||
@@ -163 +163 @@
 === Configuring Doxygen
 
-The configuration settings in the Doxyfile that are required to make this plugin work are
-[http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_html GENERATE_HTML]
-and
-[http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_searchenginel SEARCHENGINE]
-both to YES. Note that calls to the search engine used by Doxygen will be hijacked by
-the Trac search engine.
+To make this plugin work, you have to set to YES the following items in the Doxyfile:
+[http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_html GENERATE_HTML],
+[http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_searchenginel SEARCHENGINE],
+[http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_server_based_search SERVER_BASED_SEARCH] and
+[http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_external_search EXTERNAL_SEARCH].
+Note that calls to the search engine used by Doxygen will be hijacked by the Trac search engine.
 
 You may replace the standard Doxygen header and footer HTML by your own
@@ -193 +193 @@
 The `documentation_target` part is used for specifying what Doxygen generated content will be displayed when following the link.
 It must be a name for which a documentation was produced by Doxygen, depending on the way you ran it. 
-Most of the time, it will be a function, a classe, a file etc. 
+Most of the time, it will be a function, a class, a file etc. 
 Technically, it must be the content of a `field` tag having a `name` attribute equals to `name` in the `searchdata_file`.
+If the name is empty, the link leads to the main page of the documentation.
 
 Some examples:
 {{{
 [doxygen:foo] # Link to the documentation of the function (or class etc) foo in the main documentation.
-[doxygen:SecondProject/foo] similarly for another documentation 
+[doxygen:SecondProject/foo] similarly for another documentation.
+[doxygen:] or [doxygen:/] Main page of the documentation.
+[doxygen:SecondProject/] Main page of the second project documentation.
 }}}