Skip to main content

@kind

Syntax​

@kind class|constant|event|external|file|function|member|mixin|module|namespace|typedef

Overview​

@kind overrides the kind that JSDoc infers for a symbol. In most cases you do not need it – JSDoc infers the kind from context. Use @kind when auto-detection is incorrect.

Example​

/**
* @kind constant
*/
var MAX_SIZE = 100;

Valid kinds​

class, constant, event, external, file, function, member, mixin, module, namespace, typedef

See also​