org.calrissian.restdoclet

Class RestDoclet

java.lang.Object

com.sun.javadoc.Doclet

org.calrissian.restdoclet.RestDoclet

public class RestDoclet
extends com.sun.javadoc.Doclet

Constructor Summary

Constructors

Constructor and Description
RestDoclet()

Method Summary

Methods

Modifier and Type	Method and Description
static com.sun.javadoc.LanguageVersion	languageVersion() NOTE: Without this method present and returning LanguageVersion.JAVA_1_5, Javadoc will not process generics because it assumes LanguageVersion.JAVA_1_1
static int	optionLength(String option) Required to validate command line options.
static boolean	start(com.sun.javadoc.RootDoc root) Generate documentation here.

Methods inherited from class com.sun.javadoc.Doclet

validOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestDoclet

public RestDoclet()

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)

Generate documentation here. This method is required for all doclets.

Returns:

true on success.

optionLength

public static int optionLength(String option)

Required to validate command line options.

Parameters:

option - option name

Returns:

option length

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

NOTE: Without this method present and returning LanguageVersion.JAVA_1_5, Javadoc will not process generics because it assumes LanguageVersion.JAVA_1_1

Returns:

language version (hard coded to LanguageVersion.JAVA_1_5)