org.apache.tapestry.mojo
Class ParametersDoclet

java.lang.Object
  com.sun.javadoc.Doclet
      org.apache.tapestry.mojo.ParametersDoclet

public class ParametersDoclet
extends com.sun.javadoc.Doclet

Generates an XML file that identifies all the classes that contain parameters, and all the parameters within each component class. This XML is later converted into part of the Maven generated HTML site.

To keep the -doclet parameter passed to javadoc simple, this class should not have any outside dependencies.

Constructor Summary

ParametersDoclet()

Method Summary

static com.sun.javadoc.LanguageVersion	languageVersion() Yes we are interested in annotations, etc.
static int	optionLength(String option)
static boolean	start(com.sun.javadoc.RootDoc root)
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametersDoclet

public ParametersDoclet()

Method Detail

languageVersion

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

Yes we are interested in annotations, etc.

optionLength

public static int optionLength(String option)

validOptions

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

start

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