Class JSDocTag
A JSDoc tag.
Examples:
@param {Object=} options An object literal with options.
@return {!Server}
Import path
import javascript
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 | Gets the JSDoc comment to which this element belongs. |
getName | Gets the (optional) name associated with the tag, such as the name of the documented parameter for a |
getParent | Gets the JSDoc comment this tag belongs to. |
getTitle | Gets the tag title; for instance, the title of a |
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 |
toString | Gets a textual representation of this element. |
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 |
getLocation | Gets this element’s location. | from Locatable |
getNumLines | Gets the number of lines covered by this element. | from Locatable |
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 |