javascript - Getting jsdoc and Crockford's design patterns to get along -


i'm using douglas crockford's design pattern implement private, privileged , public methods. looks (using requirejs):

define(function () {     return function () {         var = {},          _init = function () {             // "constructor"         },          _privatefn = function () {             return 42;         };          that.publicfn = function () {             return 2 * _privatefn();         };          _init(arguments);          return that;     }; }); 

however, i'm having trouble getting jsdoc toolkit parse correctly. i've played around @name , @memberof annotations (like here), no matter do, can't functions show up.

does know solution?

okay, figured out. here's how it:

/** * @name mymodule * @namespace */ define(['mymodule'], (function () {     "use strict";      var clazz = function (config) {         var = {},          /**         * @private         * @type number         * @name mymodule#_privatefield         * @field         */         _privatefield = 42,          /**         * returns private field         *          * @private         * @memberof mymodule#         */         _privatefn = function () {             return _privatefield;         };          /**         * uppercases string value.         *          * @public         * @name mymodule#publicfn         * @function         * @param {string} value value uppercase.         */         that.publicfn = function (value) {             return value.touppercase();         };          return that;     }      return clazz; })); 

Comments

Popular posts from this blog

javascript - Enclosure Memory Copies -

php - Replacing tags in braces, even nested tags, with regex -