CodeQL library for Java/Kotlin
codeql/java-all 0.9.2-dev (changelog, source)
Search

Class JavadocText

A piece of Javadoc text.

Import path

import java

Direct supertypes

Indirect supertypes

Predicates

getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this element belongs.

getJavadoc

Gets the Javadoc comment that contains this piece of text.

getText

Gets the text itself.

toString

Gets a printable representation of this Javadoc element.

Inherited predicates

getFile

Gets the file associated with this element.

from Top
getIndex

Gets the index of this child element relative to its parent.

from JavadocElement
getLocation

Gets the source location for this element.

from Top
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
getParent

Gets the parent of this Javadoc element.

from JavadocElement
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

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