dokka icon indicating copy to clipboard operation
dokka copied to clipboard

[K2] Stabilize pure Kotlin/JVM and mixed Kotlin/Java projects

Open IgnatBeresnev opened this issue 1 year ago • 2 comments

This issue is part of a larger issue: Migrate Dokka's analysis to K2 compiler (#2888).

Goal

Dokka should be able to generate documentation for any pure Kotlin/JVM project, or any project that uses a mix of Kotlin and Java together.

That means, it has to work with:

  • All JVM versions officially supported by Kotlin. Running on Java 8, 11 and 17 should produce the same result.
  • Projects that use pure Java and/or JVM-only Kotlin libraries (KMP libraries fall outside of the scope, they should be addressed in #3137). All user-visible types must be resolved correctly, including external documentation links.
  • Projects that only use Kotlin's standard library and/or Java SE API directly (declarations from java.lang, java.util and similar packages).
  • Dokka's JVM-only Javadoc format.

Once done, we should be able to turn on the K2 analysis by default for all JVM-only user projects.

Due date

The K2 analysis should be used by default in all JVM-only user projects in Dokka 2.0.0, with the ability to fall back to K1.

If there are unresolved issues or bugs by that time, at the very least it should be available for early testing (i.e toggleable via a flag).

Sub-tasks

  • [x] https://github.com/Kotlin/dokka/issues/3114
  • [x] https://github.com/Kotlin/dokka/issues/3392
  • [x] https://github.com/Kotlin/dokka/issues/3350
  • [x] https://github.com/Kotlin/dokka/issues/3336
  • [x] https://github.com/Kotlin/dokka/issues/3135
  • [x] https://github.com/Kotlin/dokka/issues/3129
  • [x] https://github.com/Kotlin/dokka/issues/3207
  • [x] https://github.com/Kotlin/dokka/issues/3234
  • [x] https://github.com/Kotlin/dokka/issues/3335
  • [x] https://github.com/Kotlin/dokka/issues/3352
  • [x] https://github.com/Kotlin/dokka/issues/3375
  • [x] https://github.com/Kotlin/dokka/issues/3384
  • [ ] https://github.com/Kotlin/dokka/issues/3250
  • [x] https://github.com/Kotlin/dokka/issues/3316
  • [ ] https://github.com/Kotlin/dokka/issues/3348
  • [ ] https://github.com/Kotlin/dokka/issues/3356
  • [x] https://github.com/Kotlin/dokka/issues/3363
  • [x] https://github.com/Kotlin/dokka/issues/3196
  • [ ] https://github.com/Kotlin/dokka/issues/3339
  • [x] https://github.com/Kotlin/dokka/issues/3355
  • [ ] https://github.com/Kotlin/dokka/issues/3367
  • [ ] https://github.com/Kotlin/dokka/issues/3369
  • [ ] https://github.com/Kotlin/dokka/issues/3338

Upstream issues

IgnatBeresnev avatar Aug 24 '23 16:08 IgnatBeresnev