Changelog History
Page 1
-
v0.13.6
November 08, 2020๐ฅ Breaking
- None.
โจ Enhancements
- ๐ Support documentation generation from
.swiftmodule
binaries using--swift-build-tool symbolgraph
with Swift 5.3.
John Fairhurst
๐ Bug Fixes
- ๐ Always bypass codesigning when building Xcode projects.
John Fairhurst #1183
-
v0.13.5
July 06, 2020๐ฅ Breaking
- None.
โจ Enhancements
โ Add search function to
apple
theme.
Giles Payne #726โ Add option
--[no-]separate-global-declarations
to always create separate documentation pages for top-level declarations as well as classes, structures, enums etc. even if they don't have members. As part of this, improve the main page declaration in all modes.
Nikolay Volosatov John Fairhurst
๐ Bug Fixes
- ๐
Style fixes for
apple
andjony
themes to codeblocks inside lists and links.
John Fairhurst #818 #1177
-
v0.13.4
May 31, 2020๐ฅ Breaking
- None.
โจ Enhancements
- โก๏ธ Update JavaScript libraries: jQuery 3.5.1 (all themes), Lunr 2.3.8,
typeahead.js 1.3.1 (
fullwidth
theme only).
John Fairhurst
๐ Bug Fixes
๐ Fix warnings from Ruby 2.7.
John Fairhurst #1185Accept
root_url
without trailing slash.
John Fairhurst #1188
-
v0.13.3
April 24, 2020๐ฅ Breaking
- None.
โจ Enhancements
โ Added a config option to provide sources of privately hosted pod
dependencies when using the--podspec
option.
--pod-sources url1,url2,โฆurlN
.
Jonathan Bailey
#650๐ Improve Dash docset support: support online redirection when
๐--root-url
is set, and provide--docset-playground-url
to
๐ support docset playground links.
John Fairhurst๐ Bug Fixes
๐ Fix module version not being used from podspec.
Jonathan BaileyAutolink Swift custom attributes/property wrappers.
John Fairhurst -
v0.13.2
April 02, 2020๐ฅ Breaking
- None.
โจ Enhancements
๐ Support Xcode 11.4. Default Objective-C property attributes are now stripped from declarations: turn this off with
--keep-default-property-attributes
.
John Fairhurst #829Render LaTeX expressions written using
$equation$
or$$equation$$
syntax.
Arthur Guiot John Fairhurst #1156Wrap long method names on category pages. Use
name_html
in custom mustache templates to take advantage of this.
John Fairhurst #995๐ Support Dash-style
apple_ref
links to specific API items, for more stable and human-readable links from external docs.
Paul Cantrell
๐ Bug Fixes
๐ Don't generate documentation if the
xcodebuild
command fails.
John Fairhurst jpsim/SourceKitten#643๐ Use multi-line parsed declarations in more places including protocol methods and typealiases.
John Fairhurst #896
-
v0.13.1
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
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
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
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
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