Class Javadoc::Javadoc

A Javadoc comment.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAuthor

Gets the value of the @author tag, if any.

getCommentedElement

Gets the Java code element that is commented by this piece of Javadoc.

getNumberOfLines

Gets the number of lines in this Javadoc comment.

getVersion

Gets the value of the @version tag, if any.

toString

Gets a textual representation of this element.

Inherited predicates

getAChild

Gets a documentation element attached to this parent.

from JavadocParent
getATag

Gets a documentation element with the specified Javadoc tag name.

from JavadocParent
getChild

Gets the child documentation element at the specified (zero-based) position.

from JavadocParent
getFile

Gets the file associated with this element.

from Top
getLocation

Gets the source location for this element.

from Top
getNumChild

Gets the number of documentation elements attached to this parent.

from JavadocParent
getNumberOfCommentLines

Gets the number of comment lines that this element ranges over.

from Top
getNumberOfLinesOfCode

Gets the number of lines of code that this element ranges over.

from Top
getTotalNumberOfLines

Gets the total number of lines that this element ranges over, including lines of code, comment and whitespace-only lines.

from Top
hasLocationInfo

Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see Locations.

from Top