Tags:
documentation1Add my vote for this tag integration1Add my vote for this tag create new tag
, view all tags

DoxygenPlugin

Create links to doxygen-generated docs using %DOX{classname}%

Introduction

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}% %DOX{nKernelServer}%
%DOX{classname}% %DOX{nebulacollide::nKernelClient::BadConnection}% %DOX{nebulacollide::nKernelClient::BadConnection}%
%DOX{path/to/html}% %DOX{nebulacollide/html/collide_usage.html}% %DOX{nebulacollide/html/collide_usage.html}%
%DOX{classname[displayName]}% %DOX{nKernelServer[The Kernel]}% %DOX{nKernelServer[The Kernel]}%

Where classname is the case sensitive name of the class you wish to link to. For example %DOX{nKernelServer}% creates a link like this %DOX{nKernelServer}%.

If you are using namespaces or nested classes, specific the fully qualified name with :: as you would referecing it in code as in the example above.

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 %DOX{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 %DOX{nKernelServer[The Kernel]}%

DoxygenPlugin Global Settings

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

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Create links to doxygen-generated docs using %DOX{classname}%

  • Debug plugin: (See output in data/debug.txt)
    • 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 = neb

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 Plugins web (see below)
  • Unzip DoxygenPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/DoxygenPlugin.txt Plugin topic
    data/TWiki/DoxygenPluginTests.txt Plugin topic tests
    lib/TWiki/Plugins/DoxygenPlugin.pm Plugin Perl module
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test if the installation was successful:
    • %DOX{ nKernelServer project="neb" }% : %DOX{ nKernelServer project="neb" }%
  • Other examples

Plugin Info

Plugin Author: TWiki:Main.WillNorris, TWiki:Main.LeafGarland
Copyright: © 2003 TWiki:Main.WillNorris
2003 TWiki:Main.LeafGarland
© 2007-2011 TWiki:Main.TWikiContributors
License: GPL (GNU General Public License)
Plugin Version: 2011-02-01
Change History:  
2011-02-01: TWikibug:Item6638: Doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
2007-01-11: Added support for namespaces and nested classes -- TWiki:Main.RickMach
2003-08-01: 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: DoxygenPluginTests, TWikiPreferences, TWikiPlugins

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 DoxygenPlugin.md5 r5 r4 r3 r2 r1 manage 0.2 K 2011-02-02 - 05:59 PeterThoeny  
Compressed Zip archivetgz DoxygenPlugin.tgz r5 r4 r3 r2 r1 manage 5.2 K 2011-02-02 - 05:59 PeterThoeny  
Compressed Zip archivezip DoxygenPlugin.zip r6 r5 r4 r3 r2 manage 7.1 K 2011-02-02 - 05:59 PeterThoeny  
Unknown file formatEXT DoxygenPlugin_installer r4 r3 r2 r1 manage 3.4 K 2011-02-02 - 05:59 PeterThoeny  
Edit | Attach | Watch | Print version | History: r9 < r8 < r7 < r6 < r5 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r9 - 2013-10-16 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2016 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.