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

Changelog History
Page 5

  • v0.4.1 Changes

    🚀 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 Changes

    💥 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.

  • v0.3.2 Changes

    💥 Breaking
    • None.
    ✨ Enhancements
    • None.
    🐛 Bug Fixes

    • 🛠 Fixed an issue that prevented building projects with different schema & module names.
      JP Simard #259

    • 📚 Hide documentation coverage from header using --hide-documentation-coverage.
      mbogh #129

    • 🖨 Print a more informative error when unable to find an Xcode that has the requested Swift version.
      Samuel Giddins

  • v0.3.1 Changes

    💥 Breaking
    • None.
    ✨ Enhancements
    • None.
    🐛 Bug Fixes
    • ➕ Added missing Swift 2 declaration types.
      JP Simard

  • v0.3.0 Changes

    💥 Breaking
    • 0️⃣ --swift-version now defaults to 2.0 instead of 1.2.
      JP Simard
    ✨ Enhancements

    • 👍 Now supports Swift 2.0 (previous Swift versions are still supported).
      JP Simard Samuel Giddins

    • Declarations can now be grouped by custom categories defined in a JSON or YAML file passed to --categories.
      Paul Cantrell

    🐛 Bug Fixes

    • "View on GitHub" is now only generated if a GitHub URL is specified.
      mbogh #244

    • Empty extensions are no longer documented.
      Paul Cantrell

    • 👍 Undocumented enum cases are now supported.
      JP Simard #74

  • v0.2.4 Changes

    💥 Breaking
    • None.
    ✨ Enhancements

    • 👌 Improved how SourceKitten is vendored.
      JP Simard

    • 👉 Show type declaration under its title.
      Paul Cantrell

    • ➕ Added support for custom assets: pass --assets-directory to jazzy.
      gurkendoktor

    • ➕ Added support for custom copyright text: pass --copyright to jazzy.
      emaloney

    🐛 Bug Fixes

    • 🛠 Fixed a crash when parsing an empty documentation comment.
      JP Simard #236

    • --exclude now works properly if its argument is a relative path.
      Paul Cantrell

  • v0.2.3 Changes

    💥 Breaking
    • None.
    ✨ Enhancements
    • 0️⃣ The jazzy CLI now accepts a --swift-version option (defaulting to 1.2), and will automatically find an appropriate Xcode installation.
      Samuel Giddins #214
    🐛 Bug Fixes
    • Declarations with no USR will no longer be documented.
      JP Simard

  • v0.2.2 Changes

    💥 Breaking
    • None.
    ✨ Enhancements
    • ➕ Added support for custom templates: use the -t/--template-directory argument to jazzy.
      JP Simard #20
    🐛 Bug Fixes
    • None.

  • v0.2.1 Changes

    💥 Breaking
    • None.
    ✨ Enhancements
    • ➕ Added the ability to ignore certain files by passing in an -e/--exclude argument to jazzy.
      JP Simard #173
    🐛 Bug Fixes
    • None.

  • v0.2.0 Changes

    💥 Breaking

    • 👍 Jazzy now only supports projects using Swift 1.2.
      JP Simard #170

    • 0️⃣ Increase default minimum ACL to public.
      JP Simard #186

    ✨ Enhancements
    • 👉 Use key.accessibility to determine ACL (value coming from SourceKit, which is generally more accurate than parsing the declaration for an accessibility keyword).
      JP Simard #185
    🐛 Bug Fixes
    • None.