Class JSDocParamTag

A @param tag.

Example:

@param {Object=} options An object literal with options.

Import path

import javascript

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

documentsSimpleName	Holds if this tag documents a simple name (as opposed to a name path).	from JSDocTag
getAPrimaryQlClass	Gets the primary QL class for the Locatable.	from Locatable
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
getJSDocComment	Gets the JSDoc comment to which this element belongs.	from JSDocTag
getLocation	Gets this element’s location.	from Locatable
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
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
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