Update plugin org.jetbrains.dokka to v1.6.20 #131

renovate · 2022-04-14T14:48:29Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
org.jetbrains.dokka	`1.6.10` -> `1.6.20`

Release Notes

Kotlin/dokka

`v1.6.20`

Features

Introduce documentedVisibilities setting that allows including/excluding any visibility modifier in documentation. This is a more flexible replacement for includeNonPublic, which has now been deprecated (Introduce documentedVisibilities setting Kotlin/dokka#2270)
Make HTML pages customizable through FreeMarker HTML templates (KT-50452 Make flexible html for customization Kotlin/dokka#2374)
Add global settings to JSON dokka CLI input (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 (KT-50292 - Implement vertical alignment of parameter Kotlin/dokka#2309)
Enhance primary constructor signature, display val/var keywords and default values (Enhance generated primary constructor signature for html format Kotlin/dokka#2313)
Add a level of indentation to childless items in navigation tree (Add a level of indentation to childless items in navigation tree (KT-50294) Kotlin/dokka#2291)
Add horizontal margin to breadcrumbs delimiter (Add horizontal margin to breadcrumbs delimiter (KT-50296) Kotlin/dokka#2285)
Fixed various CSS rendering issues (Fix css bugs wih link and table row Kotlin/dokka#2284, Fix rendering issues Kotlin/dokka#2389)

Bugfixes

Fixed OutOfMemoryError: Metaspace-related issues for the majority of cases (Use sourceRoots as samples dirs by default Kotlin/dokka#2216)
Fixed classpath issues for HMPP libraries (Fix classpath in HMPP Kotlin/dokka#2431)
Using @ symbol within code blocks in .md files doesn't lead to cropped documents anymore (Fix using @ symbol inside code block Kotlin/dokka#2418)
Fixed incorrect placement of HTML head tags, which led to missing favicon in multi-module projects (Fix HTML head and favicon in multi-module projects Kotlin/dokka#2365)
Fixed resolution of ultralight methods that led to flaky signature generation (Bug resolving in ultralightmethod Kotlin/dokka#2400)
Coroutines dispatchers are now shut down after each module pass to avoid resource leaks (Shutdown coroutines dispatchers after each module pass Kotlin/dokka#2325)
Suppressed property setters are now excluded from documentation (Allow filtering of property setter Kotlin/dokka#2220)
Suppressing extensions doesn't fail builds anymore (Fix filtering suppresed extensions Kotlin/dokka#2348), thanks to @BarkingBad!
Fixed java getter / setter name generation for kotlin-java interop, now isBoolean instead of getBoolean (Fix java getter / setter name generation Kotlin/dokka#2356), thanks to @CharlesG-Branch!
Fixed MathJax plugin, previously completely broken (Fix MathJax rendering bug Kotlin/dokka#2342), thanks to @wyskoj!
Fixed Input/Output streams to minimize resource leaks (Close input stream in FileWriter Kotlin/dokka#2312, Close Input/Output streams Kotlin/dokka#2319)

Plugin API Changes

Add an extension point for rendering custom documentation tags (Custom doctag extension Kotlin/dokka#2343)
Add an extension point for an external documentable provider (Add external documentable provider Kotlin/dokka#2307), thanks to @Kordyjan!
Add filtering stategies extension point and fix constructors in Kotlin-as-Java (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 (Expose Kotlin-as-Java methods that could be used not only as part of transformers Kotlin/dokka#2351), thanks to @BarkingBad!
Refactor Ancestry Graphs (Refactor Ancestry Graphs Kotlin/dokka#2326), thanks to @BarkingBad!
Fixed resolving of DRIs for Enum Entries (Fix resolving DRIs of Enum Entries Kotlin/dokka#2305), thanks to @BarkingBad!

General Improvements

Collect annotations from package-info.java (Collect annotations from package-info.java Kotlin/dokka#2331), thanks to @ember-rose!
Add support for header tags (<h1> / <h2> / <h3>) in Javadoc (Add support for header tags 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-actual keywords (Add option to merge implicit expect-actual declarations Kotlin/dokka#2316)
Add a note about using Dokka in a precompiled script plugin (Add a note about usage in a precompiled script plugin Kotlin/dokka#2303), thanks to @chkpnt!
Fixed wrong Groovy DSL example (Fix wrong Groovy DSL example Kotlin/dokka#2302), thanks to @chkpnt!
Various code cleanups (Code cleanups Kotlin/dokka#2165, Convert more fun interfaces Kotlin/dokka#2360, Remove bintray publish plugins Kotlin/dokka#2364, Optimize CI a bit Kotlin/dokka#2385), thanks to @Goooler!

Known issues

Kotlin Multiplatform projects that use .klib libraries may experience problems. There will be a separate 1.6.21 release that will address this issue shortly.