2012-09-07 12 views
5

Tengo un conjunto unitario JavaScript definen como:jsdoc y JavaScript documentación Singleton

/** 
* 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(); 

})(); 

Sin advertencias se imprimen en modo detallado (-v), pero los informes de documentación única "com.mydomain.ClassName()" con "Una descripción aquí" como descripción ... ¿cómo puedo generar documentación para los métodos de ClassName también?

Respuesta

7

¡He resuelto! :)

/** 
* 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(); 

})(); 

Acabo de reemplazar @lends with @name!

ACTUALIZACIÓN: el enfoque correcto con el fin de tener la documentación completa es la siguiente:

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

var ClassName = function(){}; 

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

return new ClassName(); 

})();