Taglet Manual
The W-Bean Param Taglet is an aid to documenting W-Beans.
The taglet adds a new Javadoc tag that lets you specify the values expected by your W-Bean. It should be used in class level Javadoc, as follows:
package sample;
/**
* A sample for testing the WBean taglet
*
* This is a description for the sample.
*
* @wbean.param firstParam bean java.lang.String true A mandatory parameter
* @wbean.param secondParam session java.util.HashMap false An optional parameter
*/
public class Sample {
...
}
Each value expected by your W-Bean is introduced by a @wbean.param tag. This is followed by space separated values that specify:
- The parameter/attribute name.
- Its scope.
- Its class.
- Whether it is mandatory.
- A descriptive comment.
To use the taglet you need to make it known to Javadoc. The jar file containing the taglet may be found at taglet/lib/wbean-param-taglet.jar.
On the command line:
javadoc -taglet com.oldlight.weaver.taglet.WBeanParamTaglet
-tagletpath wbean-param-taglet.jar -d docs
-sourcepath sourcepath package
Or in ant:
<javadoc sourcefiles="sample/Sample.java"
destdir="docs">
<taglet name="com.oldlight.weaver.taglet.WBeanParamTaglet"
path="wbean-param-taglet.jar"/>
</javadoc>
Please refer any questions or comments about the Taglet to the Weaver users email list.