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

Changelog History
Page 2

  • v0.9.1

    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

    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

    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

    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

    πŸ’₯ 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
    • πŸ›  Fix support for Ruby 2.2.
      John Fairhurst #801

    • πŸ›  Fix many cases of incorrect, missing or superfluous docs on Swift declarations.
      John Fairhurst

  • v0.8.1

    πŸ’₯ Breaking
    • None.
    ✨ Enhancements
    • πŸ‘ Allow all markdown in returns and parameter description callouts.
      John Fairhurst #476
    πŸ› Bug Fixes
  • v0.8.0

    πŸ’₯ 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
    • Blank line no longer needed before lists or code blocks.
      John Fairhurst #546

    • πŸ”— Linking to headers in apple theme gives correct vertical alignment.
      John Fairhurst

    • Headers in source code markdown no longer cause corruption.
      John Fairhurst #628

  • v0.7.5

    πŸ’₯ 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

  • v0.7.4

    πŸ’₯ 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

    πŸ’₯ 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