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

Changelog History
Page 4

  • v0.7.4 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements

    • ๐Ÿ“š Generate shields.io badge for documentation coverage, unless hide_documentation_coverage is set.
      Harlan Haskins #723

    • โž• Add support for searching docs when using the fullwidth theme. A new option, --disable-search, lets you turn this off.
      Esad Hajdarevic Tom MacWright Nadia Barbosa #14

    • New config option use_safe_filenames encodes unsafe characters when generating filenames. By default, documentation may receive filenames like /(_:_:).html. With use_safe_filenames, the same file will receive the name _2F_28_5F_3A_5F_3A_29.html instead.
      Jeremy David Giesbrecht #699 #146 #361 #547

    • References to Objective-C methods are now autolinked.
      Minh Nguyแป…n #362

    • ๐Ÿ“š Print documentation coverage percentage and the number of undocumented methods to the command line when running jazzy.
      Jason Wray

    ๐Ÿ› Bug Fixes

    • ๐Ÿ›  Fix issue where existing abstracts for non custom sections would be completely overwritten when using extra abstract injection with --abstract.
      Thibaud Robelain #600

    • ๐Ÿ›  Fix issue where generic type parameters registered as undocumented symbols.
      Jeremy David Giesbrecht #429

    • ๐Ÿ›  Fix issue where parameter and return callouts were duplicated in documentation.
      Jeremy David Giesbrecht #673

    • ๐Ÿ›  Fix issue where Objective-C superclass in declaration was unlinked.
      Minh Nguyแป…n #706

    • ๐Ÿ›  Fix issue where multiple Objective-C categories of the same external class in different files were merged into one and named after the first category found.
      Minh Nguyแป…n #539

    • String literals in code listings are no longer wrapped in <q> tags (apple and fullwidth themes only).
      Minh Nguyแป…n #714

    • ๐Ÿ›  Fix issue where passing a --podspec argument would use a malformed SWIFT_VERSION value, causing compilation to fail.
      JP Simard

  • v0.7.3 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements

    • Podspec-based documentation will take trunk's pushed_with_swift_version attribute into account when generating documentation by default.
      Orta Therox

    • ๐Ÿ“š Podspec-based documentation respects the swift-version config option.
      Orta Therox

    โœจ Enhancements
    ๐Ÿ› Bug Fixes

    • ๐Ÿ“‡ Rename Dash typedef type from "Alias" to "Type".
      Bogdan Popescu

    • ๐Ÿ›  Fix crash when sorting multiple identically named declarations with no USR, which is very common when generating docs for podspecs supporting multiple platforms.
      JP Simard #661

    • ๐Ÿ›  Fix Xcode not being found when specifying a custom Swift version (--swift-version).
      Samuel Giddins Paul Cantrell #656

    • ๐Ÿ›  Fix crash when generating Objective-C docs for projects with "@" directives in documentation comments with Xcode 8.1 or later.
      Jรฉrรฉmie Girault

  • v0.7.2 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements
    • None.
    ๐Ÿ› Bug Fixes

    • Declarations marked @available(..., unavailable, ...) are no longer documented.
      JP Simard #654

    • Treat the open ACL as more public than public.
      JP Simard

  • v0.7.1 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements
    • โž• Added support for the new access control specifiers of fileprivate and open.
      Shmuel Kallner #645 #646
    ๐Ÿ› Bug Fixes

    • ๐Ÿ›  Fix issue where jazzy could not be installed from Gemfile due to SourceKitten symlinks already being present.
      William Meleyal #438

    • ๐Ÿ‘• The lint report in undocumented.json is more human-readable: includes fully qualified symbol names, pretty printed.
      Paul Cantrell #598

    • ๐Ÿ‘ The exclude option now properly supports wildcards.
      Paul Cantrell #640

  • v0.7.0 Changes

    ๐Ÿ’ฅ Breaking
    • ๐Ÿ“„ The docset_platform option is no longer available. The module name will now be used instead of jazzy.
      JP Simard #423
    โœจ Enhancements
    • ๐Ÿ‘Œ Improved auto-linking behavior to link declarations within declarations and fix cases where declarations would link to themselves or their current page.
      Esad Hajdarevic #483
    ๐Ÿ› Bug Fixes

    • ๐Ÿ›  Fix issue where single-line declaration + bodies in Swift would include the body in the parsed declaration.
      JP Simard #226

    • ๐Ÿ›  Fix issue where some sections would become empty when using custom groups.
      JP Simard #475

    • ๐Ÿ›  Fix issue where directories ending with .swift would be considered Swift source files.
      JP Simard #586

  • v0.6.3 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements

    • ๐Ÿ‘ --exclude flag now supports excluding directories in addition to files.
      Gurrinder #503

    • โšก๏ธ The cocoapods gem was updated to 1.0.1 and rouge to 1.11.0.
      Samuel Giddins #568

    • ๐Ÿ“š Extra markdown documentation can now be included as their own pages in the sidebar using the --documentation option and in the generated Dash docset as Guides.
      Karl Bowden #435

    • Section headings can now include additional markdown content using the --abstract option.
      Karl Bowden #435

    • If Swift version is not specified, look for Swift toolchain or clang location in the following order:

      • $XCODE_DEFAULT_TOOLCHAIN_OVERRIDE
      • $TOOLCHAIN_DIR
      • xcrun -find swift
      • /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
      • /Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
      • ~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
      • ~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain

    This will be especially useful once jazzy supports generating docs for Swift Package Manager modules with a toolchain not tied to an Xcode release.
    JP Simard

    ๐Ÿ› Bug Fixes
    • Don't document clang-unexposed Objective-C declarations.
      JP Simard #573

  • v0.6.2 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements
    • Include one level of nested classes, structs, protocols and enums in the navigation bar.
      JP Simard #64
    ๐Ÿ› Bug Fixes
    • None.

  • v0.6.1 Changes

    ๐Ÿ’ฅ Breaking
    • None.
    โœจ Enhancements

    • ๐Ÿ“š Objective-C documentation now also includes Swift declarations.
      JP Simard #136

    • 0๏ธโƒฃ Default to the Xcode version selected in xcode-select if no Swift version is specified.
      Samuel Giddins #427

    ๐Ÿ› Bug Fixes

    • ๐Ÿ‘‰ Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages.
      Zachary Waldowski #524

    • ๐Ÿ›  Fix crash when using unexposed declarations in Objective-C.
      JP Simard #543

    • No longer document Swift extensions on types with an ACL lower than min-acl when they contain MARKs.
      JP Simard #544

  • v0.6.0 Changes

    ๐Ÿ’ฅ Breaking

    • ๐Ÿ’ป Config files now use the same option names as the command line. If you are using one of the keys that has changed in your .jazzy.yaml, you will receive a warning. See the pull request for a complete list of changed options. As always, you can get a list of all options with jazzy --help config.
      Paul Cantrell

    • Jazzy's undocumented.txt has been replaced with undocumented.json. This new format includes contextual information that one might use to lint documentation in an automated fashion.
      Jeff Verkoeyen

    • 0๏ธโƒฃ --swift-version now defaults to 2.2 instead of 2.1.1.
      Tamar Nachmany

    โœจ Enhancements

    • โž• Add --skip-documentation flag. Skips site generation phase. undocumented.json is still generated.
      Jeff Verkoeyen

    • ๐Ÿ“š Merge Objective-C categories into their parent type documentation to match Swift behavior.
      Esad Hajdarevic #457

    • โž• Add support for documenting Swift 2.2 associatedtypes and infix, postfix & prefix operators.
      JP Simard

    ๐Ÿ› Bug Fixes

    • โž• Add support for Objective-C module imports.
      JP Simard #452

    • โ†ช Workaround for an apparent SourceKit bug which sometimes caused extensions to be merged into the wrong type.
      Paul Cantrell #459 #460

  • v0.5.0 Changes

    ๐Ÿ’ฅ Breaking

    • 0๏ธโƒฃ --swift-version now defaults to 2.1.1 instead of 2.1.
      Nikita Lutsenko #416

    • ๐Ÿ‘ Swift 1.x is no longer supported.

    • ๐Ÿฑ --templates-directory and --assets-directory have been deprecated in favor of --theme. Specify either 'apple' (default), 'fullwidth' or the path to your mustache templates and other assets for a custom theme.
      Karl Bowden JP Simard #130

    โœจ Enhancements

    • โž• Add --sdk [iphone|watch|appletv][os|simulator]|macosx option for Objective-C projects.
      Jeff Verkoeyen

    • โž• Add --head option to inject custom HTML into <head></head>.
      JP Simard

    ๐Ÿ› Bug Fixes

    • ๐Ÿ›  Fix an issue where extension documentation would use the original type documentation block rather than the comment immediately preceding the extension.
      JP Simard #230 #313 #334

    • ๐Ÿ›  Fix multi-byte documentation issues.
      Norio Nomura #403