Dokka Versions Save

API documentation engine for Kotlin

v1.9.20

1 month ago

General bugfixes

HTML format

Runners

Gradle Plugin

Maven Plugin

CLI runner

Plugin API

Other:

See Dokka 1.9.20 milestone for the list of all changes.

v1.9.10

6 months ago

General

  • Fix re-emerged code analysis concurrency issues which led to flaky builds (#1599, #3143)
  • Preserve the order of collection items when deserializing Dokka's configuration (#3006). Thanks to @eunwoop!

HTML format

  • Fix an indefinite loop in the script that resizes symbol signature blocks (#3116)

Gradle

  • Fix resolution of platform dependencies for Kotlin 1.9 / Gradle 8 (#3153, #3147)
  • Mark tasks as not compatible with the Gradle configuration cache (#3070). Thanks to @BoD!

Java

  • Fix Java contravariant types being represented as covariant (#3091). Thanks to @juliamcclellan!

v1.9.0

7 months ago

General improvements

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:

Bugfixes

Java interoperability

Javadoc format

Other

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 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 - there is significantly less position hardcoding now. See this example for how it can be done.

If you are overriding styles.css with your own file, please update the baseline styles to the latest, and see if anything is broken. If you get stuck with adapting your styles to the changes, the diff might help.

If you are overriding base.ftl or header.ftl templates, please update them to the latest, and adapt your changes.

CLI runner

Due to the analysis refactoring needed for the migration to K2 (#3099), the JARs required to run Dokka have slightly changed.

The following JARs are no longer supported or published:

Please, replace them with a single JAR:

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 for more details.

v1.8.20

10 months ago

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)
  • Make Javadoc tag parsing case-sensitive as per Javadoc specification (#2907)
  • Improve performance by reducing allocations and thus decreasing time spent in GC (#2729)

Bugfixes

  • Fix unresolved links leading to declarations from another source set #2878
  • Fix Dokka not failing the build if there are errors (#2934), regression from 1.8.10. Thanks to @jush!
  • Fix TypeNotPresentException thrown in projects without KGP (#2890), regression from 1.8.10.

Gradle plugin

  • Start using kotlin-dsl plugin (#2702, #2833). Thanks to @aSemy!
  • Use Gradle filesystem types for task properties and apply default values lazily (#2707, #2983). Thanks to @aSemy!

Plugin API

  • Change the default logging level of console apps (DokkaConsoleLogger) to PROGRESS (#2871)
  • Introduce @InternalDokkaApi annotation (#2904)
  • Mark various utility API as Dokka-internal (#2937)

Infrastructure

Big thanks to @aSemy, @Goooler and @3flex for their valuable contributions and for improving the internal developer experience when working on Dokka!

  • Use convention plugins to configure the subprojects (#2704 by @aSemy)
  • Use Gradle Version Catalog and type-safe project dependencies (#2884 by @aSemy)
  • Migrate buildSrc to a composite build (#2912 by @Goooler)
  • Tidy up build configurations and project files (#2911, #2930, #2909, #2946, #2910, #2705 by @aSemy)
  • Execute unit tests in parallel (#2953 by @Goooler)
  • Add the ability to use different Java versions for build and test tasks (#2918 by @aSemy)
  • Add reproducible archive build config (#2947 by @aSemy)
  • Configure Kotlin compiler options lazily (#2883 by @Goooler)
  • Improve GitHub Actions workflows (#2939, #2938 by @Goooler)
  • Stop testing on Java 15 as it has reached EOL (#2892 by @3flex)
  • Remove a workaround for a fixed Gradle issue (#2891 by @3flex)

Documentation

  • Add informational badges to the main README.md (#2940). Thanks to @Goooler!
  • Fix typos, inconsistencies and incorrect links in documentation (#2979, #2973, #2952). Thanks to @LiYing2010, @strangesource and @ansman!
  • Add more information about the infrastructure to CONTRIBUTING.md (#2952)

Security

  • Bump npm dependencies to address various vulnerabilities (#2894, #2923)

Other

  • Update publication POM links to https (#2931). Thanks to @aSemy!
  • Tidy up Gradle example projects and warning suppressions (#2916, #2975). Thanks to @aSemy!

v1.8.10

1 year ago

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 and Samples tabs into the main declaration description (#2688).
  • Add Members and Members & 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!

v1.7.20

1 year ago

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)
  • Display details for @Deprecated declarations such as deprecation message, level and proposed replacement (#2622)
  • Display and document Enum's synthetic values() and valueOf() functions (#2650)
  • Do not render constructors for annotation classes (#2642)
  • Display values of Java constants (#2609)
  • Trim spaces inside indented code blocks (#2661, #2232, #2233)
  • Replace package name on the cover of package pages with "Package-level declarations" (#2586)

HTML format

  • Add IntelliJ icons to the navigation side menu (#2578)
  • Add auto-scrolling to selected navigation item (#2575)
  • Use OS color scheme to initialize light/dark mode, thanks to @pt2121! (#2611)
  • Update styling of all section tabs (including platform tabs) to match kotlinlang.org (#2589)
  • Format long signatures dynamically based on client width (#2659)
  • Add a horizontal divider between function overloads that are displayed on the same page (#2585)
  • Add Cmd + K / Ctrl + K hotkey for opening search dialog, thanks to @atyrin! (#2633)
  • Make current breadcrumb element not clickable and of default font color (#2588)
  • Update code highlighting colors (#2670)
  • Do not render platform tabs for common-only content (#2613)
  • Apply the same style to all KDoc tag headers, making it more consistent (#2587)
  • Move source links into signature, especially helpful on pages with many overloads (#2476)
  • Add inner/nested declarations to the navigation side menu (#2597)
  • Disable copy button for signatures (#2577)

Javadoc format

  • Support var HTML tag, thanks to @atyrin (#2617)

Kotlin-as-Java plugin

  • Render annotation blocks for transformed classes, previously ignored (#2549)

Gradle runner

  • Remove kotlin-stdlib dependency, which should fix errors like Module was compiled with an incompatible version of Kotlin, thanks to @martinbonnin! (#2570)

Bugfixes

  • Fixed missing spaces between adjacent Markdown elements, where _try_ *this* would be rendered as trythis (#2640)
  • Fixed dependency resolution errors when building documentation for multiplatform projects with enabled compatibility metadata variant (#2634)
  • Fixed a rare StackOverflowError related to type-aliased native references (#2664)
  • Fixed IllegalStateException that was caused by using JS's dynamic types (#2645)
  • Fixed a bug where certain private declarations were rendered as public (#2639)
  • Fixed incorrect handling of static declarations used within @see tag (#2627)
  • Fixed Java Enum types being rendered as Any (#2647)
  • Fixed incorrect signature generation that was caused by generic types caching (#2619)
  • Fixed incorrect parsing of static imports in Java annotation params (#2593)
  • Fixed sourceRoots configuration param not handling single .java files, thanks to @2017398956! (#2604)
  • Fixed unresponsive HTML anchor button (#2644)
  • Fixed dokka-customFormat-example project to use up-to-date logo styles (#2608)

Developer experience

  • Enable Gradle Enterprise build scans, thanks to @Goooler! (#2641)
  • Use GitHub Actions artifacts to store generated documentation snapshots, thanks to @StefMa! (#2630)

Other

  • Warn users that GFM, Javadoc and Jekyll formats are in early alpha stages by printing a build log message during execution (#2550)
  • Revise developer guides documentation that should help plugin authors and new contributors (#2523)
  • Bump Gradle to 7.5.1, thanks to @Goooler! (#2618)
  • Fix spelling errors, thanks to @FelixDombek! (#2594)

v1.7.10

1 year ago

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 (#2543)

Java sources

  • Fixed build failure caused by having configured source links for Java code (#2544)
  • Fixed several exotic problems that led to build failures, all related to using annotation in Java sources (#2509, #2551, #2350)
  • Fixed IntelliJ platform WARN: Attempt to load key messages that appeared when analyzing Java sources (#2559)

v1.7.0

1 year ago

Improvements

General

HTML format

Javadoc format

GFM format

Kotlin-as-Java plugin

Gradle runner

Fixes

General bugfixes

Security

Plugin API

Other

Thanks to all the contributors!

v1.6.21

2 years ago

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 (#2448)

Bugfixes

  • Support KLIB libraries for common platform, previously led to ERROR CLASS instead of references in documentation (#2441)
  • Fixed a maven plugin build problem related to coroutines which only occurred in multi-module builds (#2461)

v1.6.20

2 years ago

Features

HTML format changes

Bugfixes

Plugin API Changes

General Improvements

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.