Newer
Older
JS-Duck
=======
Simple JavaScript Duckumentation generator.
,~~.
( 6 )-_,
(\___ )=='-'
\ . ) )
\ `-' / hjw
~'`~'`~'`~'`~
This duck is not ready yet...
List of @tags to support
------------------------
* @class - OK
* @extends - OK
* @singleton - OK
* @cfg - OK
* @constructor - OK
* @method - OK
* @event - OK
* @param - OK
* @return - OK
* @member
* @static
* @link
* @ignore @hide @private - in JsDuck implementation @ignore and @hide
are considered aliases for @private. (Some usage stats from ExtJS
source: @hide 306 times, @private 199 times, @ignore 11 times.)
* @namespace - Looks useless to me and indeed ExtJS source doesn't use
it at all.
Some links:
* [ext-doc @tags](http://code.google.com/p/ext-doc/wiki/TagSpecification)
* [jsdoc-toolkit @tags](http://code.google.com/p/jsdoc-toolkit/w/list)