Package com.nomagic.reportwizard.tools.doc

Interface Document

All Known Implementing Classes:
DocumentImpl
@OpenApiAll public interface Document
The interface represent to Comment Document.
Since:
Sep 3, 2008

  • Method Summary

    Modifier and Type
    Method
    Description
    Tag
    get(String tagName)
    Return tag of specified kind of this document item.
    String
    getRawComment()
    Return the full unprocessed text of the comment.
    Collection<Tag>
    getTags()
    Return all tags in this document item.
    Collection<Tag>
    getTags(String tagName)
    Return tags of specified kind of this document item.

  • Method Details

    • getRawComment

      String getRawComment()
      Return the full unprocessed text of the comment.
      Returns:
      the full unprocessed text of the comment.

    • getTags

      Collection<Tag> getTags()
      Return all tags in this document item.
      Returns:
      collection of tags in this document item

    • getTags

      Collection<Tag> getTags(String tagName)
      Return tags of specified kind of this document item.
      Parameters:
      tagName - tag name
      Returns:
      collection of tags in this document item

    • get

      Tag get(String tagName)
      Return tag of specified kind of this document item. If tags with same kind found, return the first tag of this kind.
      Parameters:
      tagName - tag name
      Returns:
      tag of specified kind of this document item