CHANGELOG.md in jazzy-0.6.2 vs CHANGELOG.md in jazzy-0.6.3

- old
+ new

@@ -1,5 +1,53 @@ +## 0.6.3 + +##### Breaking + +* None. + +##### Enhancements + +* `--exclude` flag now supports excluding directories in addition to files. + [Gurrinder](https://github.com/gurrinder) + [#503](https://github.com/realm/jazzy/issues/503) + +* The `cocoapods` gem was updated to 1.0.1 and `rouge` to 1.11.0. + [Samuel Giddins](https://github.com/segiddins) + [#568](https://github.com/realm/jazzy/issues/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](https://github.com/agentk) + [#435](https://github.com/realm/jazzy/issues/435) + +* Section headings can now include additional markdown content using the + `--abstract` option. + [Karl Bowden](https://github.com/agentk) + [#435](https://github.com/realm/jazzy/issues/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](https://github.com/jpsim) + +##### Bug Fixes + +* Don't document clang-unexposed Objective-C declarations. + [JP Simard](https://github.com/jpsim) + [#573](https://github.com/realm/jazzy/issues/573) + ## 0.6.2 ##### Breaking * None. @@ -24,23 +72,26 @@ ##### Enhancements * Objective-C documentation now also includes Swift declarations. [JP Simard](https://github.com/jpsim) [#136](https://github.com/realm/jazzy/issues/136) + * Default to the Xcode version selected in `xcode-select` if no Swift version is specified. [Samuel Giddins](https://github.com/segiddins) [#427](https://github.com/realm/jazzy/issues/427) ##### Bug Fixes * Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages. [Zachary Waldowski](https://github.com/zwaldowski) [#524](https://github.com/realm/jazzy/issues/524) + * Fix crash when using unexposed declarations in Objective-C. [JP Simard](https://github.com/jpsim) [#543](https://github.com/realm/jazzy/issues/543) + * No longer document Swift extensions on types with an ACL lower than `min-acl` when they contain `MARK`s. [JP Simard](https://github.com/jpsim) [#544](https://github.com/realm/jazzy/issues/544) @@ -52,25 +103,29 @@ using one of the keys that has changed in your `.jazzy.yaml`, you will receive a warning. See the [pull request](https://github.com/realm/jazzy/pull/456) for a complete list of changed options. As always, you can get a list of all options with `jazzy --help config`. [Paul Cantrell](https://github.com/pcantrell) + * 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](https://github.com/jverkoey) + * `--swift-version` now defaults to 2.2 instead of 2.1.1. [Tamar Nachmany](https://github.com/tamarnachmany) ##### Enhancements * Add `--skip-documentation` flag. Skips site generation phase. `undocumented.json` is still generated. [Jeff Verkoeyen](https://github.com/jverkoey) + * Merge Objective-C categories into their parent type documentation to match Swift behavior. [Esad Hajdarevic](https://github.com/esad) [#457](https://github.com/realm/jazzy/issues/457) + * Add support for documenting Swift 2.2 `associatedtype`s and infix, postfix & prefix operators. [JP Simard](https://github.com/jpsim) ##### Bug Fixes