Changes between Version 69 and Version 70 of DoxygenPlugin


Ignore:
Timestamp:
Dec 16, 2015, 12:27:09 PM (8 years ago)
Author:
figaro
Comment:

Tagged as plugin

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v69 v70  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Doxygen Plugin for Trac
     3= Embed Doxygen-generated pages into Trac
    44
    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.
    8 
    9 The doxygen plugin provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.
     7This 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.
     8
     9The plugin provides a new main navigation tab (named ''Doxygen'' by default), which will present an index page.
    1010If you have to present only one documentation project, that index page can directly be a Doxygen-generated page, like the index.html, main.html (default) or hierarchy.html.
    1111An alternative is to pick a Wiki page to use as the index, and this is indeed the best option if you have multiple documentation projects to serve. That way you can build your own ''meta'' index the way you want, using `doxygen:...` links within that page.
     
    190190== TracLinks
    191191
    192 It is possible to create links to doxygen documentation from anywhere within a Wiki text, by using the `doxygen:` link prefix.
     192It is possible to create links to Doxygen documentation from anywhere within a Wiki text, by using the `doxygen:` link prefix.
    193193
    194194The general syntax of such links is: `doxygen:documentation_path/documentation_target`, where `documentation_path` is optional.
     
    204204Some examples:
    205205{{{
    206 [doxygen:main.html Documentation] # Simple documentation in doxygen path.
     206[doxygen:main.html Documentation] # Simple documentation in Doxygen path.
    207207
    208208[doxygen:FirstProject/annotated Annotated List of Classes in FirstProject]