Skip to content

Latest commit

 

History

History
1899 lines (1260 loc) · 53.5 KB

CHANGELOG.md

File metadata and controls

1899 lines (1260 loc) · 53.5 KB
Raw

Master

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • None.

0.15.3

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Don't crash in SourceKitten when the Swift 6 compiler reports educational notes.
    John Fairhurst #1399

0.15.2

Breaking
  • None.
Enhancements
Bug Fixes
  • None.

0.15.1

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.15.0

Breaking
  • None.
Enhancements

  • 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-file modules 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

Bug Fixes

0.14.4

Breaking
  • None.
Enhancements

  • 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

Bug Fixes

0.14.3

Breaking
  • None.
Enhancements
Bug Fixes
  • None.

0.14.2

Breaking
  • 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
Enhancements

  • 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

Bug Fixes
  • In Swift symbolgraph mode, stop including extensions to types that are beneath the minimum ACL.
    John Fairhurst #1291

0.14.1

Breaking
  • Support Swift SPI groups. Swift declarations marked @_spi are no longer included in docs when --min-acl is set to public or open. Use --include-spi-declarations to include docs for these declarations.
    John Fairhurst #1263
Enhancements
Bug Fixes

0.14.0

Breaking
  • Require at least Ruby 2.6.3.
Enhancements

  • 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 all target="_blank" links.
    JP Simard

Bug Fixes

  • 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

0.13.7

The next release of Jazzy will require a minimum of Ruby 2.6.

Breaking
  • None.
Enhancements
Bug Fixes

0.13.6

Breaking
  • None.
Enhancements
  • Support documentation generation from .swiftmodule binaries using --swift-build-tool symbolgraph with Swift 5.3.
    John Fairhurst
Bug Fixes

0.13.5

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

0.13.4

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

0.13.3

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

0.13.2

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 #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

Bug Fixes

0.13.1

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#631

  • Add custom_categories_unlisted_prefix configuration setting. This is the prefix for navigation section names that aren't explicitly listed in custom_categories. Defaults to 'Other '.
    JP Simard

  • Add hide_unlisted_documentation configuration setting. Setting this to true 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 Simard

  • Pick the right version of declarations with type attributes.
    John Fairhurst #1148

0.13.0

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

0.12.0

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

0.11.2

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.11.1

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

0.11.0

Breaking
  • None.
Enhancements

  • Sass support now provided by libsass via sassc 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 and Package.swift files are present. Add --build-tool-flags as a preferred alias for --xcodebuild-flags.
    John Fairhurst #487

Bug Fixes

0.10.0

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

0.9.6

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.

0.9.5

Breaking
  • None.
Enhancements
Bug Fixes

0.9.4

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.9.3

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

  • Fix crash when specifying empty Swift version. Now correctly uses the default Swift version.
    JP Simard

  • Fix jony theme selection.
    John Fairhurst #962

0.9.2

Breaking
  • None.
Enhancements

  • 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

Bug Fixes

  • 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

0.9.1

Breaking
  • None.
Enhancements

  • 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

Bug Fixes

0.9.0

Breaking
  • 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 corresponding download_badge YAML configuration key.
    Samuel Giddins
Enhancements
  • None.
Bug Fixes

0.8.4

Breaking
  • None.
Enhancements
Bug Fixes

  • 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

0.8.3

Breaking
  • None.
Enhancements

  • 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

Bug Fixes

  • 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

0.8.2

Breaking
  • None.
Enhancements
Bug Fixes

0.8.1

Breaking
  • None.
Enhancements
Bug Fixes

0.8.0

Breaking
Enhancements
  • Add --[no-]download-badge flag to skip downloading the documentation coverage badge from shields.io. Useful if generating docs offline.
    JP Simard #765
Bug Fixes

0.7.5

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

  • 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

0.7.4

Breaking
  • None.
Enhancements

  • 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. With use_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

Bug Fixes

  • 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 and fullwidth themes only).
    Minh Nguyễn #714

  • Fix issue where passing a --podspec argument would use a malformed SWIFT_VERSION value, causing compilation to fail.
    JP Simard

0.7.3

Breaking
  • None.
Enhancements

  • 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

Enhancements
Bug Fixes

  • 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

0.7.2

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

  • Declarations marked @available(..., unavailable, ...) are no longer documented.
    JP Simard #654

  • Treat the open ACL as more public than public.
    JP Simard

0.7.1

Breaking
  • None.
Enhancements
Bug Fixes

  • 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

0.7.0

Breaking
  • The docset_platform option is no longer available. The module name will now be used instead of jazzy.
    JP Simard #423
Enhancements
  • 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
