Class Javadoc.TagArgument

All Implemented Interfaces:
Cloneable, Iterable<Resource>, ResourceCollection, SelectorContainer
Enclosing class:

public class Javadoc.TagArgument extends FileSet
Class representing a -tag argument.
  • Constructor Details

    • TagArgument

      public TagArgument()
      Sole constructor.
  • Method Details

    • setName

      public void setName(String name)
      Sets the name of the tag.
      name - The name of the tag. Must not be null or empty.
    • setScope

      public void setScope(String verboseScope) throws BuildException
      Sets the scope of the tag. This is in comma-separated form, with each element being one of "all" (the default), "overview", "packages", "types", "constructors", "methods", "fields". The elements are treated in a case-insensitive manner.
      verboseScope - The scope of the tag. Must not be null, should not be empty.
      BuildException - if all is specified along with other elements, if any elements are repeated, if no elements are specified, or if any unrecognised elements are specified.
    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether or not the tag is enabled.
      enabled - Whether or not this tag is enabled.
    • getParameter

      public String getParameter() throws BuildException
      Returns the -tag parameter this argument represented.
      the -tag parameter as a string
      BuildException - if either the name or description is null or empty.