JSDoc, документирующие функции, хранящиеся внутри объекта

Question

У меня возникли проблемы с получением функций для показа в JSDoc, когда они хранятся внутри объекта. Итак, у меня есть что-то вроде:

/** 
*/ 
var methods = {}; 

/** 
Get all resources 
*/ 
methods.getResources = function(){ 
    return name; 
} 

Как я могу получить функцию getResources в JSDoc? Я попытался добавить @class к методам без везения.

Answer 1

@namespace и @memberOf должно быть тем, что вы ищете.

/** 
* @namespace methods 
*/ 
var methods = {}; 

/** 
* Get all resources 
* @memberOf methods 
*/ 
methods.getResources = function(){ 
    return name; 
}