CHANGELOG.md

Master

Breaking

• None.

Enhancements

• None.

Bug Fixes

• None.

0.10.0

Breaking

• Change SwiftDocs.init(file:arguments:) to SwiftDocs.init?(file:arguments:).
  Norio Nomura

Enhancements

• Add Request.failableSend() that can handle SourceKitService crashes. sourcekitten doc does not stop when SourceKitService crashes.
  Norio Nomura

Bug Fixes

• Fix crash when offset points end of string.
  Norio Nomura #164

0.9.0

Breaking

• Change Line from tuple to struct with extra properties range and byteRange.
  Norio Nomura

Enhancements

• None.

Bug Fixes

• None.

0.8.0

Breaking

• Replaced all uses of XPCDictionary, XPCArray, XPCRepresentable & xpc_object_t with SourceKit equivalents.
  JP Simard

Enhancements

• Supports building with Swift 2.2 snapshot & Swift Package Manager on OS X.
  JP Simard

Bug Fixes

• Fix crash when file contains NULL character.
  Norio Nomura SwiftLint#379

0.7.4

Breaking

• None.

Enhancements

• Add Structure.init(sourceKitResponse:).
  Norio Nomura

• Improve performance of Request.send().
  Norio Nomura

Bug Fixes

• Add support for parsing module imports in Objective-C.
  JP Simard jazzy#452

0.7.3

Breaking

• None.

Enhancements

• Add NSString.lineAndCharacterForByteOffset.
  JP Simard

Bug Fixes

• Fixed multi-byte character handling in File.getDocumentationCommentBody.
  JP Simard

0.7.2

Breaking

• None.

Enhancements

• Optimize NSString.lineAndCharacterForCharacterOffset(...), NSString.NSRangeToByteRange(...) and SyntaxMap.commentRangeBeforeOffset(_:).
  Norio Nomura #119

• Fix unicode handling of String.commentBody(range:).
  Norio Nomura

Bug Fixes

• None.

0.7.1

Enhancements

• Optimize NSRange operation.
  Norio Nomura #119

0.7.0

Breaking

• File is now a final class instead of a struct and contents & lines are now marked as var. This was done so that mutations to the underlying file on disk can be mirrored in a File instance.
  JP Simard

Enhancements

None.

Bug Fixes

• Fix issue where Swift extensions would pick up documentation from previous tokens.
  JP Simard #65

• Fix String.stringByTrimmingTrailingCharactersInSet(_:) returning full string when all characters matched character set.
  JP Simard

• Fix indexOfByteOffset(offset:) failing when string include some emoji.
  Norio Nomura #111

• Fix pragma mark extraction with multibyte characters.
  1ec5 #114

0.6.2

Breaking

None.

Enhancements

• Increase robustness of file path handling.
  Boris Bügling #86

Bug Fixes

• Add support for C/C++ struct, field & ivar types.
  JP Simard jazzy#374 jazzy#387

0.6.1

Breaking

None.

Enhancements

• Support "wall of asterisk" documentation comments.
  Jeff Verkoeyen

Bug Fixes

• Fix a string interpolation issue when generating completion options.
  Benedikt Terhechte #97

• Fix an out-of-bounds exception when generating pragma marks.
  JP Simard jazzy#370

0.6.0

Breaking

None.

Enhancements

• Ability to generate Objective-C documentation.
  Thomas Goyne JP Simard

Bug Fixes

• Don't process SourceKit's response when building Structure.
  JP Simard #82

0.5.2

Breaking

None.

Enhancements

• Add compilerargs option to complete command.
  Masayuki Yamaya

• Add support for Xcode 7.1.
  JP Simard

Bug Fixes

• Fix a bug where documentation inside a function would crash SourceKitten.
  JP Simard #75

0.5.1

Breaking

None.

Enhancements

• Improve error reporting when compiler arguments can't be parsed and log xcodebuild output to file instead of stderr.
  JP Simard

Bug Fixes

None.

0.5.0

Breaking

• Updated to Swift 2.0.
  JP Simard

Enhancements

• Update File lines convenience property to be immutable.
  Keith Smiley

• Added the ability to generate code completion options (complete command).
  JP Simard

Bug Fixes

None.

0.4.5

Breaking

None.

Enhancements

• Add lines convenience property to File
  Keith Smiley

Bug Fixes

None.

0.4.4

Breaking

• Simplified rpath's.
  JP Simard

Enhancements

None.

Bug Fixes

• Fixed a crash when parsing an empty documentation comment.
  JP Simard #236

0.4.3

Breaking

None.

Enhancements

None.

Bug Fixes

• Fixed issue when installing 0.4.2 via Homebrew.
  JP Simard

0.4.2

Breaking

None.

Enhancements

None.

Bug Fixes

• SourceKitten can now be installed alongside Carthage because SourceKittenFramework now nests its Commandant and LlamaKit frameworks.
  JP Simard

0.4.1

Breaking

• SwiftDocs now prints its file path in its description.
  JP Simard

Enhancements

None.

Bug Fixes

None.

0.4.0

Breaking

• Requires Swift 1.2 to build.
  JP Simard

Enhancements

None.

Bug Fixes

None.

0.3.2

Breaking

None.

Enhancements

• Added definition line ranges to declarations.
  JP Simard #198

• Parse doc.full_as_xml.
  JP Simard #37

• Parse documentation comments.
  JP Simard

Bug Fixes

• 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

0.3.0

Breaking

• Everything. No, seriously lots has changed in this release and you should consider SourceKitten entirely rewritten. SourceKitten now uses dynamic frameworks for the bulk of its functionality, which means that everything is now much more modular and testable.
  JP Simard #17

Enhancements

• Consolidated error generation.
  JP Simard #24

Bug Fixes

None.

0.2.8

Breaking

None.

Enhancements

None.

Bug Fixes

• Fixed issue where certain Swift files wouldn't be parsed.
  JP Simard #18

0.2.7

Breaking

None.

Enhancements

None.

Bug Fixes

• Fixed improper UTF8 parsing of MARK comments.
  JP Simard realm/jazzy#131

0.2.6

Breaking

None.

Enhancements

• Added CHANGELOG.md.
  JP Simard realm/jazzy#125

• Include parse errors in the JSON output.
  JP Simard #16

Bug Fixes

• Fixed crash when files contained a declaration on the first line.
  JP Simard #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 realm/jazzy#126