Bug Fixes

  • 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

0.6.3

Breaking
  • None.
Enhancements

  • --exclude flag now supports excluding directories in addition to files.
    Gurrinder #503

  • The cocoapods gem was updated to 1.0.1 and rouge 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

Bug Fixes
  • Don't document clang-unexposed Objective-C declarations.
    JP Simard #573

0.6.2

Breaking
  • None.
Enhancements
  • Include one level of nested classes, structs, protocols and enums in the navigation bar.
    JP Simard #64
Bug Fixes
  • None.

0.6.1

Breaking
  • None.
Enhancements

  • 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

Bug Fixes

  • 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 contain MARKs.
    JP Simard #544

0.6.0

Breaking

  • 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 with jazzy --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

Enhancements

  • 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 associatedtypes and infix, postfix & prefix operators.
    JP Simard

Bug Fixes

  • Add support for Objective-C module imports.
    JP Simard #452

  • Workaround for an apparent SourceKit bug which sometimes caused extensions to be merged into the wrong type.
    Paul Cantrell #459 #460

0.5.0

Breaking

  • --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

Enhancements

  • 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

Bug Fixes

  • 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

0.4.1

Note: this is the last official release of jazzy supporting Swift 1.x.

Breaking
  • None.
Enhancements

  • 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(...)

    Paul Cantrell #327 #329 #359

  • Miscellaneous minor font size, weight, and color adjustments.
    Jeff Verkoeyen

  • In-page anchors now appear below the header.
    Jeff Verkoeyen

Bug Fixes

  • 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

0.4.0

Breaking
  • --swift-version now defaults to 2.1 instead of 2.0.
    JP Simard
Enhancements

  • 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

Bug Fixes
  • None.

0.3.2

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

  • 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

0.3.1

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • Added missing Swift 2 declaration types.
    JP Simard

0.3.0

Breaking
  • --swift-version now defaults to 2.0 instead of 1.2.
    JP Simard
Enhancements

  • 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

Bug Fixes

  • "View on GitHub" is now only generated if a GitHub URL is specified.
    mbogh #244

  • Empty extensions are no longer documented.
    Paul Cantrell

  • Undocumented enum cases are now supported.
    JP Simard #74

0.2.4

Breaking
  • None.
Enhancements

  • 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

Bug Fixes

  • 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

0.2.3

Breaking
  • None.
Enhancements
  • The jazzy CLI now accepts a --swift-version option (defaulting to 1.2), and will automatically find an appropriate Xcode installation.
    Samuel Giddins #214
Bug Fixes
  • Declarations with no USR will no longer be documented.
    JP Simard

0.2.2

Breaking
  • None.
Enhancements
  • Added support for custom templates: use the -t/--template-directory argument to jazzy.
    JP Simard #20
Bug Fixes
  • None.

0.2.1

Breaking
  • None.
Enhancements
  • Added the ability to ignore certain files by passing in an -e/--exclude argument to jazzy.
    JP Simard #173
Bug Fixes
  • None.

0.2.0

Breaking
Enhancements
  • 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
Bug Fixes
  • None.

0.1.6

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.1.5

Breaking
  • None.
Enhancements
Bug Fixes

  • 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 and deinit.
    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

0.1.4

Breaking
  • None.
Enhancements
  • None.
Bug Fixes
  • No longer count undocumented externally declared tokens as undocumented.
    JP Simard #188

0.1.3

Breaking
  • None.
Enhancements

  • Improve the styling of dl elements (parsed key-value pairs).
    segiddins

  • Raise exceptions if Xcode requirements aren't met.
    JP Simard

Bug Fixes

  • 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

  • Fixed --source-directory CLI option.
    JP Simard #177

0.1.2

Breaking
  • None.
Enhancements
Bug Fixes
  • (Really) fixes installation as a RubyGem.
    beltex #159

0.1.1

Breaking
  • None.
Enhancements
  • None.
Bug Fixes

0.1.0

sourcekitten

Breaking
  • None.
Enhancements
  • Add the ability to document a Pod from just a podspec, which allows jazzy to run on cocoadocs.org.
    Samuel Giddins #58
Bug Fixes
  • 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

0.0.20

sourcekitten

Breaking
  • Don't skip declarations with no documentation comments by default. Allow skipping using --skip-undocumented.
    JP Simard #129
Enhancements
  • Combine abstract and discussion in page overview.
    JP Simard #115
Bug Fixes
  • Don't show 'Show in Github' link for types declared in system frameworks.
    JP Simard #110

0.0.19

sourcekitten

Breaking

None.

Enhancements
Bug Fixes

  • 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