Sourced from dokka-gradle-plugin's releases.
1.6.20 Beta
Features
- Introduce
documentedVisibilitiessetting that allows including/excluding any visibility modifier in documentation. This is a more flexible replacement forincludeNonPublic, which has now been deprecated (Kotlin/dokka#2270)- Make HTML pages customizable through FreeMarker HTML templates (Kotlin/dokka#2374)
- Add global settings to JSON dokka CLI input (Kotlin/dokka#2292), thanks to
@BarkingBad!HTML format changes
- Add vertical alignment (wrapping) of signatures when 3 and more parameters are present (Kotlin/dokka#2309)
- Enhance primary constructor signature, display
val/varkeywords and default values (Kotlin/dokka#2313)- Add a level of indentation to childless items in navigation tree (Kotlin/dokka#2291)
- Add horizontal margin to breadcrumbs delimiter (Kotlin/dokka#2285)
- Fixed various CSS rendering issues (Kotlin/dokka#2284, Kotlin/dokka#2389)
Bugfixes
- Fixed
OutOfMemoryError: Metaspace-related issues for the majority of cases (Kotlin/dokka#2216)- Fixed classpath issues for HMPP libraries (Kotlin/dokka#2431)
- Using
@symbol within code blocks in.mdfiles doesn't lead to cropped documents anymore (Kotlin/dokka#2418)- Fixed incorrect placement of HTML head tags, which led to missing favicon in multi-module projects (Kotlin/dokka#2365)
- Fixed resolution of ultralight methods that led to flaky signature generation (Kotlin/dokka#2400)
- Coroutines dispatchers are now shut down after each module pass to avoid resource leaks (Kotlin/dokka#2325)
- Suppressed property setters are now excluded from documentation (Kotlin/dokka#2220)
- Suppressing extensions doesn't fail builds anymore (Kotlin/dokka#2348), thanks to
@BarkingBad!- Fixed java getter / setter name generation for kotlin-java interop, now
isBooleaninstead ofgetBoolean(Kotlin/dokka#2356), thanks to@CharlesG-Branch!- Fixed MathJax plugin, previously completely broken (Kotlin/dokka#2342), thanks to
@wyskoj!- Fixed Input/Output streams to minimize resource leaks (Kotlin/dokka#2312, Kotlin/dokka#2319)
Plugin API Changes
- Add an extension point for rendering custom documentation tags (Kotlin/dokka#2343)
- Add an extension point for an external documentable provider (Kotlin/dokka#2307), thanks to
@Kordyjan!- Add filtering stategies extension point and fix constructors in Kotlin-as-Java (Kotlin/dokka#2277), thanks to
@BarkingBad!- Expose Kotlin-as-Java methods that could be used not only as part of transformers (Kotlin/dokka#2351), thanks to
@BarkingBad!- Refactor Ancestry Graphs (Kotlin/dokka#2326), thanks to
@BarkingBad!- Fixed resolving of DRIs for Enum Entries (Kotlin/dokka#2305), thanks to
@BarkingBad!General Improvements
- Collect annotations from
package-info.java(Kotlin/dokka#2331), thanks to@ember-rose!- Add support for header tags (
<h1>/<h2>/<h3>) in Javadoc (Kotlin/dokka#2345), thanks to@asfalcone!- Add an option to merge implicit expect-actual declarations, enables merging of pages for related declarations which are not connected via
expect-actualkeywords (Kotlin/dokka#2316)- Add a note about using Dokka in a precompiled script plugin (Kotlin/dokka#2303), thanks to
@chkpnt!- Fixed wrong Groovy DSL example (Kotlin/dokka#2302), thanks to
@chkpnt!- Various code cleanups (Kotlin/dokka#2165, Kotlin/dokka#2360, Kotlin/dokka#2364, Kotlin/dokka#2385), thanks to
@Goooler!Known issues
- Kotlin Multiplatform projects that use
.kliblibraries may experience problems. There will be a separate1.6.21release that will address this issue shortly.
bf0476e Update documentation, examples and test references to 1.6.20 (https://github.com/facebook/flipper/issues/2440)301b12f Update version to 1.6.20 release92adc58 Fix classpath in HMPP (https://github.com/facebook/flipper/issues/2431)34916ec Fix using @ symbol inside code block (https://github.com/facebook/flipper/issues/2418)5af8d0f Update mkdocs gradle plugin to fix documentation generation (https://github.com/facebook/flipper/issues/2422)3bb04e0 Update Kotlin to 1.6.20 (https://github.com/facebook/flipper/issues/2417)cb596b4 Fix type parameter annotation regression (https://github.com/facebook/flipper/issues/2388) (https://github.com/facebook/flipper/issues/2410)a20b476 Update version to 1.6.20-RCa36b3af Update Kotlin to 1.6.20-RC2 (https://github.com/facebook/flipper/issues/2407)57133de Bug resolving in ultralightmethod (https://github.com/facebook/flipper/issues/2400)