All Versions
58
Latest Version
Avg Release Cycle
61 days
Latest Release
-

Changelog History
Page 1

  • 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

  • v0.14.1 Changes

    💥 Breaking
    • 👌 Support Swift SPI groups. Swift declarations marked @_spi are no longer included in docs when --min-acl is set to public or open. Use --include-spi-declarations to include docs for these declarations.
      John Fairhurst #1263
    ✨ Enhancements
    🐛 Bug Fixes

  • 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 all target="_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

  • v0.13.7 Changes

    🚀 The next release of Jazzy will require a minimum of Ruby 2.6.

    💥 Breaking
    • None.
    ✨ Enhancements
    🐛 Bug Fixes

  • 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

  • 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

  • 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

  • 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 Bailey

    Autolink 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 #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

    🐛 Bug Fixes

  • v0.13.1 Changes

    January 07, 2020
    💥 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
    0️⃣ 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