dokka
dokka copied to clipboard
Use sources of dependent submodules instead of their artifacts
Assume there is a project that has two modules :moduleA
and :moduleB
.
The module A depends on the module B, e.g. via implementation(project(":moduleB"))
.
In order to generate the documentation of module A, Dokka triggers a compile task to build moduleB.jar
(or .klib
) then this artifact is a part of classpath for :moduleA
.
Built artifacts of dependent submodules are used. In this case, Dokka does not use sources of :moduleB
It causes Dokka can’t see the documentation of module B in module A. (see https://github.com/Kotlin/dokka/issues/463, https://github.com/Kotlin/dokka/issues/463#issuecomment-1384464207 and #3230).
Proposal Dokka can use the source of dependent submodules instead of its artifacts.
Possible disadvantage (it should be researched): Dokka needs to analyse the source of dependent submodules. Time of source analysis versus time compilation (in most cases already compiled artifacts).