Package org.jibx.custom.classes
Interface IDocumentFormatter
- All Known Implementing Classes:
DocumentFormatter
public interface IDocumentFormatter
Formatter interface for JavaDoc conversion to XML documentation components.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiondocToNodes
(String jdoc) Convert JavaDoc text to a list of formatted nodes.getClassDocumentation
(IClass info) Get formatted documentation from class.Get formatted documentation from class item.
-
Field Details
-
DEFAULT_IMPLEMENTATION
Default implementation class for interface.- See Also:
-
-
Method Details
-
docToNodes
Convert JavaDoc text to a list of formatted nodes.- Parameters:
jdoc
- JavaDoc text (may benull
)- Returns:
- formatted representation (may be
null
)
-
getClassDocumentation
Get formatted documentation from class. Implementations must return the documentation components in the form of a list oforg.w3c.dom.Node
instances.- Parameters:
info
- class information- Returns:
- formatted documentation (
null
if none)
-
getItemDocumentation
Get formatted documentation from class item. Implementations must return the documentation components in the form of a list oforg.w3c.dom.Node
instances.- Parameters:
info
- class item information- Returns:
- formatted representation (
null
if none)
-