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

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_IMPLEMENTATION Default implementation class for interface.

Method Summary

Methods

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.
java.util.List	getItemDocumentation(IClassItem info) Get formatted documentation from class item.

Field Detail

DEFAULT_IMPLEMENTATION

static final java.lang.String DEFAULT_IMPLEMENTATION

Default implementation class for interface.

See Also:

Constant Field Values

Method Detail

docToNodes

java.util.List docToNodes(java.lang.String jdoc)

Convert JavaDoc text to a list of formatted nodes.

Parameters:

jdoc - JavaDoc text (may be null)

Returns:

formatted representation (may be null)

getClassDocumentation

java.util.List getClassDocumentation(IClass info)

Get formatted documentation from class. Implementations must return the documentation components in the form of a list of org.w3c.dom.Node instances.

Parameters:

info - class information

Returns:

formatted documentation (null if none)

getItemDocumentation

java.util.List getItemDocumentation(IClassItem info)

Get formatted documentation from class item. Implementations must return the documentation components in the form of a list of org.w3c.dom.Node instances.

Parameters:

info - class item information

Returns:

formatted representation (null if none)