0.29.0: Kitty Nibble

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: Ball of Twine

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: Bastet

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: Cinco de Gato

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: Cool Cat

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: Curiosity killed the cat

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: Utthita Marjaryasana

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: Have a nice Felidae

Breaking

• None.

Enhancements

• None.

Bug Fixes

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

0.23.0: Thunkis Catus

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: Syntax Tree Ornament

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