Changelog History
Page 1
-
v0.14.3 Changes
๐ฅ Breaking
- None.
โจ Enhancements
๐ Support Swift 5.7 and Xcode 14.
John Fairhurstโก๏ธ Update Javascript: jQuery 3.6.1, KaTeX 0.13.5
John Fairhurst
๐ Bug Fixes
- None.
-
v0.14.2 Changes
๐ฅ Breaking
- ๐ When building with Swift 5.6 and not passing
โ-module
to Jazzy, declarations may not be correctly identified as undocumented and docs may include unwanted extensions. Passโ-module MyModuleName
to fix this.
John Fairhurst
โจ Enhancements
๐ Support using pre-generated symbolgraph files in Swift symbolgraph mode.
Nathan Wongโ Issue a warning on some combinations of Objective-C flags.
John Fairhurst #900๐ Support Swift 5.6. The bundled
sourcekitten
is a universal binary.
John Fairhurst
๐ Bug Fixes
- In Swift symbolgraph mode, stop including extensions to types that are beneath
the minimum ACL.
John Fairhurst #1291
- ๐ When building with Swift 5.6 and not passing
-
v0.14.1 Changes
๐ฅ Breaking
- ๐ Support Swift SPI groups. Swift declarations marked
@_spi
are no longer included in docs when--min-acl
is set topublic
oropen
. Use--include-spi-declarations
to include docs for these declarations.
John Fairhurst #1263
โจ Enhancements
Correct line number references with Xcode 13.
John Fairhurst๐ Support
union
declarations in Objective-C headers.
Brian Osborn John Fairhurst๐ Support Swift concurrency features: identify actors and asynchronous methods.
John Fairhurst
๐ Bug Fixes
- ๐ Improve HTML5 correctness, all themes.
John Fairhurst #1280
- ๐ Support Swift SPI groups. Swift declarations marked
-
v0.14.0 Changes
๐ฅ Breaking
- ๐ Require at least Ruby 2.6.3.
โจ Enhancements
๐ Support DocC-style autolinks and callouts in markdown.
John Fairhurstโ Add
--source-host
option to support projects hosted on GitLab and Bitbucket as well as GitHub. Options--source-host-url
and--source-host-files-url
and new Mustache tags replace the 'github' versions which remain as back-compatibility aliases.
John Fairhurst #314โ Add
rel="noopener"
to alltarget="_blank"
links.
JP Simard
๐ Bug Fixes
๐ Fix source-host line number references in Swift symbolgraph mode, and in ObjC mode for references to one-line declarations.
John Fairhurst๐ Fix crash with
` `
in markdown.
John Fairhurst #1270๐ Fix symbolgraph mode with Xcode 13.
John Fairhurst
- ๐ Require at least Ruby 2.6.3.
-
v0.13.7 Changes
๐ The next release of Jazzy will require a minimum of Ruby 2.6.
๐ฅ Breaking
- None.
โจ Enhancements
โก๏ธ Update JavaScript libraries: jQuery 3.6.0, Lunr 2.3.9, KaTeX 0.13.5.
John Fairhurst๐ Support the markdown footnotes extension in all themes.
John Fairhurst #1246
๐ Bug Fixes
- ๐ Fix parameter doc comments in Swift symbolgraph mode.
John Fairhurst #1244
-
v0.13.6 Changes
November 08, 2020๐ฅ Breaking
- None.
โจ Enhancements
- ๐ Support documentation generation from
.swiftmodule
binaries using--swift-build-tool symbolgraph
with Swift 5.3.
John Fairhurst
๐ Bug Fixes
- ๐ Always bypass codesigning when building Xcode projects.
John Fairhurst #1183
-
v0.13.5 Changes
July 06, 2020๐ฅ Breaking
- None.
โจ Enhancements
โ Add search function to
apple
theme.
Giles Payne #726โ Add option
--[no-]separate-global-declarations
to always create separate documentation pages for top-level declarations as well as classes, structures, enums etc. even if they don't have members. As part of this, improve the main page declaration in all modes.
Nikolay Volosatov John Fairhurst
๐ Bug Fixes
- ๐
Style fixes for
apple
andjony
themes to codeblocks inside lists and links.
John Fairhurst #818 #1177
-
v0.13.4 Changes
May 31, 2020๐ฅ Breaking
- None.
โจ Enhancements
- โก๏ธ Update JavaScript libraries: jQuery 3.5.1 (all themes), Lunr 2.3.8,
typeahead.js 1.3.1 (
fullwidth
theme only).
John Fairhurst
๐ Bug Fixes
๐ Fix warnings from Ruby 2.7.
John Fairhurst #1185Accept
root_url
without trailing slash.
John Fairhurst #1188
-
v0.13.3 Changes
April 24, 2020๐ฅ Breaking
- None.
โจ Enhancements
โ Added a config option to provide sources of privately hosted pod
dependencies when using the--podspec
option.
--pod-sources url1,url2,โฆurlN
.
Jonathan Bailey
#650๐ Improve Dash docset support: support online redirection when
๐--root-url
is set, and provide--docset-playground-url
to
๐ support docset playground links.
John Fairhurst๐ Bug Fixes
๐ Fix module version not being used from podspec.
Jonathan BaileyAutolink Swift custom attributes/property wrappers.
John Fairhurst -
v0.13.2 Changes
April 02, 2020๐ฅ Breaking
- None.
โจ Enhancements
๐ Support Xcode 11.4. Default Objective-C property attributes are now stripped from declarations: turn this off with
--keep-default-property-attributes
.
John Fairhurst #829Render LaTeX expressions written using
$equation$
or$$equation$$
syntax.
Arthur Guiot John Fairhurst #1156Wrap long method names on category pages. Use
name_html
in custom mustache templates to take advantage of this.
John Fairhurst #995๐ Support Dash-style
apple_ref
links to specific API items, for more stable and human-readable links from external docs.
Paul Cantrell
๐ Bug Fixes
๐ Don't generate documentation if the
xcodebuild
command fails.
John Fairhurst jpsim/SourceKitten#643๐ Use multi-line parsed declarations in more places including protocol methods and typealiases.
John Fairhurst #896