swagger-api/swagger-codegen

Documentation generator for JS client?

Offen

#2.079 geöffnet am 09.02.2016

Auf GitHub ansehenContributor Guide
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

Repository-Metriken

Stars
 (12.701 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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?

Contributor Guide

Research-Richtung
Untersuchen Sie den von swagger codegen generierten JavaScript Client Code und testen Sie verschiedene Dokumentationsgeneratoren wie JSDoc, ESDoc und YUIDoc mit verschiedenen Konfigurationsoptionen. Überprüfen Sie die Issue Kommentare auf Hinweise oder Workarounds. Erwägen Sie die Verwendung von TypeDoc, wenn der Client TypeScript Definitionen hat, oder erkunden Sie die direkte Generierung von Markdown Dokumentation aus der OpenAPI Spezifikation.
Tech Stack
javascript
Domain
documentation
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60