CodeQL library for JavaScript/TypeScript
codeql/javascript-all 2.0.2-dev (changelog, source)
Search

Class DocComment

A JSDoc comment.

Example:

 /** a JSDoc comment */
 

Import path

import javascript

Direct supertypes

Indirect supertypes

Inherited predicates

getAPrimaryQlClass

Gets the primary QL class for the Locatable.

from Locatable
getEndLine

Gets the line on which this element ends.

from Locatable
getFile

Gets the file this program element comes from.

from Locatable
getLine

Gets the ith line of comment text.

from Comment
getLocation

Gets this element’s location.

from Locatable
getNextToken

Gets the next token after this comment.

from Comment
getNumLines

Gets the number of lines covered by this element.

from Comment
getPrimaryQlClasses

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

from Locatable
getStartLine

Gets the line on which this element starts.

from Locatable
getText

Gets the text of this comment, not including delimiters.

from Comment
getTopLevel

Gets the toplevel element this comment belongs to.

from Comment
onLines

Holds if this comment spans lines start to end (inclusive) in file f.

from Comment
toString

Gets a textual representation of this element.

from Comment