Module JSDoc

Provides classes for working with JSDoc comments.

Import path

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 any type expression *.

JSDocAppliedTypeExpr

An applied type expression such as Array<string>.

JSDocArrayTypeExpr

An array type expression such as [string].

JSDocError

An error encountered while parsing a JSDoc comment.

JSDocFunctionTypeExpr

A function type expression such as function(string): number.

JSDocNamedTypeExpr

A type expression referring to a named type.

JSDocNonNullableTypeExpr

A non-nullable type expression such as !number.

JSDocNullTypeExpr

A null type expression.

JSDocNullableTypeExpr

A nullable type expression such as ?number.

JSDocOptionalParameterTypeExpr

An optional parameter type such as number=.

JSDocParamTag

A @param tag.

JSDocRecordTypeExpr

A record type expression such as { x: number, y: string }.

JSDocRestParameterTypeExpr

A rest parameter type such as string....

JSDocTag

A JSDoc tag such as @param Object options An object literal with options.

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 undefined.

JSDocUnionTypeExpr

A union type expression such as number|string.

JSDocUnknownTypeExpr

A type expression representing an unknown type ?.

JSDocVoidTypeExpr

A type expression representing the void type.