CHANGELOG.md

Main

Breaking

• None.

Enhancements

• None.

Bug Fixes

• None.

0.35.0

Breaking

• None.

Enhancements

• Support docs generation with SwiftPM in Swift 5.10.
  Added new syntax, attribute and declaration kinds introduced in Swift 5.10.
  John Fairhurst

• Added new syntax, attribute and declaration kinds introduced in Swift 5.9.
  John Fairhurst

• Added new syntax, attribute and declaration kinds introduced in Swift 5.8.
  JP Simard

• Added support for static_assert declaration introduced in C11.
  Zach Jaquish

Bug Fixes

• Fix an issue where the path to the SourceKit library would not be properly detected on Linux, when the swift executable was symlinked into a directory in PATH from its actual install tree.
  Julia DeMille

• Fix a crash when a file cannot be read as UTF-8.
  Martin Redington #765

• Fix compiling via make with Xcode 15.
  JP Simard #793

0.34.1

Breaking

• None.

Enhancements

• Add Request.sendAsync() function.
  JP Simard #759

Bug Fixes

• None.

0.34.0

Breaking

• SourceKitten now requires Swift 5.7 or higher to build.
  JP Simard

Enhancements

• Added support for bzlmod.
  Keith Smiley

Bug Fixes

• None.

0.33.1

Breaking

• None.

Enhancements

• Add a File.clearCaches() function to clear a file's cached data.
  JP Simard

Bug Fixes

• None.

0.33.0

Breaking

• SourceKitten now requires Swift 5.6 or higher to build, and macOS 12 or higher to run.
  JP Simard

• SourceKitten now always uses the in-process version of sourcekitd on macOS. The IN_PROCESS_SOURCEKIT environment variable is ignored and the SourceKittenConfiguration.preferInProcessSourceKit API has been completely removed.
  JP Simard

Enhancements

• Adds Bazel Build Support.
  Maxwell Elliott

• Support docs generation with Xcode 14 projects.
  John Fairhurst

Bug Fixes

• None.

0.32.0

Breaking

• SourceKitten now requires Swift 5.3 or higher to build.
  JP Simard

Enhancements

• Support docs generation on Swift 5.6.
  John Fairhurst

• Added SwiftDeclarationAttributeKind values introduced in Swift 5.6.
  JP Simard

• Add IN_PROCESS_SOURCEKIT environment variable, which causes to use the in-process version of sourcekitd on macOS. This avoids the use of XPC, which is prohibited in some sandboxed environments, such as in Swift Package Manager plugins.
  Juozas Valancius

Bug Fixes

• None.

0.31.1

Breaking

• None.

Enhancements

• Objective C Union support.
  Brian Osborn #705

• Add key.attributes and key.attribute enum cases to SwiftDocKey.
  Erick Sanchez

• Add --prettify and --sort-keys flags to complete command, both of which default to false. Previously these options were hardcoded to be enabled, which slowed down the command when processing large inputs.
  Paul Taykalo #710

• Add new SwiftDeclarationAttributeKind members available starting with Swift 5.4/5.5.
  John Fairhurst

Bug Fixes

• None.

0.31.0

Breaking

• SourceKitten now requires Swift 5.2 or higher to build.
  JP Simard

• SourceKittenFramework can no longer be integrated as a Carthage depdendency.
  JP Simard

• SourceKitten.xcworkspace and sourcekitten.xcproject have been completely removed. You can still use Xcode to develop SourceKitten by opening it as a Swift Package by typing xed . or xed Package.swift from your shell.
  JP Simard

• The command line syntax has slightly changed due to migrating from the Commandant command line parsing library to swift-argument-parser. For the most part the breaking changes are all to make the syntax more unix compliant and intuitive to use. For example, commands such as sourcekitten --help or sourcekitten -h now work as expected. The help output from various commands has greatly improved as well. A few notable breaking changes:

  • doc --spm-module was removed (use --spm --module-name instead)
  • sourcekitten module_info is now sourcekitten module-info
    JP Simard

Enhancements

• None.

Bug Fixes

• Always bypass codesigning when building Xcode projects.
  John Fairhurst #1183

0.30.1

Breaking

• None.

Enhancements

• Add SwiftDeclarationAttributeKind values introduced in Swift 5.3.
  JP Simard

Bug Fixes

• None.

0.30.0

Breaking

• SourceKitten now requires Swift 5.1 or higher to build.
  JP Simard

Enhancements

• Update Yams to 4.0.0.
  Keith Smiley JP Simard

