Changes between Version 75 and Version 76 of DoxygenPlugin

Timestamp:

Feb 26, 2016, 8:36:08 PM (8 years ago)

Author:

anonymous

Comment:

--

DoxygenPlugin

@@ -10 +10 @@
 
 The plugin also provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.
-If you have to present only one documentation project, that index page can directly be a Doxygen-generated page, like the index.html, main.html (default) or hierarchy.html.
+If you have to present only one documentation project, that index page can directly be a Doxygen-generated page, like the index.html (default), files.html etc.
 An alternative is to pick a Wiki page to use as the index, and this is indeed the best option if you have multiple documentation projects to serve. That way you can build your own ''meta'' index the way you want, using `doxygen:...` links within that page.
 
-Configuring the Doxygen plugin is straightforward if you have only one Doxygen generated documentation to wrap, and a bit more involved if you have many.
+Configuring the Doxygen plugin is straightforward if you have a Doxygen generated documentation ready and no other to use, and a bit more involved if you want to use all the features.
 
 This plugin is compatible with the following releases of Trac:
@@ -133 +133 @@
 = Documentation generated by Doxygen =
 
- - Documentation for the stable API: 
-   [doxygen:stable/hierarchy class hierarchy], [doxygen:stable/dirs directory hierarchy]
- - Documentation for the trunk API: 
-   [doxygen:devel/hierarchy class hierarchy], [doxygen:devel/dirs directory hierarchy]
+ - Main page for the stable documentation: 
+   [doxygen:] or [doxygen:/] or [doxygen:stable/]
+ - Documentation for the devel documentation: 
+   [doxygen:devel/]
 }}}
 
@@ -146 +146 @@
 || `html_output` ||Default documentation project suffix, as generated by Doxygen using the HTML_OUTPUT Doxygen configuration setting. ''(Since 0.10)''. || ||
 || `title` || Title to use for the main navigation tab. || Doxygen ||
-|| `input` || Directory containing the sources.  ''(unavailable in versions <= 0.11)'' ||  ||
+|| `input` || Directory containing the sources. Mostly usefull for Doxygen EXCLUDE option. ''(unavailable in versions <= 0.11)'' ||  ||
 || `doxyfile` || Full path of the Doxyfile to be created.  ''(unavailable in versions <= 0.11)'' ||  ||
 || `doxygen`  || Full path of the Doxygen command.  ''(unavailable in versions <= 0.11)'' || `/usr/local/bin/doxygen` ||
-|| `doxygen_args`      || Argument of the Doxygen command. This is usefull if you plan to include this file from another one to override a few Doxygen options ''(unavailable in versions <= 0.11)'' || Default to the  `doxyfile` option above.   ||
-|| `searchdata_file` || The name of the file specified by the "SEARCHDATA_FILE" option of DOXYGEN.  ''(unavailable in versions <= 0.11)'' || searchdata.xml ||
-|| `default_documentation` || Default documentation project, relative to [doxygen] path. When no explicit path is given in a documentation request, this path will be prepended to the request before looking for documentation files. ||   ||
+|| `doxygen_args`      || Argument of the Doxygen command. This is usefull if you plan to include the `doxyfile` produced by the plugin from another file  to override a few Doxygen options ''(unavailable in versions <= 0.11)'' || Default to the  `doxyfile` option above.   ||
+|| `searchdata_file` || The name of the file specified by the "SEARCHDATA_FILE" Doxygen configuration setting.  ''(unavailable in versions <= 0.11)'' || searchdata.xml ||
+|| `default_documentation` || Default documentation project, relative to [doxygen] path. When no explicit path is given in a documentation request, this path will be used to find the `searchdata_file` ||   ||
 || `index`      || Default index page to pick in the generated documentation. || index.html (main.html  in versions <= 0.11)||
 || `wiki_index` || Wiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option. ||   ||
@@ -157 +157 @@
 || `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 ||
-^''(up to date with r15345)''^
+^''(up to date with r15362)''^