0.6.3: Custom Docs

Breaking

• None.

Enhancements

• --exclude flag now supports excluding directories in addition to files.
  Gurrinder
  #503

• The cocoapods gem was updated to 1.0.1 and rouge to 1.11.0.
  Samuel Giddins
  #568

• Extra markdown documentation can now be included as their own pages in the
  sidebar using the --documentation option and in the generated Dash docset
  as Guides.
  Karl Bowden
  #435

• Section headings can now include additional markdown content using the
  --abstract option.
  Karl Bowden
  #435

• If Swift version is not specified, look for Swift toolchain or clang location
  in the following order:

  • $XCODE_DEFAULT_TOOLCHAIN_OVERRIDE
  • $TOOLCHAIN_DIR
  • xcrun -find swift
  • /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
  • /Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
  • ~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
  • ~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain

  This will be especially useful once jazzy supports generating docs for
  Swift Package Manager modules with a toolchain not tied to an Xcode release.
  JP Simard

Bug Fixes

• Don't document clang-unexposed Objective-C declarations.
  JP Simard
  #573

0.6.2: Nest Egg

This release just comes with one enhancement:

The navigation side bar now includes one level of nested classes, structs, protocols and enums in the navigation bar (#64).

0.6.1: Swift-Colored Glasses

The big news in this release is that Objective-C documentation now includes the equivalent Swift translation! 🎉

Here's a bunch of other enhancements and bug fixes included in this release:

Enhancements

• Objective-C documentation now also includes Swift declarations.
  JP Simard
  #136
• Default to the Xcode version selected in xcode-select if no Swift version is
  specified.
  Samuel Giddins
  #427

Bug Fixes

• Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages.
  Zachary Waldowski
  #524
• Fix crash when using unexposed declarations in Objective-C.
  JP Simard
  #543
• No longer document Swift extensions on types with an ACL lower than min-acl
  when they contain MARKs.
  JP Simard
  #544

0.6.0: Grand Unified Theory

This release helps bring the behavior of Objective-C category documentation in line with its Swift extension counterpart, merging the category interface into the parent type. Thanks @esad!

Along those same lines, @pcantrell aligned the config file keys to match their command line names. Finally, no more confusion!

So the theme for this release is unifying previously divergent behaviors so to speak.

Also Jazzy, though formerly a documentation generator, now has the newfound ability to not generate documentation... . But seriously, this is useful to validate your documentation by just running jazzy as a dry run, or to check the documentation coverage of your library! Thanks @jverkoey!

There are a number of other changes in this release which you'll find in its entirety below:

Breaking

• Config files now use the same option names as the command line. If you are
  using one of the keys that has changed in your .jazzy.yaml, you will receive
  a warning. See the pull request for
  a complete list of changed options. As always, you can get a list of all
  options with jazzy --help config.
  Paul Cantrell
• Jazzy's undocumented.txt has been replaced with undocumented.json. This new
  format includes contextual information that one might use to lint
  documentation in an automated fashion.
  Jeff Verkoeyen
• --swift-version now defaults to 2.2 instead of 2.1.1.
  Tamar Nachmany

Enhancements

• Add --skip-documentation flag. Skips site generation phase. undocumented.json
  is still generated.
  Jeff Verkoeyen
• Merge Objective-C categories into their parent type documentation to match
  Swift behavior.
  Esad Hajdarevic
  #457
• Add support for documenting Swift 2.2 associatedtypes and infix, postfix &
  prefix operators.
  JP Simard

Bug Fixes

• Add support for Objective-C module imports.
  JP Simard
  #452
• Workaround for an apparent SourceKit bug which sometimes caused extensions
  to be merged into the wrong type.
  Paul Cantrell
  #459
  #460

Thanks to our contributors @pcantrell, @jverkoey, @tamarnachmany & @esad for making this release possible!

0.5.0: Now with themes!

Breaking

• --swift-version now defaults to 2.1.1 instead of 2.1.
  Nikita Lutsenko
  #416
• Swift 1.x is no longer supported.
• --templates-directory and --assets-directory have been deprecated in favor
  of --theme. Specify either 'apple' (default), 'fullwidth' or the path to
  your mustache templates and other assets for a custom theme.
  Karl Bowden
  JP Simard
  #130

Enhancements

• Add --sdk [iphone|watch|appletv][os|simulator]|macosx option for Objective-C
  projects.
  Jeff Verkoeyen
• Add --head option to inject custom HTML into <head></head>.
  JP Simard

Bug Fixes

• Fix an issue where extension documentation would use the original type
  documentation block rather than the comment immediately preceding the
  extension.
  JP Simard
  #230
  #313
  #334
• Fix multi-byte documentation issues.
  Norio Nomura
  #403

0.4.1: Wall of Asterisks

Note: this is the last official release of jazzy supporting Swift 1.x.

This release contains:

• better Objective-C support
• more consistent & powerful automatic hyperlinking of declarations
• improvements to the generated HTML/CSS styling & behavior
• lots of bug fixes

Breaking

• None.

Enhancements

• Support "wall of asterisk" documentation comments.
  Jeff Verkoeyen
  #347

• Expanding a token no longer causes the document to 'jump' to the hash.
  Jeff Verkoeyen
  #352

• Autolinking improvements:

  • Autolinks only match ThingsInBackticks, and must match the entire
    string. This prevents spurious matching in prose and sample code.
  • Autolinks supports siblings, ancestors, top-level elements, and
    dot-separated chains starting with any of the above: someProperty,
    SomeType.NestedType.someMethod(_:).
  • New ... wildcard prevents you from having to list all method parameters:
    someMethod(...)

  pcantrell
  #327
  #329
  #359

• Miscellaneous minor font size, weight, and color adjustments.
  Jeff Verkoeyen

• In-page anchors now appear below the header.
  Jeff Verkoeyen

Bug Fixes

• Fix an out-of-bounds exception when generating pragma marks.
  JP Simard
  #370
• Add support for C/C++ struct, field & ivar types.
  JP Simard
  #374
  #387
• Links to source files on GitHub are no longer broken when source_directory
  does not point to the current working directory.
  pcantrell
• When excluded_files is specified in a config file, it is now resolved
  relative to the file (like other options) instead of relative to the working
  directory.
  pcantrell

0.4.0: Long Live Objective-C

Jazzy FINALLY has support for Objective-C projects! 🎉

We'd love to get your feedback, especially if you're having trouble integrating it with your project.

There's a lot of other nice goodies in this release for both Swift and Objective-C. Big thanks to @pcantrell who drastically improved the handling of Swift extensions & support for configuration files.

Breaking

• --swift-version now defaults to 2.1 instead of 2.0.
  JP Simard

Enhancements

• Support for documenting Objective-C projects! 🎉
  Pass --objc, --umbrella-header ... and -framework-root ....
  JP Simard
  #56
• Mentions of top-level declarations in documentation comments are now
  automatically hyperlinked to their reference.
  JP Simard
• Jazzy can now read options from a configuration file. The command line
  provides comprehensive help for available options via jazzy -h config.
  pcantrell
  #310
• Render special list items (e.g. Throws, See, etc.). See
  http://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for
  a complete list.
  JP Simard
  #317
• Support for Swift 2.1.
  JP Simard
• Swift extensions are now merged with their extended type, rendering a note
  to describe extension default implementations and extension methods.
  pcantrell

Bug Fixes

• None.

0.3.2: All the Fixin's

Bug Fixes

• Fixed an issue that prevented building projects with different schema & module
  names.
  JP Simard
  #259
• Hide documentation coverage from header using --hide-documentation-coverage.
  mbogh
  #129
• Print a more informative error when unable to find an Xcode that has the
  requested Swift version.
  Samuel Giddins
• Added missing Swift 2 declaration types.
  JP Simard

0.3.1: Skipped a Beat

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Added missing Swift 2 declaration types.
  JP Simard

0.3.0: Minor Third

Breaking

• --swift-version now defaults to 2.0 instead of 1.2.
  JP Simard

Enhancements

• Now supports Swift 2.0 (previous Swift versions are still supported).
  JP Simard
  Samuel Giddins
• Declarations can now be grouped by custom categories defined in a JSON or YAML
  file passed to --categories.
  pcantrell

Bug Fixes

• "View on GitHub" is now only generated if a GitHub URL is specified.
  mbogh
  #244
• Empty extensions are no longer documented.
  pcantrell
• Undocumented enum cases are now supported (Swift 2 only).
  JP Simard
  #74