Changes between Version 31 and Version 32 of DoxygenPlugin


Ignore:
Timestamp:
Sep 5, 2006, 11:41:37 AM (10 years ago)
Author:
cboos
Comment:

Replaced the Wiki Macros section by a TracLinks section, as the doxygen: is not a macro, but a link resolver

Legend:

Unmodified
Added
Removed
Modified
  • DoxygenPlugin

    v31 v32  
    154154----
    155155
    156 == Wiki Macros ==
     156== TracLinks ==
    157157
    158 Using provided wiki macro you can make a link to doxygen documentation page wherever you want. Specified links are related to setted up doxygen path:
     158It's possible to create links to doxygen documentation from anywhere within a Wiki text, by using the `doxygen:` link prefix.
    159159
     160The general syntax of such links is: `doxygen:documentation_path/documentation_target`, where `documentation_path` is optional.
     161If `documentation_path` is not specified, the `[doxygen] default_documentation` setting will be used instead.
     162
     163The `documentation_target` part is used for specifying what Doxygen generated content will be displayed when following the link. It can be:
     164 - the name of one of the many documentation summary page generated by Doxygen:
     165   * annotated, classes, dirs, files, functions, globals, hierarchy, index, inherits, main, namespaces and namespacemembers
     166 - the name of a documented struct or class
     167 - the name of a directory {o}
     168 - the name of a file {o}
     169
     170Some examples:
    160171{{{
    161172[doxygen:main.html Documentation] # Simple documentation in doxygen path.
    162 [doxygen:FirstProject/main.html First]   # Multiple documentation in separate
    163 [doxygen:SecondProject/main.html Second] # directories in doxygen path.
     173
     174[doxygen:FirstProject/annotated Annotated List of Classes in FirstProject]
     175[doxygen:SecondProject/main.html Main doc index for SecondProject]
    164176}}}
    165177