What is jazzy?

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

Both Swift and Objective-C projects are supported.

Objective-C support was recently added, so please report any issues you find.

Instead of parsing your source files, jazzy hooks into Clang and SourceKit to use the AST representation of your code and its comments for more accurate results. The output matches the look and feel of Apple’s official reference documentation, post WWDC 2014.

Design Goals

  • Generate source code docs matching Apple’s official reference documentation
  • Support for standard Objective-C and Swift documentation comment syntax
  • Leverage modern HTML templating (Mustache)
  • Leverage the power and accuracy of the Clang AST and SourceKit
  • Support for Dash docsets
  • Support Swift and Objective-C (mixed projects are a work in progress)

Overview

  • Pricing: Free
  • Resource Link: https://github.com/realm/jazzy
  • Resource Maker on Twitter: Realm
  • Mobile Platform Destination: iOS Apps
  • Mobile Platform Support: Native iOS
  • Programming Languages: Ruby