swagger-api/swagger-codegen

Documentation generator for JS client?

開放

#2,079 建立於 2016年2月9日

在 GitHub 查看貢獻者指南
 (7 則留言) (0 個反應) (0 位負責人)HTML (5,474 個分叉)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

倉庫指標

星標
 (12,701 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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?

貢獻者指南

研究方向
研究由 swagger codegen 生成的 JavaScript 客戶端程式碼，並使用不同的配置選項測試各種文件產生器，如 JSDoc、ESDoc 和 YUIDoc。查看 issue 評論以尋找任何提示或解決方案。如果客戶端有 TypeScript 定義，考慮使用 TypeDoc；或者探索直接從 OpenAPI 規格產生 Markdown 文件。
技術棧
javascript
領域
documentation
議題類型
調研
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
JavaScript
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60