com.j256.springrequestdoclet

Class SpringRequestDoclet

java.lang.Object

com.sun.javadoc.Doclet

com.j256.springrequestdoclet.SpringRequestDoclet

public class SpringRequestDoclet
extends com.sun.javadoc.Doclet

Spring request doclet main class. Although it extends @{link Doclet} is really a collection of static methods that (I guess) are called via reflection.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
SpringRequestDoclet()

Method Summary

Methods

Modifier and Type	Method and Description
static com.sun.javadoc.LanguageVersion	languageVersion() This method may be necessary to expose show generic arguments in the class information.
static int	optionLength(String option) This method is necessary otherwise syntax errors because of invalid options is generated.
static boolean	start(com.sun.javadoc.RootDoc root) Actually do the processing of the variable class information so we can general the documentation output.
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter docErrorReporter) This method is necessary otherwise syntax errors are generated because of invalid options is generated.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringRequestDoclet

public SpringRequestDoclet()

Method Detail

start

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

Actually do the processing of the variable class information so we can general the documentation output.

See Also:

Doclet.start(RootDoc)

languageVersion

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

This method may be necessary to expose show generic arguments in the class information.

See Also:

Doclet.languageVersion()

optionLength

public static int optionLength(String option)

This method is necessary otherwise syntax errors because of invalid options is generated. At least "return 1;" is required. "return 0;" is option unknown. There may be options that this specific doclet uses but there is also other options that are part of the javadoc calls -- at least when done via maven.

See Also:

Doclet.optionLength(String)

validOptions

public static boolean validOptions(String[][] options,
                   com.sun.javadoc.DocErrorReporter docErrorReporter)

This method is necessary otherwise syntax errors are generated because of invalid options is generated. This is also how the options and any arguments are processed. There is where we could set various output flags or maybe choose a different collector or writer.

See Also:

Doclet.validOptions(String[][], DocErrorReporter)