Resultados da pesquisa a pedido "jsdoc"
Como exibir métodos Javascript em um 'grupo' no JSDOC?
Existe a possibilidade de 'agrupar' funções dentro de uma classe (AMD / RequireJS Module)? Minhas aulas às vezes têm mais de 20 funções que realmente pertencem a uma 'implementação de interface' específica e às vezes precisam ser agrupadas para ...
Qual é a maneira correta de documentar retornos de chamada com o jsdoc?
Passei um bom tempo vasculhando a Internet procurando a melhor maneira de documentar adequadamente os retornos de chamada com o jsdoc, mas, infelizmente, ainda não encontrei um ótimo. Aqui está a minha pergunta: Estou escrevendo uma biblioteca ...
Enum como tipo @param no JSDoc
É possível usar uma enumeração para o JSDoc@param declaração de tipo como no exemplo a seguir? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { }Se eu usar um IDE como ...
JSDoc com AngularJS
Atualmente no meu projeto, estamos usando o JSDoc, começamos a implementar o Angular recentemente e quero continuar usando o JSDoc para garantir que toda a documentação esteja no mesmo local. Dei uma olhada nas pessoas dizendo apenas para usar o ...
Como documentar um dicionário no JSDoc?
Tendo o próximo exemplo:
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 ...
Como você documenta uma matriz de objetos como um parâmetro no JSDoc?
Eu tenho uma matriz que se parece com isso: