Contents

## jazzy <sup>♪♫</sup>
**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][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.

### Requirements

Jazzy requires [Xcode 6 Beta](https://developer.apple.com/xcode/) to run.

### Installing

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

### Usage

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

### Front-End TODO

- 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

### Parsing TODO

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

### Design Goals

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](http://mustache.github.io))
- Leverage the power and accuracy of the [Clang AST][ast]
- Compatibility with [appldoc](https://github.com/tomaz/appledoc) when possible

### License

This project is under the MIT license.

[ast]: http://clang.llvm.org/docs/IntroductionToTheClangAST.html  "Introduction To The Clang AST"

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jazzy-0.0.3	README.md