Changes between Version 79 and Version 80 of DoxygenPlugin


Ignore:
Timestamp:
May 7, 2020, 10:04:50 PM (4 years ago)
Author:
figaro
Comment:

Update links

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v79 v80  
    77[[Image(doxygen.png, align=right)]]
    88
    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.
     9This plugin produces and embeds one or multiple [http://doxygen.nl/ 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. Doxygen itself is GPL licensed.
    1010
    1111The 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.
     
    8787A `[doxygen]` section should be created in TracIni.
    8888There is only one mandatory setting, which is the `path` to the generated documentation.
    89 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.
    90 
    91 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`:
     89This should match the [http://www.doxygen.nl/manual/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.
     90
     91Note that there is also the [http://www.doxygen.nl/manual/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`:
    9292
    9393{{{#!ini
     
    171171
    172172To make this plugin work, you have to set to YES the following items in the Doxyfile:
    173 [http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_html GENERATE_HTML],
    174 [http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_searchenginel SEARCHENGINE],
    175 [http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_server_based_search SERVER_BASED_SEARCH] and
    176 [http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_external_search EXTERNAL_SEARCH].
     173[http://www.doxygen.nl/manual/config.html#cfg_generate_html GENERATE_HTML],
     174[http://www.doxygen.nl/manual/config.html#cfg_searchenginel SEARCHENGINE],
     175[http://www.doxygen.nl/manual/config.html#cfg_server_based_search SERVER_BASED_SEARCH] and
     176[http://www.doxygen.nl/manual/config.html#cfg_external_search EXTERNAL_SEARCH].
    177177Note that calls to the search engine used by Doxygen will be hijacked by the Trac search engine.
    178178
     
    185185}}}
    186186
    187 See [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_header HTML_HEADER]
    188 and [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_footer HTML_FOOTER].
    189 
    190 In versions <= 0.11, the [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_create_subdirs CREATE_SUBDIRS] option should be set to NO;
     187See [http://www.doxygen.nl/manual/config.html#cfg_html_header HTML_HEADER]
     188and [http://www.doxygen.nl/manual/config.html#cfg_html_footer HTML_FOOTER].
     189
     190In versions <= 0.11, the [http://www.doxygen.nl/manual/config.html#cfg_create_subdirs CREATE_SUBDIRS] option should be set to NO;
    191191this is not mandatory anymore.
    192192