Skip to topic | Skip to bottom
Home
topic end
Start of topic | Skip to actions

DoxygenPlugin

This plugin allows you to create links to classes within doxygen-generated documentation.

Syntax Rules

%DOX{classname[displayName] project="optionalProjectName"}%

Examples

syntax example result
%DOX{classname}% %DOX{nKernelServer}% nKernelServer [bad link?]
%DOX{path/to/html}% %DOX{nebulacollide/html/collide_usage.html}% nebulacollide/html/collide_usage.html
%DOX{classname[displayName]}% %DOX{nKernelServer[The Kernel]}% The Kernel [bad link?]

Where classname is the case sensitive name of the class you wish to link to. For example nKernelServer [bad link?] creates a link like this nKernelServer [bad link?].

If you wish to link to a specific function or other API page, then you can use %DOX{path}% where path is the path to the html file relative to /doc/doxydoc/. For example if you wished to link to /doc/doxydoc/nebulacollide/html/collide_usage.html then you would type %DOX{nebulacollide/html/collide_usage.html}% to get a link like this nebulacollide/html/collide_usage.html.

To have the link display text other than the class name or file path, put the alternative text in square brackets like this %DOX{nKernelServer[The Kernel]}%, which would display as The Kernel [bad link?]

DoxygenPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %DOXYGENPLUGIN_SHORTDESCRIPTION%

  • Set SHORTDESCRIPTION = Creates links to doxygen-generated docs using %DOX{classname}%.
    • Set DEBUG = 0

  • default project if repository isn't specified in the plugin parameters (case doesn't matter here because it all gets uppercased anyway)
    • Set PROJECT = VTFAPPS

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip DoxygenPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/DoxygenPlugin.txt Plugin topic
    data/TWiki/DoxygenPlugin.txt,v Plugin topic repository
    data/TWiki/DoxygenPluginTests.txt Plugin topic tests
    data/TWiki/DoxygenPluginTests.txt,v Plugin topic tests repository
    lib/TWiki/Plugins/DoxygenPlugin.pm Plugin Perl module
  • Test if the installation was successful:
  • Other examples

Plugin Info

Plugin Author: TWiki:Main/WillNorris, TWiki:Main/LeafGarland
Plugin Version: 01 Aug 2003 (V1.000)
Change History:  
01 Aug 2003: Initial version
CPAN Dependencies: none
Other Dependencies: doxygen
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/DoxygenPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/DoxygenPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/WillNorris - 01 Aug 2003

End of topic
Skip to action links | Back to top

You are here: TWiki > SearchResult? > DoxygenPlugin

to top

Copyright © 1997-2024 California Institute of Technology.