Changelog History
Page 2
-
v0.13.1 Changes
January 07, 2020๐ฅ Breaking
- None.
โจ Enhancements
๐ Allow inline html tags in ObjC doc comments.
Chris Williams
#976๐ Support code formatting in ObjC doc comments with
@c
,@code
and
@endcode
.
Bryce Pauken
jpsim/SourceKitten#631Add
custom_categories_unlisted_prefix
configuration setting. This
is the prefix for navigation section names that aren't explicitly
0๏ธโฃ listed incustom_categories
. Defaults to 'Other '.
JP SimardAdd
hide_unlisted_documentation
configuration setting. Setting this
๐ totrue
hides documentation entries in the sidebar from the
๐documentation
config value that aren't explicitly listed in
custom_categories
.
JP Simard๐ Bug Fixes
๐ Fix crash when SourceKit returns out of bounds string byte offsets.
JP SimardPick the right version of declarations with type attributes.
John Fairhurst
#1148 -
v0.13.0 Changes
December 09, 2019๐ฅ Breaking
- None.
โจ Enhancements
โ Add section headings for members added by Swift conditional conformances.
John Fairhurst
#717๐ Parse markdown in MARK comments, make the html available to themes via
name_html
mustache tag key for section headings.
John Fairhurst๐ Include protocol conformances added by extensions in Swift docs.
John Fairhurst๐ Bug Fixes
Render bullet lists correctly when followed by a callout.
John Fairhurst
#785Render markup of text inside double quotes.
John Fairhurst
#992๐ Fix
sourcekitten_sourcefile
used from config file.
John Fairhurst
#1137 -
v0.12.0 Changes
November 11, 2019๐ฅ Breaking
- None.
โจ Enhancements
- ๐ Support for mixed Swift-ObjC modules: generate two sets of SourceKitten
json and pass them on using
--sourcekitten-sourcefile
.
Joe Susnick John Fairhurst #447
๐ Bug Fixes
Stop displaying type attributes on extension declarations.
John Fairhurst๐ Show ObjC and Swift classes (etc.) in the same category.
John Fairhurst๐ Merge Swift extensions into ObjC classes.
John Fairhurst Joe Susnick
-
v0.11.2 Changes
September 25, 2019๐ฅ Breaking
- None.
โจ Enhancements
- None.
๐ Bug Fixes
๐ Generate Swift docs with Xcode 11 and paths with spaces.
John Fairhurst
#1108Reinstate guessing of module name from podspec, broken in 0.11.0.
John Fairhurst
#1109 -
v0.11.1 Changes
September 17, 2019๐ฅ Breaking
- None.
โจ Enhancements
- None.
๐ Bug Fixes
- Don't use SwiftPM if there is an Xcode workspace or project in a non-root
directory.
John Fairhurst #1103
-
v0.11.0 Changes
September 13, 2019๐ฅ Breaking
- None.
โจ Enhancements
๐ Sass support now provided by
libsass
viasassc
instead of the deprecated Ruby Sass gem.
John Fairhurstโก๏ธ Update bundled jQuery to 3.4.1 (all themes).
Paul Idstein๐ Support Xcode 11 Swift projects that pass a response file to the Swift compiler.
John Fairhurst #1087๐ฆ Generate Swift docs from a Swift Package Manager package without requiring an Xcode project file. Add
--swift-build-tool
to choose the build method if both.xcodeproj
andPackage.swift
files are present. Add--build-tool-flags
as a preferred alias for--xcodebuild-flags
.
John Fairhurst #487
๐ Bug Fixes
Preserve non-latin characters in guide filenames and heading IDs.
John Fairhurst #1091Generate correct html for custom categories containing special characters.
John Fairhurst #945๐ Fix crash on files with misplaced documentation comments.
John Fairhurst #1083
-
v0.10.0 Changes
June 22, 2019๐ฅ Breaking
- The included
sourcekitten
binary is built with Xcode 10.2. This means it does not run on macOS earlier than 10.14.4 without the Swift 5 Runtime Support for Command Line Tools being installed.
John Fairhurst
โจ Enhancements
๐ Support CocoaPods 1.6+. Use the
swift_version[s]
dsl in--podspec
mode to set the Swift language version.
John Fairhurst๐ Show the extension declaration when documenting Swift extensions.
John Fairhurst๐ Allow docs title customization. Include
--module-version
when it is set and support--title
to fully customize the title. Pass{{module_version}}
and{{docs_title}}
to templates.
Maximilian Alexander John Fairhurst #666 #411
๐ Bug Fixes
๐ Unfold member documentation when linked to from current web page.
John Fairhurst #788๐ Generate docs when there are unusual characters in source pathnames.
John Fairhurst #1049๐ Generate docs for signed modules with Xcode 10.2.
John Fairhurst #1057๐ Use correct module name when only target name is supplied.
Chris Zielinski #422
- The included
-
v0.9.6 Changes
April 04, 2019๐ This is (probably) the last release to support Ruby earlier than 2.3. This is due to a change in a dependency.
๐ This is (probably) the last release to support macOS earlier than 10.14.4 without the Swift 5 Runtime Support for Command Line Tools package installed. This is a consequence of Swift 5 ABI stability.
๐ฅ Breaking
- None.
โจ Enhancements
๐ Swift 5 support: suppress unwanted newlines and
deinit
declarations.
John Fairhurstโก๏ธ Update JavaScript libraries: jQuery 3.3.1 (all themes), Lunr 2.3.5,
typeahead.js 1.2.1 (fullwidth
theme only).
John Fairhurst
#901๐ท Avoid
clean build
when using the new Xcode build system.
Norio Nomura๐ Bug Fixes
- None.
-
v0.9.5 Changes
January 26, 2019๐ฅ Breaking
- None.
โจ Enhancements
๐ Link to documentation pages from contents pages.
John Fairhurst
#730๐ Call out unavailable and deprecated Objective-C declarations.
Stefan Kieleithner
John Fairhurst
#843๐ Bug Fixes
๐ Support Swift 4.2 with
--podspec
.
John Fairhurst
#1015๐ Fix multiline copyright for
apple
theme.
Fabien Lydoire
John Fairhurst
#1016 -
v0.9.4 Changes
January 26, 2019๐ฅ Breaking
- None.
โจ Enhancements
- None.
๐ Bug Fixes
๐ Fix crash with pre-existing
Docs
directory.
John Fairhurst
#965๐ Fix crash with unicode scalars in string literals.
John Fairhurst
#972๐ Fix error compiling a Swift podspec in Xcode 10.
Minh Nguyแป n
#970