CodeQL library for Java
Search

Class JavadocTag

A Javadoc block tag. This does not include inline tags.

Import path

import java

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

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

getTagName

Gets the name of this Javadoc tag.

getText

Gets the text associated with this Javadoc tag.

toString

Gets a printable representation of this Javadoc tag.

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
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
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
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
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
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
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
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