dokka icon indicating copy to clipboard operation
dokka copied to clipboard

Add a short description to each inheritor in Inheritors tab

Open dfroze opened this issue 2 years ago • 2 comments

Hi,

So I have multiple classes that has as interface "Builder", as seen in the image. 2022-05-16_17-06

I've added description for each class, but nothing shows when it is generated.

   /**
     * Builder to generate [Config]
     */
    class Builder(ctx: Context): com.example.Builder {
}

Am I missing something or is there no solution for this?

dfroze avatar May 16 '22 14:05 dfroze

Hi!

I take it you expected documentation to be shown next to each individual inheritor? If so, it's not implemented to be this way, but it may be a good idea to add some short description as already done for functions.

Otherwise you may find your builder documentation if you click one of the links, it'll redirect you to that Builder's page and you will see the docs there

I'll modify the issue to be an enhancement if you don't mind :)

IgnatBeresnev avatar May 18 '22 08:05 IgnatBeresnev

Yes, a short description for each one would be great. I find it hard to navigate from this position without knowing anything about each inheritor (destination). Maybe also display the class name of each inheritor instead of 6 time just "Builder" .

dfroze avatar May 18 '22 09:05 dfroze