Changes between Version 80 and Version 81 of DoxygenPlugin


Ignore:
Timestamp:
Apr 4, 2022, 2:22:56 PM (3 months ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v80 v81  
    77[[Image(doxygen.png, align=right)]]
    88
    9 This 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.
     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.
     
    4747Install the plugin either manually or automatically. In either case, you may need to restart the web server to see the Doxygen button in the navigation menu bar.
    4848
    49 === Manual
     49=== Manual installation
    5050
    5151Download 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`.
     
    5959This will generate a Python egg in the dist directory. Copy the egg file into the `trac/plugins` directory and follow the Configuration steps below.
    6060
    61 === Automatic
     61=== Scripted installation
    6262
    6363Using easy_install to fetch, build and install:
     
    100100When documenting multiple projects, the `path` option is used to set a common prefix, which is shared by all generated documentations.
    101101
    102 Suppose you are requesting a documentation file that have the `doxygen:` TracLinks embedded. To specify which project should be used when no explicit path is given, you can also use `default_documentation`.
     102Suppose you are requesting a documentation file that has `doxygen:` TracLinks embedded. To specify which project should be used when no explicit path is given, you can also use `default_documentation`.
    103103
    104104'''Example:''' Imagine you have two sets of documentation, one for the latest trunk and one for a stable branch, and they are like this:
     
    157157|| `wiki_index` || Wiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option. ||   ||
    158158|| `encoding`   || Default encoding used by the generated documentation files. ''(Since 0.10)''. || utf-8 (iso-8859-1 in versions <= 0.11) ||
    159 || `ext`        || Space separated list of extensions for doxygen managed files. ''(deprecated after version 0.11)'' || htm html png ||
     159|| `ext`        || Space separated list of extensions for Doxygen managed files. ''(deprecated after version 0.11)'' || htm html png ||
    160160|| `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 ||
     161
    161162^''(up to date with r15362)''^
    162163
     
    177178Note that calls to the search engine used by Doxygen will be hijacked by the Trac search engine.
    178179
    179 You may replace the standard Doxygen header and footer HTML by your own
    180 (this was mandatory in versions <= 0.11, even if they contain only a blank line):
     180You may replace the standard Doxygen header and footer HTML by your own files:
    181181
    182182{{{
     
    185185}}}
    186186
    187 See [http://www.doxygen.nl/manual/config.html#cfg_html_header HTML_HEADER]
    188 and [http://www.doxygen.nl/manual/config.html#cfg_html_footer HTML_FOOTER].
    189 
    190 In versions <= 0.11, the [http://www.doxygen.nl/manual/config.html#cfg_create_subdirs CREATE_SUBDIRS] option should be set to NO;
    191 this is not mandatory anymore.
     187See [http://www.doxygen.nl/manual/config.html#cfg_html_header HTML_HEADER] and [http://www.doxygen.nl/manual/config.html#cfg_html_footer HTML_FOOTER].
     188
     189In versions <= 0.11, the [http://www.doxygen.nl/manual/config.html#cfg_create_subdirs CREATE_SUBDIRS] option should be set to NO; this is not mandatory anymore.
    192190
    193191== TracLinks
     
    202200Most of the time, it will be a function, a class, a file etc.
    203201Technically, it must be the content of a `field` tag having a `name` attribute equals to `name` in the `searchdata_file`.
    204 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).
     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.
    205203
    206204Some examples: