A C F G I L O P R S U V W
All Classes All Packages

A

add(String) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

asReference(Type) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

asText(Tag[]) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

asText(Type) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

C

check(String) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

closeFile(PrintWriter) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

com.xebialabs.gradle.documentation.restdoc.doclet - package com.xebialabs.gradle.documentation.restdoc.doclet

copy(File) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

F

file(File) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

FileCatalog - Class in com.xebialabs.gradle.documentation.restdoc.doclet

Maintains a list of files referenced from the documentation.

FileCatalog() - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

fileNameFor(Type) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

fileNameFor(String) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

firstWord(Tag) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

fromClasspath(String) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

G

getAnnotationValue(ProgramElementDoc, String) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestServiceWriter

getDeprecatedTags(Doc) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

getItems() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

getMissing() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

getName() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

getParametrizedTypes(Type) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

getTags(Doc) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

I

isResource(String) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

L

languageVersion() - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

Needed by Javadoc engine to provide generic type information.

O

openFile(String, String) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

openStream() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

optionLength(String) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

Needed by Javadoc engine.

OverviewWriter - Class in com.xebialabs.gradle.documentation.restdoc.doclet

Generates the summary page.

OverviewWriter(PrintWriter, String) - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.OverviewWriter

P

PageTemplate - Class in com.xebialabs.gradle.documentation.restdoc.doclet

Provides header and footer for generated files.

PageTemplate(PrintWriter) - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.PageTemplate

R

renderType(Type) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

Resource - Class in com.xebialabs.gradle.documentation.restdoc.doclet

Utility class for working with files and class path resources.

Resource() - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

RestDoclet - Class in com.xebialabs.gradle.documentation.restdoc.doclet

Doclet implementation for generating REST documentation.

RestDoclet() - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

RestdocWriter - Class in com.xebialabs.gradle.documentation.restdoc.doclet

HtmlWriter with convenience methods for writing REST documentation.

RestdocWriter(PrintWriter) - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

restOfSentence(Tag) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

RestServiceWriter - Class in com.xebialabs.gradle.documentation.restdoc.doclet

Writes a documentation page for a single service class.

RestServiceWriter(PrintWriter, ClassDoc, boolean) - Constructor for class com.xebialabs.gradle.documentation.restdoc.doclet.RestServiceWriter

Creates a new writer.

S

SINGLETON - Static variable in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

start(RootDoc) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

Main entry point for Javadoc.

U

unzip(File) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

V

validOptions(String[][], DocErrorReporter) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestDoclet

Needed by Javadoc engine.

W

write(PrintWriter) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.Resource

write(String, PrintWriter) - Static method in class com.xebialabs.gradle.documentation.restdoc.doclet.FileCatalog

write(List<ClassDoc>) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.OverviewWriter

writeFooter() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.PageTemplate

writeHeader() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.OverviewWriter

writeHeader(String) - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.PageTemplate

writeRestService() - Method in class com.xebialabs.gradle.documentation.restdoc.doclet.RestServiceWriter

Writes the entire page.

A C F G I L O P R S U V W
All Classes All Packages