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