Я пытаюсь использовать 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
, но ничто из этого не помогает. Независимо от того, что я делаю, баз просто не хочет появляться.
Кто-нибудь знает, какую структуру директив я могу использовать, чтобы база появилась в сгенерированной документации?
P.S. Я пробовал читать страницы, подобные этому на сайте JSDoc http://usejsdoc.org/howto-commonjs-modules.html, но он описывает только случаи foo.bar
, а не foo.bar.baz
.