Kotlin/dokka
### [`v1.6.21`](https://togithub.com/Kotlin/dokka/releases/v1.6.21)
This is a bugfix release that mostly enables building documentation for multiplatform projects that utilize `.klib` libraries.
#### Changes
- Support Kotlin 1.6.21
- Update `jsoup` dependency to avoid [CVE-2021-37714](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-37714) ([#2448](https://togithub.com/Kotlin/dokka/issues/2448))
#### Bugfixes
- Support `KLIB` libraries for common platform, previously led to `ERROR CLASS` instead of references in documentation ([#2441](https://togithub.com/Kotlin/dokka/issues/2441))
- Fixed a maven plugin build problem related to coroutines which only occurred in multi-module builds ([#2461](https://togithub.com/Kotlin/dokka/issues/2461))
### [`v1.6.20`](https://togithub.com/Kotlin/dokka/releases/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 (https://github.com/Kotlin/dokka/pull/2270)
- Make HTML pages customizable through FreeMarker HTML templates (https://github.com/Kotlin/dokka/pull/2374)
- Add global settings to JSON dokka CLI input (https://github.com/Kotlin/dokka/pull/2292), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
##### HTML format changes
- Add vertical alignment (wrapping) of signatures when 3 and more parameters are present (https://github.com/Kotlin/dokka/pull/2309)
- Enhance primary constructor signature, display `val`/`var` keywords and default values (https://github.com/Kotlin/dokka/pull/2313)
- Add a level of indentation to childless items in navigation tree (https://github.com/Kotlin/dokka/pull/2291)
- Add horizontal margin to breadcrumbs delimiter (https://github.com/Kotlin/dokka/pull/2285)
- Fixed various CSS rendering issues (https://github.com/Kotlin/dokka/pull/2284, https://github.com/Kotlin/dokka/pull/2389)
##### Bugfixes
- Fixed `OutOfMemoryError: Metaspace`-related issues for the majority of cases (https://github.com/Kotlin/dokka/pull/2216)
- Fixed classpath issues for HMPP libraries (https://github.com/Kotlin/dokka/pull/2431)
- Using `@` symbol within code blocks in `.md` files doesn't lead to cropped documents anymore (https://github.com/Kotlin/dokka/pull/2418)
- Fixed incorrect placement of HTML head tags, which led to missing favicon in multi-module projects (https://github.com/Kotlin/dokka/pull/2365)
- Fixed resolution of ultralight methods that led to flaky signature generation (https://github.com/Kotlin/dokka/pull/2400)
- Coroutines dispatchers are now shut down after each module pass to avoid resource leaks (https://github.com/Kotlin/dokka/pull/2325)
- Suppressed property setters are now excluded from documentation (https://github.com/Kotlin/dokka/pull/2220)
- Suppressing extensions doesn't fail builds anymore (https://github.com/Kotlin/dokka/pull/2348), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
- Fixed java getter / setter name generation for kotlin-java interop, now `isBoolean` instead of `getBoolean` (https://github.com/Kotlin/dokka/pull/2356), thanks to [@CharlesG-Branch](https://togithub.com/CharlesG-Branch)!
- Fixed MathJax plugin, previously completely broken (https://github.com/Kotlin/dokka/pull/2342), thanks to [@wyskoj](https://togithub.com/wyskoj)!
- Fixed Input/Output streams to minimize resource leaks (https://github.com/Kotlin/dokka/pull/2312, https://github.com/Kotlin/dokka/pull/2319)
##### Plugin API Changes
- Add an extension point for rendering custom [documentation tags](https://kotlinlang.org/docs/kotlin-doc.html#block-tags) (https://github.com/Kotlin/dokka/pull/2343)
- Add an extension point for an external documentable provider (https://github.com/Kotlin/dokka/pull/2307), thanks to [@Kordyjan](https://togithub.com/Kordyjan)!
- Add filtering stategies extension point and fix constructors in Kotlin-as-Java (https://github.com/Kotlin/dokka/pull/2277), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
- Expose Kotlin-as-Java methods that could be used not only as part of transformers (https://github.com/Kotlin/dokka/pull/2351), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
- Refactor Ancestry Graphs (https://github.com/Kotlin/dokka/pull/2326), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
- Fixed resolving of DRIs for Enum Entries (https://github.com/Kotlin/dokka/pull/2305), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
##### General Improvements
- Collect annotations from `package-info.java` (https://github.com/Kotlin/dokka/pull/2331), thanks to [@ember-rose](https://togithub.com/ember-rose)!
- Add support for header tags (`
` / `
` / `
`) in Javadoc (https://github.com/Kotlin/dokka/pull/2345), thanks to [@asfalcone](https://togithub.com/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 (https://github.com/Kotlin/dokka/pull/2316)
- Add a note about using Dokka in a precompiled script plugin (https://github.com/Kotlin/dokka/pull/2303), thanks to [@chkpnt](https://togithub.com/chkpnt)!
- Fixed wrong Groovy DSL example (https://github.com/Kotlin/dokka/pull/2302), thanks to [@chkpnt](https://togithub.com/chkpnt)!
- Various code cleanups (https://github.com/Kotlin/dokka/pull/2165, https://github.com/Kotlin/dokka/pull/2360, https://github.com/Kotlin/dokka/pull/2364, https://github.com/Kotlin/dokka/pull/2385), thanks to [@Goooler](https://togithub.com/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.
Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, click this checkbox.
serras
commented
2 years ago
This PR contains the following updates:
1.6.10->1.6.21Release Notes
Kotlin/dokka
### [`v1.6.21`](https://togithub.com/Kotlin/dokka/releases/v1.6.21) This is a bugfix release that mostly enables building documentation for multiplatform projects that utilize `.klib` libraries. #### Changes - Support Kotlin 1.6.21 - Update `jsoup` dependency to avoid [CVE-2021-37714](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-37714) ([#2448](https://togithub.com/Kotlin/dokka/issues/2448)) #### Bugfixes - Support `KLIB` libraries for common platform, previously led to `ERROR CLASS` instead of references in documentation ([#2441](https://togithub.com/Kotlin/dokka/issues/2441)) - Fixed a maven plugin build problem related to coroutines which only occurred in multi-module builds ([#2461](https://togithub.com/Kotlin/dokka/issues/2461)) ### [`v1.6.20`](https://togithub.com/Kotlin/dokka/releases/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 (https://github.com/Kotlin/dokka/pull/2270) - Make HTML pages customizable through FreeMarker HTML templates (https://github.com/Kotlin/dokka/pull/2374) - Add global settings to JSON dokka CLI input (https://github.com/Kotlin/dokka/pull/2292), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! ##### HTML format changes - Add vertical alignment (wrapping) of signatures when 3 and more parameters are present (https://github.com/Kotlin/dokka/pull/2309) - Enhance primary constructor signature, display `val`/`var` keywords and default values (https://github.com/Kotlin/dokka/pull/2313) - Add a level of indentation to childless items in navigation tree (https://github.com/Kotlin/dokka/pull/2291) - Add horizontal margin to breadcrumbs delimiter (https://github.com/Kotlin/dokka/pull/2285) - Fixed various CSS rendering issues (https://github.com/Kotlin/dokka/pull/2284, https://github.com/Kotlin/dokka/pull/2389) ##### Bugfixes - Fixed `OutOfMemoryError: Metaspace`-related issues for the majority of cases (https://github.com/Kotlin/dokka/pull/2216) - Fixed classpath issues for HMPP libraries (https://github.com/Kotlin/dokka/pull/2431) - Using `@` symbol within code blocks in `.md` files doesn't lead to cropped documents anymore (https://github.com/Kotlin/dokka/pull/2418) - Fixed incorrect placement of HTML head tags, which led to missing favicon in multi-module projects (https://github.com/Kotlin/dokka/pull/2365) - Fixed resolution of ultralight methods that led to flaky signature generation (https://github.com/Kotlin/dokka/pull/2400) - Coroutines dispatchers are now shut down after each module pass to avoid resource leaks (https://github.com/Kotlin/dokka/pull/2325) - Suppressed property setters are now excluded from documentation (https://github.com/Kotlin/dokka/pull/2220) - Suppressing extensions doesn't fail builds anymore (https://github.com/Kotlin/dokka/pull/2348), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! - Fixed java getter / setter name generation for kotlin-java interop, now `isBoolean` instead of `getBoolean` (https://github.com/Kotlin/dokka/pull/2356), thanks to [@CharlesG-Branch](https://togithub.com/CharlesG-Branch)! - Fixed MathJax plugin, previously completely broken (https://github.com/Kotlin/dokka/pull/2342), thanks to [@wyskoj](https://togithub.com/wyskoj)! - Fixed Input/Output streams to minimize resource leaks (https://github.com/Kotlin/dokka/pull/2312, https://github.com/Kotlin/dokka/pull/2319) ##### Plugin API Changes - Add an extension point for rendering custom [documentation tags](https://kotlinlang.org/docs/kotlin-doc.html#block-tags) (https://github.com/Kotlin/dokka/pull/2343) - Add an extension point for an external documentable provider (https://github.com/Kotlin/dokka/pull/2307), thanks to [@Kordyjan](https://togithub.com/Kordyjan)! - Add filtering stategies extension point and fix constructors in Kotlin-as-Java (https://github.com/Kotlin/dokka/pull/2277), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! - Expose Kotlin-as-Java methods that could be used not only as part of transformers (https://github.com/Kotlin/dokka/pull/2351), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! - Refactor Ancestry Graphs (https://github.com/Kotlin/dokka/pull/2326), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! - Fixed resolving of DRIs for Enum Entries (https://github.com/Kotlin/dokka/pull/2305), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! ##### General Improvements - Collect annotations from `package-info.java` (https://github.com/Kotlin/dokka/pull/2331), thanks to [@ember-rose](https://togithub.com/ember-rose)! - Add support for header tags (`` / `
` / `
`) in Javadoc (https://github.com/Kotlin/dokka/pull/2345), thanks to [@asfalcone](https://togithub.com/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 (https://github.com/Kotlin/dokka/pull/2316) - Add a note about using Dokka in a precompiled script plugin (https://github.com/Kotlin/dokka/pull/2303), thanks to [@chkpnt](https://togithub.com/chkpnt)! - Fixed wrong Groovy DSL example (https://github.com/Kotlin/dokka/pull/2302), thanks to [@chkpnt](https://togithub.com/chkpnt)! - Various code cleanups (https://github.com/Kotlin/dokka/pull/2165, https://github.com/Kotlin/dokka/pull/2360, https://github.com/Kotlin/dokka/pull/2364, https://github.com/Kotlin/dokka/pull/2385), thanks to [@Goooler](https://togithub.com/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.
Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.