AliSoftware / AliSoftware/OHHTTPStubs

API documentation generation using Jazzy

未關閉
#244 6 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
Documentation Enhancement
主要語言
Objective-C
星號
5.1k
分支
597
PR 合併指標
30 天內沒有已合併 PR

描述

### New Issue Checklist

- [x] I have tried with the latest version of OHHTTPStubs
- [x] I have read the [README](https://github.com/AliSoftware/OHHTTPStubs/blob/master/README.md)
- [x] I have read the [Using the right Swift Version of `OHHTTPStubs` for your project](https://github.com/AliSoftware/OHHTTPStubs#using-the-right-swift-version-of-ohhttpstubs-for-your-project) section
- [x] I have searched in the [existing issues](https://github.com/AliSoftware/OHHTTPStubs/issues?utf8=✓&q=is%3Aissue)
- [x] I have read [the OHHTTPStubs wiki](https://github.com/AliSoftware/OHHTTPStubs/wiki) to see if there wasn't a detailed page talking about my issue

### Issue Description

I am wondering if it would be nice to add [`jazzy`](https://github.com/realm/jazzy) to generate the API documentation.
This would:
- **expose the code documentation automatically**, reducing the workload of maintaining the README and the wiki
- **add information about API documentation coverage**: we could then see if the API is fully documented

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。