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

Class RestDocWriter

java.lang.Object

com.xebialabs.commons.html.HtmlWriter

com.xebialabs.gradle.documentation.restdoc.doclet.RestDocWriter

Direct Known Subclasses:

OverviewWriter, RestServiceWriter

public class RestDocWriter
extends com.xebialabs.commons.html.HtmlWriter

HtmlWriter with convenience methods for writing REST documentation.

Constructor Summary

Constructors

Constructor	Description
RestDocWriter(PrintWriter writer)

Method Summary

Modifier and Type	Method	Description
protected String	asReference(TypeMirror typeMirror)
protected String	asText(List<? extends DocTree> docTreeList)
protected String	asText(TypeMirror typeMirror)
protected void	checkAndAppendLink(DocTree docTree, StringBuilder builder)
static String	firstWord(String sentence)
protected List<DocTree>	getDeprecatedTags(Element service)
protected List<DocTree>	getDocTree(Element element)
protected List<DocTree>	getEntireComment(Element element)
protected List<DocTree>	getHeadersTags(Element service)
List<TypeMirror>	getParametrizedTypes(TypeMirror typeMirror)
protected List<DocTree>	getParamTags(Element service)
protected List<? extends DocTree>	getPermissionTags(Element service)
protected List<DocTree>	getRestDetailsTags(Element service)
protected List<DocTree>	getReturnTags(Element service)
protected List<DocTree>	getSeeTags(Element service)
protected Object	renderType(TypeMirror typeMirror)

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 Details

RestDocWriter

public RestDocWriter(PrintWriter writer)

Method Details

asText

protected String asText(List<? extends DocTree> docTreeList)

checkAndAppendLink

protected void checkAndAppendLink(DocTree docTree,
 StringBuilder builder)

asText

protected String asText(TypeMirror typeMirror)

firstWord

public static String firstWord(String sentence)

asReference

protected String asReference(TypeMirror typeMirror)

getParametrizedTypes

public List<TypeMirror> getParametrizedTypes(TypeMirror typeMirror)

renderType

protected Object renderType(TypeMirror typeMirror)

getDeprecatedTags

protected List<DocTree> getDeprecatedTags(Element service)

getRestDetailsTags

protected List<DocTree> getRestDetailsTags(Element service)

getPermissionTags

protected List<? extends DocTree> getPermissionTags(Element service)

getHeadersTags

protected List<DocTree> getHeadersTags(Element service)

getReturnTags

protected List<DocTree> getReturnTags(Element service)

getSeeTags

protected List<DocTree> getSeeTags(Element service)

getParamTags

protected List<DocTree> getParamTags(Element service)

getDocTree

protected List<DocTree> getDocTree(Element element)

getEntireComment

protected List<DocTree> getEntireComment(Element element)