A command-line tool that generates Apple-style API documentation for Swift and Objective-C projects.
Jazzy is a command-line utility that generates API documentation for Swift and Objective-C projects. It produces documentation that matches Apple's official reference style by using the Clang AST and SourceKit to parse code structure and comments accurately. It solves the problem of creating professional, consistent documentation for Apple platform developers.
Swift and Objective-C developers working on libraries, frameworks, or apps who need to generate API reference documentation. Particularly useful for open-source projects and teams maintaining public APIs.
Developers choose Jazzy because it produces documentation that looks exactly like Apple's official docs, supports both Swift and Objective-C with high accuracy through AST parsing, and integrates with modern workflows including Swift Package Manager and Dash docsets.
Soulful docs for Swift & Objective-C
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Uses Clang and SourceKit to parse the abstract syntax tree, ensuring precise documentation that reflects code structure accurately, as highlighted in the README for high-quality output.
Generates documentation that visually matches Apple's post-WWDC 2014 reference docs, providing a familiar and professional look for API references.
Works with both Swift and Objective-C, including mixed-language projects, though the README admits this feature has rough edges.
Creates docsets for the Dash documentation browser, enabling offline access and quick reference, with options for customization and web deployment.
Supports LaTeX equations via KaTeX for inline and block math in documentation comments, adding flexibility for technical documentation.
Running on Linux requires manual installation and building of SourceKitten, as noted in the README, making it less straightforward and more error-prone than on macOS.
Documenting mixed Swift/Objective-C projects involves generating separate SourceKitten files and has acknowledged rough edges, adding overhead for developers.
When using symbol graph mode for faster processing, documentation comments are only available for public declarations, and extension presentation may not match source code, reducing detail for internal APIs.
Does not support all Objective-C documentation keywords, only a subset like @param and @return, limiting full HeaderDoc compatibility and potentially missing annotations.