All Versions
47
Latest Version
Avg Release Cycle
66 days
Latest Release
7 days ago

Changelog History
Page 3

  • v0.7.2

    💥 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

    💥 Breaking
    • None.
    ✨ Enhancements
    🐛 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

    💥 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

    💥 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

    💥 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

    💥 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

    💥 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

    💥 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

  • v0.4.1

    🚀 Note: this is the last official release of jazzy supporting Swift 1.x.

    💥 Breaking
    • None.
    ✨ Enhancements
    • 👌 Support "wall of asterisk" documentation comments.
      Jeff Verkoeyen #347

    • Expanding a token no longer causes the document to 'jump' to the hash.
      Jeff Verkoeyen #352

    • Autolinking improvements:

      • Autolinks only match `ThingsInBackticks`, and must match the entire string. This prevents spurious matching in prose and sample code.
      • Autolinks supports siblings, ancestors, top-level elements, and dot-separated chains starting with any of the above: someProperty, SomeType.NestedType.someMethod(_:).
      • New ... wildcard prevents you from having to list all method parameters: someMethod(...)

    Paul Cantrell #327 #329 #359

    🐛 Bug Fixes
    • 🛠 Fix an out-of-bounds exception when generating pragma marks.
      JP Simard #370

    • ➕ Add support for C/C++ struct, field & ivar types.
      JP Simard #374 #387

    • 🔗 Links to source files on GitHub are no longer broken when source_directory does not point to the current working directory.
      Paul Cantrell

    • When excluded_files is specified in a config file, it is now resolved relative to the file (like other options) instead of relative to the working directory.
      Paul Cantrell

  • v0.4.0

    💥 Breaking
    • 0️⃣ --swift-version now defaults to 2.1 instead of 2.0.
      JP Simard
    ✨ Enhancements
    • 👌 Support for documenting Objective-C projects! 🎉 Pass --objc, --umbrella-header ... and -framework-root ....
      JP Simard #56

    • 📚 Mentions of top-level declarations in documentation comments are now automatically hyperlinked to their reference.
      JP Simard

    • 🔧 Jazzy can now read options from a configuration file. The command line provides comprehensive help for available options via jazzy -h config.
      Paul Cantrell #310

    • 👀 Render special list items (e.g. Throws, See, etc.). See https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for a complete list.
      JP Simard #317

    • 👌 Support for Swift 2.1.
      JP Simard

    • 🔀 Swift extensions are now merged with their extended type, rendering a note to describe extension default implementations and extension methods.
      Paul Cantrell

    🐛 Bug Fixes
    • None.