Module JSDoc
Provides classes for working with JSDoc comments.
Import path
import semmle.javascript.JSDoc
Imports
javascript |
Provides classes for working with JavaScript programs, as well as JSON, YAML and HTML. |
Classes
Documentable |
A program element that can have a JSDoc comment. |
JSDoc |
A JSDoc comment. |
JSDocAnyTypeExpr |
An |
JSDocAppliedTypeExpr |
An applied type expression. |
JSDocArrayTypeExpr |
An array type expression. |
JSDocError |
An error encountered while parsing a JSDoc comment. |
JSDocFunctionTypeExpr |
A function type expression. |
JSDocNamedTypeExpr |
A type expression referring to a named type. |
JSDocNonNullableTypeExpr |
A non-nullable type expression. |
JSDocNullTypeExpr |
A null type expression. |
JSDocNullableTypeExpr |
A nullable type expression. |
JSDocOptionalParameterTypeExpr |
An optional parameter type. |
JSDocParamTag |
A |
JSDocRecordTypeExpr |
A record type expression. |
JSDocRestParameterTypeExpr |
A rest parameter type. |
JSDocTag |
A JSDoc tag. |
JSDocTypeExpr |
A JSDoc type expression. |
JSDocTypeExprParent |
A syntactic element that a JSDoc type expression may be nested in, that is, either a JSDoc tag or another JSDoc type expression. |
JSDocUndefinedTypeExpr |
A type expression representing the type of |
JSDocUnionTypeExpr |
A union type expression. |
JSDocUnknownTypeExpr |
A type expression representing an unknown type. |
JSDocVoidTypeExpr |
A type expression representing the void type. |