Package org.glassfish.jersey.wadl.doclet

Class ResourceDoclet

java.lang.Object

org.glassfish.jersey.wadl.doclet.ResourceDoclet

public class ResourceDoclet
extends Object

Creates a resourcedoc XML file.

The ResourceDoc file contains the javadoc documentation of resource classes, so that this can be used for extending generated wadl with useful documentation.

Author:

Martin Grotzke

Constructor Summary

Constructors

Constructor	Description
ResourceDoclet()

Method Summary

Modifier and Type	Method	Description
static int	optionLength(String option)	Return array length for given option: 1 + the number of arguments that the option takes.
static boolean	start(RootDoc root)	Start the doclet.
static boolean	validOptions(String[][] options, DocErrorReporter reporter)	Validate options.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceDoclet

public ResourceDoclet()

Method Detail

start

public static boolean start(RootDoc root)

Start the doclet.

Parameters:

root - the root JavaDoc document.

Returns:

true if no exception is thrown.

optionLength

public static int optionLength(String option)

Return array length for given option: 1 + the number of arguments that the option takes.

Parameters:

option - option

Returns:

the number of args for the specified option

validOptions

public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter)

Validate options.

Parameters:

options - options to be validated

reporter - DocErrorReporter for collecting eventual errors

Returns:

if the specified options are valid