Документация JSDoc и JavaScript singleton

У меня есть синглтон JavaScript, определенный как:

/**
 * A description here
 * @class
 */
com.mydomain.ClassName = (function(){

/**
 * @constructor
 * @lends com.mydomain.ClassName
 */ 
var ClassName = function(){};

/**
 * method description
 * @public
 * @lends com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};

return new ClassName();

})();

Предупреждения не печатаются в подробном режиме (-v), но в документации сообщается только "com.mydomain.ClassName()" с описанием "A description here"... как я могу создать документацию и для методов ClassName?


javascript jsdoc
person daveoncode    schedule 07.09.2012    source источник

Ответы (1)


arrow_upward
7
arrow_downward

Я решил! :)

  /**
 * A description here
 * @class
 */
com.mydomain.ClassName = (function(){

/**
 * @constructor
 * @name com.mydomain.ClassName
 */ 
var ClassName = function(){};

/**
 * method description
 * @public
 * @name com.mydomain.ClassName.method1
*/
ClassName.prototype.method1 = function(){};

return new ClassName();

})();

Я только что заменил @lends на @name!

ОБНОВЛЕНИЕ: правильный подход к получению полной документации следующий:

/**
 * A description here
 * @class
 */
com.mydomain.ClassName = (function(){

var ClassName = function(){};

/**
 * method description
 * @memberOf com.mydomain.ClassName
*/
ClassName.prototype.method1 = function(){};

return new ClassName();

})();
person daveoncode    schedule 07.09.2012