Skip to content

Latest commit

 

History

History
758 lines (496 loc) · 20.8 KB

CHANGELOG.md

File metadata and controls

758 lines (496 loc) · 20.8 KB
Raw

Master

Enhancements
Bug Fixes

  • Fix issue where jazzy could not be installed from Gemfile due to SourceKitten symlinks already being present.
    William Meleyal #438

  • The lint report in undocumented.json is more human-readable: includes fully qualified symbol names, pretty printed.
    Paul Cantrell #598

  • The exclude option now properly supports wildcards.
    Paul Cantrell #640

0.7.0

Breaking
  • The docset_platform option is no longer available. The module name will now be used instead of jazzy.
    JP Simard #423
Enhancements
  • Improved auto-linking behavior to link declarations within declarations and fix cases where declarations would link to themselves or their current page.
    Esad Hajdarevic #483
Bug Fixes

  • Fix issue where single-line declaration + bodies in Swift would include the body in the parsed declaration.
    JP Simard #226

  • Fix issue where some sections would become empty when using custom groups.
    JP Simard #475

  • Fix issue where directories ending with .swift would be considered Swift source files.
    JP Simard #586

0.6.3

Breaking
  • None.
Enhancements

  • --exclude flag now supports excluding directories in addition to files.
    Gurrinder #503

  • The cocoapods gem was updated to 1.0.1 and rouge to 1.11.0.
    Samuel Giddins #568

  • Extra markdown documentation can now be included as their own pages in the sidebar using the --documentation option and in the generated Dash docset as Guides.
    Karl Bowden #435

  • Section headings can now include additional markdown content using the --abstract option.
    Karl Bowden #435

  • If Swift version is not specified, look for Swift toolchain or clang location in the following order:

    • $XCODE_DEFAULT_TOOLCHAIN_OVERRIDE
    • $TOOLCHAIN_DIR
    • xcrun -find swift
    • /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
    • /Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
    • ~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
    • ~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain

    This will be especially useful once jazzy supports generating docs for Swift Package Manager modules with a toolchain not tied to an Xcode release.
    JP Simard

Bug Fixes
  • Don't document clang-unexposed Objective-C declarations.
    JP Simard #573

0.6.2

Breaking
  • None.
Enhancements
  • Include one level of nested classes, structs, protocols and enums in the navigation bar.
    JP Simard #64
Bug Fixes
  • None.

0.6.1

Breaking
  • None.
Enhancements

  • Objective-C documentation now also includes Swift declarations.
    JP Simard #136

  • Default to the Xcode version selected in xcode-select if no Swift version is specified.
    Samuel Giddins #427

Bug Fixes

  • Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages.
    Zachary Waldowski #524

  • Fix crash when using unexposed declarations in Objective-C.
    JP Simard #543

  • No longer document Swift extensions on types with an ACL lower than min-acl when they contain MARKs.
    JP Simard #544

0.6.0

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

0.5.0

Breaking

  • --swift-version now defaults to 2.1.1 instead of 2.1.
    Nikita Lutsenko #416

  • Swift 1.x is no longer supported.

  • --templates-directory and --assets-directory have been deprecated in favor of --theme. Specify either 'apple' (default), 'fullwidth' or the path to your mustache templates and other assets for a custom theme.
    Karl Bowden JP Simard #130

Enhancements

  • Add --sdk [iphone|watch|appletv][os|simulator]|macosx option for Objective-C projects.
    Jeff Verkoeyen

  • Add --head option to inject custom HTML into <head></head>.
    JP Simard

Bug Fixes

  • Fix an issue where extension documentation would use the original type documentation block rather than the comment immediately preceding the extension.
    JP Simard #230 #313 #334

  • Fix multi-byte documentation issues.
    Norio Nomura #403

0.4.1

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

  • Miscellaneous minor font size, weight, and color adjustments.
    Jeff Verkoeyen

  • In-page anchors now appear below the header.
    Jeff Verkoeyen

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

0.4.0

Breaking
  • --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 http://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.

0.3.2

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

0.3.1

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Added missing Swift 2 declaration types.
    JP Simard

0.3.0

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

0.2.4

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

0.2.3

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

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

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

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

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.1.5

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

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

0.1.3

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

Breaking
  • None.
Enhancements
Bug Fixes
  • (Really) fixes installation as a RubyGem.
    beltex #159

0.1.1

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.1.0

sourcekitten

Breaking
  • None.
Enhancements
  • Add the ability to document a Pod from just a podspec, which allows jazzy to run on cocoadocs.org.
    Samuel Giddins #58
Bug Fixes
  • De-duplicate the sidebar list of extensions and show all children for an extension, regardless of how many extensions on a type there are.
    Samuel Giddins

0.0.20

sourcekitten

Breaking
  • Don't skip declarations with no documentation comments by default. Allow skipping using --skip-undocumented.
    JP Simard #129
Enhancements
  • Combine abstract and discussion in page overview.
    JP Simard #115
Bug Fixes
  • Don't show 'Show in Github' link for types declared in system frameworks.
    JP Simard #110

0.0.19

sourcekitten

Breaking

None.

Enhancements
Bug Fixes

  • Fixed crash when files contained a declaration on the first line.
    JP Simard jpsim/sourcekitten#14

  • Fixed invalid JSON issue when last file in an Xcode project failed to parse.
    JP Simard

  • Fixed crash when attempting to parse the declaration of extension Array.
    JP Simard #126