• Add SwiftDeclarationAttributeKind values introduced in Swift 5.2.
  JP Simard

Bug Fixes

• Fix crashes when parsing .m files.
  Joe Laws

• Stop the program immediately if the xcodebuild command fails.
  John Fairhurst #643

0.29.0

Breaking

• Replace all uses of Int/Int64/NSRange representing byte offsets to use newly introduced ByteCount and ByteRange values instead. This will minimize the risk of accidentally using a byte-based offset in character-based contexts.
  Paul Taykalo JP Simard

Enhancements

• None.

Bug Fixes

• Improve key.parsed_declaration in Swift 5.1+ for declarations on multiple lines without a body.
  John Fairhurst #633

0.28.0

Breaking

• Replace many of the public extensions on String, and its internal caching mechanism CacheContainer, with a new StringView type.
  Paul Taykalo

Enhancements

• Allow inline html tags in ObjC doc comments.
  Chris Williams #409 realm/jazzy#976

• Support code formatting in ObjC doc comments with @c, @code and @endcode.
  Bryce Pauken #631

Bug Fixes

• Fix crash when SourceKit returns out of bounds string byte offsets.
  JP Simard

0.27.0

Breaking

• Update Commandant dependency to version 0.17.0, removing the antitypical/Result dependency in favor of the Swift standard library's Result type.
  JP Simard #623

Enhancements

• None.

Bug Fixes

• None.

0.26.0

Breaking

• SourceKitten now requires Swift 5.0 or higher to build.
  JP Simard

Enhancements

• Support building SourceKitten with Swift 5.1.
  Pedro Larroy

• Add new libclang types introduced between 0.49 and 0.59.
  JP Simard

• Add new SwiftDeclarationAttributeKind and SwiftDeclarationKind members introduced in Swift 5.1.
  JP Simard

• SyntaxKind now conforms to CaseIterable.
  JP Simard

Bug Fixes

• Fix Swift response files for paths including special characters.
  John Fairhurst

0.25.0

Breaking

• None.

Enhancements

• Add --spm option to guess the name of a Swift Package Manager module for documentation generation.
  John Fairhurst

• Support doc generation for modules built with Xcode 11.
  John Fairhurst

• Add Module.init?(spmArguments:spmName:inPath) and use in doc command to ensure Swift Package Manager module documentation is up to date.
  John Fairhurst

Bug Fixes

• Fix crash with misplaced documentation comment.
  John Fairhurst

0.24.0

Breaking

• Change Module.init?(spmName:) to Module.init?(spmName:inPath:).
  Norio Nomura

• SourceKitObjectConvertible now has SourceKitObject parameter requirement instead of sourcekitd_object_t. SourceKitObject isn't publicly initializable (this helps memory management).
  Colton Schlosser

• Dictionary and Array now conditionally conform to SourceKitObjectConvertible, instead of crashing when using unexpected types.
  Colton Schlosser

Enhancements

• Add cursorInfoUSR case to the Request.
  Timofey Solonin

• Add a Dictionary<String, SourceKitRepresentable>.referencedUSRs computed property to retrieve referenced USRs from a SourceKit cursor info response.
  Colton Schlosser

Bug Fixes

• Fix testCommandantDocsSPM failed on using Swift Package in Xcode 11, because Xcode 11 does not use SRCROOT as current directory on executing tests in Package.swift.
  Norio Nomura

• Release memory created for sourcekitd requests.
  Colton Schlosser realm/SwiftLint#2812

0.23.2

Breaking

• None.

Enhancements

• Add parsed extension declarations to Swift docs.
  John Fairhurst

• Make File conform to Equatable and Hashable.
  Elliott Williams

Bug Fixes

• None.

0.23.1

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix warnings or errors when compiling in Swift 5 language mode.
  Yi Wang JP Simard

0.23.0

Breaking

• None.

Enhancements

• Introduce XcodeBuildSetting for interacting with project build settings.
  Chris Zielinski

• Improve module name inference for Module.
  Chris Zielinski

• Add Swift 5 support. Add new SwiftDeclarationAttributeKind and SwiftDeclarationKind members and make those enums conform to CaseIterable.
  Norio Nomura

Bug Fixes

• “.swift”-suffixed directory in xcodebuild arguments no longer detected as Swift file.
  Minh Nguyễn #574

• Fix xcodebuild clean path for new build system and Xcode 10.2.
  John Fairhurst realm/jazzy#1057

• Pathnames containing shell-escaped characters in xcodebuild arguments no longer prevent documentation generation.
  John Fairhurst

