Class Javadoc.TagArgument

    • Constructor Detail

      • TagArgument

        public TagArgument()
        Sole constructor.
    • Method Detail

      • setName

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

        public void setScope​(java.lang.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.
        Parameters:
        verboseScope - The scope of the tag. Must not be null, should not be empty.
        Throws:
        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.
        Parameters:
        enabled - Whether or not this tag is enabled.
      • getParameter

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