Package com.xebialabs.gradle.documentation.restdoc.doclet

Class RestDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

All Implemented Interfaces:

Doclet

public class RestDoclet
extends StandardDoclet

Nested Class Summary

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

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
RestDoclet()

Method Summary

Modifier and Type	Method	Description
static void	closeFile(PrintWriter writer)
static String	fileNameFor(String service)
Set<Doclet.Option>	getSupportedOptions()
PrintWriter	openFile(String fileName, String title)
boolean	run(DocletEnvironment docEnv)
void	setDestinationDir(String destinationDir)
void	setJsonOutputFile(String jsonOutputFile)
void	setProductName(String productName)
void	setShowJsonSupport(String showJsonSupport)

Methods inherited from class jdk.javadoc.doclet.StandardDoclet

getLocale, getName, getReporter, getSupportedSourceVersion, init

Methods inherited from class java.lang.Object

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

Constructor Details

RestDoclet

public RestDoclet()

Method Details

getSupportedOptions

public Set<Doclet.Option> getSupportedOptions()

Specified by:

getSupportedOptions in interface Doclet

Overrides:

getSupportedOptions in class StandardDoclet

run

public boolean run(DocletEnvironment docEnv)

Specified by:

run in interface Doclet

Overrides:

run in class StandardDoclet

fileNameFor

public static String fileNameFor(String service)

openFile

public PrintWriter openFile(String fileName,
 String title)

closeFile

public static void closeFile(PrintWriter writer)

setDestinationDir

public void setDestinationDir(String destinationDir)

setShowJsonSupport

public void setShowJsonSupport(String showJsonSupport)

setProductName

public void setProductName(String productName)

setJsonOutputFile

public void setJsonOutputFile(String jsonOutputFile)