com.xebialabs.deployit.documentation

Class CiReferenceHtmlWriter

java.lang.Object

com.xebialabs.commons.html.HtmlWriter

com.xebialabs.deployit.documentation.CiReferenceHtmlWriter

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

Html generator for CI documentation.

Constructor Summary

Constructors

Constructor and Description
CiReferenceHtmlWriter(java.io.PrintWriter writer)

Method Summary

Modifier and Type	Method and Description
void	categoryHeader(java.lang.String category)
void	ciDescription(java.lang.String description)
void	ciDetailTitle(com.xebialabs.deployit.plugin.api.reflect.Type type)
void	ciProperties(java.util.Collection<com.xebialabs.deployit.plugin.api.reflect.PropertyDescriptor> properties, java.lang.String category)
void	ciTypeInfo(com.xebialabs.deployit.plugin.api.reflect.Descriptor ci)
void	controlTaskMethod(com.xebialabs.deployit.plugin.api.reflect.MethodDescriptor method, int row)
void	detailsHeader()
void	detailsSeparator()
void	endCiReference()
void	endControlTask()
void	endDocument()
void	endToc()
void	setCis(java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> cis)
void	startCiReference()
void	startControlTask(java.lang.String category)
void	startDocument()
void	startToc()
void	tocEntry(com.xebialabs.deployit.plugin.api.reflect.Descriptor ci, java.lang.String firstSentence, int row)
void	tocHeader()

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

CiReferenceHtmlWriter

public CiReferenceHtmlWriter(java.io.PrintWriter writer)

Method Detail

startCiReference

public void startCiReference()

endCiReference

public void endCiReference()

tocHeader

public void tocHeader()

startToc

public void startToc()

endToc

public void endToc()

tocEntry

public void tocEntry(com.xebialabs.deployit.plugin.api.reflect.Descriptor ci,
                     java.lang.String firstSentence,
                     int row)

detailsHeader

public void detailsHeader()

detailsSeparator

public void detailsSeparator()

ciDescription

public void ciDescription(java.lang.String description)

ciDetailTitle

public void ciDetailTitle(com.xebialabs.deployit.plugin.api.reflect.Type type)

ciTypeInfo

public void ciTypeInfo(com.xebialabs.deployit.plugin.api.reflect.Descriptor ci)

ciProperties

public void ciProperties(java.util.Collection<com.xebialabs.deployit.plugin.api.reflect.PropertyDescriptor> properties,
                         java.lang.String category)

startControlTask

public void startControlTask(java.lang.String category)

endControlTask

public void endControlTask()

controlTaskMethod

public void controlTaskMethod(com.xebialabs.deployit.plugin.api.reflect.MethodDescriptor method,
                              int row)

categoryHeader

public void categoryHeader(java.lang.String category)

setCis

public void setCis(java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> cis)

startDocument

public void startDocument()

endDocument

public void endDocument()