Releases: realm/jazzy
0.13.3
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 Bailey -
Autolink Swift custom attributes/property wrappers.
John Fairhurst
0.13.2
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
#829 -
Render LaTeX expressions written using
$equation$
or$$equation$$
syntax.
Arthur Guiot
John Fairhurst
#1156 -
Wrap 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
#1167
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
0.13.1
Breaking
- None.
Enhancements
-
Allow inline html tags in ObjC doc comments.
Chris Williams
#976 -
Support code formatting in ObjC doc comments with
@c
,@code
and
@endcode
.
Bryce Pauken
jpsim/SourceKitten#631 -
Add
custom_categories_unlisted_prefix
configuration setting. This
is the prefix for navigation section names that aren't explicitly
listed incustom_categories
. Defaults to 'Other '.
JP Simard -
Add
hide_unlisted_documentation
configuration setting. Setting this
totrue
hides documentation entries in the sidebar from the
documentation
config value that aren't explicitly listed in
custom_categories
.
JP Simard
Bug Fixes
-
Fix crash when SourceKit returns out of bounds string byte offsets.
JP Simard -
Pick the right version of declarations with type attributes.
John Fairhurst
#1148
0.13.0
Breaking
- None.
Enhancements
-
Add section headings for members added by Swift conditional conformances.
John Fairhurst
#717 -
Parse markdown in MARK comments, make the html available to themes via
name_html
mustache tag key for section headings.
John Fairhurst -
Include protocol conformances added by extensions in Swift docs.
John Fairhurst
Bug Fixes
-
Render bullet lists correctly when followed by a callout.
John Fairhurst
#785 -
Render markup of text inside double quotes.
John Fairhurst
#992 -
Fix
sourcekitten_sourcefile
used from config file.
John Fairhurst
#1137
0.12.0
Breaking
- None.
Enhancements
- Support for mixed Swift-ObjC modules: generate two sets of SourceKitten
json and pass them on using--sourcekitten-sourcefile
.
Joe Susnick
John Fairhurst
#447
Bug Fixes
-
Stop displaying type attributes on extension declarations.
John Fairhurst -
Show ObjC and Swift classes (etc.) in the same category.
John Fairhurst -
Merge Swift extensions into ObjC classes.
John Fairhurst
Joe Susnick
0.11.2
Breaking
- None.
Enhancements
- None.
Bug Fixes
-
Generate Swift docs with Xcode 11 and paths with spaces.
John Fairhurst
#1108 -
Reinstate guessing of module name from podspec, broken in 0.11.0.
John Fairhurst
#1109
0.11.1
0.11.0
Breaking
- None.
Enhancements
-
Sass support now provided by
libsass
viasassc
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
andPackage.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.