dokka icon indicating copy to clipboard operation
dokka copied to clipboard

Error class: unknown class for Interfaces when generating documentation

Open mjovanc opened this issue 10 months ago • 1 comments

Describe the bug The bug is that when generating dokkaHtmlMultiModule it says it can not find the class Deferred from this:

public fun <T> Deferred<T>.asCompletableFuture(): CompletableFuture<T> {}

However Deferred is an interface:

public interface Deferred<out T> : Job {}

The documentation showing error like this:

fun <T> <Error class: unknown class><T>.asCompletableFuture(): CompletableFuture<T>

Expected behaviour

The expected behaviour would be to generate the documentation like this:

fun <T> <Deferred><T>.asCompletableFuture(): CompletableFuture<T>

Which also links to the interace Deferred in this case.

Screenshots

Skärmavbild 2023-08-28 kl  23 20 25

To Reproduce

The easiest is to use kotlinx.coroutines version 1.73 which is at this date the latest one and run the gradle task dokkaHtmlMultiModule to generate the documentation locally and open up build/dokka/htmlMultiModule/index.html

Installation

  • Operating system: macOS
  • Build tool: Gradle v7.4.2
  • Dokka version: 1.8.20

Are you willing to provide a PR?

Absolutely! If I get some help identifying where the issue persists.

mjovanc avatar Aug 28 '23 21:08 mjovanc