Changes between Version 78 and Version 79 of DoxygenPlugin
- Timestamp:
- Feb 19, 2017, 9:19:44 AM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DoxygenPlugin
v78 v79 5 5 == Description 6 6 7 [[Image(doxygen.png, align=right)]] 8 7 9 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. 8 10 9 11 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 chosen options, and Doxygen will run immediately on them. 10 12 11 The plugin also provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.13 The plugin also provides a new main navigation tab, named ''Doxygen'' by default, which will present an index page. 12 14 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. 13 15 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. … … 152 154 || `searchdata_file` || The name of the file specified by the "SEARCHDATA_FILE" Doxygen configuration setting. ''(unavailable in versions <= 0.11)'' || searchdata.xml || 153 155 || `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` || || 154 || `index` || Default index page to pick in the generated documentation. || index.html (main.html in versions <= 0.11)||156 || `index` || Default index page to pick in the generated documentation. || index.html (main.html in versions <= 0.11) || 155 157 || `wiki_index` || Wiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option. || || 156 || `encoding` || Default encoding used by the generated documentation files. ''(Since 0.10)''. || utf-8 (iso-8859-1 in versions <= 0.11) ||158 || `encoding` || Default encoding used by the generated documentation files. ''(Since 0.10)''. || utf-8 (iso-8859-1 in versions <= 0.11) || 157 159 || `ext` || Space separated list of extensions for doxygen managed files. ''(deprecated after version 0.11)'' || htm html png || 158 160 || `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 ||