Class JSDoc::JSDocTag

A JSDoc tag such as @param Object options An object literal with options.

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

documentsSimpleName

Holds if this tag documents a simple name (as opposed to a name path).

getDescription

Gets the description associated with the tag.

getIndex

Gets the index of this tag within its parent comment.

getJSDocComment
getName

Gets the (optional) name associated with the tag, such as the name of the documented parameter for a @param tag.

getParent

Gets the JSDoc comment this tag belongs to.

getTitle

Gets the tag title; for instance, the title of a @param tag is "param".

getTopLevel

Gets the toplevel in which this tag appears.

getType

Gets the (optional) type associated with the tag, such as the type of the documented parameter for a @param tag.

toString

Gets a textual representation of this element.

Inherited predicates

getEndLine

Gets the line on which this element ends.

from Locatable
getFile

Gets the file this program element comes from.

from Locatable
getLocation

Gets this element’s location.

from JSDocTypeExprParent
getNumLines

Gets the number of lines covered by this element.

from Locatable
getStartLine

Gets the line on which this element starts.

from Locatable