Interface CtJavaDocTag

All Superinterfaces:
Cloneable, CtElement, CtQueryable, CtVisitable, FactoryAccessor, Serializable, SourcePositionHolder
All Known Implementing Classes:

public interface CtJavaDocTag extends CtElement
This code element defines a javadoc tag Example:
name description
  • Field Details

  • Method Details

    • getType

      The type of the tag
      the type of the tag
    • setType

      <E extends CtJavaDocTag> E setType(String type)
      Define the type of the tag
      type - the type name
    • setType

      <E extends CtJavaDocTag> E setType(CtJavaDocTag.TagType type)
      Define the type of the tag
      type - the new type
    • getRealName

      String getRealName()
      The type of the tag
      the type of the tag
    • setRealName

      <E extends CtJavaDocTag> E setRealName(String realName)
      Define the real name of tag type
      realName - the real name of type
    • getContent

      String getContent()
      Get the content of the atg
      the content of the tag
    • setContent

      <E extends CtJavaDocTag> E setContent(String content)
      Define the content of the tag
      content - the new content of the tag
    • getParam

      String getParam()
      Get the parameter of the tag return null when none is specified (only for @param and @throws)
      the parameter
    • setParam

      <E extends CtJavaDocTag> E setParam(String param)
      Define a parameter
      param - the parameter
    • clone

      CtJavaDocTag clone()
      Description copied from interface: CtElement
      Clone the element which calls this method in a new object. Note that that references are kept as is, and thus, so if you clone whole classes or methods, some parts of the cloned element (eg executable references) may still point to the initial element. In this case, consider using methods Refactoring.copyType(CtType) and Refactoring.copyMethod(CtMethod) instead which does additional work beyond cloning.
      Specified by:
      clone in interface CtElement