Generating HTML docs
Now that you know how to write properly formatted documentation so that it can be used within Xcode’s Quick Help infrastructure, you will likely want to publish this documentation online for consulting later, and encourage people to use your library.
Apple’s toolchain falls short in this matter and there is no official documentation generator that will make it look and feel like Apple’s own docs. However, there is a very popular and healthy project that can take care of it: Jazzy.
Jazzy is an open source project, written in Ruby, whose goal is to generate documentation for Swift and Objective-C.
Jazzy is maintained by Realm and you can find all the documentation, use cases, and more information about the project at ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access