codecov[bot]
commented
1 year ago Codecov Report
Merging #26 (3d90335) into main (9fdf44f) will not change coverage. Report is 7 commits behind head on main. The diff coverage is
n/a.
@@ Coverage Diff @@
## main #26 +/- ##
=======================================
Coverage 77.02% 77.02%
=======================================
Files 9 9
Lines 148 148
Branches 32 32
=======================================
Hits 114 114
Misses 16 16
Partials 18 18 :mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more
This PR contains the following updates:
1.8.20->1.9.0Release Notes
Kotlin/dokka (org.jetbrains.dokka)
### [`v1.9.0`](https://togithub.com/Kotlin/dokka/releases/tag/v1.9.0): 1.9.0 Beta #### General improvements - Generate dedicated pages for type aliases and enhance their presentation ([https://github.com/Kotlin/dokka/issues/2862](https://togithub.com/Kotlin/dokka/issues/2862), [https://github.com/Kotlin/dokka/issues/2971](https://togithub.com/Kotlin/dokka/issues/2971)) - Add documentation for [Enum.entries](https://youtrack.jetbrains.com/issue/KT-48872) introduced in Kotlin 1.9.0 ([https://github.com/Kotlin/dokka/issues/2762](https://togithub.com/Kotlin/dokka/issues/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 ([https://github.com/Kotlin/dokka/pull/2836](https://togithub.com/Kotlin/dokka/pull/2836), [https://github.com/Kotlin/dokka/pull/3021](https://togithub.com/Kotlin/dokka/pull/3021), [https://github.com/Kotlin/dokka/pull/3082](https://togithub.com/Kotlin/dokka/pull/3082), [https://github.com/Kotlin/dokka/pull/3018](https://togithub.com/Kotlin/dokka/pull/3018)) - Use JetBrains Sans as the primary text font ([https://github.com/Kotlin/dokka/pull/3017](https://togithub.com/Kotlin/dokka/pull/3017)) - Improve the experience of reading the documentation when JavaScript is disabled in the browser ([https://github.com/Kotlin/dokka/pull/3020](https://togithub.com/Kotlin/dokka/pull/3020), [https://github.com/Kotlin/dokka/pull/2836](https://togithub.com/Kotlin/dokka/pull/2836)) ##### Bugfixes - Fix a redundant dot in the path of search elements ([https://github.com/Kotlin/dokka/issues/2289](https://togithub.com/Kotlin/dokka/issues/2289)) - Fix unknown asset paths leaking into HTML body ([https://github.com/Kotlin/dokka/pull/3061](https://togithub.com/Kotlin/dokka/pull/3061)) - Fix invisible/hidden packages for modules with a space in the name ([https://github.com/Kotlin/dokka/issues/3011](https://togithub.com/Kotlin/dokka/issues/3011)) #### Java interoperability - Fix multi-param methods being classified as field setters ([https://github.com/Kotlin/dokka/issues/2992](https://togithub.com/Kotlin/dokka/issues/2992)) #### Javadoc format - Add basic support for `@author`, `@since` and `@return` tags ([https://github.com/Kotlin/dokka/issues/1770](https://togithub.com/Kotlin/dokka/issues/1770)). Thanks to [@irina-turova](https://togithub.com/irina-turova)! #### Other - Decompose Kotlin/Java analysis ([https://github.com/Kotlin/dokka/pull/3034](https://togithub.com/Kotlin/dokka/pull/3034)) - Improve copying base-frontend files between subprojects ([https://github.com/Kotlin/dokka/pull/2970](https://togithub.com/Kotlin/dokka/pull/2970)). Thanks to [@aSemy](https://togithub.com/aSemy)! *** #### 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](https://togithub.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](https://togithub.com/Kotlin/dokka/blob/1.9.0/plugins/base/src/main/resources/dokka/styles/logo-styles.css) - there is significantly less position hardcoding now. See [this example](https://togithub.com/Kotlin/dokka/blob/master/examples/gradle/dokka-customFormat-example/logo-styles.css) for how it can be done. If you are overriding `styles.css` with your own file, please update the baseline styles to the [latest](https://togithub.com/Kotlin/dokka/blob/1.9.0/plugins/base/src/main/resources/dokka/styles/style.css), and see if anything is broken. If you get stuck with adapting your styles to the changes, the [diff](https://gist.github.com/IgnatBeresnev/0ef6a2db6aec49e6a43c12a2a9f287d0/revisions#diff-380b7b38760dd442e897eb0164c58f6a17da966ccaca6318017a468c163979b1) might help. If you are overriding `base.ftl` or `header.ftl` templates, please update them to the [latest](https://togithub.com/Kotlin/dokka/tree/1.9.0/plugins/base/src/main/resources/dokka/templates), and adapt your changes. ##### CLI runner Due to the analysis refactoring needed for the migration to K2 ([#3099](https://togithub.com/Kotlin/dokka/issues/3099)), the JARs required to run Dokka have slightly changed. The following JARs are **no longer supported** or published: - [dokka-analysis.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/dokka-analysis) - [kotlin-analysis-intellij.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-intellij) - [kotlin-analysis-compiler.jar](https://mvnrepository.com/artifact/org.jetbrains.dokka/kotlin-analysis-compiler) Please, replace them with a single JAR: - [analysis-kotlin-descriptors-1.9.0.jar](https://repo1.maven.org/maven2/org/jetbrains/dokka/analysis-kotlin-descriptors/1.9.0/) ##### 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](https://togithub.com/Kotlin/dokka/issues/3099) for more details.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 has been generated by Mend Renovate. View repository job log here.