Closed
Description
This issue tracks adding support for all of the documented Google Closure Compiler annotations.
Tags
-
@const
-
@constructor
-
@define
-
@deprecated
-
@dict
-
@enum
-
@export
-
@extends
-
@externs
-
@fileoverview
-
@final
-
@implements
(@implements (Interfaces) #375) -
@implicitCast
-
@inheritDoc
(@inheritDoc and @override tags support. #53) -
@interface
(@implements (Interfaces) #375) -
@lends
-
@license
-
@modifies
-
@noalias
-
@nocollapse
-
@nocompile
-
@nosideeffects
-
@override
(@inheritDoc and @override tags support. #53) -
@package
(add support for @package access #962) -
@param
-
@polymer
-
@polymerBehavior
-
@preserve
(synonym for@license
) -
@private
(needs to accept a type) (In the Closure dictionary, make the 'private' tag more flexible #730) -
@protected
(needs to accept a type) (For Closure, the 'protected' tag should accept a type #731) -
@public
-
@record
(partial synonym for@interface
; see Structural Interfaces in Closure Compiler for details) -
@return
-
@struct
-
@suppress
-
@template
(Support Closure Compiler generic types #567) -
@this
(implemented, but with different semantics) -
@throws
-
@type
(needs to accept a description) (For Closure, allow the 'type' tag to have a description #732) -
@typedef
(implemented, but with different semantics) -
@unrestricted
Other annotation
- Inline docs for function arguments (Inline Docs for function arguments (jsdoc2.4 backward compatibility) #473)
- Generic types (Support Closure Compiler generic types #567)
Miscellaneous
-
Run JSDoc on Closure Library with 0 warnings -
Generate useful documentation by running JSDoc on Closure Library