Changes between Version 77 and Version 78 of DoxygenPlugin
- Timestamp:
- Mar 22, 2016, 9:38:03 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DoxygenPlugin
v77 v78 7 7 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 8 9 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.9 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 10 11 11 The plugin also provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page. … … 34 34 == Download 35 35 36 Download the zipped source for the appropriate branch: [export:doxygenplugin/0.10 0.10], [export:doxygenplugin/0.11 0.11], 36 Download the zipped source for the appropriate branch: [export:doxygenplugin/0.10 0.10], [export:doxygenplugin/0.11 0.11], [export:doxygenplugin/trunk trunk]. 37 37 38 38 == Source … … 47 47 === Manual 48 48 49 Download the source code for the DoxygenPlugin from [export:doxygenplugin here] or checkout the source from the Trac hacks subversion repository at `http ://trac-hacks.org/svn/doxygenplugin`.49 Download the source code for the DoxygenPlugin from [export:doxygenplugin here] or checkout the source from the Trac hacks subversion repository at `https://trac-hacks.org/svn/doxygenplugin`. 50 50 51 51 Change to the doxygenplugin/trunk (or another version) directory and run: … … 85 85 A `[doxygen]` section should be created in TracIni. 86 86 There is only one mandatory setting, which is the `path` to the generated documentation. 87 This should match the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_output_directory OUTPUT_DIRECTORY] setting in the Doxyfile. If that is a relative path, you will need to pre pendthe current working directory used when running `doxygen`. Also, don't forget to grant the users the `DOXYGEN_VIEW` permission, else a blank page will be returned.87 This should match the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_output_directory OUTPUT_DIRECTORY] setting in the Doxyfile. If that is a relative path, you will need to prefix the current working directory used when running `doxygen`. Also, don't forget to grant the users the `DOXYGEN_VIEW` permission, else a blank page will be returned. 88 88 89 89 Note that there is also the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_output HTML_OUTPUT] setting which might play a role here. By default, the value for this setting is `html`, and this will be appended to the path specified in `OUTPUT_DIRECTORY`: … … 129 129 }}} 130 130 131 In this situation use the `wiki_index` 131 In this situation use the `wiki_index`, so you can place links to both documentation sets: 132 132 {{{ 133 133 = Documentation generated by Doxygen = … … 135 135 - Main page for the stable documentation: 136 136 [doxygen:] or [doxygen:/] or [doxygen:stable/] 137 - Documentation for the devel documentation:137 - Documentation for the development documentation: 138 138 [doxygen:devel/] 139 139 }}} … … 200 200 Most of the time, it will be a function, a class, a file etc. 201 201 Technically, it must be the content of a `field` tag having a `name` attribute equals to `name` in the `searchdata_file`. 202 If the name is empty, the link leads to the main page of the documentation; this is useful lto give access to the main page of a documentation which is not the default one (for example the Wiki page of a project may list the documentations of the older versions with these links).202 If the name is empty, the link leads to the main page of the documentation; this is useful to give access to the main page of a documentation which is not the default one (for example the Wiki page of a project may list the documentations of the older versions with these links). 203 203 204 204 Some examples: … … 210 210 }}} 211 211 212 213 212 == Recent Changes 214 213 215 214 [[ChangeLog(doxygenplugin, 3)]] 216 217 215 218 216 == Author/Contributors