Interface CtJavaDoc

    • Method Detail

      • getTags

        java.util.List<CtJavaDocTag> getTags()
        Get all the tag of the javadoc
        Returns:
        the tag list
      • setTags

        <E extends CtJavaDoc> E setTags​(java.util.List<CtJavaDocTag> tags)
        Define the list of tags
        Parameters:
        tags - the new list of tags
      • addTag

        <E extends CtJavaDoc> E addTag​(CtJavaDocTag tag)
        Add a new tag at the end of the list
        Parameters:
        tag - the new tag
      • addTag

        <E extends CtJavaDoc> E addTag​(int index,
                                       CtJavaDocTag tag)
        Add a new tag at the index position
        Parameters:
        index - the index of the new tag
        tag - the new tag
      • removeTag

        <E extends CtJavaDoc> E removeTag​(int index)
        Remove a tag from the index
        Parameters:
        index - the position of the tag to remove
      • removeTag

        <E extends CtJavaDoc> E removeTag​(CtJavaDocTag tag)
        Remove a specific tag
        Parameters:
        tag - the tag to remove
      • getShortDescription

        java.lang.String getShortDescription()
        Get the short summary of the javadoc (first sentence of the javadoc)
        Returns:
        the summary of the javadoc
      • getLongDescription

        java.lang.String getLongDescription()
        Get the long description of the javadoc
        Returns:
        the long description of the javadoc
      • getJavadocElements

        java.util.List<JavadocDescriptionElement> getJavadocElements()
        Returns the list of parsed Javadoc elements