Sourced from org.jetbrains.dokka:dokka-gradle-plugin's releases.
1.8.10 Beta
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 (https://github.com/facebook/flipper/issues/2728, https://github.com/facebook/flipper/issues/2737, https://github.com/facebook/flipper/issues/2736). Thanks to
@sarahhaggartyfor helping!- Support generating documentation for Kotlin/Wasm projects (#2814). Thanks to
@igoriakovlev!- Move the contents of
Inheritors,Parameters,See alsoandSamplestabs into the main declaration description (https://github.com/facebook/flipper/issues/2688).- Add
MembersandMembers & Extensionstabs to class-like declaration pages (https://github.com/facebook/flipper/issues/2764).- Display source set / platform indicators at all times, which should help identify the supported platform of single-platform libraries and modules. (https://github.com/facebook/flipper/issues/2847).
- Generate the default no-arg constructor for Java declarations (https://github.com/facebook/flipper/issues/2765).
Bugfixes
- Fixed analysis environment not being properly disposed (https://github.com/facebook/flipper/issues/2755).
- Fixed nondeterministic sorting of function/property overloads (https://github.com/facebook/flipper/issues/2784).
- Fixed inconsistent alphabetical order of element groups in index and navigation (https://github.com/facebook/flipper/issues/2861).
- Fixed constructors being rendered as functions (https://github.com/facebook/flipper/issues/2689).
- Fixed default values for
varproperties being displayed (https://github.com/facebook/flipper/issues/2717).- Fixed source links leading to the KDoc instead of the declaration (https://github.com/facebook/flipper/issues/2724).
- Fixed thread-safety issues in
DokkaLogger(#2827).- Fixed documentation not being inherited in case of diamond inheritance (https://github.com/facebook/flipper/issues/2686).
Gradle Plugin
- Fixed
NoSuchMethodErrorwhen running under Gradle 8 (#2796).- Fixed possible metaspace leaks due to external thread locals not being disposed (https://github.com/facebook/flipper/issues/2678).
- Fixed premature initialization of
outputDirectoryinput property (https://github.com/facebook/flipper/issues/556).- Fixed premature initialization of
moduleVersioninput 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
MultiModuletasks (#2806). Thanks to@TWiStErRob!Javadoc
- Fixed truncation of module and package description after the first sentence (https://github.com/facebook/flipper/issues/2055). Thanks to
@BlackAnubis7!- Fixed rendering of empty/useless Kotlin companion objects (https://github.com/facebook/flipper/issues/200, https://github.com/facebook/flipper/issues/2086)
- Fixed leaking configuration/environment details in generated links (#2803).
- Fixed incorrect links when
javadoc.jarproduced by Dokka is imported into IntelliJ IDEA / Android Studio (https://github.com/facebook/flipper/issues/2734). Thanks to@bomberaya!Plugin API
- Mark Plugin API as experimental (https://github.com/facebook/flipper/issues/2716).
Infrastructure
... (truncated)
7753776 Do no render Types tab when there are no types (https://github.com/facebook/flipper/issues/2900)4b5a88d Do not propagate opt-inaba2d12 Update dokka_version to the release one5ccda6f Mark Plugin Api as experimental (https://github.com/facebook/flipper/issues/2743)605ce9e Reorganize tabs for Classlike (https://github.com/facebook/flipper/issues/2764)5762271 Exclude user guides from mkdocs documentation (https://github.com/facebook/flipper/issues/2868)1e10c6f Fix mkdocs documentation leading to non-stable versions (https://github.com/facebook/flipper/issues/2870)1fd0459 Consistent alphabetical order of element groups in index and navigation (https://github.com/facebook/flipper/issues/2861)daed35f Do not render filter-section for empty source sets (https://github.com/facebook/flipper/issues/2858)e8423ec Deprecate methods for adding/removing task dependencies (https://github.com/facebook/flipper/issues/2857)