Brag how good your Swift frameworks are documented
Framework developers need to ensure to document the public APIs of their frameworks. Ideally you advertise the documentation status in your project's README.
I got the following question because I showed the documentation status in one of my open-source projects (SwiftPlantUML):
Sorry to bother with a question not directly related to the project, but how do you get the percentage on your documentation badge (at the
README.md)? is it generated by jazzy? is it a real calculated value or is it hardcoded? I could not find where it was calculated.
Jazzy automatically generates
undocumented.jsonlisting all types that are undocumented
badge.svgshowing the documentation coverage and perfect to include in your README
- coverage (%) information in the
index.htmlof the generated documentation
If you do not want the status information in the HTML page then you can suppress this with one of two options:
- command-line option
in your project’s configuration file
You can add the generated badge to your README with Markdown. Example below: