Changes between Version 77 and Version 78 of DoxygenPlugin


Ignore:
Timestamp:
Mar 22, 2016, 9:38:03 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v77 v78  
    77This 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.
    88
    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.
     9The 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.
    1010
    1111The plugin also provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.
     
    3434== Download
    3535
    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].
     36Download the zipped source for the appropriate branch: [export:doxygenplugin/0.10 0.10], [export:doxygenplugin/0.11 0.11], [export:doxygenplugin/trunk trunk].
    3737
    3838== Source
     
    4747=== Manual
    4848
    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`.
     49Download 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`.
    5050
    5151Change to the doxygenplugin/trunk (or another version) directory and run:
     
    8585A `[doxygen]` section should be created in TracIni.
    8686There 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 prepend 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.
     87This 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.
    8888
    8989Note 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`:
     
    129129}}}
    130130
    131 In this situation use the `wiki_index` , so you can place links to both documentation sets:
     131In this situation use the `wiki_index`, so you can place links to both documentation sets:
    132132{{{
    133133= Documentation generated by Doxygen =
     
    135135 - Main page for the stable documentation:
    136136   [doxygen:] or [doxygen:/] or [doxygen:stable/]
    137  - Documentation for the devel documentation:
     137 - Documentation for the development documentation:
    138138   [doxygen:devel/]
    139139}}}
     
    200200Most of the time, it will be a function, a class, a file etc.
    201201Technically, 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 usefull 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).
     202If 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).
    203203
    204204Some examples:
     
    210210}}}
    211211
    212 
    213212== Recent Changes
    214213
    215214[[ChangeLog(doxygenplugin, 3)]]
    216 
    217215
    218216== Author/Contributors