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