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

Class RestServiceWriter

java.lang.Object

com.xebialabs.commons.html.HtmlWriter

com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

com.xebialabs.gradle.documentation.restdoc.doclet.RestServiceWriter

public class RestServiceWriter
extends RestdocWriter

Writes a documentation page for a single service class.

Constructor Summary

Constructors

Constructor	Description
RestServiceWriter(java.io.PrintWriter writer, com.sun.javadoc.ClassDoc service, boolean printJsonContentType)	Creates a new writer.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getAnnotationValue(com.sun.javadoc.ProgramElementDoc element, java.lang.String annotationType)
void	writeRestService()	Writes the entire page.

Methods inherited from class com.xebialabs.gradle.documentation.restdoc.doclet.RestdocWriter

asReference, asText, asText, firstWord, getDeprecatedTags, getParametrizedTypes, getTags, renderType, restOfSentence

Methods inherited from class com.xebialabs.commons.html.HtmlWriter

anchor, body, bold, br, code, definitionList, div, element, getWriter, h1, h2, h3, h4, head, hr, html, img, italic, link, linkCss, p, row, rowHeader, span, table, td, th, title, tr, wrap, write

Methods inherited from class java.lang.Object

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

Constructor Detail

RestServiceWriter

public RestServiceWriter(java.io.PrintWriter writer,
                         com.sun.javadoc.ClassDoc service,
                         boolean printJsonContentType)

Creates a new writer. Use a new instance for each page.

Parameters:

writer - the stream to write to.

service - the javadoc info of the Rest class to be documented.

printJsonContentType -

Method Detail

writeRestService

public void writeRestService()

Writes the entire page.

getAnnotationValue

public static java.lang.String getAnnotationValue(com.sun.javadoc.ProgramElementDoc element,
                                                  java.lang.String annotationType)