Interface IDocumentFormatter

All Known Implementing Classes:
DocumentFormatter

public interface IDocumentFormatter
Formatter interface for JavaDoc conversion to XML documentation components.
  • Field Details

    • DEFAULT_IMPLEMENTATION

      static final String DEFAULT_IMPLEMENTATION
      Default implementation class for interface.
      See Also:
  • Method Details

    • docToNodes

      List docToNodes(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

      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

      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)