Kotlin/dokka
### [`v1.7.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.20): 1.7.20 Beta
This release focuses primarily on improving user experience and HTML format in particular.
##### Improvements
##### General
- Display inherited extensions (can be disabled by setting `suppressInheritedMembers` configuration property) ([#2625](https://togithub.com/Kotlin/dokka/issues/2625))
- Display details for `@Deprecated` declarations such as deprecation message, level and proposed replacement ([#2622](https://togithub.com/Kotlin/dokka/issues/2622))
- Display and document `Enum`'s synthetic `values()` and `valueOf()` functions ([#2650](https://togithub.com/Kotlin/dokka/issues/2650))
- Do not render constructors for annotation classes ([#2642](https://togithub.com/Kotlin/dokka/issues/2642))
- Display values of `Java` constants ([#2609](https://togithub.com/Kotlin/dokka/issues/2609))
- Trim spaces inside indented code blocks ([#2661](https://togithub.com/Kotlin/dokka/issues/2661), [#2232](https://togithub.com/Kotlin/dokka/issues/2232), [#2233](https://togithub.com/Kotlin/dokka/issues/2233))
- Replace package name on the cover of package pages with "Package-level declarations" ([#2586](https://togithub.com/Kotlin/dokka/issues/2586))
##### HTML format
- Add IntelliJ icons to the navigation side menu ([#2578](https://togithub.com/Kotlin/dokka/issues/2578))
- Add auto-scrolling to selected navigation item ([#2575](https://togithub.com/Kotlin/dokka/issues/2575))
- Use OS color scheme to initialize light/dark mode, thanks to [@pt2121](https://togithub.com/pt2121)! ([#2611](https://togithub.com/Kotlin/dokka/issues/2611))
- Update styling of all section tabs (including platform tabs) to match [kotlinlang.org](https://kotlinlang.org/docs/home.html) ([#2589](https://togithub.com/Kotlin/dokka/issues/2589))
- Format long signatures dynamically based on client width ([#2659](https://togithub.com/Kotlin/dokka/issues/2659))
- Add a horizontal divider between function overloads that are displayed on the same page ([#2585](https://togithub.com/Kotlin/dokka/issues/2585))
- Add `Cmd + K` / `Ctrl + K` hotkey for opening search dialog, thanks to [@atyrin](https://togithub.com/atyrin)! ([#2633](https://togithub.com/Kotlin/dokka/issues/2633))
- Make current breadcrumb element not clickable and of default font color ([#2588](https://togithub.com/Kotlin/dokka/issues/2588))
- Update code highlighting colors ([#2670](https://togithub.com/Kotlin/dokka/issues/2670))
- Do not render platform tabs for common-only content ([#2613](https://togithub.com/Kotlin/dokka/issues/2613))
- Apply the same style to all KDoc tag headers, making it more consistent ([#2587](https://togithub.com/Kotlin/dokka/issues/2587))
- Move source links into signature, especially helpful on pages with many overloads ([#2476](https://togithub.com/Kotlin/dokka/issues/2476))
- Add inner/nested declarations to the navigation side menu ([#2597](https://togithub.com/Kotlin/dokka/issues/2597))
- Disable copy button for signatures ([#2577](https://togithub.com/Kotlin/dokka/issues/2577))
##### Javadoc format
- Support `var` HTML tag, thanks to [@atyrin](https://togithub.com/atyrin) ([#2617](https://togithub.com/Kotlin/dokka/issues/2617))
##### Kotlin-as-Java plugin
- Render annotation blocks for transformed classes, previously ignored ([#2549](https://togithub.com/Kotlin/dokka/issues/2549))
##### Gradle runner
- Remove `kotlin-stdlib` dependency, which should fix errors like `Module was compiled with an incompatible version of Kotlin`, thanks to [@martinbonnin](https://togithub.com/martinbonnin)! ([#2570](https://togithub.com/Kotlin/dokka/issues/2570))
##### Bugfixes
- Fixed missing spaces between adjacent `Markdown` elements, where `_try_ *this*` would be rendered as `trythis` ([#2640](https://togithub.com/Kotlin/dokka/issues/2640))
- Fixed dependency resolution errors when building documentation for multiplatform projects with enabled compatibility metadata variant ([#2634](https://togithub.com/Kotlin/dokka/issues/2634))
- Fixed a rare `StackOverflowError` related to type-aliased native references ([#2664](https://togithub.com/Kotlin/dokka/issues/2664))
- Fixed `IllegalStateException` that was caused by using JS's dynamic types ([#2645](https://togithub.com/Kotlin/dokka/issues/2645))
- Fixed a bug where certain `private` declarations were rendered as `public` ([#2639](https://togithub.com/Kotlin/dokka/issues/2639))
- Fixed incorrect handling of static declarations used within `@see` tag ([#2627](https://togithub.com/Kotlin/dokka/issues/2627))
- Fixed `Java` Enum types being rendered as `Any` ([#2647](https://togithub.com/Kotlin/dokka/issues/2647))
- Fixed incorrect signature generation that was caused by generic types caching ([#2619](https://togithub.com/Kotlin/dokka/issues/2619))
- Fixed incorrect parsing of static imports in `Java` annotation params ([#2593](https://togithub.com/Kotlin/dokka/issues/2593))
- Fixed `sourceRoots` configuration param not handling single `.java` files, thanks to [@2017398956](https://togithub.com/2017398956)! ([#2604](https://togithub.com/Kotlin/dokka/issues/2604))
- Fixed unresponsive HTML anchor button ([#2644](https://togithub.com/Kotlin/dokka/issues/2644))
- Fixed `dokka-customFormat-example` project to use up-to-date logo styles ([#2608](https://togithub.com/Kotlin/dokka/issues/2608))
##### Developer experience
- Enable `Gradle Enterprise` build scans, thanks to [@Goooler](https://togithub.com/Goooler)! ([#2641](https://togithub.com/Kotlin/dokka/issues/2641))
- Use `GitHub Actions` artifacts to store generated documentation snapshots, thanks to [@StefMa](https://togithub.com/StefMa)! ([#2630](https://togithub.com/Kotlin/dokka/issues/2630))
##### Other
- Warn users that GFM, Javadoc and Jekyll formats are in early alpha stages by printing a build log message during execution ([#2550](https://togithub.com/Kotlin/dokka/issues/2550))
- Revise developer guides documentation that should help plugin authors and new contributors ([#2523](https://togithub.com/Kotlin/dokka/issues/2523))
- Bump Gradle to 7.5.1, thanks to [@Goooler](https://togithub.com/Goooler)! ([#2618](https://togithub.com/Kotlin/dokka/issues/2618))
- Fix spelling errors, thanks to [@FelixDombek](https://togithub.com/FelixDombek)! ([#2594](https://togithub.com/Kotlin/dokka/issues/2594))
### [`v1.7.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.10): 1.7.10 Beta
Bugfix release that addresses several blockers and regressions.
##### General
- Support `Kotlin` 1.7.10
##### Gradle plugin
- Do not expose `Kotlin` stdlib in plugin dependencies, this should fix errors like `Module was compiled with an incompatible version of Kotlin` when using `Dokka`. Thanks to [@martinbonnin](https://togithub.com/martinbonnin) ([#2543](https://togithub.com/Kotlin/dokka/issues/2543))
##### Java sources
- Fixed build failure caused by having configured source links for `Java` code ([#2544](https://togithub.com/Kotlin/dokka/issues/2544))
- Fixed several exotic problems that led to build failures, all related to using annotation in `Java` sources ([#2509](https://togithub.com/Kotlin/dokka/issues/2509), [#2551](https://togithub.com/Kotlin/dokka/issues/2551), [#2350](https://togithub.com/Kotlin/dokka/issues/2350))
- Fixed `IntelliJ` platform `WARN: Attempt to load key` messages that appeared when analyzing `Java` sources ([#2559](https://togithub.com/Kotlin/dokka/issues/2559))
### [`v1.7.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.0): 1.7.0 Beta
##### Improvements
##### General
- Update to `Kotlin` 1.7.0, `IntelliJ` Platform 213
- Support [definitely non-nullable types](https://kotlinlang.org/docs/whatsnew17.html#stable-definitely-non-nullable-types) ([https://github.com/Kotlin/dokka/pull/2520](https://togithub.com/Kotlin/dokka/pull/2520))
- Don't expose enum entry constructor arguments, thanks to [@ebraminio](https://togithub.com/ebraminio) ([https://github.com/Kotlin/dokka/pull/2497](https://togithub.com/Kotlin/dokka/pull/2497))
- Preserve ordering of enum entries as in source code, previously reversed ([https://github.com/Kotlin/dokka/pull/2469](https://togithub.com/Kotlin/dokka/pull/2469))
- Improve support for inherited `Java` fields with accessors, now properly interpreted as `val`/`var` properties ([https://github.com/Kotlin/dokka/pull/2481](https://togithub.com/Kotlin/dokka/pull/2481), [https://github.com/Kotlin/dokka/pull/2532](https://togithub.com/Kotlin/dokka/pull/2532), [https://github.com/Kotlin/dokka/pull/2540](https://togithub.com/Kotlin/dokka/pull/2540))
- Skip `@Deprecated` members with `HIDDEN` level ([https://github.com/Kotlin/dokka/pull/2486](https://togithub.com/Kotlin/dokka/pull/2486))
- Make rendered default value dependent on source set for expect/actual declarations ([https://github.com/Kotlin/dokka/pull/2449](https://togithub.com/Kotlin/dokka/pull/2449))
##### HTML format
- Render quotes as blockquotes instead of code blocks, thanks to [@TheOnlyTails](https://togithub.com/TheOnlyTails) ([https://github.com/Kotlin/dokka/pull/2496](https://togithub.com/Kotlin/dokka/pull/2496))
##### Javadoc format
- Make `Javadoc` pages generation deterministic ([https://github.com/Kotlin/dokka/pull/2479](https://togithub.com/Kotlin/dokka/pull/2479))
- Update shipped `jQuery` to avoid multiple CVEs, thanks to [@ToppleTheNun](https://togithub.com/ToppleTheNun) ([https://github.com/Kotlin/dokka/issues/1938](https://togithub.com/Kotlin/dokka/issues/1938))
##### GFM format
- Support rendering of code blocks and inline code used in KDocs, thanks to [@cosinekitty](https://togithub.com/cosinekitty) ([https://github.com/Kotlin/dokka/pull/2485](https://togithub.com/Kotlin/dokka/pull/2485))
##### Kotlin-as-Java plugin
- Include `Java` access modifiers into function signatures, thanks to [@tripolkaandrey](https://togithub.com/tripolkaandrey) ([https://github.com/Kotlin/dokka/pull/2510](https://togithub.com/Kotlin/dokka/pull/2510))
##### Gradle runner
- Make `dokka-analysis` dependency `compileOnly`, this should help avoid compatibility problems if different versions of `Kotlin` are bundled in `Gradle` and `Dokka` ([https://github.com/Kotlin/dokka/pull/2521](https://togithub.com/Kotlin/dokka/pull/2521))
- Enable stricter validation for cacheable `Gradle` tasks, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2500](https://togithub.com/Kotlin/dokka/pull/2500))
- Remove unused & redundant dependencies for `Gradle` runner, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2502](https://togithub.com/Kotlin/dokka/pull/2502))
- Remove outdated suppression in `Gradle` runner, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2501](https://togithub.com/Kotlin/dokka/pull/2501))
##### Fixes
##### General bugfixes
- Fixed a compiler deadlock issue which led to stalling builds in some KMP projects ([https://github.com/Kotlin/dokka/pull/2480](https://togithub.com/Kotlin/dokka/pull/2480))
- Fixed incorrect argument names of functional type parameters ([https://github.com/Kotlin/dokka/pull/2478](https://togithub.com/Kotlin/dokka/pull/2478))
- Fixed missing external docs for AndroidX libraries, thanks to [@EdricChan03](https://togithub.com/EdricChan03) ([https://github.com/Kotlin/dokka/pull/2456](https://togithub.com/Kotlin/dokka/pull/2456))
- Fixed tests failing on Windows, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2507](https://togithub.com/Kotlin/dokka/pull/2507))
##### Security
- Get rid of bundled `log4j` 1.2 that came as a transitive dependency ([https://github.com/Kotlin/dokka/issues/2488](https://togithub.com/Kotlin/dokka/issues/2488))
- Update Jackson to avoid [CVE-2020-36518](https://nvd.nist.gov/vuln/detail/CVE-2020-36518), thanks to [@1mt](https://togithub.com/1mt) ([https://github.com/Kotlin/dokka/pull/2525](https://togithub.com/Kotlin/dokka/pull/2525))
##### Plugin API
- Decompose `base.ftl` template: now `header.ftl`, `footer.ftl` and `page_metadata.ftl` can be overridden individually ([https://github.com/Kotlin/dokka/pull/2432](https://togithub.com/Kotlin/dokka/pull/2432))
##### Other
- Add Kotlin stability & support badges, thanks to [@etolstoy](https://togithub.com/etolstoy) ([https://github.com/Kotlin/dokka/pull/2511](https://togithub.com/Kotlin/dokka/pull/2511))
- Remove an unused runner parameter, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2498](https://togithub.com/Kotlin/dokka/pull/2498))
- Correct typos, thanks to [@PaladiRka](https://togithub.com/PaladiRka) ([https://github.com/Kotlin/dokka/pull/2504](https://togithub.com/Kotlin/dokka/pull/2504)) and [@mahozad](https://togithub.com/mahozad) ([https://github.com/Kotlin/dokka/pull/2506](https://togithub.com/Kotlin/dokka/pull/2506))!
Thanks to all the contributors!
### [`v1.6.21`](https://togithub.com/Kotlin/dokka/releases/tag/v1.6.21): 1.6.21 Beta
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/tag/v1.6.20): 1.6.20 Beta
#### 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](https://togithub.com/Kotlin/dokka/pull/2270))
- Make HTML pages customizable through FreeMarker HTML templates ([https://github.com/Kotlin/dokka/pull/2374](https://togithub.com/Kotlin/dokka/pull/2374))
- Add global settings to JSON dokka CLI input ([https://github.com/Kotlin/dokka/pull/2292](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2309))
- Enhance primary constructor signature, display `val`/`var` keywords and default values ([https://github.com/Kotlin/dokka/pull/2313](https://togithub.com/Kotlin/dokka/pull/2313))
- Add a level of indentation to childless items in navigation tree ([https://github.com/Kotlin/dokka/pull/2291](https://togithub.com/Kotlin/dokka/pull/2291))
- Add horizontal margin to breadcrumbs delimiter ([https://github.com/Kotlin/dokka/pull/2285](https://togithub.com/Kotlin/dokka/pull/2285))
- Fixed various CSS rendering issues ([https://github.com/Kotlin/dokka/pull/2284](https://togithub.com/Kotlin/dokka/pull/2284), [https://github.com/Kotlin/dokka/pull/2389](https://togithub.com/Kotlin/dokka/pull/2389))
#### Bugfixes
- Fixed `OutOfMemoryError: Metaspace`-related issues for the majority of cases ([https://github.com/Kotlin/dokka/pull/2216](https://togithub.com/Kotlin/dokka/pull/2216))
- Fixed classpath issues for HMPP libraries ([https://github.com/Kotlin/dokka/pull/2431](https://togithub.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](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2365))
- Fixed resolution of ultralight methods that led to flaky signature generation ([https://github.com/Kotlin/dokka/pull/2400](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2325))
- Suppressed property setters are now excluded from documentation ([https://github.com/Kotlin/dokka/pull/2220](https://togithub.com/Kotlin/dokka/pull/2220))
- Suppressing extensions doesn't fail builds anymore ([https://github.com/Kotlin/dokka/pull/2348](https://togithub.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](https://togithub.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](https://togithub.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://togithub.com/Kotlin/dokka/pull/2312), [https://github.com/Kotlin/dokka/pull/2319](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2343))
- Add an extension point for an external documentable provider ([https://github.com/Kotlin/dokka/pull/2307](https://togithub.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](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2351)), thanks to [@BarkingBad](https://togithub.com/BarkingBad)!
- Refactor Ancestry Graphs ([https://github.com/Kotlin/dokka/pull/2326](https://togithub.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](https://togithub.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](https://togithub.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](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2316))
- Add a note about using Dokka in a precompiled script plugin ([https://github.com/Kotlin/dokka/pull/2303](https://togithub.com/Kotlin/dokka/pull/2303)), thanks to [@chkpnt](https://togithub.com/chkpnt)!
- Fixed wrong Groovy DSL example ([https://github.com/Kotlin/dokka/pull/2302](https://togithub.com/Kotlin/dokka/pull/2302)), thanks to [@chkpnt](https://togithub.com/chkpnt)!
- Various code cleanups ([https://github.com/Kotlin/dokka/pull/2165](https://togithub.com/Kotlin/dokka/pull/2165), [https://github.com/Kotlin/dokka/pull/2360](https://togithub.com/Kotlin/dokka/pull/2360), [https://github.com/Kotlin/dokka/pull/2364](https://togithub.com/Kotlin/dokka/pull/2364), [https://github.com/Kotlin/dokka/pull/2385](https://togithub.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: Branch creation - At any time (no schedule defined), Automerge - 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, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
1.6.10->1.7.20Release Notes
Kotlin/dokka
### [`v1.7.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.20): 1.7.20 Beta This release focuses primarily on improving user experience and HTML format in particular. ##### Improvements ##### General - Display inherited extensions (can be disabled by setting `suppressInheritedMembers` configuration property) ([#2625](https://togithub.com/Kotlin/dokka/issues/2625)) - Display details for `@Deprecated` declarations such as deprecation message, level and proposed replacement ([#2622](https://togithub.com/Kotlin/dokka/issues/2622)) - Display and document `Enum`'s synthetic `values()` and `valueOf()` functions ([#2650](https://togithub.com/Kotlin/dokka/issues/2650)) - Do not render constructors for annotation classes ([#2642](https://togithub.com/Kotlin/dokka/issues/2642)) - Display values of `Java` constants ([#2609](https://togithub.com/Kotlin/dokka/issues/2609)) - Trim spaces inside indented code blocks ([#2661](https://togithub.com/Kotlin/dokka/issues/2661), [#2232](https://togithub.com/Kotlin/dokka/issues/2232), [#2233](https://togithub.com/Kotlin/dokka/issues/2233)) - Replace package name on the cover of package pages with "Package-level declarations" ([#2586](https://togithub.com/Kotlin/dokka/issues/2586)) ##### HTML format - Add IntelliJ icons to the navigation side menu ([#2578](https://togithub.com/Kotlin/dokka/issues/2578)) - Add auto-scrolling to selected navigation item ([#2575](https://togithub.com/Kotlin/dokka/issues/2575)) - Use OS color scheme to initialize light/dark mode, thanks to [@pt2121](https://togithub.com/pt2121)! ([#2611](https://togithub.com/Kotlin/dokka/issues/2611)) - Update styling of all section tabs (including platform tabs) to match [kotlinlang.org](https://kotlinlang.org/docs/home.html) ([#2589](https://togithub.com/Kotlin/dokka/issues/2589)) - Format long signatures dynamically based on client width ([#2659](https://togithub.com/Kotlin/dokka/issues/2659)) - Add a horizontal divider between function overloads that are displayed on the same page ([#2585](https://togithub.com/Kotlin/dokka/issues/2585)) - Add `Cmd + K` / `Ctrl + K` hotkey for opening search dialog, thanks to [@atyrin](https://togithub.com/atyrin)! ([#2633](https://togithub.com/Kotlin/dokka/issues/2633)) - Make current breadcrumb element not clickable and of default font color ([#2588](https://togithub.com/Kotlin/dokka/issues/2588)) - Update code highlighting colors ([#2670](https://togithub.com/Kotlin/dokka/issues/2670)) - Do not render platform tabs for common-only content ([#2613](https://togithub.com/Kotlin/dokka/issues/2613)) - Apply the same style to all KDoc tag headers, making it more consistent ([#2587](https://togithub.com/Kotlin/dokka/issues/2587)) - Move source links into signature, especially helpful on pages with many overloads ([#2476](https://togithub.com/Kotlin/dokka/issues/2476)) - Add inner/nested declarations to the navigation side menu ([#2597](https://togithub.com/Kotlin/dokka/issues/2597)) - Disable copy button for signatures ([#2577](https://togithub.com/Kotlin/dokka/issues/2577)) ##### Javadoc format - Support `var` HTML tag, thanks to [@atyrin](https://togithub.com/atyrin) ([#2617](https://togithub.com/Kotlin/dokka/issues/2617)) ##### Kotlin-as-Java plugin - Render annotation blocks for transformed classes, previously ignored ([#2549](https://togithub.com/Kotlin/dokka/issues/2549)) ##### Gradle runner - Remove `kotlin-stdlib` dependency, which should fix errors like `Module was compiled with an incompatible version of Kotlin`, thanks to [@martinbonnin](https://togithub.com/martinbonnin)! ([#2570](https://togithub.com/Kotlin/dokka/issues/2570)) ##### Bugfixes - Fixed missing spaces between adjacent `Markdown` elements, where `_try_ *this*` would be rendered as `trythis` ([#2640](https://togithub.com/Kotlin/dokka/issues/2640)) - Fixed dependency resolution errors when building documentation for multiplatform projects with enabled compatibility metadata variant ([#2634](https://togithub.com/Kotlin/dokka/issues/2634)) - Fixed a rare `StackOverflowError` related to type-aliased native references ([#2664](https://togithub.com/Kotlin/dokka/issues/2664)) - Fixed `IllegalStateException` that was caused by using JS's dynamic types ([#2645](https://togithub.com/Kotlin/dokka/issues/2645)) - Fixed a bug where certain `private` declarations were rendered as `public` ([#2639](https://togithub.com/Kotlin/dokka/issues/2639)) - Fixed incorrect handling of static declarations used within `@see` tag ([#2627](https://togithub.com/Kotlin/dokka/issues/2627)) - Fixed `Java` Enum types being rendered as `Any` ([#2647](https://togithub.com/Kotlin/dokka/issues/2647)) - Fixed incorrect signature generation that was caused by generic types caching ([#2619](https://togithub.com/Kotlin/dokka/issues/2619)) - Fixed incorrect parsing of static imports in `Java` annotation params ([#2593](https://togithub.com/Kotlin/dokka/issues/2593)) - Fixed `sourceRoots` configuration param not handling single `.java` files, thanks to [@2017398956](https://togithub.com/2017398956)! ([#2604](https://togithub.com/Kotlin/dokka/issues/2604)) - Fixed unresponsive HTML anchor button ([#2644](https://togithub.com/Kotlin/dokka/issues/2644)) - Fixed `dokka-customFormat-example` project to use up-to-date logo styles ([#2608](https://togithub.com/Kotlin/dokka/issues/2608)) ##### Developer experience - Enable `Gradle Enterprise` build scans, thanks to [@Goooler](https://togithub.com/Goooler)! ([#2641](https://togithub.com/Kotlin/dokka/issues/2641)) - Use `GitHub Actions` artifacts to store generated documentation snapshots, thanks to [@StefMa](https://togithub.com/StefMa)! ([#2630](https://togithub.com/Kotlin/dokka/issues/2630)) ##### Other - Warn users that GFM, Javadoc and Jekyll formats are in early alpha stages by printing a build log message during execution ([#2550](https://togithub.com/Kotlin/dokka/issues/2550)) - Revise developer guides documentation that should help plugin authors and new contributors ([#2523](https://togithub.com/Kotlin/dokka/issues/2523)) - Bump Gradle to 7.5.1, thanks to [@Goooler](https://togithub.com/Goooler)! ([#2618](https://togithub.com/Kotlin/dokka/issues/2618)) - Fix spelling errors, thanks to [@FelixDombek](https://togithub.com/FelixDombek)! ([#2594](https://togithub.com/Kotlin/dokka/issues/2594)) ### [`v1.7.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.10): 1.7.10 Beta Bugfix release that addresses several blockers and regressions. ##### General - Support `Kotlin` 1.7.10 ##### Gradle plugin - Do not expose `Kotlin` stdlib in plugin dependencies, this should fix errors like `Module was compiled with an incompatible version of Kotlin` when using `Dokka`. Thanks to [@martinbonnin](https://togithub.com/martinbonnin) ([#2543](https://togithub.com/Kotlin/dokka/issues/2543)) ##### Java sources - Fixed build failure caused by having configured source links for `Java` code ([#2544](https://togithub.com/Kotlin/dokka/issues/2544)) - Fixed several exotic problems that led to build failures, all related to using annotation in `Java` sources ([#2509](https://togithub.com/Kotlin/dokka/issues/2509), [#2551](https://togithub.com/Kotlin/dokka/issues/2551), [#2350](https://togithub.com/Kotlin/dokka/issues/2350)) - Fixed `IntelliJ` platform `WARN: Attempt to load key` messages that appeared when analyzing `Java` sources ([#2559](https://togithub.com/Kotlin/dokka/issues/2559)) ### [`v1.7.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.0): 1.7.0 Beta ##### Improvements ##### General - Update to `Kotlin` 1.7.0, `IntelliJ` Platform 213 - Support [definitely non-nullable types](https://kotlinlang.org/docs/whatsnew17.html#stable-definitely-non-nullable-types) ([https://github.com/Kotlin/dokka/pull/2520](https://togithub.com/Kotlin/dokka/pull/2520)) - Don't expose enum entry constructor arguments, thanks to [@ebraminio](https://togithub.com/ebraminio) ([https://github.com/Kotlin/dokka/pull/2497](https://togithub.com/Kotlin/dokka/pull/2497)) - Preserve ordering of enum entries as in source code, previously reversed ([https://github.com/Kotlin/dokka/pull/2469](https://togithub.com/Kotlin/dokka/pull/2469)) - Improve support for inherited `Java` fields with accessors, now properly interpreted as `val`/`var` properties ([https://github.com/Kotlin/dokka/pull/2481](https://togithub.com/Kotlin/dokka/pull/2481), [https://github.com/Kotlin/dokka/pull/2532](https://togithub.com/Kotlin/dokka/pull/2532), [https://github.com/Kotlin/dokka/pull/2540](https://togithub.com/Kotlin/dokka/pull/2540)) - Skip `@Deprecated` members with `HIDDEN` level ([https://github.com/Kotlin/dokka/pull/2486](https://togithub.com/Kotlin/dokka/pull/2486)) - Make rendered default value dependent on source set for expect/actual declarations ([https://github.com/Kotlin/dokka/pull/2449](https://togithub.com/Kotlin/dokka/pull/2449)) ##### HTML format - Render quotes as blockquotes instead of code blocks, thanks to [@TheOnlyTails](https://togithub.com/TheOnlyTails) ([https://github.com/Kotlin/dokka/pull/2496](https://togithub.com/Kotlin/dokka/pull/2496)) ##### Javadoc format - Make `Javadoc` pages generation deterministic ([https://github.com/Kotlin/dokka/pull/2479](https://togithub.com/Kotlin/dokka/pull/2479)) - Update shipped `jQuery` to avoid multiple CVEs, thanks to [@ToppleTheNun](https://togithub.com/ToppleTheNun) ([https://github.com/Kotlin/dokka/issues/1938](https://togithub.com/Kotlin/dokka/issues/1938)) ##### GFM format - Support rendering of code blocks and inline code used in KDocs, thanks to [@cosinekitty](https://togithub.com/cosinekitty) ([https://github.com/Kotlin/dokka/pull/2485](https://togithub.com/Kotlin/dokka/pull/2485)) ##### Kotlin-as-Java plugin - Include `Java` access modifiers into function signatures, thanks to [@tripolkaandrey](https://togithub.com/tripolkaandrey) ([https://github.com/Kotlin/dokka/pull/2510](https://togithub.com/Kotlin/dokka/pull/2510)) ##### Gradle runner - Make `dokka-analysis` dependency `compileOnly`, this should help avoid compatibility problems if different versions of `Kotlin` are bundled in `Gradle` and `Dokka` ([https://github.com/Kotlin/dokka/pull/2521](https://togithub.com/Kotlin/dokka/pull/2521)) - Enable stricter validation for cacheable `Gradle` tasks, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2500](https://togithub.com/Kotlin/dokka/pull/2500)) - Remove unused & redundant dependencies for `Gradle` runner, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2502](https://togithub.com/Kotlin/dokka/pull/2502)) - Remove outdated suppression in `Gradle` runner, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2501](https://togithub.com/Kotlin/dokka/pull/2501)) ##### Fixes ##### General bugfixes - Fixed a compiler deadlock issue which led to stalling builds in some KMP projects ([https://github.com/Kotlin/dokka/pull/2480](https://togithub.com/Kotlin/dokka/pull/2480)) - Fixed incorrect argument names of functional type parameters ([https://github.com/Kotlin/dokka/pull/2478](https://togithub.com/Kotlin/dokka/pull/2478)) - Fixed missing external docs for AndroidX libraries, thanks to [@EdricChan03](https://togithub.com/EdricChan03) ([https://github.com/Kotlin/dokka/pull/2456](https://togithub.com/Kotlin/dokka/pull/2456)) - Fixed tests failing on Windows, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2507](https://togithub.com/Kotlin/dokka/pull/2507)) ##### Security - Get rid of bundled `log4j` 1.2 that came as a transitive dependency ([https://github.com/Kotlin/dokka/issues/2488](https://togithub.com/Kotlin/dokka/issues/2488)) - Update Jackson to avoid [CVE-2020-36518](https://nvd.nist.gov/vuln/detail/CVE-2020-36518), thanks to [@1mt](https://togithub.com/1mt) ([https://github.com/Kotlin/dokka/pull/2525](https://togithub.com/Kotlin/dokka/pull/2525)) ##### Plugin API - Decompose `base.ftl` template: now `header.ftl`, `footer.ftl` and `page_metadata.ftl` can be overridden individually ([https://github.com/Kotlin/dokka/pull/2432](https://togithub.com/Kotlin/dokka/pull/2432)) ##### Other - Add Kotlin stability & support badges, thanks to [@etolstoy](https://togithub.com/etolstoy) ([https://github.com/Kotlin/dokka/pull/2511](https://togithub.com/Kotlin/dokka/pull/2511)) - Remove an unused runner parameter, thanks to [@3flex](https://togithub.com/3flex) ([https://github.com/Kotlin/dokka/pull/2498](https://togithub.com/Kotlin/dokka/pull/2498)) - Correct typos, thanks to [@PaladiRka](https://togithub.com/PaladiRka) ([https://github.com/Kotlin/dokka/pull/2504](https://togithub.com/Kotlin/dokka/pull/2504)) and [@mahozad](https://togithub.com/mahozad) ([https://github.com/Kotlin/dokka/pull/2506](https://togithub.com/Kotlin/dokka/pull/2506))! Thanks to all the contributors! ### [`v1.6.21`](https://togithub.com/Kotlin/dokka/releases/tag/v1.6.21): 1.6.21 Beta 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/tag/v1.6.20): 1.6.20 Beta #### 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](https://togithub.com/Kotlin/dokka/pull/2270)) - Make HTML pages customizable through FreeMarker HTML templates ([https://github.com/Kotlin/dokka/pull/2374](https://togithub.com/Kotlin/dokka/pull/2374)) - Add global settings to JSON dokka CLI input ([https://github.com/Kotlin/dokka/pull/2292](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2309)) - Enhance primary constructor signature, display `val`/`var` keywords and default values ([https://github.com/Kotlin/dokka/pull/2313](https://togithub.com/Kotlin/dokka/pull/2313)) - Add a level of indentation to childless items in navigation tree ([https://github.com/Kotlin/dokka/pull/2291](https://togithub.com/Kotlin/dokka/pull/2291)) - Add horizontal margin to breadcrumbs delimiter ([https://github.com/Kotlin/dokka/pull/2285](https://togithub.com/Kotlin/dokka/pull/2285)) - Fixed various CSS rendering issues ([https://github.com/Kotlin/dokka/pull/2284](https://togithub.com/Kotlin/dokka/pull/2284), [https://github.com/Kotlin/dokka/pull/2389](https://togithub.com/Kotlin/dokka/pull/2389)) #### Bugfixes - Fixed `OutOfMemoryError: Metaspace`-related issues for the majority of cases ([https://github.com/Kotlin/dokka/pull/2216](https://togithub.com/Kotlin/dokka/pull/2216)) - Fixed classpath issues for HMPP libraries ([https://github.com/Kotlin/dokka/pull/2431](https://togithub.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](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2365)) - Fixed resolution of ultralight methods that led to flaky signature generation ([https://github.com/Kotlin/dokka/pull/2400](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2325)) - Suppressed property setters are now excluded from documentation ([https://github.com/Kotlin/dokka/pull/2220](https://togithub.com/Kotlin/dokka/pull/2220)) - Suppressing extensions doesn't fail builds anymore ([https://github.com/Kotlin/dokka/pull/2348](https://togithub.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](https://togithub.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](https://togithub.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://togithub.com/Kotlin/dokka/pull/2312), [https://github.com/Kotlin/dokka/pull/2319](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2343)) - Add an extension point for an external documentable provider ([https://github.com/Kotlin/dokka/pull/2307](https://togithub.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](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2351)), thanks to [@BarkingBad](https://togithub.com/BarkingBad)! - Refactor Ancestry Graphs ([https://github.com/Kotlin/dokka/pull/2326](https://togithub.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](https://togithub.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](https://togithub.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](https://togithub.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](https://togithub.com/Kotlin/dokka/pull/2316)) - Add a note about using Dokka in a precompiled script plugin ([https://github.com/Kotlin/dokka/pull/2303](https://togithub.com/Kotlin/dokka/pull/2303)), thanks to [@chkpnt](https://togithub.com/chkpnt)! - Fixed wrong Groovy DSL example ([https://github.com/Kotlin/dokka/pull/2302](https://togithub.com/Kotlin/dokka/pull/2302)), thanks to [@chkpnt](https://togithub.com/chkpnt)! - Various code cleanups ([https://github.com/Kotlin/dokka/pull/2165](https://togithub.com/Kotlin/dokka/pull/2165), [https://github.com/Kotlin/dokka/pull/2360](https://togithub.com/Kotlin/dokka/pull/2360), [https://github.com/Kotlin/dokka/pull/2364](https://togithub.com/Kotlin/dokka/pull/2364), [https://github.com/Kotlin/dokka/pull/2385](https://togithub.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: Branch creation - At any time (no schedule defined), Automerge - 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 Mend Renovate. View repository job log here.