0.11.0

Breaking

• None.

Enhancements

• Sass support now provided by libsass via sassc instead of the
  deprecated Ruby Sass gem.
  John Fairhurst

• Update bundled jQuery to 3.4.1 (all themes).
  Paul Idstein

• Support Xcode 11 Swift projects that pass a response file to the Swift
  compiler.
  John Fairhurst
  #1087

• Generate Swift docs from a Swift Package Manager package without
  requiring an Xcode project file. Add --swift-build-tool to choose
  the build method if both .xcodeproj and Package.swift files are
  present. Add --build-tool-flags as a preferred alias for
  --xcodebuild-flags.
  John Fairhurst
  #487

Bug Fixes

• Preserve non-latin characters in guide filenames and heading IDs.
  John Fairhurst
  #1091

• Generate correct html for custom categories containing special
  characters.
  John Fairhurst
  #945

• Fix crash on files with misplaced documentation comments.
  John Fairhurst
  #1083

0.10.0

Breaking

• The included sourcekitten binary is built with Xcode 10.2. This means
  it does not run on macOS earlier than 10.14.4 without the Swift 5 Runtime
  Support for Command Line Tools being installed.
  John Fairhurst

Enhancements

• Support CocoaPods 1.6+. Use the swift_version[s] dsl in --podspec mode
  to set the Swift language version.
  John Fairhurst

• Show the extension declaration when documenting Swift extensions.
  John Fairhurst

• Allow docs title customization. Include --module-version when it is set
  and support --title to fully customize the title. Pass {{module_version}}
  and {{docs_title}} to templates.
  Maximilian Alexander
  John Fairhurst
  #666
  #411

Bug Fixes

• Unfold member documentation when linked to from current web page.
  John Fairhurst
  #788

• Generate docs when there are unusual characters in source pathnames.
  John Fairhurst
  #1049

• Generate docs for signed modules with Xcode 10.2.
  John Fairhurst
  #1057

• Use correct module name when only target name is supplied.
  Chris Zielinski
  #422

0.9.6

This is (probably) the last release to support Ruby earlier than 2.3. This is due to a change in a dependency.

This is (probably) the last release to support macOS earlier than 10.14.4 without the Swift 5 Runtime Support for Command Line Tools package installed. This is a consequence of Swift 5 ABI stability.

Breaking

• None.

Enhancements

• Swift 5 support: suppress unwanted newlines and deinit declarations.
  John Fairhurst

• Update JavaScript libraries: jQuery 3.3.1 (all themes), Lunr 2.3.5,
  typeahead.js 1.2.1 (fullwidth theme only).
  John Fairhurst
  #901

• Avoid clean build when using the new Xcode build system.
  Norio Nomura

Bug Fixes

• None.

0.9.5

Breaking

• None.

Enhancements

• Link to documentation pages from contents pages.
  John Fairhurst
  #730

• Call out unavailable and deprecated Objective-C declarations.
  Stefan Kieleithner
  John Fairhurst
  #843

Bug Fixes

• Support Swift 4.2 with --podspec.
  John Fairhurst
  #1015

• Fix multiline copyright for apple theme.
  Fabien Lydoire
  John Fairhurst
  #1016

0.9.4

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix crash with pre-existing Docs directory.
  John Fairhurst
  #965

• Fix crash with unicode scalars in string literals.
  John Fairhurst
  #972

• Fix error compiling a Swift podspec in Xcode 10.
  Minh Nguyễn
  #970

0.9.3

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix crash when specifying empty Swift version. Now correctly uses the default
  Swift version.
  JP Simard

• Fix jony theme selection.
  John Fairhurst
  #962

0.9.2

Breaking

• None.

Enhancements

• Add a new 'jony' theme similar to the 2017 Apple documentation style.
  Harshil Shah

• Add the ability to limit documentation to certain files by passing in an
  -i/--include argument.
  Nick Fox
  #949

• Improve Swift declarations to look more like the Xcode Quick Help version,
  for example including { get set }, and include all attributes.
  John Fairhurst
  #768
  #591

Bug Fixes

• Preserve MARK comment headings associated with extensions and enum cases.
  John Fairhurst

• Fix issue where Overview items were invalidly being referenced with NULL
  types in the generated Dash docset index.
  Andrew De Ponte

• Don't display FIXME or TODO comments as section markers.
  John Fairhurst
  #658

0.9.1

Breaking

• None.

Enhancements

• Added a config option (--undocumented-text UNDOCUMENTED_TEXT) to set the
  default text for undocumented symbols.
  Akhil Batra
  #913

• Added a config option to hide Objective-C or Swift declarations:
  --hide-declarations [objc|swift].
  Ibrahim Ulukaya
  #828

• Automatically use Swift or Objective-C syntax highlighting for code blocks
  in documentation comments. Improve Swift highlighting with latest Rouge.
  John Fairhurst
  #218

Bug Fixes

• Fix Swift declarations when generating Objective-C docs for generic types.
  John Fairhurst
  #910

• Don't create documentation nodes for generic type parameters.
  John Fairhurst
  #878

0.9.0

Breaking

• Generate documentation coverage badge locally. Since this avoids the failable
  HTTP request to shields.io previously used to obtain the badge, we've removed
  the --[no-]download-badge flag and the corresponding download_badge
  YAML configuration key.
  Samuel Giddins

Enhancements

• None.

Bug Fixes

• Fixed issue that prevented Jazzy from running on case sensitive file systems.
  Jeremy David Giesbrecht
  #891

• Fixed issue preventing --podspec from working with test_specs.
  John Fairhurst
  #894

• Always display correct declaration for undocumented symbols.
  John Fairhurst
  #864

• Trim common indentation in multiline declarations.
  John Fairhurst
  #836

0.8.4

Breaking

• None.

Enhancements

• Align jazzy terminology with Apple usage.
  Xiaodi Wu
  John Fairhurst

• Add url attribute that can be more accurate than {{section}}.html as a URL
  in custom templates.
  John Fairhurst

Bug Fixes

• Fix crash when specifying swift_version as a floating point value in
  .jazzy.yaml rather than a string.
  JP Simard
  #860

• Autolink from parameter documentation and from external markdown documents
  including README. Autolink to symbols containing & < >.
  John Fairhurst
  #715
  #789
  #805

• Fix Swift 4 declarations containing ampersands (&) being truncated.
  JP Simard