[Sugar-devel] [Karma] documenting w/ jsdoc
Bryan Berry
bryan at olenepal.org
Wed Sep 2 23:22:06 EDT 2009
subzero,
I played around with jsdoc this morning and achieved some limited
success
Liberal use of @name, and @memberOf seem to help a lot
I haven't succeeded in fixing all the ignored functions, in large part
because I am still mystified by js's prototypal inheritance.
I hope this helps a bit
http://git.sugarlabs.org/projects/karma/repos/mainline/blobs/master/js/jquery.karma-0.5.js#line42
* @name jQuery
http://git.sugarlabs.org/projects/karma/repos/mainline/blobs/master/js/jquery.karma-0.5.js#line43
* @exports $ as jQuery
http://git.sugarlabs.org/projects/karma/repos/mainline/blobs/master/js/jquery.karma-0.5.js#line81
* @name Karma
http://git.sugarlabs.org/projects/karma/repos/mainline/blobs/master/js/jquery.karma-0.5.js#line313
/** @memberOf Karma **/
--
Bryan W. Berry
Technology Director
OLE Nepal, http://www.olenepal.org
More information about the Sugar-devel
mailing list