public class DocumentFormatter extends java.lang.Object implements IDocumentFormatter
Modifier and Type | Field and Description |
---|---|
private org.w3c.dom.Document |
m_document
Document used for constructing DOM components.
|
DEFAULT_IMPLEMENTATION
Constructor and Description |
---|
DocumentFormatter()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
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.
|
private final org.w3c.dom.Document m_document
protected org.w3c.dom.Node reformDocSegment(java.lang.String jdoc)
jdoc
- raw JavaDoc textpublic 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 informationnull
if none)public java.util.List getItemDocumentation(IClassItem info)
org.w3c.dom.Node
instances.getItemDocumentation
in interface IDocumentFormatter
info
- item informationnull
if none)