• swiftc no longer passed as a compiler argument when using doc and the new build system.
  John Fairhurst

0.22.0

Breaking

• SourceKitten now requires Swift 4.2 or higher to build.
  JP Simard

Enhancements

• Add Request.syntaxTree to get a serialized representation of the file's SwiftSyntax tree.
  JP Simard

Bug Fixes

• Fix crash in NSString.location(fromByteOffset:) when using unicode characters.
  JP Simard realm/SwiftLint#2276

0.21.3

This is the last release to support building with Swift 4.0 and Swift 4.1.

Breaking

• None.

Enhancements

• If New Build System is enabled on Xcode, the doc command does not need to use the clean action on xcodebuild.
  Norio Nomura

• Use 'as' bridging on Linux when using Swift 4.2.
  JP Simard

Bug Fixes

• None.

0.21.2

Breaking

• None.

Enhancements

• Add support for C-language annotations (e.g. __attribute__((annotate("This is an annotation")))).
  Jeff Verkoeyen

• Improve support for building & running with Swift 4.2.
  Norio Nomura

• Add new values for SwiftDeclarationAttributeKind and SyntaxKind with Swift 4.2.
  JP Simard

Bug Fixes

• None.

0.21.1

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Support building with Swift 4.2. There are still runtime issues to resolve.
  Norio Nomura

• Fix a crash when running with Swift 4.2.
  Norio Nomura SR-7954

0.21.0

Breaking

• SourceKitten now requires Swift 4.0 or higher to build.
  JP Simard

Enhancements

• Make all SwiftDeclarationAttributeKind cases available no matter which version of Swift was used to compile SourceKitten.
  Marcelo Fabri

Bug Fixes

• Fix issue locating libsourcekitdInProc.so on some Linux distributions.
  Mike Hovan #513

0.20.0

This is the last release to support Swift 3.2 and Swift 3.3. The next release will require Swift 4.0 or higher.

Breaking

• Change type of parameter from sourcekitd_object_t to SourceKitObject?.

  • File.process(dictionary:cursorInfoRequest:syntaxMap:)
  • Request.customRequest(request:)
  • SwiftDocs.init(file:dictionary:cursorInfoRequest:) Norio Nomura

• Remove File.lines:setter.
  Norio Nomura

Enhancements

• Add SwiftDeclarationAttributeKind that represents declaration attributes in Swift.
  Daniel Metzing #504

• Add SourceKitObject that represents sourcekitd_object_t in Swift.
  Norio Nomura #489

• Replaced linear index search with binary search in NSString extension.
  Tamas Lustyik

• SourceKit search strategy improved on Linux. Supports swiftenv.
  Alexander Lash

• Add elements case to SwiftDocKey.
  Sho Ikeda

• Added module_info command to sourcekitten CLI.
  Erik Abair

Bug Fixes

• Fix index command fails using filename with spaces in compiler arguments.
  Norio Nomura #480

• Only allow U+000A and U+000D as line break tokens.
  Marcelo Fabri #475

• Fix ThreadSanitizer reports data race warning in SwiftLint.
  Norio Nomura realm/SwiftLint#2089

0.19.1

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix Swift Package Manager warnings when using SourceKitten targets as dependencies.
  JP Simard #478

0.19.0

Breaking

• SourceKitten now requires Xcode 9 and Swift 3.2+ to build.
  Norio Nomura

• Deprecated Request.failableSend(). Please use Request.send() instead.
  Norio Nomura

• Some APIs changed to throws.

  • File.format(trimmingTrailingWhitespace:useTabs:indentWidth:) throws
  • Structure.init(file:) throws
  • SyntaxMap.init(file:) throws Norio Nomura

Enhancements

• Return SWIFT_NAME when generating Objective-C docs.
  Ibrahim Ulukaya

Bug Fixes

• Fix Swift declarations when generating Objective-C docs for generic types.
  John Fairhurst

0.18.4

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix Swift 4.0.2 deprecation warnings in dependencies, specifically SWXMLHash.
  Norio Nomura

0.18.3

Breaking

• None.

Enhancements

• Support Swift 4.0.2.
  Norio Nomura #435

Bug Fixes

• Preserve horizontal alignment in multi-line Swift declarations.
  John Fairhurst

0.18.2

Breaking

• None.

Enhancements

• Add tabWidth parameter (default: 1) for lineAndCharacter.
  Marcel Jackwerth

• Add File(pathDeferringReading:) initializer.
  JP Simard

Bug Fixes

• Fix Swift declarations when generating Objective-C docs being truncated where ampersands were included.
  JP Simard

