1.8.10
Dokka's documentation has been entirely rewritten and can now be found on kotlinlang.org:
- 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). Dokka 1.8.10 should be fully compatible with Kotlin 1.8.0.
Improvements
- Revise project documentation and examples (#2728, #2737, #2736). Thanks to @sarahhaggarty for helping!
- Support generating documentation for Kotlin/Wasm projects (#2814). Thanks to @igoriakovlev!
- Move the contents of
Inheritors
,Parameters
,See also
andSamples
tabs into the main declaration description (#2688). - Add
Members
andMembers & Extensions
tabs to class-like declaration pages (#2764). - Display source set / platform indicators at all times, which should help identify the supported platform of single-platform libraries and modules. (#2847).
- Generate the default no-arg constructor for Java declarations (#2765).
Bugfixes
- Fixed analysis environment not being properly disposed (#2755).
- Fixed nondeterministic sorting of function/property overloads (#2784).
- Fixed inconsistent alphabetical order of element groups in index and navigation (#2861).
- Fixed constructors being rendered as functions (#2689).
- Fixed default values for
var
properties being displayed (#2717). - Fixed source links leading to the KDoc instead of the declaration (#2724).
- Fixed thread-safety issues in
DokkaLogger
(#2827). - Fixed documentation not being inherited in case of diamond inheritance (#2686).
Gradle Plugin
- Fixed
NoSuchMethodError
when running under Gradle 8 (#2796). - Fixed possible metaspace leaks due to external thread locals not being disposed (#2678).
- Fixed premature initialization of
outputDirectory
input property (#556). - Fixed premature initialization of
moduleVersion
input property (#2799). Thanks to @JavierSegoviaCordoba! - Fixed unnecessary snapshotting of source link directory input which led to performance problems (#2807).
- Fixed missing group and description for
MultiModule
tasks (#2806). Thanks to @TWiStErRob!
Javadoc
- Fixed truncation of module and package description after the first sentence (#2055). Thanks to @BlackAnubis7!
- Fixed rendering of empty/useless Kotlin companion objects (#200, #2086)
- Fixed leaking configuration/environment details in generated links (#2803).
- Fixed incorrect links when
javadoc.jar
produced by Dokka is imported into IntelliJ IDEA / Android Studio (#2734). Thanks to @bomberaya!
Plugin API
- Mark Plugin API as experimental (#2716).
Infrastructure
- Enable Gradle build cache, and add caching of Maven dependencies for GitHub Actions (#2711, #2722). Thanks to @aSemy!
- Add concurrency cancellation for build/test GitHub Actions (#2710). Thanks to @aSemy!
Other
- Update
jackson-databind
to avoid CVE-2022-42003 (#2733). Thanks to @ryanlewis! - Update
Jsoup
to avoid CVE-2022-36033 (#2772). - Deprecate methods for adding/removing task dependencies in Dokka's Gradle plugin (#2857).
- Documentation improvements and fixes (#2719, #2718, #2744). Thanks to @SimonMarquis and @ansman!