a soulful way to generate docs for Swift & Objective-C

jazzy is a command-line utility that generates documentation for your Swift or Objective-C projects.

Instead of parsing your source files, jazzy hooks into clang and uses the AST representation of your code and its comments for more accurate results.

jazzy’s output matches the look & feel of Apple’s official reference documentation, post WWDC 2014.

Jazzy requires Xcode 6 Beta to run.

To install jazzy, run [sudo] gem install jazzy from your command line.

Run jazzy from your command line. Run jazzy -h for a list of additional options.

• Index generation
• Instance/class method distinction
• Class inheritance, conforms, import, availability
• Syntax Highlighting
• Cross-linking
• Search in page
• Handle availability options
• Inline code examples
• Unit tests
• Lists (unordered/ordered)
• Generate docsets for Dash & Xcode
• Pass in arbitrary Mustache templates

• Swift files
• @name
• @warning
• @see
• Unit tests
• Enum's
• Instance variables

jazzy's main design goals are:

• Generate source code docs matching Apple's official reference documentation
• Support for Xcode and Dash docsets
• High readability of source code comments
• Leverage modern HTML templating (Mustache)
• Leverage the power and accuracy of the Clang AST
• Compatibility with appledoc when possible

This project is under the MIT license.