0.18.1

Breaking

• None.

Enhancements

• Updates to support Xcode 9 beta 5 & accompanying versions of Swift 3.2/4.0.
  JP Simard

Bug Fixes

• Fix compilation failures due to long debug times by removing compiler flag: -warn-long-function-bodies=200.
  Marcelo Fabri

0.18.0

Breaking

• Xcode 8.3 or later and Swift 3.1 or later are required to build.
  Norio Nomura

Enhancements

• Cache NSString.CacheContainer on Linux, matching behavior on Darwin, speeding up many repeated operations on NSString on Linux.
  JP Simard realm/SwiftLint#1577

• Process Swift 3.2/4 doc comments.
  John Fairhurst

• Support building with Xcode 9 beta 3 and the latest Swift 4 snapshots.
  JP Simard

Bug Fixes

• None.

0.17.6

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix handling of Swift extensions of nested types.
  John Fairhurst

0.17.5

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Improve quality & accuracy of Swift interfaces for Objective-C declarations when generating Objective-C docs.
  Norio Nomura #385

0.17.4

Breaking

• None.

Enhancements

• Generate Swift declaration for more Objective-C methods.
  Zheng Li #376

Bug Fixes

• Fix running sourcekitten version when building with Swift Package Manager.
  JP Simard

• Fix crash in lineAndCharacter(forByteOffset:) with strings including multi-byte unicode characters.
  Marcelo Fabri realm/SwiftLint#1006

• Fix compilation with latest Swift 4 snapshots.
  Norio Nomura

0.17.3

Breaking

• None.

Enhancements

• None.

Bug Fixes

• More accurate doc comment association in Swift.
  John Fairhurst #368

• Fix crashes when parsing XML with Swift 3.1.1 on Linux.
  Norio Nomura #379

• Fix compilation with latest Swift 4 snapshots.
  Norio Nomura

0.17.2

Breaking

• None.

Enhancements

• Update Cartfile.resolved & corresponding git submodule to point to Yams 0.3.1. Also loosen the Yams version dependency in Package.swift to only specify ~> 0.3 and not = 0.3.0.
  Norio Nomura

Bug Fixes

• None.

0.17.1

Breaking

• None.

Enhancements

• Added a new field numBytesToErase in CodeCompletionItem to indicate how many bytes should be deleted prior to the cursor in order to finish the completion.
  @KelvinJin

• Support Swift 3.1 on macOS. sourcekitInProc appears to be broken on Linux as of Swift 3.1.
  Norio Nomura #348

Bug Fixes

• Fix a crash that occurred when a documentation comment ended with an extended grapheme cluster.
  Lukas Stührk #350

0.17.0

Breaking

• Change Text enum case names to match Swift 3 API guidelines.
  @istx25

Enhancements

• None.

Bug Fixes

• Make sending Requests safer in concurrent environments.
  @krzysztofzablocki

0.16.0

Breaking

• The SourceKitten CocoaPods podspec used to actually refer to SourceKittenFramework, so it has been renamed. Existing pushes to CocoaPods trunk will be preserved, but from now on if you use SourceKittenFramework via CocoaPods, please specify to use the SourceKittenFramework pod.
  JP Simard

Enhancements

• Add Request.yaml API to create a sourcekit request from yaml and expose as a request --yaml [file|text] CLI command.
  Keith Smiley #312

Bug Fixes

• None.

0.15.3

Breaking

• None.

Enhancements

• Reduce compilation time.
  Norio Nomura

Bug Fixes

• None.

0.15.2

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix Objective-C enum cases not being documented.
  JP Simard #304

0.15.1

Breaking

• None.

Enhancements

• Improve performance of Yaml parsing.
  JP Simard #289

Bug Fixes

• CXComment.commandName() was returning nil on custom code comments since Xcode 8.1. This caused a force unwrap when generating documentation. Inline command comment is now used as a fallback to catch this edge case.
  Jérémie Girault

0.15.0

Breaking

• SourceKitten now requires Xcode 8.0 and Swift 3.0 to build. APIs have been adapted to conform to the Swift 3 API Design Guidelines.
  JP Simard Norio Nomura

Enhancements

• Add --spm-module [ModuleName] flag to complete to automatically detect compiler flags for Swift Package Manager modules. swift build must be run prior to support detection.
  vdka #270

• Now builds and passes most tests on Linux using the Swift Package Manager with Swift 3.0. This requires libsourcekitdInProc.so to be built and located in /usr/lib, or in another location specified by the LINUX_SOURCEKIT_LIB_PATH environment variable. A preconfigured Docker image is available on Docker Hub by the ID of norionomura/sourcekit:30.
  JP Simard Norio Nomura #179

