Update dokka to v1.9.20 #75
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/dokka
branch
2 times, most recently
from
0e0e368
to
a9f8b22
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
a9f8b22
to
c3f1706
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
c3f1706
to
ebcf0bf
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
ebcf0bf
to
8e8fcb8
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
8e8fcb8
to
ecb763a
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
ecb763a
to
a4d912d
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
a4d912d
to
19e093b
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
19e093b
to
14c4616
Compare
renovate
bot
force-pushed
the
renovate/dokka
branch
from
14c4616
to
9e2aeeb
Compare
renovate
bot
changed the title
renovate
bot
changed the title
| datasource | package | from | to | | ---------- | ----------------------------------------------------- | ------ | ------ | | maven | org.jetbrains.dokka:org.jetbrains.dokka.gradle.plugin | 1.6.10 | 1.9.20 | | maven | org.jetbrains.dokka:dokka-core | 1.6.10 | 1.9.20 |
renovate
bot
force-pushed
the
renovate/dokka
branch
from
9e2aeeb
to
8d206a2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.6.10->1.9.201.6.10->1.9.20Release Notes
Kotlin/dokka (org.jetbrains.dokka:dokka-core)
v1.9.20: 1.9.20General bugfixes
sealedkeyword in signatures (https://github.com/Kotlin/dokka/issues/2994)innerkeyword in Kotlin signatures (https://github.com/Kotlin/dokka/issues/2793)@paramtag not working with type parameters (https://github.com/Kotlin/dokka/issues/3199)HTML format
Runners
Gradle Plugin
Maven Plugin
dokka:helpbeing absent (https://github.com/Kotlin/dokka/issues/3035). Thanks to @aSemy!CLI runner
sourceRootsconfiguration option (https://github.com/Kotlin/dokka/issues/2571)Plugin API
Other:
wasm-jsandwasm-wasitargets 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,@sinceand@returntags (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.cssto 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.csswith 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.ftlorheader.ftltemplates, 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
TypeNotPresentExceptionthrown in projects without KGP (#2890), regression from 1.8.10.Gradle plugin
kotlin-dslplugin (#2702, #2833). Thanks to @aSemy!Plugin API
DokkaConsoleLogger) toPROGRESS(#2871)@InternalDokkaApiannotation (#2904)Infrastructure
Big thanks to @aSemy, @Goooler and @3flex for their valuable contributions and for improving the internal
developer experience when working on Dokka!
buildSrcto a composite build (#2912 by @Goooler)Documentation
README.md(#2940). Thanks to @Goooler!CONTRIBUTING.md(#2952)Security
Other
v1.8.10: 1.8.10Dokka's documentation has been entirely rewritten and can now be found on kotlinlang.org:
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
Inheritors,Parameters,See alsoandSamplestabs into the main declaration description (#2688).MembersandMembers & Extensionstabs to class-like declaration pages (#2764).Bugfixes
varproperties being displayed (#2717).DokkaLogger(#2827).Gradle Plugin
NoSuchMethodErrorwhen running under Gradle 8 (#2796).outputDirectoryinput property (#556).moduleVersioninput property (#2799). Thanks to @JavierSegoviaCordoba!MultiModuletasks (#2806). Thanks to @TWiStErRob!Javadoc
javadoc.jarproduced by Dokka is imported into IntelliJ IDEA / Android Studio (#2734). Thanks to @bomberaya!Plugin API
Infrastructure
Other
jackson-databindto avoid CVE-2022-42003 (#2733). Thanks to @ryanlewis!Jsoupto avoid CVE-2022-36033 (#2772).v1.7.20: 1.7.20This release focuses primarily on improving user experience and HTML format in particular.
Improvements
General
suppressInheritedMembersconfiguration property) (#2625)@Deprecateddeclarations such as deprecation message, level and proposed replacement (#2622)Enum's syntheticvalues()andvalueOf()functions (#2650)Javaconstants (#2609)HTML format
Cmd + K/Ctrl + Khotkey for opening search dialog, thanks to @atyrin! (#2633)Javadoc format
varHTML tag, thanks to @atyrin (#2617)Kotlin-as-Java plugin
Gradle runner
kotlin-stdlibdependency, which should fix errors likeModule was compiled with an incompatible version of Kotlin, thanks to @martinbonnin! (#2570)Bugfixes
Markdownelements, where_try_ *this*would be rendered astrythis(#2640)StackOverflowErrorrelated to type-aliased native references (#2664)IllegalStateExceptionthat was caused by using JS's dynamic types (#2645)privatedeclarations were rendered aspublic(#2639)@seetag (#2627)JavaEnum types being rendered asAny(#2647)Javaannotation params (#2593)sourceRootsconfiguration param not handling single.javafiles, thanks to @2017398956! (#2604)dokka-customFormat-exampleproject to use up-to-date logo styles (#2608)Developer experience
Gradle Enterprisebuild scans, thanks to @Goooler! (#2641)GitHub Actionsartifacts to store generated documentation snapshots, thanks to @StefMa! (#2630)Other
v1.7.10: 1.7.10Bugfix release that addresses several blockers and regressions.
General
Kotlin1.7.10Gradle plugin
Kotlinstdlib in plugin dependencies, this should fix errors likeModule was compiled with an incompatible version of Kotlinwhen usingDokka. Thanks to @martinbonnin (#2543)Java sources
Javacode (#2544)Javasources (#2509, #2551, #2350)IntelliJplatformWARN: Attempt to load keymessages that appeared when analyzingJavasources (#2559)v1.7.0: 1.7.0Improvements
General
Kotlin1.7.0,IntelliJPlatform 213Javafields with accessors, now properly interpreted asval/varproperties (https://github.com/Kotlin/dokka/pull/2481, https://github.com/Kotlin/dokka/pull/2532, https://github.com/Kotlin/dokka/pull/2540)@Deprecatedmembers withHIDDENlevel (https://github.com/Kotlin/dokka/pull/2486)HTML format
Javadoc format
Javadocpages generation deterministic (https://github.com/Kotlin/dokka/pull/2479)jQueryto avoid multiple CVEs, thanks to @ToppleTheNun (https://github.com/Kotlin/dokka/issues/1938)GFM format
Kotlin-as-Java plugin
Javaaccess modifiers into function signatures, thanks to @tripolkaandrey (https://github.com/Kotlin/dokka/pull/2510)Gradle runner
dokka-analysisdependencycompileOnly, this should help avoid compatibility problems if different versions ofKotlinare bundled inGradleandDokka(https://github.com/Kotlin/dokka/pull/2521)Gradletasks, thanks to @3flex (https://github.com/Kotlin/dokka/pull/2500)Gradlerunner, thanks to @3flex (https://github.com/Kotlin/dokka/pull/2502)Gradlerunner, thanks to @3flex (https://github.com/Kotlin/dokka/pull/2501)Fixes
General bugfixes
Security
log4j1.2 that came as a transitive dependency (https://github.com/Kotlin/dokka/issues/2488)Plugin API
base.ftltemplate: nowheader.ftl,footer.ftlandpage_metadata.ftlcan be overridden individually (https://github.com/Kotlin/dokka/pull/2432)Other
Thanks to all the contributors!
v1.6.21: 1.6.21This is a bugfix release that mostly enables building documentation for multiplatform projects that utilize
.kliblibraries.Changes
jsoupdependency to avoid CVE-2021-37714 (#2448)Bugfixes
KLIBlibraries for common platform, previously led toERROR CLASSinstead of references in documentation (#2441)v1.6.20: 1.6.20Features
documentedVisibilitiessetting that allows including/excluding any visibility modifier in documentation. This is a more flexible replacement forincludeNonPublic, which has now been deprecated (https://github.com/Kotlin/dokka/pull/2270)HTML format changes
val/varkeywords and default values (https://github.com/Kotlin/dokka/pull/2313)Bugfixes
OutOfMemoryError: Metaspace-related issues for the majority of cases (https://github.com/Kotlin/dokka/pull/2216)@symbol within code blocks in.mdfiles doesn't lead to cropped documents anymore (https://github.com/Kotlin/dokka/pull/2418)isBooleaninstead ofgetBoolean(https://github.com/Kotlin/dokka/pull/2356), thanks to @CharlesG-Branch!Plugin API Changes
General Improvements
package-info.java(https://github.com/Kotlin/dokka/pull/2331), thanks to @ember-rose!<h1>/<h2>/<h3>) in Javadoc (https://github.com/Kotlin/dokka/pull/2345), thanks to @asfalcone!expect-actualkeywords (https://github.com/Kotlin/dokka/pull/2316)Known issues
.kliblibraries may experience problems. There will be a separate1.6.21release that will address this issue shortly.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 is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR was generated by Mend Renovate. View the repository job log.