Javadoc plugin

This plugin allows the editor to create links to a Javadoc page using the full same of a class or a method, and referring the Javadoc base URL using an identifier. This allows to easily refer to one or several Javadoc sites without hard-coding the base URL at each time.

Download

Latest version: Version 1.0.0

Usage

<javadoc>java.lang.String</javadoc>
<javadoc mysite>my.site.MyClass</javadoc>
<javadoc mysite>my.site.MyClass#myMethod(String)</javadoc>
<javadoc mysite>my.site.MyClass#myMethod(String)|myMethod</javadoc>

Tips:

Links to methods must use the same format than in the @see or {@link} Javadoc tag
An alternate text may be provided by using the | as a separator between the class/method name and the alternate text

Site management

The mysite flag is a reference into the $sites array in the plugin syntax.php file:

$sites = array (
  'jdk6' => 'http://java.sun.com/javase/6/docs/api',
  'mysite' => 'http://my.site.com/javadoc'
  );

You can add as many site keywords as wished. If no site is provided in the javadoc tag, the jdk6 site is used by default.

Future versions of this plugin will allow:

customization of the site entries through the configuration manager.

Release notes

Version	Status	Release	Date	Comments
1.0.0	Release		2007-10-03	Release version, no change from the Beta
1.0.0	Beta	01	2007-09-27	Allows an alternate text to the link Displays an image that indicates it is a Javadoc link
1.0.0	Alpha	03	2007-09-26	Takes method names into account
1.0.0	Alpha	02		Allows the <javadoc> tag to be included in other tags (lists, tables…)
1.0.0	Alpha	01		Correction of link generation
1.0.0	Dev			Initial version