General improvements
- Generate dedicated pages for type aliases and enhance their presentation (#2862, #2971)
- Add documentation for Enum.entries introduced in Kotlin 1.9.0 (#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 (#2836, #3021, #3082, #3018)
- Use JetBrains Sans as the primary text font (#3017)
- Improve the experience of reading the documentation when JavaScript is disabled in the browser (#3020, #2836)
Bugfixes
- Fix a redundant dot in the path of search elements (#2289)
- Fix unknown asset paths leaking into HTML body (#3061)
- Fix invisible/hidden packages for modules with a space in the name (#3011)
Java interoperability
- Fix multi-param methods being classified as field setters (#2992)
Javadoc format
- Add basic support for
@author,@sinceand@returntags (#1770). Thanks to @irina-turova!
Other
- Decompose Kotlin/Java analysis (#3034)
- Improve copying base-frontend files between subprojects (#2970). Thanks to @aSemy!
Known problems
Some Multiplatform Gradle 8 projects might experience build failures when resolving native/platform dependencies. Please, see #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.