swagger-api/swagger-codegen

Documentation generator for JS client?

Open

#2.079 aberto em 9 de fev. de 2016

Ver no GitHub
 (7 comments) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

The generated client code has nice documentation comments, but I haven't been able to produce any good output from it. Is there actually a JS api doc generator that produces any good output from these sources? I've tried ESDoc, JSDoc, and YUIDoc, and all came out with essentially empty output. Is there a magic tool/configuration combo that works?

Guia do colaborador

Direção de pesquisa
Investigue o código do cliente JavaScript gerado pelo swagger codegen e teste vários geradores de documentação como JSDoc, ESDoc e YUIDoc com diferentes opções de configuração. Revise os comentários da issue para quaisquer dicas ou soluções alternativas. Considere usar o TypeDoc se o cliente tiver definições TypeScript, ou explore gerar documentação Markdown diretamente da especificação OpenAPI.
Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
Pesquisa
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60