Как мне JSDoc Методы Вложенного Объекта?
Я пытался использовать JSDoc3 для создания документации по файлу, но у меня возникли некоторые трудности. Файл (который является модулем Require.js) в основном выглядит так:
define([], function() {
/*
* @exports mystuff/foo
*/
var foo = {
/**
* @member
*/
bar: {
/**
* @method
*/
baz: function() { /*...*/ }
}
};
return foo;
}
Проблема в том, что я не могу получитьbaz
отображаться в сгенерированной документации. Вместо этого я просто получаю файл документации дляfoo/foo
модуль, который перечисляетbar
член, ноbar
не имеетbaz
(просто ссылка наfoo
исходный код).
Я пытался изменитьbar
Директива@property
вместо этого, и я попытался изменитьbaz
Директива@member
или же@property
, но ничего из этого не помогает. Неважно, что я делаю, Баз просто не хочет появляться.
Кто-нибудь знает, какую структуру директив я мог бы использовать, чтобы baz появился в сгенерированной документации?
Постскриптум Я пытался читать такие страницы на сайте JSDochttp://usejsdoc.org/howto-commonjs-modules.html, но он описывает только случаиfoo.bar
неfoo.bar.baz
.