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

Changelog History
Page 3

  • v0.9.3 Changes

    May 06, 2018
    💥 Breaking
    • None.
    ✨ Enhancements
    • None.
    🐛 Bug Fixes

    🛠 Fix crash when specifying empty Swift version. Now correctly uses the default
    Swift version.
    JP Simard

    🛠 Fix jony theme selection.
    John Fairhurst
    #962

  • v0.9.2 Changes

    April 21, 2018
    💥 Breaking
    • None.
    ✨ Enhancements

    ➕ Add a new 'jony' theme similar to the 2017 Apple documentation style.
    Harshil Shah

    ➕ Add the ability to limit documentation to certain files by passing in an
    -i/--include argument.
    Nick Fox
    #949

    👌 Improve Swift declarations to look more like the Xcode Quick Help version,
    for example including { get set }, and include all attributes.
    John Fairhurst
    #768
    #591

    🐛 Bug Fixes

    Preserve MARK comment headings associated with extensions and enum cases.
    John Fairhurst

    🛠 Fix issue where Overview items were invalidly being referenced with NULL
    📄 types in the generated Dash docset index.
    Andrew De Ponte

    Don't display FIXME or TODO comments as section markers.
    John Fairhurst
    #658

  • v0.9.1 Changes

    January 08, 2018
    💥 Breaking
    • None.
    ✨ Enhancements

    ➕ Added a config option (--undocumented-text UNDOCUMENTED_TEXT) to set the
    0️⃣ default text for undocumented symbols.
    Akhil Batra
    #913

    ➕ Added a config option to hide Objective-C or Swift declarations:
    --hide-declarations [objc|swift].
    Ibrahim Ulukaya
    #828

    Automatically use Swift or Objective-C syntax highlighting for code blocks
    📚 in documentation comments. Improve Swift highlighting with latest Rouge.
    John Fairhurst
    #218

    🐛 Bug Fixes

    🛠 Fix Swift declarations when generating Objective-C docs for generic types.
    John Fairhurst
    #910

    📚 Don't create documentation nodes for generic type parameters.
    John Fairhurst
    #878

  • v0.9.0 Changes

    October 27, 2017
    💥 Breaking
    • 📚 Generate documentation coverage badge locally. Since this avoids the failable
      🚚 HTTP request to shields.io previously used to obtain the badge, we've removed
      the --[no-]download-badge flag and the corresponding download_badge
      🔧 YAML configuration key.
      Samuel Giddins
    ✨ Enhancements
    • None.
    🐛 Bug Fixes

    🛠 Fixed issue that prevented Jazzy from running on case sensitive file systems.
    Jeremy David Giesbrecht
    #891

    🛠 Fixed issue preventing --podspec from working with test_specs.
    John Fairhurst
    #894

    Always display correct declaration for undocumented symbols.
    John Fairhurst
    #864

    Trim common indentation in multiline declarations.
    John Fairhurst
    #836

  • v0.8.4 Changes

    September 28, 2017
    💥 Breaking
    • None.
    ✨ Enhancements

    Align jazzy terminology with Apple usage.
    Xiaodi Wu
    John Fairhurst

    ➕ Add url attribute that can be more accurate than {{section}}.html as a URL
    in custom templates.
    John Fairhurst

    🐛 Bug Fixes

    🛠 Fix crash when specifying swift_version as a floating point value in
    .jazzy.yaml rather than a string.
    JP Simard
    #860

    📚 Autolink from parameter documentation and from external markdown documents
    including README. Autolink to symbols containing & < >.
    John Fairhurst
    #715
    #789
    #805

    🛠 Fix Swift 4 declarations containing ampersands (&) being truncated.
    JP Simard

  • v0.8.3 Changes

    July 07, 2017
    💥 Breaking
    • None.
    ✨ Enhancements

    Generate Swift declaration for more Objective-C declarations.
    Zheng Li

    👌 Improve quality & accuracy of Swift interfaces for Objective-C declarations
    📄 when generating Objective-C docs.
    Norio Nomura

    🖨 Process Swift 3.2/4 doc comments.
    John Fairhurst

    🐛 Bug Fixes

    🛠 Fix missing doc comments on some extensions.
    John Fairhurst
    #454

    🛠 Fix failure when attempting to download documentation coverage badge with
    🍎 jazzy using macOS system Ruby, or a Ruby built with outdated versions of
    OpenSSL.
    JP Simard
    #824

    Stop --skip-undocumented from skipping documented items nested
    inside extensions of types from other modules.
    John Fairhurst
    #502

    🛠 Fix members added to extensions of a nested type showing up in the parent.
    John Fairhurst
    #333

  • v0.8.2 Changes

    💥 Breaking
    • None.
    ✨ Enhancements

    • Report number of included and skipped declarations in CLI output.
      John Fairhurst #238

    • 🏗 Build ObjC docs with clang modules enabled by default (-fmodules flag).
      Maksym Grebenets #636

    • Shave ~1MB from jazzy's gem distribution.
      JP Simard

    🐛 Bug Fixes

  • v0.8.1 Changes

    💥 Breaking
    • None.
    ✨ Enhancements
    • 👍 Allow all markdown in returns and parameter description callouts.
      John Fairhurst #476
    🐛 Bug Fixes

  • v0.8.0 Changes

    💥 Breaking
    ✨ Enhancements
    • ➕ Add --[no-]download-badge flag to skip downloading the documentation coverage badge from shields.io. Useful if generating docs offline.
      JP Simard #765
    🐛 Bug Fixes

  • v0.7.5 Changes

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

    • 🛠 Fix issue where using a custom theme would crash jazzy when using Ruby 2.4.
      Jason Wray #752

    • 🛠 Fix support for Ruby 2.0.0.
      Jason Wray #747

    • 🛠 Fix issue where header files are not found if inside subdirectories of the framework_root specified folder.
      Christopher Gretzki #518