Changes between Version 74 and Version 75 of DoxygenPlugin

Timestamp:

Feb 20, 2016, 5:42:10 PM (8 years ago)

Author:

Committo-Ergo-Sum

Comment:

--

DoxygenPlugin

@@ -5 +5 @@
 == Description
 
-This plugin embeds one or multiple [http://www.stack.nl/~dimitri/doxygen/ doxygen]-generated documentation(s) within Trac, to have a consistent look and feel, and easy referencing to Doxygen pages using the usual TracLinks and the `doxygen:` prefix.
-
-The plugin provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.
+This plugin produces and embeds one or multiple [http://www.stack.nl/~dimitri/doxygen/ doxygen]-generated documentation(s) within Trac, to have up-to-date documentation and easy referencing to Doxygen pages using the usual TracLinks and the `doxygen:` prefix.
+
+The plugin provides a new link in the admin panel, which will present a web form version of the Doxygen standard configuration file (named ''Doxyfile'' by default).Submitting the form will archive the choosen options, and Doxygen will run immediatly on them.
+
+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.
 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.
@@ -90 +92 @@
 [doxygen]
 path = /var/cache/doxygen/myproject
-html_output = html
 }}}
 
@@ -142 +143 @@
 These are all the configuration options recognized in the `[doxygen]` section of TracIni:
 || '''Option Name''' || '''Documentation''' || '''Default value''' ||
-|| `path` || Directory containing doxygen generated files. ||  ||
+|| `path` || Directory containing Doxygen ouput. ||  ||
 || `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 ||
-|| `searchdata_file` || the name of the file specified by the "SEARCHDATA_FILE" option of DOXYGEN.  ''(unavailable in versions <= 0.11)''|| searchdata.xml ||
+|| `title` || Title to use for the main navigation tab. || Doxygen ||
+|| `input` || Directory containing the sources.  ''(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. ||   ||
-|| `index`      || Default index page to pick in the generated documentation. || main.html ||
+|| `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. ||   ||
 || `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 ||
-^''(up to date with r1249)''^
+^''(up to date with r15345)''^
 
 
@@ -210 +215 @@
 [[ChangeLog(doxygenplugin, 3)]]
 
-== Feedback
-
-[[Poll(Are you using this plugin?; Yes, it's usefull.; No, but plan to.; No, it's useless.; No, I don't need it.)]]
 
 == Author/Contributors