Class JSDoc::JSDocParamTag

A @param tag.

Direct supertypes

Indirect supertypes

Predicates

getDocumentedParameter

Gets the parameter this tag refers to, if it can be determined.

Inherited predicates

documentsSimpleName

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

from JSDocTag
getDescription

Gets the description associated with the tag.

from JSDocTag
getEndLine

Gets the line on which this element ends.

from Locatable
getFile

Gets the file this program element comes from.

from Locatable
getIndex

Gets the index of this tag within its parent comment.

from JSDocTag
getJSDocCommentfrom JSDocTag
getLocation

Gets this element’s location.

from JSDocTypeExprParent
getName

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

from JSDocTag
getNumLines

Gets the number of lines covered by this element.

from Locatable
getParent

Gets the JSDoc comment this tag belongs to.

from JSDocTag
getStartLine

Gets the line on which this element starts.

from Locatable
getTitle

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

from JSDocTag
getTopLevel

Gets the toplevel in which this tag appears.

from JSDocTag
getType

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

from JSDocTag
toString

Gets a textual representation of this element.

from JSDocTag

Charpred