Changelog History
Page 4
-
v0.7.4 Changes
๐ฅ 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 #14New config option
use_safe_filenames
encodes unsafe characters when generating filenames. By default, documentation may receive filenames like/(_:_:).html
. Withuse_safe_filenames
, the same file will receive the name_2F_28_5F_3A_5F_3A_29.html
instead.
Jeremy David Giesbrecht #699 #146 #361 #547References 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 #539String literals in code listings are no longer wrapped in
<q>
tags (apple
andfullwidth
themes only).
Minh Nguyแป n #714๐ Fix issue where passing a
--podspec
argument would use a malformedSWIFT_VERSION
value, causing compilation to fail.
JP Simard
-
v0.7.3 Changes
๐ฅ 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
-
v0.7.1 Changes
๐ฅ 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
-
v0.7.0 Changes
๐ฅ Breaking
- ๐ The
docset_platform
option is no longer available. The module name will now be used instead ofjazzy
.
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
- ๐ The
-
v0.6.3 Changes
๐ฅ Breaking
- None.
โจ Enhancements
๐
--exclude
flag now supports excluding directories in addition to files.
Gurrinder #503โก๏ธ The
cocoapods
gem was updated to 1.0.1 androuge
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 #435Section headings can now include additional markdown content using the
--abstract
option.
Karl Bowden #435If 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
-
v0.6.1 Changes
๐ฅ Breaking
- None.
โจ Enhancements
๐ Objective-C documentation now also includes Swift declarations.
JP Simard #1360๏ธโฃ 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 #543No longer document Swift extensions on types with an ACL lower than
min-acl
when they containMARK
s.
JP Simard #544
-
v0.6.0 Changes
๐ฅ 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 withjazzy --help config
.
Paul CantrellJazzy'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 Verkoeyen0๏ธโฃ
--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
associatedtype
s 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
-
v0.5.0 Changes
๐ฅ Breaking
0๏ธโฃ
--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