Skip to content

Releases: realm/jazzy

0.2.4: Copy, Right?

27 Aug 17:39
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • Improved how SourceKitten is vendored.
    JP Simard
  • Show type declaration under its title.
    pcantrell
  • 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.
    pcantrell

0.2.3: Xcode, I choose you!

31 Jul 03:55
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • 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

0.2.2: Groomed Stache

07 Jul 19:43
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
  • Added support for custom templates: use the -t/--template-directory
    argument to jazzy.
    JP Simard
    #20
Bug Fixes
  • None.

0.2.1: Exclude me

06 May 07:49
Compare
Choose a tag to compare

0.2.1

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.

0.2.0: Catching up with Swift

23 Apr 18:48
Compare
Choose a tag to compare

0.2.0

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

0.1.6: Install me maybe?

23 Apr 18:45
Compare
Choose a tag to compare

Finally, the feature you've been waiting for is now available... you can now install jazzy! lol, just kidding, the last release wasn't installable, so this release fixes that little problem.

0.1.6

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.1.5: All That Jazz, Now in Style

09 Apr 18:11
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
Bug Fixes
  • Fixed issue where docset would contain duplicate files.
    JP Simard
    #204
  • Fixed installation issues on case-sensitive file systems.
    kishikawakatsumi
  • Fixed out-of-bounds exception when parsing the declaration in files starting
    with a declaration.
    JP Simard
    #30
  • Fixed out-of-bounds exception and inaccurate parsed declarations when using
    multibyte characters.
    JP Simard
    #35
  • Fixed parsing issues with keyword functions such as subscript, init and
    deinit.
    JP Simard
    #27
  • Fixed issues where USR wasn't accurate because dependencies couldn't be
    resolved.
    JP Simard
  • Allow using a version of Xcode that is symlinked to
    /Applications/Xcode.app.
    Samuel Giddins

0.1.4: Fixin the Fixins

24 Mar 23:30
Compare
Choose a tag to compare

0.1.3 didn't entirely fix #188, this release attempts to rectify that mishap.

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • No longer count undocumented externally declared tokens as undocumented.
    JP Simard
    #188

0.1.3: All The Fixins

24 Mar 23:05
Compare
Choose a tag to compare

Lots of bug fixes in this release. Enjoy!

Breaking
  • None.
Enhancements
  • Improve the styling of dl elements (parsed key-value pairs).
    segiddins
  • Raise exceptions if Xcode requirements aren't met.
    JP Simard
Bug Fixes
  • No longer count initializers with parameters as undocumented.
    JP Simard
    #183
  • No longer crash when a token is missing a USR.
    JP Simard
    #171
  • Fixed encoding issues in some environments.
    James Barrow
    #152
  • No longer count undocumented externally declared tokens as undocumented.
    JP Simard
    #188
  • Fixed --source-directory CLI option.
    JP Simard
    #177

0.1.2: The Rise of the Symlinks, the Prequel

28 Feb 20:30
Compare
Choose a tag to compare
Breaking
  • None.
Enhancements
Bug Fixes
  • (Really) fixes installation as a RubyGem.
    beltex
    #159