Releases: realm/jazzy
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
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 correspondingdownload_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 withtest_spec
s.
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
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