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


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

Syntax Rules

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


syntax example result
%DOX{classname}% %DOX{nKernelServer}% nKernelServer [bad link?]
%DOX{classname}% %DOX{nebulacollide::nKernelClient::BadConnection}% nebulacollide::nKernelClient::BadConnection [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 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 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%

  • 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

  • The Nebula Device project codebase
    • Set DOCS_BASE_FST = /var/www/html/openfst/doxygen/fst/html

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

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 in your twiki installation directory. Content:
    File: Description:
    data/TWiki/DoxygenPlugin.txt Plugin topic
    data/TWiki/DoxygenPluginTests.txt Plugin topic tests
    lib/TWiki/Plugins/ Plugin Perl module
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test if the installation was successful:
  • 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:

Related Topics: DoxygenPluginTests, TWikiPreferences, TWikiPlugins

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r2 - 2020-07-06 - MichaelRiley
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on at TWiki:TWiki.DoxygenPlugin.