ESDoc

Tags

@default

Specifies a plain EZMAScript expression assumed as the default value of an item.

@default val

@deprecated

@deprecated Optional message

@event

Indicates that a property is an event handler.

@event

Example usage:

type ButtonProperties = {
    /**
     * @event
     */
    click?: (e: MouseEvent) => void,
};

@example

Attaches an example. If an @example tag contains no code blocks, then it is entirely treated as code.

@example
trace("hi");

@example
Example description.
```
trace("hi")
```

@hidden

Equivalent to @private.

@hidden

@package

Indicates that the ESDoc comment belongs to the file rather than to the item following it.

@package

@param

@param paramName Description

@private

Equivalent to @hidden.

@private

@return

@return Description

@see

@see [Display text](https://google.com)
@see {@link itemReference}

@throws

@throws {RangeError} Optional description

References

Include a link to a EZMAScript declaration anywhere by using {@link ...}.

{@link a.B}
{@link a.B | Display text}