Class JSDoc::Documentable

A program element that can have a JSDoc comment.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getDocumentation

Gets the JSDoc comment for this element, if any.

Inherited predicates

getAChild

Gets a child node of this node.

from ASTNode
getAChildExpr

Gets a child expression of this node.

from ASTNode
getAChildStmt

Gets a child statement of this node.

from ASTNode
getAToken

Gets a token belonging to this element.

from ASTNode
getChild

Gets the ith child node of this node.

from ASTNode
getChildExpr

Gets the ith child expression of this node.

from ASTNode
getChildStmt

Gets the ith child statement of this node.

from ASTNode
getChildTypeExpr

Gets the ith child type expression of this node.

from ASTNode
getEndLine

Gets the line on which this element ends.

from Locatable
getFile

Gets the file this program element comes from.

from Locatable
getFirstControlFlowNode

Gets the first control flow node belonging to this syntactic entity.

from ASTNode
getFirstToken

Gets the first token belonging to this element.

from ASTNode
getLastToken

Gets the last token belonging to this element.

from ASTNode
getLocation

Gets this element’s location.

from ASTNode
getNumChild

Gets the number of child nodes of this node.

from ASTNode
getNumChildExpr

Gets the number of child expressions of this node.

from ASTNode
getNumChildStmt

Gets the number of child statements of this node.

from ASTNode
getNumLines

Gets the number of lines covered by this element.

from Locatable
getParent

Gets the parent node of this node, if any.

from ASTNode
getStartLine

Gets the line on which this element starts.

from Locatable
getTopLevel

Gets the toplevel syntactic unit to which this element belongs.

from ASTNode
inExternsFile

Holds if this syntactic entity belongs to an externs file.

from ASTNode
isAmbient

Holds if this is part of an ambient declaration or type annotation in a TypeScript file.

from ASTNode
toString

Gets a textual representation of this element.

from Locatable