Dokka: Javadoc is missing a lot of information

Created on 19 May 2017 · 4Comments · Source: Kotlin/dokka

With this simple test class:

package test;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class Test
{
    @NotNull
    public static String test(@Nullable String test) {
        if(test == null)
            return "null";
        return test.toLowerCase();
    }
}

Dokka is generating an incomplete documentation page for it in javadoc mode.

It is missing the "extends Object" information, the "Methods inherited from class java.lang.Object", the default constructor "Test()", the method annotations and the method parameter.

Page generated by dokka

Page generated by javadoc

The same is applied to Kotkin classes but it is missing less information then Java classes.

Example Kotlin class:

class TestKotlin {
    fun test(test: String?): String {
        if (test == null)
            return "null"
        return test.toLowerCase()
    }

Page generated by dokka

The most critical issues are the arguments missing in method information, the default constructor being omitted and the annotations which contains the @Documented decoration not being documented as they should.

Source

joserobjr

👍15

All 4 comments

Any news on this matter?

eddyfrank on 12 Sep 2018

It looks like javadocs are still missing the method summary, has there been any progress on this? I'm willing to look into this and try to fix it, I just don't want to put needless effort into it if someone else is working on it.

JJK3 on 28 Oct 2019

Yes and no. We'd really appreciate your help with this, @JJK3, just not now, because we're refactoring dokka quite extensively. We're changing the whole internal model, so fixing this javadoc format would be a waste of time, because it will have to be rewritten from scratch before the next big release (0.11.0).