0.8.3

Breaking

• None.

Enhancements

• Generate Swift declaration for more Objective-C declarations.
  Zheng Li

• Improve quality & accuracy of Swift interfaces for Objective-C declarations
  when generating Objective-C docs.
  Norio Nomura

• Process Swift 3.2/4 doc comments.
  John Fairhurst

Bug Fixes

• Fix missing doc comments on some extensions.
  John Fairhurst
  #454

• Fix failure when attempting to download documentation coverage badge with
  jazzy using macOS system Ruby, or a Ruby built with outdated versions of
  OpenSSL.
  JP Simard
  #824

• Stop --skip-undocumented from skipping documented items nested
  inside extensions of types from other modules.
  John Fairhurst
  #502

• Fix members added to extensions of a nested type showing up in the parent.
  John Fairhurst
  #333

0.8.2

Breaking

• None.

Enhancements

• Report number of included and skipped declarations in CLI output.
  John Fairhurst
  #238

• Build ObjC docs with clang modules enabled by default (-fmodules flag).
  Maksym Grebenets
  #636

• Shave ~1MB from jazzy's gem distribution.
  JP Simard

Bug Fixes

• Fix support for Ruby 2.2.
  John Fairhurst
  #801

• Fix many cases of incorrect, missing or superfluous docs on Swift
  declarations.
  John Fairhurst

0.8.1

Breaking

• None.

Enhancements

• Allow all markdown in returns and parameter description callouts.
  John Fairhurst
  #476

Bug Fixes

• Fix a crash that occurred when a documentation comment ended with an extended
  grapheme cluster.
  Lukas Stührk
  #794
  SourceKitten#350

0.8.0

Breaking

• undocumented.json is now only in the output directory and is no longer
  copied into docsets.
  Jeremy David Giesbrecht
  #754

Enhancements

• Add --[no-]download-badge flag to skip downloading the documentation
  coverage badge from shields.io. Useful if generating docs offline.
  JP Simard
  #765

Bug Fixes

• Blank line no longer needed before lists or code blocks.
  John Fairhurst
  #546

• Linking to headers in apple theme gives correct vertical alignment.
  John Fairhurst

• Headers in source code markdown no longer cause corruption.
  John Fairhurst
  #628

0.7.5

A few important Ruby version fixes if you're using 2.0 or 2.4, as well as an old Objective-C bug if you were documenting a framework with nested headers.

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix issue where using a custom theme would crash jazzy when using Ruby 2.4.
  Jason Wray
  #752

• Fix support for Ruby 2.0.0.
  Jason Wray
  #747

• Fix issue where header files are not found if inside subdirectories of the
  framework_root specified folder.
  Christopher Gretzki
  #518

0.7.4

The fullwidth theme now comes with search functionality! Big thanks to our friends at PSPDFKit and Mapbox for contributing to this!

Lots of other great enhancements and bug fixes. Enjoy! 🥃

Breaking

• None.

Enhancements

• Generate shields.io badge for documentation coverage, unless
  hide_documentation_coverage is set.
  Harlan Haskins
  #723
• Add support for searching docs when using the fullwidth theme. A new option,
  --disable-search, lets you turn this off.
  Esad Hajdarevic
  Tom MacWright
  Nadia Barbosa
  #14
• New config option use_safe_filenames encodes unsafe characters when
  generating filenames. By default, documentation may receive filenames like
  /(_:_:).html. With use_safe_filenames, the same file will receive the name
  _2F_28_5F_3A_5F_3A_29.html instead.
  Jeremy David Giesbrecht
  #699
  #146
  #361
  #547
• References to Objective-C methods are now autolinked.
  Minh Nguyễn
  #362
• Print documentation coverage percentage and the number of undocumented
  methods to the command line when running jazzy.
  Jason Wray

Bug Fixes

• Fix issue where existing abstracts for non custom sections would be completely
  overwritten when using extra abstract injection with --abstract.
  Thibaud Robelain
  #600
• Fix issue where generic type parameters registered as undocumented symbols.
  Jeremy David Giesbrecht
  #429
• Fix issue where parameter and return callouts were duplicated in documentation.
  Jeremy David Giesbrecht
  #673
• Fix issue where Objective-C superclass in declaration was unlinked.
  Minh Nguyễn
  #706
• Fix issue where multiple Objective-C categories of the same external class
  in different files were merged into one and named after the first category
  found.
  Minh Nguyễn
  #539
• String literals in code listings are no longer wrapped in <q> tags (apple
  and fullwidth themes only).
  Minh Nguyễn
  #714
• Fix issue where passing a --podspec argument would use a malformed
  SWIFT_VERSION value, causing compilation to fail.
  JP Simard

0.7.3

Breaking

• None.

Enhancements

• Podspec-based documentation will take trunk's pushed_with_swift_version
  attribute into account when generating documentation by default.
  Orta Therox
• Podspec-based documentation respects the swift-version config option.
  Orta Therox

Enhancements

• Support Objective-C class properties.
  Jérémie Girault
  JP Simard
• Support documenting Swift 3 operator precedence groups.
  JP Simard

Bug Fixes

• Rename Dash typedef type from "Alias" to "Type".
  Bogdan Popescu
• Fix crash when sorting multiple identically named declarations with no USR,
  which is very common when generating docs for podspecs supporting multiple
  platforms.
  JP Simard
  #661
• Fix Xcode not being found when specifying a custom Swift version
  (--swift-version).
  Samuel Giddins
  Paul Cantrell
  #656
• Fix crash when generating Objective-C docs for projects with "@" directives in
  documentation comments with Xcode 8.1 or later.
  Jérémie Girault

0.7.2: More Public Than Public

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Declarations marked @available(..., unavailable, ...) are no longer
  documented.
  JP Simard
  #654
• Treat the open ACL as more public than public.
  JP Simard

0.7.1: Xcode 8 Support

Breaking

• None.

Enhancements

• Added support for the new access control specifiers of fileprivate and open.
  Shmuel Kallner
  #645
  #646

Bug Fixes

• Fix issue where jazzy could not be installed from Gemfile due to
  SourceKitten symlinks already being present.
  William Meleyal
  #438
• The lint report in undocumented.json is more human-readable: includes fully
  qualified symbol names, pretty printed.
  Paul Cantrell
  #598
• The exclude option now properly supports wildcards.
  Paul Cantrell
  #640

0.7.0: Autolink Improvements

Breaking

• The docset_platform option is no longer available. The module name will
  now be used instead of jazzy.
  JP Simard
  #423

Enhancements

• Improved auto-linking behavior to link declarations within declarations and
  fix cases where declarations would link to themselves or their current page.
  Esad Hajdarevic
  #483

Bug Fixes

• Fix issue where single-line declaration + bodies in Swift would include the
  body in the parsed declaration.
  JP Simard
  #226
• Fix issue where some sections would become empty when using custom groups.
  JP Simard
  #475
• Fix issue where directories ending with .swift would be considered Swift
  source files.
  JP Simard
  #586