Como faço para JSDoc um método de objeto aninhado?
Eu tenho tentado usar o JSDoc3 para gerar documentação em um arquivo, mas estou tendo alguma dificuldade. O arquivo (que é um módulo Require.js) basicamente se parece com isto:
define([], function() {
/*
* @exports mystuff/foo
*/
var foo = {
/**
* @member
*/
bar: {
/**
* @method
*/
baz: function() { /*...*/ }
}
};
return foo;
}
O problema é que não consigobaz
para aparecer na documentação gerada. Em vez disso, acabei de obter um arquivo de documentação para umfoo/foo
módulo, que lista umbar
membro, masbar
não tembaz
(apenas um link parafoo
código fonte).
Eu tentei mudarbar
directiva para@property
em vez disso, e eu tentei mudarbaz
directiva para@member
ou@property
, mas nada disso ajuda. Não importa o que eu faça, baz parece não querer aparecer.
Alguém sabe qual estrutura de diretiva eu poderia usar para fazer com que o baz apareça na documentação gerada?
P.S. Eu tentei ler páginas como esta no site do JSDochttp://usejsdoc.org/howto-commonjs-modules.html, mas apenas descreve casos defoo.bar
, nãofoo.bar.baz
.