Changes between Version 31 and Version 32 of DoxygenPlugin

Timestamp:

Sep 5, 2006, 9:41:37 AM (18 years ago)

Author:

Christian Boos

Comment:

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

DoxygenPlugin

@@ -154 +154 @@
 ----
 
-== Wiki Macros ==
+== TracLinks ==
 
-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:
+It's possible to create links to doxygen documentation from anywhere within a Wiki text, by using the `doxygen:` link prefix.
 
+The general syntax of such links is: `doxygen:documentation_path/documentation_target`, where `documentation_path` is optional.
+If `documentation_path` is not specified, the `[doxygen] default_documentation` setting will be used instead.
+
+The `documentation_target` part is used for specifying what Doxygen generated content will be displayed when following the link. It can be:
+ - the name of one of the many documentation summary page generated by Doxygen:
+   * annotated, classes, dirs, files, functions, globals, hierarchy, index, inherits, main, namespaces and namespacemembers
+ - the name of a documented struct or class
+ - the name of a directory {o}
+ - the name of a file {o}
+
+Some examples:
 {{{
 [doxygen:main.html Documentation] # Simple documentation in doxygen path.
-[doxygen:FirstProject/main.html First]   # Multiple documentation in separate
-[doxygen:SecondProject/main.html Second] # directories in doxygen path.
+
+[doxygen:FirstProject/annotated Annotated List of Classes in FirstProject]
+[doxygen:SecondProject/main.html Main doc index for SecondProject] 
 }}}