|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.google.caja.parser.quasiliteral.RuleDoclet com.google.caja.parser.quasiliteral.HtmlRuleDoclet
public class HtmlRuleDoclet
Extracts and formats the rules of Caja from DefaultCajaRewriter as a html page output to the given file
Field Summary | |
---|---|
private org.w3c.dom.Element |
body
|
private int |
countRules
|
private static java.lang.String |
HTML_NS
|
private org.w3c.dom.Document |
htmlDocument
|
private org.w3c.dom.Element |
table
|
Fields inherited from class com.google.caja.parser.quasiliteral.RuleDoclet |
---|
rewriter |
Constructor Summary | |
---|---|
HtmlRuleDoclet()
|
Method Summary | |
---|---|
void |
finish(java.io.Writer output)
Initializes the RuleDoclet This method is called before any documentation generation occurs and may be overridden to initialize variables or open files |
void |
generateFooter(java.io.Writer output,
RulesetDescription ruleSet)
Emits a documentation about ruleSet into the header
of the document being written to in output |
void |
generateHeader(java.io.Writer output,
RulesetDescription ruleSet)
Emits a documentation about ruleSet into the header
of the document being written to in output |
void |
generateRuleDocumentation(java.io.Writer output,
RuleDescription anno)
Emits a documentation describing rule to output |
java.lang.String |
getDefaultExtension()
Returns the default file extension for the format output by this doclet. |
private org.w3c.dom.Element |
headerRow(java.lang.String... cells)
|
void |
initialize(java.io.Writer output)
Initializes the RuleDoclet This method is called before any documentation generation occurs and may be overridden to initialize variables or open files |
private org.w3c.dom.Element |
row(java.lang.String... cells)
|
Methods inherited from class com.google.caja.parser.quasiliteral.RuleDoclet |
---|
generateDocumentation, setRewriter |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private org.w3c.dom.Document htmlDocument
private org.w3c.dom.Element body
private org.w3c.dom.Element table
private int countRules
private static final java.lang.String HTML_NS
Constructor Detail |
---|
public HtmlRuleDoclet()
Method Detail |
---|
public java.lang.String getDefaultExtension()
RuleDoclet
getDefaultExtension
in class RuleDoclet
public void initialize(java.io.Writer output)
RuleDoclet
initialize
in class RuleDoclet
output
- a stream to which documentation can be written.private org.w3c.dom.Element headerRow(java.lang.String... cells)
private org.w3c.dom.Element row(java.lang.String... cells)
public void generateHeader(java.io.Writer output, RulesetDescription ruleSet)
RuleDoclet
ruleSet
into the header
of the document being written to in output
generateHeader
in class RuleDoclet
public void generateFooter(java.io.Writer output, RulesetDescription ruleSet)
RuleDoclet
ruleSet
into the header
of the document being written to in output
generateFooter
in class RuleDoclet
public void finish(java.io.Writer output)
RuleDoclet
finish
in class RuleDoclet
output
- a stream to which documentation can be written.public void generateRuleDocumentation(java.io.Writer output, RuleDescription anno)
RuleDoclet
rule
to output
generateRuleDocumentation
in class RuleDoclet
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |