QuickJavaDocPlugin could produce JavaDoc on the fly based on the current given Java source code, use this will max the usage of Javadoc tags. I use QDox( http://qdox.codehaus.org/ ) as my tag and source parser.

Install: unzip QuickJavaDocPluginBin.zip(info) to your jspwiki web app install dir and then restart the web app server or reload the app.

Wanna change output color format? Just edit the css file css/syntax.css and u'll got it.

Usage:#

[{QuickJavaDocPlugin

<CR or LN, just a empty line here>
--- The source code body here, might have multi lines. ---
}]

Parameters:#

  • source code, is putting in the body of that Tag(all JSPWiki Plugin supports a special parameter called '_body'), the first line must be an empty line.

Sample usage:

[{QuickJavaDocPlugin

/**
 * QuickJavaDocPlugin could produce JavaDoc on the fly based on the current given
 * Java source code, use this will max the usage of Javadoc tags.
 * 
 * @author BeanSoft
 * @version 1.00 2007-1-30
 */
public class QuickJavaDocPlugin implements WikiPlugin {
	/**
	 * Body param name, a special name called "_body" provided by JSPWiki.
	 */
	protected static final String PARAM_BODY = "_body";
// ...
}
}]

This version is really simple and it'll be as powerful as my Code2Html plugin soon, I planded to added icons as methods and fileds, classes also with packages.

Source code: QuickJavaDocPluginSrc.zip(info).

We only relies on JSPWiki, a CSS file and QDox then nothing else is used.

Wanna a screen shot? It's here:
QuickJavaDocPlugin.png

Jacky Liu Jan 30 2007

Add new attachment

Only authorized users are allowed to upload new attachments.

List of attachments

Kind Attachment Name Size Version Date Modified Author Change note
png
QuickJavaDocPlugin.png 14.2 kB 1 30-Jan-2007 12:45 Jacky Liu
zip
QuickJavaDocPluginBin.zip 92.8 kB 1 30-Jan-2007 12:45 Jacky Liu
zip
QuickJavaDocPluginSrc.zip 90.8 kB 1 30-Jan-2007 12:46 Jacky Liu
« This page (revision-3) was last changed on 30-Jan-2007 12:50 by Jacky Liu