Package org.glassfish.jersey.wadl.doclet

Class ResourceDoclet

java.lang.Object

org.glassfish.jersey.wadl.doclet.ResourceDoclet

All Implemented Interfaces:

Doclet

public class ResourceDoclet
extends Object
implements Doclet

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:

Jorge Bescos Gascon

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
ResourceDoclet()

Method Summary

Modifier and Type	Method	Description
String	getName()
Set<? extends Doclet.Option>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
void	init(Locale locale, Reporter reporter)
boolean	run(DocletEnvironment docEnv)

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceDoclet

public ResourceDoclet()

Method Details

init

public void init(Locale locale,
 Reporter reporter)

Specified by:

init in interface Doclet

run

public boolean run(DocletEnvironment docEnv)

Specified by:

run in interface Doclet

getName

public String getName()

Specified by:

getName in interface Doclet

getSupportedOptions

public Set<? extends Doclet.Option> getSupportedOptions()

Specified by:

getSupportedOptions in interface Doclet

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Doclet