Package org.opengis.tools.taglet

Class Note

java.lang.Object
org.opengis.tools.taglet.Note
All Implemented Interfaces:
jdk.javadoc.doclet.Taglet
public final class Note extends Object implements jdk.javadoc.doclet.Taglet
The @note tag for inserting a note in a javadoc comment.
Since:
2.0
Version:
3.0.2

  • Nested Class Summary

    Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet

    jdk.javadoc.doclet.Taglet.Location

  • Constructor Summary

    Constructors
    Constructor
    Description
    Note()
    Constructs a default @note taglet.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<jdk.javadoc.doclet.Taglet.Location>
    getAllowedLocations()
    Returns the set of locations in which this taglet may be used.
    String
    getName()
    Returns the name of this custom tag.
    boolean
    isInlineTag()
    Returns true since @note is an inline tag.
    String
    toString(List<? extends com.sun.source.doctree.DocTree> tags, Element element)
    Given a list of DocTrees representing this custom tag, returns its string representation.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jdk.javadoc.doclet.Taglet

    init, isBlockTag

  • Constructor Details

    • Note

      public Note()
      Constructs a default @note taglet.

  • Method Details

    • getName

      public String getName()
      Returns the name of this custom tag.
      Specified by:
      getName in interface jdk.javadoc.doclet.Taglet
      Returns:
      the tag name.

    • getAllowedLocations

      public Set<jdk.javadoc.doclet.Taglet.Location> getAllowedLocations()
      Returns the set of locations in which this taglet may be used.
      Specified by:
      getAllowedLocations in interface jdk.javadoc.doclet.Taglet
      Returns:
      the set of locations in which this taglet may be used.

    • isInlineTag

      public boolean isInlineTag()
      Returns true since @note is an inline tag.
      Specified by:
      isInlineTag in interface jdk.javadoc.doclet.Taglet
      Returns:
      always true.

    • toString

      public String toString(List<? extends com.sun.source.doctree.DocTree> tags, Element element)
      Given a list of DocTrees representing this custom tag, returns its string representation.
      Specified by:
      toString in interface jdk.javadoc.doclet.Taglet
      Parameters:
      tags - the tags to format.
      element - the element to which the enclosing comment belongs.
      Returns:
      a string representation of the given tags.