swagger-api/swagger-codegen

Documentation generator for JS client?

Aperta

#2079 aperta il 9 feb 2016

Vedi su GitHubGuida contributor
 (7 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

Metriche repository

Star
 (12.701 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Analizza il codice client JavaScript generato da swagger codegen e testa vari generatori di documentazione come JSDoc, ESDoc e YUIDoc con diverse opzioni di configurazione. Rivedi i commenti dell'issue per eventuali suggerimenti o soluzioni alternative. Considera l'uso di TypeDoc se il client ha definizioni TypeScript, oppure esplora la generazione diretta di documentazione Markdown dalla specifica OpenAPI.
Tech stack
javascript
Dominio
documentation
Tipo issue
Ricerca
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60