This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
org.jetbrains.dokka:dokka-maven-plugin	`0.10.1` -> `1.9.20`

Release Notes

Kotlin/dokka (org.jetbrains.dokka:dokka-maven-plugin)

### [`v1.9.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.20): 1.9.20 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.9.10...v1.9.20) #### General bugfixes - Fixed sealed interfaces not having the `sealed` keyword in signatures ([https://github.com/Kotlin/dokka/issues/2994](https://togithub.com/Kotlin/dokka/issues/2994)) - Fixed incorrect links in multi-module projects with non-unique package names ([https://github.com/Kotlin/dokka/issues/2272](https://togithub.com/Kotlin/dokka/issues/2272)). Huge thanks to [@EddieRingle](https://togithub.com/EddieRingle)! - Fixed member extensions not being shown on index pages in certain scenarios ([https://github.com/Kotlin/dokka/issues/3187](https://togithub.com/Kotlin/dokka/issues/3187)) - Fixed Java's inner classes not having the `inner` keyword in Kotlin signatures ([https://github.com/Kotlin/dokka/issues/2793](https://togithub.com/Kotlin/dokka/issues/2793)) - Fixed Java's `@param` tag not working with type parameters ([https://github.com/Kotlin/dokka/issues/3199](https://togithub.com/Kotlin/dokka/issues/3199)) - Fixed Dokka failing in KMP projects when the JVM source set is suppressed ([https://github.com/Kotlin/dokka/issues/3209](https://togithub.com/Kotlin/dokka/issues/3209)) #### HTML format - Provide an ability to add a custom homepage link to the header, more details in [https://github.com/Kotlin/dokka/issues/2948#issuecomment-1976723089](https://togithub.com/Kotlin/dokka/issues/2948#issuecomment-1976723089) - Fixed tab selection resetting after navigating to a different page ([https://github.com/Kotlin/dokka/issues/2899](https://togithub.com/Kotlin/dokka/issues/2899)) - Fixed inline code not always being aligned with the surrounding text ([https://github.com/Kotlin/dokka/issues/3228](https://togithub.com/Kotlin/dokka/issues/3228)) - Fixed the "No options found" text in search being barely visible ([https://github.com/Kotlin/dokka/issues/3281](https://togithub.com/Kotlin/dokka/issues/3281)) - Fixed empty HTML tags being rendered for no reason ([https://github.com/Kotlin/dokka/pull/3343](https://togithub.com/Kotlin/dokka/pull/3343), [https://github.com/Kotlin/dokka/issues/3095](https://togithub.com/Kotlin/dokka/issues/3095)) #### Runners ##### Gradle Plugin - Mark tasks as not compatible with Gradle configuration cache, second try ([https://github.com/Kotlin/dokka/pull/3438](https://togithub.com/Kotlin/dokka/pull/3438)). Thanks to [@3flex](https://togithub.com/3flex) for noticing and fixing the problem! ##### Maven Plugin - Fixed `dokka:help` being absent ([https://github.com/Kotlin/dokka/issues/3035](https://togithub.com/Kotlin/dokka/issues/3035)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Fixed the source links configuration not working ([https://github.com/Kotlin/dokka/pull/3046](https://togithub.com/Kotlin/dokka/pull/3046)). Thanks to [@freya022](https://togithub.com/freya022) for fixing this one! ##### CLI runner - Allow using relative paths in the `sourceRoots` configuration option ([https://github.com/Kotlin/dokka/issues/2571](https://togithub.com/Kotlin/dokka/issues/2571)) #### Plugin API - Provide an extension point to customize the rendering of code blocks in HTML format ([https://github.com/Kotlin/dokka/issues/3244](https://togithub.com/Kotlin/dokka/issues/3244)) #### Other: - Make sure `wasm-js` and `wasm-wasi` targets introduced in Kotlin 1.9.20 are supported ([https://github.com/Kotlin/dokka/issues/3310](https://togithub.com/Kotlin/dokka/issues/3310)) - Avoid concurrent invocations of Kotlin compiler's API due to the compiler API itself not always being thread safe ([https://github.com/Kotlin/dokka/issues/3151](https://togithub.com/Kotlin/dokka/issues/3151)). No noticeable performance loss is expected. - Bump dependencies to the latest versions ([https://github.com/Kotlin/dokka/pull/3231](https://togithub.com/Kotlin/dokka/pull/3231), [https://github.com/Kotlin/dokka/pull/3206](https://togithub.com/Kotlin/dokka/pull/3206), [https://github.com/Kotlin/dokka/pull/3204](https://togithub.com/Kotlin/dokka/pull/3204)) - Fix a documentation link ([https://github.com/Kotlin/dokka/pull/3213](https://togithub.com/Kotlin/dokka/pull/3213)). Thanks to [@SubhrajyotiSen](https://togithub.com/SubhrajyotiSen) for noticing and fixing it! - Various build and project structure improvements ([https://github.com/Kotlin/dokka/pull/3174](https://togithub.com/Kotlin/dokka/pull/3174), [https://github.com/Kotlin/dokka/issues/3132](https://togithub.com/Kotlin/dokka/issues/3132)). Enormous thanks to [@aSemy](https://togithub.com/aSemy) for the help! See [Dokka 1.9.20](https://togithub.com/Kotlin/dokka/milestone/30?closed=1) milestone for the list of all changes. ### [`v1.9.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.10): 1.9.10 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.9.0...v1.9.10) #### General - Fix re-emerged code analysis concurrency issues which led to flaky builds ([#1599](https://togithub.com/Kotlin/dokka/issues/1599), [#3143](https://togithub.com/Kotlin/dokka/issues/3143)) - Preserve the order of collection items when deserializing Dokka's configuration ([#3006](https://togithub.com/Kotlin/dokka/issues/3006)). Thanks to [@eunwoop](https://togithub.com/eunwoop)! #### HTML format - Fix an indefinite loop in the script that resizes symbol signature blocks ([#3116](https://togithub.com/Kotlin/dokka/issues/3116)) #### Gradle - Fix resolution of platform dependencies for Kotlin 1.9 / Gradle 8 ([#3153](https://togithub.com/Kotlin/dokka/issues/3153), [#3147](https://togithub.com/Kotlin/dokka/issues/3147)) - Mark tasks as not compatible with the Gradle configuration cache ([#3070](https://togithub.com/Kotlin/dokka/issues/3070)). Thanks to [@BoD](https://togithub.com/BoD)! #### Java - Fix Java contravariant types being represented as covariant ([#3091](https://togithub.com/Kotlin/dokka/issues/3091)). Thanks to [@juliamcclellan](https://togithub.com/juliamcclellan)! ### [`v1.9.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.0): 1.9.0 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.8.20...v1.9.0) #### General improvements - Generate dedicated pages for type aliases and enhance their presentation ([https://github.com/Kotlin/dokka/issues/2862](https://togithub.com/Kotlin/dokka/issues/2862), [https://github.com/Kotlin/dokka/issues/2971](https://togithub.com/Kotlin/dokka/issues/2971)) - Add documentation for [Enum.entries](https://youtrack.jetbrains.com/issue/KT-48872) introduced in Kotlin 1.9.0 ([https://github.com/Kotlin/dokka/issues/2762](https://togithub.com/Kotlin/dokka/issues/2762)) #### HTML format This release is packed with enhancements and bugfixes that make your API reference docs mobile-friendly! You may find it a weird direction for improvement — we were just as surprised to find that almost 1/4 of Standard Library's API reference traffic is coming from mobile devices. Thanks to the Kotlin Website team, who contributed these improvements, Dokka now provides a solid experience to such visitors. ##### Improvements: - Significantly improve the mobile layout and overall responsiveness ([https://github.com/Kotlin/dokka/pull/2836](https://togithub.com/Kotlin/dokka/pull/2836), [https://github.com/Kotlin/dokka/pull/3021](https://togithub.com/Kotlin/dokka/pull/3021), [https://github.com/Kotlin/dokka/pull/3082](https://togithub.com/Kotlin/dokka/pull/3082), [https://github.com/Kotlin/dokka/pull/3018](https://togithub.com/Kotlin/dokka/pull/3018)) - Use JetBrains Sans as the primary text font ([https://github.com/Kotlin/dokka/pull/3017](https://togithub.com/Kotlin/dokka/pull/3017)) - Improve the experience of reading the documentation when JavaScript is disabled in the browser ([https://github.com/Kotlin/dokka/pull/3020](https://togithub.com/Kotlin/dokka/pull/3020), [https://github.com/Kotlin/dokka/pull/2836](https://togithub.com/Kotlin/dokka/pull/2836)) ##### Bugfixes - Fix a redundant dot in the path of search elements ([https://github.com/Kotlin/dokka/issues/2289](https://togithub.com/Kotlin/dokka/issues/2289)) - Fix unknown asset paths leaking into HTML body ([https://github.com/Kotlin/dokka/pull/3061](https://togithub.com/Kotlin/dokka/pull/3061)) - Fix invisible/hidden packages for modules with a space in the name ([https://github.com/Kotlin/dokka/issues/3011](https://togithub.com/Kotlin/dokka/issues/3011)) #### Java interoperability - Fix multi-param methods being classified as field setters ([https://github.com/Kotlin/dokka/issues/2992](https://togithub.com/Kotlin/dokka/issues/2992)) #### Javadoc format - Add basic support for `@author`, `@since` and `@return` tags ([https://github.com/Kotlin/dokka/issues/1770](https://togithub.com/Kotlin/dokka/issues/1770)). Thanks to [@irina-turova](https://togithub.com/irina-turova)! #### Other - Decompose Kotlin/Java analysis ([https://github.com/Kotlin/dokka/pull/3034](https://togithub.com/Kotlin/dokka/pull/3034)) - Improve copying base-frontend files between subprojects ([https://github.com/Kotlin/dokka/pull/2970](https://togithub.com/Kotlin/dokka/pull/2970)). Thanks to [@aSemy](https://togithub.com/aSemy)! *** #### Known problems Some Multiplatform Gradle 8 projects might experience build failures when resolving native/platform dependencies. Please, see [https://github.com/Kotlin/dokka/issues/3153](https://togithub.com/Kotlin/dokka/issues/3153) for more details and workarounds. #### Breaking changes This release introduces some breaking changes that are expected to affect only a fraction of Dokka users. ##### HTML **Note:** this section only applies to those customizing Dokka's HTML format by overriding styles or HTML templates. If you are not doing any customizations, you may skip this section. To lay a solid foundation to making the HTML format responsive, some page layouts and many styles had to be changed in a backward-incompatible manner. If you are overriding `logo-styles.css` to provide your own header logo, please update it to be in line with the [new styles](https://togithub.com/Kotlin/dokka/blob/1.9.0/plugins/base/src/main/resources/dokka/styles/logo-styles.css) - there is significantly less position hardcoding now. See [this example](https://togithub.com/Kotlin/dokka/blob/master/examples/gradle/dokka-customFormat-example/logo-styles.css) for how it can be done. If you are overriding `styles.css` with your own file, please update the baseline styles to the [latest](https://togithub.com/Kotlin/dokka/blob/1.9.0/plugins/base/src/main/resources/dokka/styles/style.css), and see if anything is broken. If you get stuck with adapting your styles to the changes, the [diff](https://gist.github.com/IgnatBeresnev/0ef6a2db6aec49e6a43c12a2a9f287d0/revisions#diff-380b7b38760dd442e897eb0164c58f6a17da966ccaca6318017a468c163979b1) might help. If you are overriding `base.ftl` or `header.ftl` templates, please update them to the [latest](https://togithub.com/Kotlin/dokka/tree/1.9.0/plugins/base/src/main/resources/dokka/templates), and adapt your changes. ##### CLI runner Due to the analysis refactoring needed for the migration to K2 ([#3099](https://togithub.com/Kotlin/dokka/issues/3099)), the JARs required to run Dokka have slightly changed. The following JARs are **no longer supported** or published: - [dokka-analysis.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis) - [kotlin-analysis-intellij.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij) - [kotlin-analysis-compiler.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler) Please, replace them with a single JAR: - [analysis-kotlin-descriptors-1.9.0.jar](https://repo1.maven.org/maven2/org/jetbrains/dokka/analysis-kotlin-descriptors/1.9.0/) ##### Plugin API An internal refactoring of Dokka's analysis API was much needed for the migration to K2, leading to breaking changes in some cases. If your Dokka plugin compiles without any problems — you may ignore this information, you are likely not affected. If something doesn't compile or doesn't work anymore, please see [#3099](https://togithub.com/Kotlin/dokka/issues/3099) for more details. ### [`v1.8.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.8.20): 1.8.20 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.8.10...v1.8.20) ### Improvements - Update Kotlin Gradle Plugin to 1.8.10 and Android Gradle Plugin to 4.1.3. - Move the "Properties" block to be above functions inside the "Members" tab ([#2908](https://togithub.com/Kotlin/dokka/issues/2908)) - Make Javadoc tag parsing case-sensitive as per Javadoc specification ([#2907](https://togithub.com/Kotlin/dokka/issues/2907)) - Improve performance by reducing allocations and thus decreasing time spent in GC ([#2729](https://togithub.com/Kotlin/dokka/issues/2729)) ### Bugfixes - Fix unresolved links leading to declarations from another source set [#2878](https://togithub.com/Kotlin/dokka/issues/2878) - Fix Dokka not failing the build if there are errors ([#2934](https://togithub.com/Kotlin/dokka/issues/2934)), regression from 1.8.10. Thanks to [@jush](https://togithub.com/jush)! - Fix `TypeNotPresentException` thrown in projects without KGP ([#2890](https://togithub.com/Kotlin/dokka/issues/2890)), regression from 1.8.10. ### Gradle plugin - Start using `kotlin-dsl` plugin ([#2702](https://togithub.com/Kotlin/dokka/issues/2702), [#2833](https://togithub.com/Kotlin/dokka/issues/2833)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Use Gradle filesystem types for task properties and apply default values lazily ([#2707](https://togithub.com/Kotlin/dokka/issues/2707), [#2983](https://togithub.com/Kotlin/dokka/issues/2983)). Thanks to [@aSemy](https://togithub.com/aSemy)! ### Plugin API - Change the default logging level of console apps (`DokkaConsoleLogger`) to `PROGRESS` ([#2871](https://togithub.com/Kotlin/dokka/issues/2871)) - Introduce `@InternalDokkaApi` annotation ([#2904](https://togithub.com/Kotlin/dokka/issues/2904)) - Mark various utility API as Dokka-internal ([#2937](https://togithub.com/Kotlin/dokka/issues/2937)) ### Infrastructure Big thanks to [@aSemy](https://togithub.com/aSemy), [@Goooler](https://togithub.com/Goooler) and [@3flex](https://togithub.com/3flex) for their valuable contributions and for improving the internal developer experience when working on Dokka! - Use convention plugins to configure the subprojects ([#2704](https://togithub.com/Kotlin/dokka/issues/2704) by [@aSemy](https://togithub.com/aSemy)) - Use Gradle Version Catalog and type-safe project dependencies ([#2884](https://togithub.com/Kotlin/dokka/issues/2884) by [@aSemy](https://togithub.com/aSemy)) - Migrate `buildSrc` to a composite build ([#2912](https://togithub.com/Kotlin/dokka/issues/2912) by [@Goooler](https://togithub.com/Goooler)) - Tidy up build configurations and project files ([#2911](https://togithub.com/Kotlin/dokka/issues/2911), [#2930](https://togithub.com/Kotlin/dokka/issues/2930), [#2909](https://togithub.com/Kotlin/dokka/issues/2909), [#2946](https://togithub.com/Kotlin/dokka/issues/2946), [#2910](https://togithub.com/Kotlin/dokka/issues/2910), [#2705](https://togithub.com/Kotlin/dokka/issues/2705) by [@aSemy](https://togithub.com/aSemy)) - Execute unit tests in parallel ([#2953](https://togithub.com/Kotlin/dokka/issues/2953) by [@Goooler](https://togithub.com/Goooler)) - Add the ability to use different Java versions for build and test tasks ([#2918](https://togithub.com/Kotlin/dokka/issues/2918) by [@aSemy](https://togithub.com/aSemy)) - Add reproducible archive build config ([#2947](https://togithub.com/Kotlin/dokka/issues/2947) by [@aSemy](https://togithub.com/aSemy)) - Configure Kotlin compiler options lazily ([#2883](https://togithub.com/Kotlin/dokka/issues/2883) by [@Goooler](https://togithub.com/Goooler)) - Improve GitHub Actions workflows ([#2939](https://togithub.com/Kotlin/dokka/issues/2939), [#2938](https://togithub.com/Kotlin/dokka/issues/2938) by [@Goooler](https://togithub.com/Goooler)) - Stop testing on Java 15 as it has reached EOL ([#2892](https://togithub.com/Kotlin/dokka/issues/2892) by [@3flex](https://togithub.com/3flex)) - Remove a workaround for a fixed Gradle issue ([#2891](https://togithub.com/Kotlin/dokka/issues/2891) by [@3flex](https://togithub.com/3flex)) ### Documentation - Add informational badges to the main `README.md` ([#2940](https://togithub.com/Kotlin/dokka/issues/2940)). Thanks to [@Goooler](https://togithub.com/Goooler)! - Fix typos, inconsistencies and incorrect links in documentation ([#2979](https://togithub.com/Kotlin/dokka/issues/2979), [#2973](https://togithub.com/Kotlin/dokka/issues/2973), [#2952](https://togithub.com/Kotlin/dokka/issues/2952)). Thanks to [@LiYing2010](https://togithub.com/LiYing2010), [@strangesource](https://togithub.com/strangesource) and [@ansman](https://togithub.com/ansman)! - Add more information about the infrastructure to `CONTRIBUTING.md` ([#2952](https://togithub.com/Kotlin/dokka/issues/2952)) ### Security - Bump npm dependencies to address various vulnerabilities ([#2894](https://togithub.com/Kotlin/dokka/issues/2894), [#2923](https://togithub.com/Kotlin/dokka/issues/2923)) ### Other - Update publication POM links to https ([#2931](https://togithub.com/Kotlin/dokka/issues/2931)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Tidy up Gradle example projects and warning suppressions ([#2916](https://togithub.com/Kotlin/dokka/issues/2916), [#2975](https://togithub.com/Kotlin/dokka/issues/2975)). Thanks to [@aSemy](https://togithub.com/aSemy)! ### [`v1.8.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.8.10): 1.8.10 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.7.20...v1.8.10) Dokka's documentation has been entirely rewritten and can now be found on [kotlinlang.org](https://kotlinlang.org/docs/dokka-introduction.html): - More examples, including Groovy DSL for Gradle project configuration - More guidelines to help beginners - More details for complex projects **Note**: Version 1.8.0 was skipped due to a Metaspace memory leak in Kotlin's reflection ([KT-56093](https://youtrack.jetbrains.com/issue/KT-56093)). Dokka 1.8.10 should be fully compatible with Kotlin 1.8.0. #### Improvements - Revise project documentation and examples ([#2728](https://togithub.com/Kotlin/dokka/issues/2728), [#2737](https://togithub.com/Kotlin/dokka/issues/2737), [#2736](https://togithub.com/Kotlin/dokka/issues/2736)). Thanks to [@sarahhaggarty](https://togithub.com/sarahhaggarty) for helping! - Support generating documentation for Kotlin/Wasm projects ([#2814](https://togithub.com/Kotlin/dokka/issues/2814)). Thanks to [@igoriakovlev](https://togithub.com/igoriakovlev)! - Move the contents of `Inheritors`, `Parameters`, `See also` and `Samples` tabs into the main declaration description ([#2688](https://togithub.com/Kotlin/dokka/issues/2688)). - Add `Members` and `Members & Extensions` tabs to class-like declaration pages ([#2764](https://togithub.com/Kotlin/dokka/issues/2764)). - Display source set / platform indicators at all times, which should help identify the supported platform of single-platform libraries and modules. ([#2847](https://togithub.com/Kotlin/dokka/issues/2847)). - Generate the default no-arg constructor for Java declarations ([#2765](https://togithub.com/Kotlin/dokka/issues/2765)). #### Bugfixes - Fixed analysis environment not being properly disposed ([#2755](https://togithub.com/Kotlin/dokka/issues/2755)). - Fixed nondeterministic sorting of function/property overloads ([#2784](https://togithub.com/Kotlin/dokka/issues/2784)). - Fixed inconsistent alphabetical order of element groups in index and navigation ([#2861](https://togithub.com/Kotlin/dokka/issues/2861)). - Fixed constructors being rendered as functions ([#2689](https://togithub.com/Kotlin/dokka/issues/2689)). - Fixed default values for `var` properties being displayed ([#2717](https://togithub.com/Kotlin/dokka/issues/2717)). - Fixed source links leading to the KDoc instead of the declaration ([#2724](https://togithub.com/Kotlin/dokka/issues/2724)). - Fixed thread-safety issues in `DokkaLogger` ([#2827](https://togithub.com/Kotlin/dokka/issues/2827)). - Fixed documentation not being inherited in case of diamond inheritance ([#2686](https://togithub.com/Kotlin/dokka/issues/2686)). ##### Gradle Plugin - Fixed `NoSuchMethodError` when running under Gradle 8 ([#2796](https://togithub.com/Kotlin/dokka/issues/2796)). - Fixed possible metaspace leaks due to external thread locals not being disposed ([#2678](https://togithub.com/Kotlin/dokka/issues/2678)). - Fixed premature initialization of `outputDirectory` input property ([#556](https://togithub.com/Kotlin/dokka/issues/556)). - Fixed premature initialization of `moduleVersion` input property ([#2799](https://togithub.com/Kotlin/dokka/issues/2799)). Thanks to [@JavierSegoviaCordoba](https://togithub.com/JavierSegoviaCordoba)! - Fixed unnecessary snapshotting of source link directory input which led to performance problems ([#2807](https://togithub.com/Kotlin/dokka/issues/2807)). - Fixed missing group and description for `MultiModule` tasks ([#2806](https://togithub.com/Kotlin/dokka/issues/2806)). Thanks to [@TWiStErRob](https://togithub.com/TWiStErRob)! ##### Javadoc - Fixed truncation of module and package description after the first sentence ([#2055](https://togithub.com/Kotlin/dokka/issues/2055)). Thanks to [@BlackAnubis7](https://togithub.com/BlackAnubis7)! - Fixed rendering of empty/useless Kotlin companion objects ([#200](https://togithub.com/Kotlin/dokka/issues/200), [#2086](https://togithub.com/Kotlin/dokka/issues/2086)) - Fixed leaking configuration/environment details in generated links ([#2803](https://togithub.com/Kotlin/dokka/issues/2803)). - Fixed incorrect links when `javadoc.jar` produced by Dokka is imported into IntelliJ IDEA / Android Studio ([#2734](https://togithub.com/Kotlin/dokka/issues/2734)). Thanks to [@bomberaya](https://togithub.com/bomberaya)! #### Plugin API - Mark Plugin API as experimental ([#2716](https://togithub.com/Kotlin/dokka/issues/2716)). #### Infrastructure - Enable Gradle build cache, and add caching of Maven dependencies for GitHub Actions ([#2711](https://togithub.com/Kotlin/dokka/issues/2711), [#2722](https://togithub.com/Kotlin/dokka/issues/2722)). Thanks to [@aSemy](https://togithub.com/aSemy)! - Add concurrency cancellation for build/test GitHub Actions ([#2710](https://togithub.com/Kotlin/dokka/issues/2710)). Thanks to [@aSemy](https://togithub.com/aSemy)! #### Other - Update `jackson-databind` to avoid CVE-2022-42003 ([#2733](https://togithub.com/Kotlin/dokka/issues/2733)). Thanks to [@ryanlewis](https://togithub.com/ryanlewis)! - Update `Jsoup` to avoid CVE-2022-36033 ([#2772](https://togithub.com/Kotlin/dokka/issues/2772)). - Deprecate methods for adding/removing task dependencies in Dokka's Gradle plugin ([#2857](https://togithub.com/Kotlin/dokka/issues/2857)). - Documentation improvements and fixes ([#2719](https://togithub.com/Kotlin/dokka/issues/2719), [#2718](https://togithub.com/Kotlin/dokka/issues/2718), [#2744](https://togithub.com/Kotlin/dokka/issues/2744)). Thanks to [@SimonMarquis](https://togithub.com/SimonMarquis) and [@ansman](https://togithub.com/ansman)! ### [`v1.7.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.7.20): 1.7.20 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.7.10...v1.7.20) 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 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.7.0...v1.7.10) 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 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.6.21...v1.7.0) #### 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 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.6.20...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/tag/v1.6.20): 1.6.20 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.6.10...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](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. ### [`v1.6.10`](https://togithub.com/Kotlin/dokka/releases/tag/v1.6.10): 1.6.10 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.6.0...v1.6.10) #### Changes - Support Kotlin 1.6.10 - Add a sample project for versioning multi-module ([https://github.com/Kotlin/dokka/pull/2170](https://togithub.com/Kotlin/dokka/pull/2170)) #### Bugfixes - Fix various `java.util.zip.ZipException` for JS dependencies ([https://github.com/Kotlin/dokka/pull/2258](https://togithub.com/Kotlin/dokka/pull/2258)) - Fix handling of Description Lists (`
`) used in JavaDocs ([https://github.com/Kotlin/dokka/pull/2259](https://togithub.com/Kotlin/dokka/pull/2259)) - Fix for "repositories not defined" issue in versioning multimodule example ([https://github.com/Kotlin/dokka/pull/2263](https://togithub.com/Kotlin/dokka/pull/2263)), thanks [@rajdeep1008](https://togithub.com/rajdeep1008)! - Fix multiple rendering issues for "See Also" block for html format ([https://github.com/Kotlin/dokka/pull/2267](https://togithub.com/Kotlin/dokka/pull/2267)) - Fix sample body not being embedded to documentation ([https://github.com/Kotlin/dokka/pull/2216](https://togithub.com/Kotlin/dokka/pull/2216)) #### Maintenance - Update npm dependencies ([https://github.com/Kotlin/dokka/pull/2251](https://togithub.com/Kotlin/dokka/pull/2251)) - Bump `de.undercouch.download` to 4.1.2 ([https://github.com/Kotlin/dokka/pull/2268](https://togithub.com/Kotlin/dokka/pull/2268)) - Bump `kotlinx.coroutines` to 1.6.0 in integration tests ([https://github.com/Kotlin/dokka/pull/2276](https://togithub.com/Kotlin/dokka/pull/2276)) ### [`v1.6.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.6.0): 1.6.0 [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.5.31...v1.6.0) Changes: - New UI - Support of version plugin for single module projects - Allow package-level suppression ([#2209](https://togithub.com/Kotlin/dokka/issues/2209)), thanks [@owengray-google](https://togithub.com/owengray-google) - GFM: Use Markdown syntax to render lists ([#2098](https://togithub.com/Kotlin/dokka/issues/2098)), thanks [@sgilson](https://togithub.com/sgilson) - Fix names of nested inheritors - Fix adding new custom stylesheets in submodules - Add keywords `expect` and `actual` in signatures ### [`v1.5.31`](https://togithub.com/Kotlin/dokka/releases/tag/v1.5.31): 1.5.31 Alpha [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.5.30...v1.5.31) Changes: - Support Kotlin 1.5.31 - Support JS KLib - Fix link to a javadoc enum entry ### [`v1.5.30`](https://togithub.com/Kotlin/dokka/releases/tag/v1.5.30): 1.5.30 Alpha [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.5.0...v1.5.30) Highlights of this release are: - Support kotlin 1.5.30 - `@literal` is also supported without code tag, thanks [@fsladkey](https://togithub.com/fsladkey) - improvements in`@link` tag support. Now it supports line breaks! ### [`v1.5.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.5.0): 1.5.0 Alpha [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.4.32...v1.5.0) Kotlin compiler upgraded to 1.5.0 Fixes: Make module name optional in CLI ([#1850](https://togithub.com/Kotlin/dokka/issues/1850)) Fix line separator issues ([#1887](https://togithub.com/Kotlin/dokka/issues/1887)) Fix preserving spaces in Javadoc comments ([#1923](https://togithub.com/Kotlin/dokka/issues/1923)) GFM renderer: sanitize line ends ([#1936](https://togithub.com/Kotlin/dokka/issues/1936)) Fix rendering html in briefs ([#1931](https://togithub.com/Kotlin/dokka/issues/1931)) Fix code blocks on Extension Points page ([#1948](https://togithub.com/Kotlin/dokka/issues/1948)) Remove extra dash ([#1968](https://togithub.com/Kotlin/dokka/issues/1968)) Don't use older dir from previous runs in versioning ([#1963](https://togithub.com/Kotlin/dokka/issues/1963)) Change jekyll links to be .html ([#1990](https://togithub.com/Kotlin/dokka/issues/1990)) Fix Gradle plugin application ([#2000](https://togithub.com/Kotlin/dokka/issues/2000)) Added features: Add a supertype for leaf dokka tasks that defines dokkaSourceSets ([#1891](https://togithub.com/Kotlin/dokka/issues/1891)) Add ability to specify older versions as a list of files ([#1890](https://togithub.com/Kotlin/dokka/issues/1890)) Cachable Gradle task ([#1905](https://togithub.com/Kotlin/dokka/issues/1905)) Multilanguage docs inheritance ([#1951](https://togithub.com/Kotlin/dokka/issues/1951)) Logging levels in CLI ([#1976](https://togithub.com/Kotlin/dokka/issues/1976)) Flatten multi-module structure ([#1980](https://togithub.com/Kotlin/dokka/issues/1980)) Special thanks to external contributors: [@rnett](https://togithub.com/rnett), [@msink](https://togithub.com/msink), [@zsmb13](https://togithub.com/zsmb13), [@rachelcarmena](https://togithub.com/rachelcarmena) and [@hfhbd](https://togithub.com/hfhbd) ### [`v1.4.32`](https://togithub.com/Kotlin/dokka/releases/tag/v1.4.32): 1.4.32 Alpha [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.4.30...v1.4.32) Fixes: - Fix configuration for suppressing obvious functions ([#1789](https://togithub.com/Kotlin/dokka/issues/1789)) - Fix visibility on enum entry property ([#1828](https://togithub.com/Kotlin/dokka/issues/1828)) - Fix missing annotations in GFM and unresolved static imports ([#1845](https://togithub.com/Kotlin/dokka/issues/1845)) Added features: - Reintroduce multimodule documentation ([#1804](https://togithub.com/Kotlin/dokka/issues/1804)) - Compiler bump to 1.4.32 ([#1818](https://togithub.com/Kotlin/dokka/issues/1818)) - Suppress inherited members ([#1814](https://togithub.com/Kotlin/dokka/issues/1814)) - Bump kotlinx.html to 0.7.3 ([#1819](https://togithub.com/Kotlin/dokka/issues/1819)) (requires adding "https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven" repository) - Add ability to document generated files ([#1832](https://togithub.com/Kotlin/dokka/issues/1832)) - Handle html in KDoc ([#1805](https://togithub.com/Kotlin/dokka/issues/1805)) - Make anchors stable ([#1851](https://togithub.com/Kotlin/dokka/issues/1851)) Special thanks to external contributors: [@AzimMuradov](https://togithub.com/AzimMuradov) and [@hfhbd](https://togithub.com/hfhbd) ### [`v1.4.30`](https://togithub.com/Kotlin/dokka/releases/tag/v1.4.30): 1.4.30 Alpha In this release we focused on improving multi-module experience that would allow links, search and navigation to be rendered for the whole project rather than independent modules. We have also updated the compiler to 1.4.30 and introduced the versioning plugin for the multi module, that lets users generate documentation for each version incrementally and switch between them on the main page. #### Breaking changes - Dokka multi module no longer uses generic `dokka${format}` task but rather `dokka${format}Partial` where `format` is the desired output format like `html` or `gfm` #### Improvements and bug fixes - JvmName support [#1675](https://togithub.com/Kotlin/dokka/issues/1675) - Use Maven directly to download additional dependencies [#1644](https://togithub.com/Kotlin/dokka/issues/1644) thanks [@adangel](https://togithub.com/adangel) - Fix docs on DProperty [#1671](https://togithub.com/Kotlin/dokka/issues/1671) - Refactor ContentTable builder and fix GFM table rendering [#1682](https://togithub.com/Kotlin/dokka/issues/1682) - Versioning [#1654](https://togithub.com/Kotlin/dokka/issues/1654) - Footer customisation [#1691](https://togithub.com/Kotlin/dokka/issues/1691) - Resolve Trove issue [#1715](https://togithub.com/Kotlin/dokka/issues/1715) - Fix incorrect DRI conversion in KotlinAsJava modes for nested definitions [#1701](https://togithub.com/Kotlin/dokka/issues/1701) - JvmOverloads ([#1712](https://togithub.com/Kotlin/dokka/issues/1712)) and add detection of JvmSynthetic ([#1718](https://togithub.com/Kotlin/dokka/issues/1718)) thanks [@bishiboosh](https://togithub.com/bishiboosh) - Annotations for parameters [#1710](https://togithub.com/Kotlin/dokka/issues/1710) - Fix links to method parameters from documentation [#1713](https://togithub.com/Kotlin/dokka/issues/1713) - Fix displaying default Java visibility [#1738](https://togithub.com/Kotlin/dokka/issues/1738) - Add legacy KotlinWebsite format to recognized link formats [#1750](https://togithub.com/Kotlin/dokka/issues/1750) - Fix parameters in CLI and bump kotlinx.cli [#1755](https://togithub.com/Kotlin/dokka/issues/1755) - Suppress tag support [#1742](https://togithub.com/Kotlin/dokka/issues/1742) - Add ability to suppress obvious functions like equals, toString [#1758](https://togithub.com/Kotlin/dokka/issues/1758) - Make Gradle plugin use `api` instead of `implementation` for dokka-core [#1771](https://togithub.com/Kotlin/dokka/issues/1771) ### [`v1.4.20`](https://togithub.com/Kotlin/dokka/releases/tag/v1.4.20): 1.4.20 Alpha [Compare Source](https://togithub.com/Kotlin/dokka/compare/v1.4.10.2...v1.4.20) #### Breaking changes - `prefix` was replaced by `matchingRegex` [#598](https://togithub.com/Kotlin/dokka/issues/598), thanks [@martinbonnin](https://togithub.com/martinbonnin) #### Improvements and bug fixes - Dokka is now build using Kotlin 1.4.20 - javadoc now handles `@inheritDoc` annotation [#1608](https://togithub.com/Kotlin/dokka/issues/1608) - breadcrumbs improvements in html format [#1590](https://togithub.com/Kotlin/dokka/issues/1590) - functions and properties can be divided into inherited and declared [#1535](https://togithub.com/Kotlin/dokka/issues/1535) - argument order is now preserved [#1619](https://togithub.com/Kotlin/dokka/issues/1619), thanks [@gzoritchak](https://togithub.com/gzoritchak) - page navigation now has correct height on Safari [#1633](https://togithub.com/Kotlin/dokka/issues/1633) ### [`v1.4.10.2`](https://togithub.com/Kotlin/dokka/releases/tag/v1.4.10.2): 1.4.10.2 Alpha - Improvements and bugfixes [Compare Source](https://togithub.com/Kotlin/dokka/compare/0.10.1...v1.4.10.2) This release is focused mainly on polishing features that were already present in Dokka ##### Improvements: - Created "On this page" component in the HTML format to allow quicker navigation through long pages - [#1504](https://togithub.com/Kotlin/dokka/issues/1504) - Javadoc will now inform when it is misconfigured with multiple sourcesets - [#1457](https://togithub.com/Kotlin/dokka/issues/1457) - Created a Java-friendly API for plugins - [#1495](https://togithub.com/Kotlin/dokka/issues/1495) - CLI module name is now optional with default value - [#1533](https://togithub.com/Kotlin/dokka/issues/1533) - Added parsing of package-info in Java sources - [#1528](https://togithub.com/Kotlin/dokka/issues/1528) - Translators now run in parallel [#1506](https://togithub.com/Kotlin/dokka/issues/1506) - Added better handling of functional types in rendered output - [#1483](https://togithub.com/Kotlin/dokka/issues/1483) - Added default values for primitive properties. Added presenting default values in signatures - [#1489](https://togithub.com/Kotlin/dokka/issues/1489) - Types are now distinguished from functions in the navigation [#1555](https://togithub.com/Kotlin/dokka/issues/1555) - Multiple improvements

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 was generated by Mend Renovate. View the repository job log.

dniel / traefik-forward-auth0

Update dependency org.jetbrains.dokka:dokka-maven-plugin to v1 #289

Release Notes

` / `

` / `

Configuration