Changes between Version 69 and Version 70 of DoxygenPlugin
- Timestamp:
- Dec 16, 2015, 12:27:09 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DoxygenPlugin
v69 v70 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 = Doxygen Plugin forTrac3 = Embed Doxygen-generated pages into Trac 4 4 5 5 == Description 6 6 7 This plugin embeds one or multiple [http://www.stack.nl/~dimitri/doxygen/ doxygen]-generated documentation(s) within Trac, to have consistent look and feel, and easy referencing to doxygen pages using the usual TracLinks and the `doxygen:` prefix.8 9 The doxygenplugin provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.7 This plugin embeds one or multiple [http://www.stack.nl/~dimitri/doxygen/ doxygen]-generated documentation(s) within Trac, to have consistent look and feel, and easy referencing to Doxygen pages using the usual TracLinks and the `doxygen:` prefix. 8 9 The plugin provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page. 10 10 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. 11 11 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. … … 190 190 == TracLinks 191 191 192 It is possible to create links to doxygen documentation from anywhere within a Wiki text, by using the `doxygen:` link prefix.192 It is possible to create links to Doxygen documentation from anywhere within a Wiki text, by using the `doxygen:` link prefix. 193 193 194 194 The general syntax of such links is: `doxygen:documentation_path/documentation_target`, where `documentation_path` is optional. … … 204 204 Some examples: 205 205 {{{ 206 [doxygen:main.html Documentation] # Simple documentation in doxygen path.206 [doxygen:main.html Documentation] # Simple documentation in Doxygen path. 207 207 208 208 [doxygen:FirstProject/annotated Annotated List of Classes in FirstProject]