Skip to content

Additional jsdoc tags supported

Lloyd Brookes edited this page Aug 10, 2016 · 1 revision

@typicalname

When documenting a class or object, use this tag to specify the variable name it's typically assigned to. The classic example is jQuery is typically assigned to $.

@done

The @todo tag renders as an unchecked checkbox. Use @done to get a checked checkbox.

@category

Used to split up member indexes.

Clone this wiki locally