Class Module

java.lang.Object
org.apache.sis.internal.doclet.Taglet
org.apache.sis.internal.doclet.Module
All Implemented Interfaces:
jdk.javadoc.doclet.Taglet

public final class Module extends Taglet
The @module tag. This tag expects no argument.
Since:
0.3
Version:
1.0
  • Nested Class Summary

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

    jdk.javadoc.doclet.Taglet.Location
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructs a @module taglet.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    format(com.sun.source.doctree.DocTree tag, StringBuilder buffer)
    Given a DocTrees representing this custom tag, appends its string representation.
    Set<jdk.javadoc.doclet.Taglet.Location>
    Returns the set of locations in which this taglet may be used.
    Returns the name of this custom tag.
    boolean
    Returns false since @module is not an inline tag.

    Methods inherited from class org.apache.sis.internal.doclet.Taglet

    getCurrentFile, init, printError, printWarning, text, toString

    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

    isBlockTag
  • Constructor Details

    • Module

      public Module()
      Constructs a @module taglet.
  • Method Details

    • getName

      public String getName()
      Returns the name of this custom tag.
      Returns:
      "module".
    • 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
      Overrides:
      getAllowedLocations in class Taglet
      Returns:
      the set of locations in which this taglet may be used.
    • isInlineTag

      public boolean isInlineTag()
      Returns false since @module is not an inline tag.
      Specified by:
      isInlineTag in interface jdk.javadoc.doclet.Taglet
      Overrides:
      isInlineTag in class Taglet
      Returns:
      always false.
    • format

      protected void format(com.sun.source.doctree.DocTree tag, StringBuilder buffer)
      Given a DocTrees representing this custom tag, appends its string representation.
      Specified by:
      format in class Taglet
      Parameters:
      tag - the tag to format.
      buffer - the buffer where to format the tag.