Update plugin org.jetbrains.dokka to v1.9.20 #141
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.8.10
->1.9.20
Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
Kotlin/dokka (org.jetbrains.dokka)
v1.9.20
: 1.9.20General bugfixes
sealed
keyword in signatures (https://github.com/Kotlin/dokka/issues/2994)inner
keyword in Kotlin signatures (https://github.com/Kotlin/dokka/issues/2793)@param
tag not working with type parameters (https://github.com/Kotlin/dokka/issues/3199)HTML format
Runners
Gradle Plugin
Maven Plugin
dokka:help
being absent (https://github.com/Kotlin/dokka/issues/3035). Thanks to @aSemy!CLI runner
sourceRoots
configuration option (https://github.com/Kotlin/dokka/issues/2571)Plugin API
Other:
wasm-js
andwasm-wasi
targets introduced in Kotlin 1.9.20 are supported (https://github.com/Kotlin/dokka/issues/3310)See Dokka 1.9.20 milestone for the list of all changes.
v1.9.10
: 1.9.10General
HTML format
Gradle
Java
v1.9.0
: 1.9.0General 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
@author
,@since
and@return
tags (https://github.com/Kotlin/dokka/issues/1770). Thanks to @irina-turova!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
orheader.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
: 1.8.20Improvements
Bugfixes
TypeNotPresentException
thrown in projects without KGP (#2890), regression from 1.8.10.Gradle plugin
kotlin-dsl
plugin (#2702, #2833). Thanks to @aSemy!Plugin API
DokkaConsoleLogger
) toPROGRESS
(#2871)@InternalDokkaApi
annotation (#2904)Infrastructure
Big thanks to @aSemy, @Goooler and @3flex for their valuable contributions and for improving the internal
developer experience when working on Dokka!
buildSrc
to a composite build (#2912 by @Goooler)Documentation
README.md
(#2940). Thanks to @Goooler!CONTRIBUTING.md
(#2952)Security
Other
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.
This PR was generated by Mend Renovate. View the repository job log.