Project is missing docc documentation #36
Description
I believe that many developers using this SDK will be working in Xcode which has built in integration with the DocC documentation compiler to convert properly commented code, and markdown-based text, into rich documentation that can be viewed in Xcode’s documentation window or hosted on a website.
The code generated by the the Apple OpenAPI Generator automatically adds such comments for free that allows documentation generation for that portion of the SDK, and will stay up to date as the OpenAPI spec evolves.
For users, building and then accessing the documentation is as easy as selecting Product -> Build Documentation from the Xcode menu.
I'd like to propose--and volunteer to get started on--introducing comments to source code, articles, and potentially other artifacts to the project that will allow generation of documentation. I also propose that future code additions contain the proper comments to support documentation generation.
- Apple documentation on this topic is at this URL: https://developer.apple.com/documentation/xcode/writing-documentation
- The Docc open source project used to generate the documentation is at this URL: https://github.com/swiftlang/swift-docc
Interested in hearing if others agree this is a good effort to undertake. Thanks!