gems jazzy 0.6.0
0.6.0: Grand Unified Theory

latest releases: 0.15.0, 0.14.4, 0.14.3...
8 years ago

This release helps bring the behavior of Objective-C category documentation in line with its Swift extension counterpart, merging the category interface into the parent type. Thanks @esad!

Along those same lines, @pcantrell aligned the config file keys to match their command line names. Finally, no more confusion!

So the theme for this release is unifying previously divergent behaviors so to speak.

Also Jazzy, though formerly a documentation generator, now has the newfound ability to not generate documentation... . But seriously, this is useful to validate your documentation by just running jazzy as a dry run, or to check the documentation coverage of your library! Thanks @jverkoey!

There are a number of other changes in this release which you'll find in its entirety below:

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
  • --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

Thanks to our contributors @pcantrell, @jverkoey, @tamarnachmany & @esad for making this release possible!

Don't miss a new jazzy release

NewReleases is sending notifications on new releases.