jEdit Community home jEdit Community Wiki > TWiki > JavaDocPlugin jEdit Community Wiki webs:
Main | Plugins | Know | TWiki | Sandbox
TWiki . { Welcome? | Register? | Changes | Topics | Index | Search | Go }

JavaDocPlugin

Write links to javadoc classes

Syntax Rules

Examples

You type... You should see... If installed...
%JAVADOC{L4J:org.apache.log4j.Logger}% Logger Logger
%JAVADOC{java.lang.String}% String String
%JAVADOC{IO:BufferedOutputStream}% BufferedOutputStream BufferedOutputStream
%JAVADOC{jEdit:org.gjt.sp.jedit.jEdit}% jEdit jEdit
%JAVADOC{java.io.File#exists()}% File.exists() File.exists()
%JAVADOC{java.util.ArrayList#get(int)}% ArrayList.get(int) ArrayList.get(int)
%JAVADOC{java.util.ArrayList#addAll(java.util.Collection)}% ArrayList.addAll(java.util.Collection) ArrayList.addAll(java.util.Collection)

In the IO example, the source contains the package, so you need only to write the class name.

JavaDocPlugin Global Settings

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

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.

Plugin Info

Plugin Author: TWiki:Main.LaurentBovet
Plugin Version: 04 Apr 2003 (V1.000)
Change History:  
04 Apr 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/JavaDocPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/JavaDocPluginDev

Related Topics: TWiki Preferences, TWiki Plugins

-- TWiki:Main.LaurentBovet - 04 Apr 2003

Topic JavaDocPlugin . { Edit | Attach | Ref-By | Printable | Diffs | r1.3 | > | r1.2 | > | r1.1 | More }
Revision r1.3 - 27 Aug 2003 - 02:23 GMT - Brad Mace Copyright © 1999-2011 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding jEdit Community Wiki? Send feedback.
Get jEdit at !SourceForge.net. Fast, secure and Free Open Source software downloads

TWiki.JavaDocPlugin moved from Plugins.JavaDocPlugin on 15 Aug 2003 - 16:48 by TWiki Guest - put it back