Skip to content

Releases: realm/jazzy

0.13.3

24 Apr 08:27
b488374
Compare
Choose a tag to compare
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

0.13.2

02 Apr 09:06
3a4421c
Compare
Choose a tag to compare
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

0.13.1

07 Jan 21:39
06a9f2e
Compare
Choose a tag to compare
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 in custom_categories. Defaults to 'Other '.
    JP Simard

  • Add hide_unlisted_documentation configuration setting. Setting this
    to true 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

09 Dec 17:25
0272684
Compare
Choose a tag to compare
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

0.12.0

11 Nov 12:03
04611d3
Compare
Choose a tag to compare
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

0.11.2

25 Sep 12:11
027fc6e
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.11.1

17 Sep 09:03
e74453a
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Don't use SwiftPM if there is an Xcode workspace or project in a non-root
    directory.
    John Fairhurst
    #1103

0.11.0

14 Sep 00:07
34ac6b1
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • Sass support now provided by libsass via sassc 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 and Package.swift files are
    present. Add --build-tool-flags as a preferred alias for
    --xcodebuild-flags.
    John Fairhurst
    #487

Bug Fixes

0.10.0

22 Jun 17:33
c528d47
Compare
Choose a tag to compare
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

0.9.6

04 Apr 09:53
74cd836
Compare
Choose a tag to compare

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.