Class CtJavaDocImpl

    • Constructor Detail

      • CtJavaDocImpl

        public CtJavaDocImpl()
    • Method Detail

      • getTags

        public java.util.List<CtJavaDocTag> getTags()
        Description copied from interface: CtJavaDoc
        Get all the tag of the javadoc
        Specified by:
        getTags in interface CtJavaDoc
        Returns:
        the tag list
      • setTags

        public <E extends CtJavaDoc> E setTags​(java.util.List<CtJavaDocTag> tags)
        Description copied from interface: CtJavaDoc
        Define the list of tags
        Specified by:
        setTags in interface CtJavaDoc
        Parameters:
        tags - the new list of tags
      • addTag

        public <E extends CtJavaDoc> E addTag​(CtJavaDocTag tag)
        Description copied from interface: CtJavaDoc
        Add a new tag at the end of the list
        Specified by:
        addTag in interface CtJavaDoc
        Parameters:
        tag - the new tag
      • addTag

        public <E extends CtJavaDoc> E addTag​(int index,
                                              CtJavaDocTag tag)
        Description copied from interface: CtJavaDoc
        Add a new tag at the index position
        Specified by:
        addTag in interface CtJavaDoc
        Parameters:
        index - the index of the new tag
        tag - the new tag
      • removeTag

        public <E extends CtJavaDoc> E removeTag​(int index)
        Description copied from interface: CtJavaDoc
        Remove a tag from the index
        Specified by:
        removeTag in interface CtJavaDoc
        Parameters:
        index - the position of the tag to remove
      • getShortDescription

        public java.lang.String getShortDescription()
        Description copied from interface: CtJavaDoc
        Get the short summary of the javadoc (first sentence of the javadoc)
        Specified by:
        getShortDescription in interface CtJavaDoc
        Returns:
        the summary of the javadoc
      • setContent

        public <E extends CtComment> E setContent​(java.lang.String content)
        Parses the content string to split in two: the description and the Javadoc tags
        Specified by:
        setContent in interface CtComment
        Overrides:
        setContent in class CtCommentImpl
      • getLongDescription

        public java.lang.String getLongDescription()
        Description copied from interface: CtJavaDoc
        Get the long description of the javadoc
        Specified by:
        getLongDescription in interface CtJavaDoc
        Returns:
        the long description of the javadoc