Friday, 9 August 2013

How to document jQuery widgets with jsdoc-toolkit?

How to document jQuery widgets with jsdoc-toolkit?

/** * @fileOverview * @version 1.0 */
(function($) { "use strict"; $.widget('mynamespace.nameofwidget', {
// foo should show up in the docs
options: {
'foo': 'bar'
},
// public function name and parameters should be documented
myPublic function () {
},
// private function no need to document
_create: function () {
// code here....
},
// private function no need to document
_setOption: function (key, value) {
// code here....
},
});
})(jQuery);

No comments:

Post a Comment