|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jibx.schema.generator.DocumentFormatter
public class DocumentFormatter
Formatter for JavaDoc conversion to XML documentation components.
Field Summary | |
---|---|
private org.w3c.dom.Document |
m_document
Document used for constructing DOM components. |
Fields inherited from interface org.jibx.custom.classes.IDocumentFormatter |
---|
DEFAULT_IMPLEMENTATION |
Constructor Summary | |
---|---|
DocumentFormatter()
Constructor. |
Method Summary | |
---|---|
java.util.List |
docToNodes(java.lang.String jdoc)
Convert JavaDoc text to a list of formatted nodes. |
java.util.List |
getClassDocumentation(IClass info)
Get formatted documentation from class, in the form of a list of org.w3c.dom.Node instances. |
java.util.List |
getItemDocumentation(IClassItem info)
Get formatted documentation from class item, in the form of a list of org.w3c.dom.Node instances. |
protected org.w3c.dom.Node |
reformDocSegment(java.lang.String jdoc)
Reformat a segment of JavaDoc text as either a CDATA section (if it contains embedded HTML tags) or a simple text node. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final org.w3c.dom.Document m_document
Constructor Detail |
---|
public DocumentFormatter()
Method Detail |
---|
protected org.w3c.dom.Node reformDocSegment(java.lang.String jdoc)
jdoc
- raw JavaDoc text
public java.util.List docToNodes(java.lang.String jdoc)
docToNodes
in interface IDocumentFormatter
jdoc
- JavaDoc text (may be null
)
null
)public java.util.List getClassDocumentation(IClass info)
org.w3c.dom.Node
instances.
getClassDocumentation
in interface IDocumentFormatter
info
- class information
null
if none)public java.util.List getItemDocumentation(IClassItem info)
org.w3c.dom.Node
instances.
getItemDocumentation
in interface IDocumentFormatter
info
- item information
null
if none)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |