- None.
- None.
- None.
- None.
- None.
- Restore compatibility with Ruby 2.6
John Fairhurst #1388
- None.
-
Update Javascript: typeahead.js 1.3.4, KaTeX 0.16.10
John Fairhurst -
Support Swift 5.10 with Swift Package Manager projects.
John Fairhurst #1381 -
Support documentation of multiple modules in a single website. Use
--modules
or the config-filemodules
for more control. See the README 'Documenting multiple modules' for more details.
Argjira Mala Pedro Alcobia John Fairhurst #564 -
Improve page breadcrumbs to include parent pages and indicate source module of extensions from other modules.
John Fairhurst -
Add
--readme-title
and--docset-title
to set the titles of the readme docs page and the Dash docset independently of the module name.
John Fairhurst -
Support Swift 5.9 symbolgraph extension symbols.
John Fairhurst #1368
- Fix incorrect activesupport usage.
John Fairhurst
- None.
-
Update Javascript: jQuery 3.7.1, KaTeX 0.16.8
John Fairhurst -
Support Swift
package
access control level.
John Fairhurst -
Initial support for Swift macro declarations. Requires
--swift-build-tool symbolgraph
.
John Fairhurst -
Support Swift
@_documentation(visibility:)
attribute. Requires--swift-build-tool spm|xcodebuild
.
John Fairhurst
-
Issue a warning instead of crashing on declarations without names.
#1325 John Fairhurst -
Fix extension ordering in symbolgraph mode.
John Fairhurst -
Fix symbolgraph mode crash involving tuple generic constraints.
John Fairhurst
- None.
-
Support Swift 5.7 and Xcode 14.
John Fairhurst -
Update Javascript: jQuery 3.6.1, KaTeX 0.13.5
John Fairhurst
- None.
- When building with Swift 5.6 and not passing
—-module
to Jazzy, declarations may not be correctly identified as undocumented and docs may include unwanted extensions. Pass—-module MyModuleName
to fix this.
John Fairhurst
-
Support using pre-generated symbolgraph files in Swift symbolgraph mode.
Nathan Wong -
Issue a warning on some combinations of Objective-C flags.
John Fairhurst #900 -
Support Swift 5.6. The bundled
sourcekitten
is a universal binary.
John Fairhurst
- In Swift symbolgraph mode, stop including extensions to types that are beneath
the minimum ACL.
John Fairhurst #1291
- Support Swift SPI groups. Swift declarations marked
@_spi
are no longer included in docs when--min-acl
is set topublic
oropen
. Use--include-spi-declarations
to include docs for these declarations.
John Fairhurst #1263
-
Correct line number references with Xcode 13.
John Fairhurst -
Support
union
declarations in Objective-C headers.
Brian Osborn John Fairhurst -
Support Swift concurrency features: identify actors and asynchronous methods.
John Fairhurst
- Improve HTML5 correctness, all themes.
John Fairhurst #1280
- Require at least Ruby 2.6.3.
-
Support DocC-style autolinks and callouts in markdown.
John Fairhurst -
Add
--source-host
option to support projects hosted on GitLab and Bitbucket as well as GitHub. Options--source-host-url
and--source-host-files-url
and new Mustache tags replace the 'github' versions which remain as back-compatibility aliases.
John Fairhurst #314 -
Add
rel="noopener"
to alltarget="_blank"
links.
JP Simard
-
Fix source-host line number references in Swift symbolgraph mode, and in ObjC mode for references to one-line declarations.
John Fairhurst -
Fix crash with
` `
in markdown.
John Fairhurst #1270 -
Fix symbolgraph mode with Xcode 13.
John Fairhurst
The next release of Jazzy will require a minimum of Ruby 2.6.
- None.
-
Update JavaScript libraries: jQuery 3.6.0, Lunr 2.3.9, KaTeX 0.13.5.
John Fairhurst -
Support the markdown footnotes extension in all themes.
John Fairhurst #1246
- Fix parameter doc comments in Swift symbolgraph mode.
John Fairhurst #1244
- None.
- Support documentation generation from
.swiftmodule
binaries using--swift-build-tool symbolgraph
with Swift 5.3.
John Fairhurst
- Always bypass codesigning when building Xcode projects.
John Fairhurst #1183
- None.
-
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
- Style fixes for
apple
andjony
themes to codeblocks inside lists and links.
John Fairhurst #818 #1177
- None.
- Update JavaScript libraries: jQuery 3.5.1 (all themes), Lunr 2.3.8,
typeahead.js 1.3.1 (
fullwidth
theme only).
John Fairhurst
-
Fix warnings from Ruby 2.7.
John Fairhurst #1185 -
Accept
root_url
without trailing slash.
John Fairhurst #1188
- None.
-
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
-
Fix module version not being used from podspec.
Jonathan Bailey -
Autolink Swift custom attributes/property wrappers.
John Fairhurst
- None.
-
Support Xcode 11.4. Default Objective-C property attributes are now stripped from declarations: turn this off with
--keep-default-property-attributes
.
John Fairhurst #829 -
Render LaTeX expressions written using
$equation$
or$$equation$$
syntax.
Arthur Guiot John Fairhurst #1156 -
Wrap 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
-
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
- None.
-
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#631 -
Add
custom_categories_unlisted_prefix
configuration setting. This is the prefix for navigation section names that aren't explicitly listed incustom_categories
. Defaults to 'Other '.
JP Simard -
Add
hide_unlisted_documentation
configuration setting. Setting this totrue
hides documentation entries in the sidebar from thedocumentation
config value that aren't explicitly listed incustom_categories
.
JP Simard
-
Fix crash when SourceKit returns out of bounds string byte offsets.
JP Simard -
Pick the right version of declarations with type attributes.
John Fairhurst #1148
- None.
-
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
-
Render bullet lists correctly when followed by a callout.
John Fairhurst #785 -
Render markup of text inside double quotes.
John Fairhurst #992 -
Fix
sourcekitten_sourcefile
used from config file.
John Fairhurst #1137
- None.
- Support for mixed Swift-ObjC modules: generate two sets of SourceKitten
json and pass them on using
--sourcekitten-sourcefile
.
Joe Susnick John Fairhurst #447
-
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
- None.
- None.
-
Generate Swift docs with Xcode 11 and paths with spaces.
John Fairhurst #1108 -
Reinstate guessing of module name from podspec, broken in 0.11.0.
John Fairhurst #1109
- None.
- None.
- Don't use SwiftPM if there is an Xcode workspace or project in a non-root
directory.
John Fairhurst #1103
- None.
-
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
-
Preserve non-latin characters in guide filenames and heading IDs.
John Fairhurst #1091 -
Generate correct html for custom categories containing special characters.
John Fairhurst #945 -
Fix crash on files with misplaced documentation comments.
John Fairhurst #1083
- 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
-
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
-
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
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.
- None.
-
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
- None.
- None.
-
Link to documentation pages from contents pages.
John Fairhurst #730 -
Call out unavailable and deprecated Objective-C declarations.
Stefan Kieleithner John Fairhurst #843
-
Support Swift 4.2 with
--podspec
.
John Fairhurst #1015 -
Fix multiline copyright for
apple
theme.
Fabien Lydoire John Fairhurst #1016
- None.
- None.
-
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
- None.
- None.
-
Fix crash when specifying empty Swift version. Now correctly uses the default Swift version.
JP Simard -
Fix jony theme selection.
John Fairhurst #962
- None.
-
Add a new 'jony' theme similar to the 2017 Apple documentation style.
Harshil Shah -
Add the ability to limit documentation to certain files by passing in an
-i
/--include
argument.
Nick Fox #949 -
Improve Swift declarations to look more like the Xcode Quick Help version, for example including
{ get set }
, and include all attributes.
John Fairhurst #768 #591
-
Preserve
MARK
comment headings associated with extensions and enum cases.
John Fairhurst -
Fix issue where Overview items were invalidly being referenced with NULL types in the generated Dash docset index.
Andrew De Ponte -
Don't display FIXME or TODO comments as section markers.
John Fairhurst #658
- None.
-
Added a config option (
--undocumented-text UNDOCUMENTED_TEXT
) to set the default text for undocumented symbols.
Akhil Batra #913 -
Added a config option to hide Objective-C or Swift declarations:
--hide-declarations [objc|swift]
.
Ibrahim Ulukaya #828 -
Automatically use Swift or Objective-C syntax highlighting for code blocks in documentation comments. Improve Swift highlighting with latest Rouge.
John Fairhurst #218
-
Fix Swift declarations when generating Objective-C docs for generic types.
John Fairhurst #910 -
Don't create documentation nodes for generic type parameters.
John Fairhurst #878
- Generate documentation coverage badge locally. Since this avoids the failable
HTTP request to shields.io previously used to obtain the badge, we've removed
the
--[no-]download-badge
flag and the correspondingdownload_badge
YAML configuration key.
Samuel Giddins
- None.
-
Fixed issue that prevented Jazzy from running on case sensitive file systems.
Jeremy David Giesbrecht #891 -
Fixed issue preventing
--podspec
from working withtest_spec
s.
John Fairhurst #894 -
Always display correct declaration for undocumented symbols.
John Fairhurst #864 -
Trim common indentation in multiline declarations.
John Fairhurst #836
- None.
-
Align jazzy terminology with Apple usage.
Xiaodi Wu John Fairhurst -
Add
url
attribute that can be more accurate than{{section}}.html
as a URL in custom templates.
John Fairhurst
-
Fix crash when specifying
swift_version
as a floating point value in.jazzy.yaml
rather than a string.
JP Simard #860 -
Autolink from parameter documentation and from external markdown documents including README. Autolink to symbols containing & < >.
John Fairhurst #715 #789 #805 -
Fix Swift 4 declarations containing ampersands (
&
) being truncated.
JP Simard
- None.
-
Generate Swift declaration for more Objective-C declarations.
Zheng Li -
Improve quality & accuracy of Swift interfaces for Objective-C declarations when generating Objective-C docs.
Norio Nomura -
Process Swift 3.2/4 doc comments.
John Fairhurst
-
Fix missing doc comments on some extensions.
John Fairhurst #454 -
Fix failure when attempting to download documentation coverage badge with jazzy using macOS system Ruby, or a Ruby built with outdated versions of OpenSSL.
JP Simard #824 -
Stop
--skip-undocumented
from skipping documented items nested inside extensions of types from other modules.
John Fairhurst #502 -
Fix members added to extensions of a nested type showing up in the parent.
John Fairhurst #333
- None.
-
Report number of included and skipped declarations in CLI output.
John Fairhurst #238 -
Build ObjC docs with clang modules enabled by default (
-fmodules
flag).
Maksym Grebenets #636 -
Shave ~1MB from jazzy's gem distribution.
JP Simard
-
Fix support for Ruby 2.2.
John Fairhurst #801 -
Fix many cases of incorrect, missing or superfluous docs on Swift declarations.
John Fairhurst
- None.
- Allow all markdown in returns and parameter description callouts.
John Fairhurst #476
- Fix a crash that occurred when a documentation comment ended with an extended
grapheme cluster.
Lukas Stührk #794 SourceKitten#350
undocumented.json
is now only in the output directory and is no longer copied into docsets.
Jeremy David Giesbrecht #754
- Add
--[no-]download-badge
flag to skip downloading the documentation coverage badge from shields.io. Useful if generating docs offline.
JP Simard #765
-
Blank line no longer needed before lists or code blocks.
John Fairhurst #546 -
Linking to headers in apple theme gives correct vertical alignment.
John Fairhurst -
Headers in source code markdown no longer cause corruption.
John Fairhurst #628
- None.
- None.
-
Fix issue where using a custom theme would crash jazzy when using Ruby 2.4.
Jason Wray #752 -
Fix support for Ruby 2.0.0.
Jason Wray #747 -
Fix issue where header files are not found if inside subdirectories of the framework_root specified folder.
Christopher Gretzki #518
- None.
-
Generate shields.io badge for documentation coverage, unless
hide_documentation_coverage
is set.
Harlan Haskins #723 -
Add support for searching docs when using the
fullwidth
theme. A new option,--disable-search
, lets you turn this off.
Esad Hajdarevic Tom MacWright Nadia Barbosa #14 -
New config option
use_safe_filenames
encodes unsafe characters when generating filenames. By default, documentation may receive filenames like/(_:_:).html
. Withuse_safe_filenames
, the same file will receive the name_2F_28_5F_3A_5F_3A_29.html
instead.
Jeremy David Giesbrecht #699 #146 #361 #547 -
References to Objective-C methods are now autolinked.
Minh Nguyễn #362 -
Print documentation coverage percentage and the number of undocumented methods to the command line when running jazzy.
Jason Wray
-
Fix issue where existing abstracts for non custom sections would be completely overwritten when using extra abstract injection with --abstract.
Thibaud Robelain #600 -
Fix issue where generic type parameters registered as undocumented symbols.
Jeremy David Giesbrecht #429 -
Fix issue where parameter and return callouts were duplicated in documentation.
Jeremy David Giesbrecht #673 -
Fix issue where Objective-C superclass in declaration was unlinked.
Minh Nguyễn #706 -
Fix issue where multiple Objective-C categories of the same external class in different files were merged into one and named after the first category found.
Minh Nguyễn #539 -
String literals in code listings are no longer wrapped in
<q>
tags (apple
andfullwidth
themes only).
Minh Nguyễn #714 -
Fix issue where passing a
--podspec
argument would use a malformedSWIFT_VERSION
value, causing compilation to fail.
JP Simard
- None.
-
Podspec-based documentation will take trunk's
pushed_with_swift_version
attribute into account when generating documentation by default.
Orta Therox -
Podspec-based documentation respects the
swift-version
config option.
Orta Therox
-
Support Objective-C class properties.
Jérémie Girault JP Simard -
Support documenting Swift 3 operator precedence groups.
JP Simard
-
Rename Dash typedef type from "Alias" to "Type".
Bogdan Popescu -
Fix crash when sorting multiple identically named declarations with no USR, which is very common when generating docs for podspecs supporting multiple platforms.
JP Simard #661 -
Fix Xcode not being found when specifying a custom Swift version (
--swift-version
).
Samuel Giddins Paul Cantrell #656 -
Fix crash when generating Objective-C docs for projects with "@" directives in documentation comments with Xcode 8.1 or later.
Jérémie Girault
- None.
- None.
-
Declarations marked
@available(..., unavailable, ...)
are no longer documented.
JP Simard #654 -
Treat the
open
ACL as more public thanpublic
.
JP Simard
- None.
- Added support for the new access control specifiers of fileprivate and open.
Shmuel Kallner #645 #646
-
Fix issue where jazzy could not be installed from Gemfile due to SourceKitten symlinks already being present.
William Meleyal #438 -
The lint report in
undocumented.json
is more human-readable: includes fully qualified symbol names, pretty printed.
Paul Cantrell #598 -
The
exclude
option now properly supports wildcards.
Paul Cantrell #640
- The
docset_platform
option is no longer available. The module name will now be used instead ofjazzy
.
JP Simard #423
- Improved auto-linking behavior to link declarations within declarations and
fix cases where declarations would link to themselves or their current page.
Esad Hajdarevic #483
-
Fix issue where single-line declaration + bodies in Swift would include the body in the parsed declaration.
JP Simard #226 -
Fix issue where some sections would become empty when using custom groups.
JP Simard #475 -
Fix issue where directories ending with
.swift
would be considered Swift source files.
JP Simard #586
- None.
-
--exclude
flag now supports excluding directories in addition to files.
Gurrinder #503 -
The
cocoapods
gem was updated to 1.0.1 androuge
to 1.11.0.
Samuel Giddins #568 -
Extra markdown documentation can now be included as their own pages in the sidebar using the
--documentation
option and in the generated Dash docset as Guides.
Karl Bowden #435 -
Section headings can now include additional markdown content using the
--abstract
option.
Karl Bowden #435 -
If Swift version is not specified, look for Swift toolchain or clang location in the following order:
$XCODE_DEFAULT_TOOLCHAIN_OVERRIDE
$TOOLCHAIN_DIR
xcrun -find swift
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
This will be especially useful once jazzy supports generating docs for Swift Package Manager modules with a toolchain not tied to an Xcode release.
JP Simard
- None.
- Include one level of nested classes, structs, protocols and enums in the
navigation bar.
JP Simard #64
- None.
- None.
-
Objective-C documentation now also includes Swift declarations.
JP Simard #136 -
Default to the Xcode version selected in
xcode-select
if no Swift version is specified.
Samuel Giddins #427
-
Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages.
Zachary Waldowski #524 -
Fix crash when using unexposed declarations in Objective-C.
JP Simard #543 -
No longer document Swift extensions on types with an ACL lower than
min-acl
when they containMARK
s.
JP Simard #544
-
Config files now use the same option names as the command line. If you are using one of the keys that has changed in your
.jazzy.yaml
, you will receive a warning. See the pull request for a complete list of changed options. As always, you can get a list of all options withjazzy --help config
.
Paul Cantrell -
Jazzy's undocumented.txt has been replaced with undocumented.json. This new format includes contextual information that one might use to lint documentation in an automated fashion.
Jeff Verkoeyen -
--swift-version
now defaults to 2.2 instead of 2.1.1.
Tamar Nachmany
-
Add
--skip-documentation
flag. Skips site generation phase.undocumented.json
is still generated.
Jeff Verkoeyen -
Merge Objective-C categories into their parent type documentation to match Swift behavior.
Esad Hajdarevic #457 -
Add support for documenting Swift 2.2
associatedtype
s and infix, postfix & prefix operators.
JP Simard
-
Workaround for an apparent SourceKit bug which sometimes caused extensions to be merged into the wrong type.
Paul Cantrell #459 #460
-
--swift-version
now defaults to 2.1.1 instead of 2.1.
Nikita Lutsenko #416 -
Swift 1.x is no longer supported.
-
--templates-directory
and--assets-directory
have been deprecated in favor of--theme
. Specify either 'apple' (default), 'fullwidth' or the path to your mustache templates and other assets for a custom theme.
Karl Bowden JP Simard #130
-
Add
--sdk [iphone|watch|appletv][os|simulator]|macosx
option for Objective-C projects.
Jeff Verkoeyen -
Add
--head
option to inject custom HTML into<head></head>
.
JP Simard
-
Fix an issue where extension documentation would use the original type documentation block rather than the comment immediately preceding the extension.
JP Simard #230 #313 #334 -
Fix multi-byte documentation issues.
Norio Nomura #403
Note: this is the last official release of jazzy supporting Swift 1.x.
- None.
-
Support "wall of asterisk" documentation comments.
Jeff Verkoeyen #347 -
Expanding a token no longer causes the document to 'jump' to the hash.
Jeff Verkoeyen #352 -
Autolinking improvements:
- Autolinks only match
`ThingsInBackticks`
, and must match the entire string. This prevents spurious matching in prose and sample code. - Autolinks supports siblings, ancestors, top-level elements, and
dot-separated chains starting with any of the above:
someProperty
,SomeType.NestedType.someMethod(_:)
. - New
...
wildcard prevents you from having to list all method parameters:someMethod(...)
- Autolinks only match
-
Miscellaneous minor font size, weight, and color adjustments.
Jeff Verkoeyen -
In-page anchors now appear below the header.
Jeff Verkoeyen
-
Fix an out-of-bounds exception when generating pragma marks.
JP Simard #370 -
Add support for C/C++ struct, field & ivar types.
JP Simard #374 #387 -
Links to source files on GitHub are no longer broken when
source_directory
does not point to the current working directory.
Paul Cantrell -
When
excluded_files
is specified in a config file, it is now resolved relative to the file (like other options) instead of relative to the working directory.
Paul Cantrell
--swift-version
now defaults to 2.1 instead of 2.0.
JP Simard
-
Support for documenting Objective-C projects! 🎉 Pass
--objc
,--umbrella-header ...
and-framework-root ...
.
JP Simard #56 -
Mentions of top-level declarations in documentation comments are now automatically hyperlinked to their reference.
JP Simard -
Jazzy can now read options from a configuration file. The command line provides comprehensive help for available options via
jazzy -h config
.
Paul Cantrell #310 -
Render special list items (e.g. Throws, See, etc.). See https://ericasadun.com/2015/06/14/swift-header-documentation-in-xcode-7/ for a complete list.
JP Simard #317 -
Support for Swift 2.1.
JP Simard -
Swift extensions are now merged with their extended type, rendering a note to describe extension default implementations and extension methods.
Paul Cantrell
- None.
- None.
- None.
-
Fixed an issue that prevented building projects with different schema & module names.
JP Simard #259 -
Hide documentation coverage from header using
--hide-documentation-coverage
.
mbogh #129 -
Print a more informative error when unable to find an Xcode that has the requested Swift version.
Samuel Giddins
- None.
- None.
- Added missing Swift 2 declaration types.
JP Simard
--swift-version
now defaults to 2.0 instead of 1.2.
JP Simard
-
Now supports Swift 2.0 (previous Swift versions are still supported).
JP Simard Samuel Giddins -
Declarations can now be grouped by custom categories defined in a JSON or YAML file passed to
--categories
.
Paul Cantrell
-
"View on GitHub" is now only generated if a GitHub URL is specified.
mbogh #244 -
Empty extensions are no longer documented.
Paul Cantrell
- None.
-
Improved how SourceKitten is vendored.
JP Simard -
Show type declaration under its title.
Paul Cantrell -
Added support for custom assets: pass
--assets-directory
to jazzy.
gurkendoktor -
Added support for custom copyright text: pass
--copyright
to jazzy.
emaloney
-
Fixed a crash when parsing an empty documentation comment.
JP Simard #236 -
--exclude
now works properly if its argument is a relative path.
Paul Cantrell
- None.
- The
jazzy
CLI now accepts a--swift-version
option (defaulting to 1.2), and will automatically find an appropriate Xcode installation.
Samuel Giddins #214
- Declarations with no USR will no longer be documented.
JP Simard
- None.
- Added support for custom templates: use the
-t
/--template-directory
argument to jazzy.
JP Simard #20
- None.
- None.
- Added the ability to ignore certain files by passing in an
-e
/--exclude
argument to jazzy.
JP Simard #173
- None.
- Use
key.accessibility
to determine ACL (value coming from SourceKit, which is generally more accurate than parsing the declaration for an accessibility keyword).
JP Simard #185
- None.
- None.
- None.
- Make the gem installable.
Samuel Giddins
- None.
-
Fixed issue where docset would contain duplicate files.
JP Simard #204 -
Fixed installation issues on case-sensitive file systems.
kishikawakatsumi -
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
anddeinit
.
JP Simard #27 -
Fixed issues where USR wasn't accurate because dependencies couldn't be resolved.
JP Simard -
Allow using a version of Xcode that is symlinked to
/Applications/Xcode.app
.
Samuel Giddins
- None.
- None.
- None.
-
Improve the styling of
dl
elements (parsed key-value pairs).
segiddins -
Raise exceptions if Xcode requirements aren't met.
JP Simard
-
No longer count initializers with parameters as undocumented.
JP Simard #183 -
No longer crash when a token is missing a USR.
JP Simard #171 -
Fixed encoding issues in some environments.
James Barrow #152 -
No longer count undocumented externally declared tokens as undocumented.
JP Simard #188
- None.
- None.
- None.
- Fixes installation as a RubyGem.
Samuel Giddins #159
- None.
- Add the ability to document a Pod from just a podspec, which allows jazzy to
run on cocoadocs.org.
Samuel Giddins #58
- De-duplicate the sidebar list of extensions and show all children for an
extension, regardless of how many extensions on a type there are.
Samuel Giddins
- Don't skip declarations with no documentation comments by default.
Allow skipping using
--skip-undocumented
.
JP Simard #129
None.
-
Include parse errors in the JSON output & print to STDERR.
JP Simard jpsim/sourcekitten#16
-
Fixed crash when files contained a declaration on the first line.
JP Simard jpsim/sourcekitten#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 #126