Changes between Version 70 and Version 71 of DoxygenPlugin


Ignore:
Timestamp:
Feb 11, 2016, 8:00:36 PM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • DoxygenPlugin

    v70 v71  
    55== Description
    66
    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.
     7This plugin embeds one or multiple [http://www.stack.nl/~dimitri/doxygen/ doxygen]-generated documentation(s) within Trac, to have a consistent look and feel, and easy referencing to Doxygen pages using the usual TracLinks and the `doxygen:` prefix.
    88
    99The plugin provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.
    … …  
    3636
    3737You can check out DoxygenPlugin from [/svn/doxygenplugin here] using Subversion,
    38 or [browser:/doxygenplugin browse the source] using Trac.
     38or [source:doxygenplugin browse the source] with Trac.
    3939
    4040== Installation
    … …  
    5959
    6060{{{#!sh
    61 $ sudo easy_install http://trac-hacks.org/svn/doxygenplugin/0.11/
     61$ sudo easy_install https://trac-hacks.org/svn/doxygenplugin/0.11/
    6262}}}
    6363
    … …  
    7676}}}
    7777
    78 === Configuring Trac
    79 
    80 ==== Basic Configuration
     78== Configuration
     79
     80=== Basic Configuration
    8181
    8282A `[doxygen]` section should be created in TracIni.
    … …  
    9292}}}
    9393
    94 ==== Settings for Multiple Documentation Projects
     94=== Settings for Multiple Documentation Projects
    9595
    9696When documenting multiple projects, the `path` option is used to set a common prefix, which is shared by all generated documentations.
    … …  
    137137}}}
    138138
    139 ==== Options Summary
     139=== Options Summary
    140140
    141141These are all the configuration options recognized in the `[doxygen]` section of TracIni:
    … …  
    177177and [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_html_footer HTML_FOOTER].
    178178
    179 These files must contain something, a blank line is sufficient, or else doxygen will put in the defaults. You can put there your own CSS style as in following example:
     179These files must contain something, a blank line is sufficient, or else Doxygen will put in the defaults. You can put there your own CSS style as in the following example:
    180180{{{#!css
    181181<style type="text/css">
    … …  
    210210}}}
    211211
    212 In order to use links to documented structs or classes Doxygen needs to be configured '''not''' to generate subdirectories, see [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_create_subdirs CREATE_SUBDIRS]. Also filenames generated must be case sensitive, preserving the original casing ([http://www.stack.nl/~dimitri/doxygen/config.html#cfg_case_sense_names CASE_SENSE_NAMES] must be set to "YES").
     212To use links to documented structs or classes Doxygen needs to be configured '''not''' to generate subdirectories, see [http://www.stack.nl/~dimitri/doxygen/config.html#cfg_create_subdirs CREATE_SUBDIRS]. Also filenames generated must be case sensitive, preserving the original casing ([http://www.stack.nl/~dimitri/doxygen/config.html#cfg_case_sense_names CASE_SENSE_NAMES] must be set to "YES").
    213213
    214214== Example