I have something like this:
/**
Diese Klasse bla bla...
@constructor
**/
my.namespace.ClassA = function(type)
{
/**
This function does something
**/
this.doSomething = function(param){
}
}
The class will get listed in the generated documentation. The function won't. Is there a way to tell JSDoc (3) that this is a member function of the class ClassA
?
Try this!
/**
* Diese Klasse bla bla...
* @constructor
*/
my.namespace.ClassA = function(type)
{
/**
* This function does something
* @function doSomething
* @memberOf my.namespace.ClassA#
*/
this.doSomething = function(param){
};
};
JSDoc seems quite clunky in this area :/ The key is to specify both memberof and the name of the function. See also .
JSDoc needs some additional information to recognize the function as member function:
/**
* Diese Klasse bla bla...
* @constructor
*/
my.namespace.ClassA = function(type)
{
/**
* This function does something
* @function
* @memberOf my.namespace.ClassA
*/
this.doSomething = function(param){
}
}
You need to explicitly describe the function using full namepath. There are 3 types of namepath syntaxes to describe functions:
Person#say // the instance method named "say."
Person.say // the static method named "say."
Person~say // the inner method named "say."
See details in this page .
The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.