• Now supports Swift Package Manager on macOS and Linux.
  JP Simard

• Now supports docinfo requests for sourcetext and module keys.
  Erik Abair

• Now supports Objective-C class properties.
  Jérémie Girault JP Simard #243

• Add podspec to support using SourceKittenFramework with CocoaPods.
  JP Simard

Bug Fixes

• NSString.lines() generated surplus line when string ended with newline character.
  Norio Nomura #259

0.14.1

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fixed Homebrew distribution.
  Norio Nomura

0.14.0

This is the last release to support Swift 2.2 and Swift 2.3. The next release will require Swift 3.0.

Breaking

• Embedding frameworks needed by sourcekitten was moved from SourceKittenFramework Xcode target to the sourcekitten target. The SourceKittenFramework.framework product built by the SourceKittenFramework target no longer contains unnecessary frameworks or multiple copies of the Swift libraries.
  Norio Nomura

• Require passing compiler arguments to index command.
  Brian Gesiak

• Remove --compilerargs CLI flag. Arguments are now passed after --.
  Keith Smiley

Enhancements

• Refactor to unite swift lang syntax types with SwiftLangSyntax protocol.

• Make SwiftDocKey public.
  Evgeny Suvorov

• Swift 2.3 support.
  Syo Ikeda

• The following availability and deprecation values are now exposed for Objective-C APIs.

  • key.always_deprecated
  • key.always_unavailable
  • key.deprecation_message
  • key.unavailable_message
    Jeff Verkoeyen

• Add SwiftDeclarationKind.PrecedenceGroup.
  JP Simard

Bug Fixes

• Fix issue where single-line declaration+bodies would include the body in the parsed declaration when generating docs.
  JP Simard #45 realm/jazzy#226

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

0.13.0

Breaking

• None.

Enhancements

• Add format command that re-indents a Swift file much like pasting into Xcode would. This command optionally takes the following parameters:

  • --file (string): relative or absolute path of Swift file to format
  • --no-trim-whitespace: trim trailing whitespace
  • --use-tabs: use tabs to indent
  • --indent-width (integer): number of spaces to indent
    JP Simard

• Add --spm-module [ModuleName] flag to doc to document Swift Package Manager modules. Need to run swift build prior to running sourcekitten doc. The right Swift toolchain version must also be selected (by setting TOOLCHAIN_DIR or similar).
  JP Simard

• Add support TOOLCHAINS environment variable to selecting alternative toolchains for loading SourceKitService.
  Norio Nomura

Bug Fixes

• Add support for handling CXCursor_UnexposedDecl declarations when documenting Objective-C.
  JP Simard realm/jazzy#543

0.12.2

Breaking

• None.

Enhancements

• Add index command.
  JP Simard

Bug Fixes

• None.

0.12.1

Breaking

• None.

Enhancements

• Swift declarations are included when generating Objective-C documentation.
  JP Simard realm/jazzy#136

Bug Fixes

• Fixed situations where the wrong documentation comment was found for a declaration, or when documentation comments were further than a single line away from their declaration and the declaration would be incorrectly considered undocumented.
  JP Simard realm/jazzy#454 realm/jazzy#502

0.12.0

Breaking

• Updated for Xcode 7.3.
  JP Simard

Enhancements

• None.

Bug Fixes

• None.

0.11.0

Breaking

• Now libclang.dylib and sourcekitd.framework are dynamically loaded at runtime by SourceKittenFramework to use the versions included in the Xcode version specified by xcode-select -p or custom toolchains. If SourceKittenFramework clients previously accessed either of these libraries directly using their APIs, those are no longer available.
  Norio Nomura #167

Enhancements

• Simplify the process of generating library wrappers and validate library wrappers in unit tests.
  JP Simard

• Support swift test on OS X.
  Norio Nomura

Bug Fixes

• Fix crash on DOS newlines.
  Norio Nomura realm/SwiftLint#315

• Fix doc.comment blank for many declarations, causing missing Jazzy docs.
  Norio Nomura #142

• Fix "Unrecognized arguments:" error on doc command.
  Norio Nomura #174

• Fix "illegal hardware instruction" error when SourceKitService returns string in other than NSUTF8StringEncoding.
  Norio Nomura #184

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 realm/SwiftLint#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 realm/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 realm/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

• 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 realm/jazzy#374 realm/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 realm/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 realm/jazzy#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 realm/jazzy#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