Changes between Version 27 and Version 28 of DoxygenPlugin


Ignore:
Timestamp:
Sep 5, 2006, 9:35:00 AM (8 years ago)
Author:
cboos
Comment:

Improve introduction to the plugin

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v27 v28  
    44
    55Integrates [http://www.stack.nl/~dimitri/doxygen/ doxygen] documentation into Trac.
     6
     7The aim is to embed one or multiple doxygen-generated documentation(s) within Trac,
     8in order to have consistent look and feel, and easy referencing to doxygen pages
     9using the usual TracLinks and the `doxygen:` prefix.
     10
     11The doxygen plugin provides a new main navigation tab (named ''Doxygen'' by default),
     12which will present an index page.
     13If you have to present only one documentation project, that index page can directly
     14be a Doxygen-generated page, like the index.html, main.html (default) or hierarchy.html.
     15An alternative is to pick a Wiki page to use as the index, and this is indeed the best
     16option if you have multiple documentation projects to serve. That way you can build
     17your own ''meta'' index the way you want, using `doxygen:...` links within that page.
     18
     19Configuring the Doxygen plugin should be easy if you have only one Doxygen generated
     20documentation to wrap, and a bit more involved if you have many --but the goal is to
     21have a great deal of flexibility, in the latter case.
    622
    723== Bugs/Feature Requests ==