Class JSDoc

A JSDoc comment.

Example:

 /**
  * An example JSDoc comment documenting a constructor function.
  *
  * @constructor
  * @param {Object=} options An object literal with options.
  */

Import path


                                import javascript

Direct supertypes

Indirect supertypes

@locatable

Predicates

getATag	Gets a JSDoc tag within this JSDoc comment.
getATagByTitle	Gets a JSDoc tag within this JSDoc comment with the given title.
getComment	Gets the raw comment this JSDoc comment is an interpretation of.
getDescription	Gets the description text of this JSDoc comment.
getLocation	Gets this element’s location.
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
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