Jazzy is a command-line documentation generator for Swift and Objective-C projects.
Jazzy solves the problem of generating accurate API documentation by leveraging Clang and SourceKit to parse the abstract syntax tree of your code rather than performing naive text parsing. This approach ensures that documentation reflects the actual structure of your codebase. The tool generates output styled to match Apple's official reference documentation, and it can work from either source code or compiled Swift modules via their symbol graphs.
Jazzy suits teams building Swift or Objective-C libraries who want professional-looking API docs without manual formatting. It works with both Xcode and Swift Package Manager projects, and in the simplest case requires only running the command from your project root with no arguments. For more complex setups, you can pass build tool arguments or specify which module to document. The tool supports multiple modules and accepts configuration through a YAML file. Jazzy requires macOS and development tools to build the project being documented.
The project maintains active engagement with its codebase, regularly addressing issues and incorporating improvements. Development shows consistent responsiveness to user-reported problems and feature requests. The maintainers demonstrate commitment to code quality and community standards through adherence to a formal code of conduct.
