Misleading representation of Java Varargs #2395
Labels
bug
language: Java
Issue/PR related to the Java language feature/analysis/docs
plugin: kotlin-as-java
An issue/PR related to Dokka's kotlin-as-java plugin
Describe the bug
When generating documentation for a Java method which contains a
varags
argument Dokka interprets varargs asArray<T>
. Documentation forlooks like that
I understand that JVM packs varargs in Array, but as an API reference, it is misleading. For instance, classic Javadoc explicitly states that a method expects a varargs parameter.
Expected behaviour
If a method contains a varargs parameter, documentation should explicitly state it. So for the provided above piece of code
documentation should be following
Screenshots
Classic Javadoc(expected behaviour):
Output of the
dokkaJavadoc
task:Output of the
dokkaHtml
task:Dokka configuration
I have added
kotlin-as-java-plugin
as I have a Java project. So nothing other than provided below and connecting Dokka to your project is not needed to reproduce the issue.dependencies { dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.6.10") }
Installation
The text was updated successfully, but these errors were encountered: