dokkaJavadoc does not recognize @return @since @author

[tnfk06]

Describe the bug
dokkaJavadoc does not recognize @return, @SInCE, @author

Expected behaviour
return, since , author should be generated to javadoc html file

Screenshots

To Reproduce
RoomRxJavaKotlin.zip

Dokka configuration
Configuration of dokka used to reproduce the bug

Installation

• Operating system: macOS/Windows/Linux
• Build tool: Gradle v6.7.1/Maven/Cli/3rd party plugin
• Dokka version: 1.4.20

Additional context
dokkaHtml works fine

[isaacchiang-kkstream]

I had the same issue in my android project with AndroidStudio. I'm using 1.6.0 version's Dokka version. Did this issue be fixed? or still working on it?

[danielshiplett]

Any idea if this is ever going to be fixed?

[IgnatBeresnev]

Any idea if this is ever going to be fixed?

Hopefully, one day it will, but we don't have the resources to fix it now as there are more pressing issues at hand :(

This shouldn't be awfully difficult to contribute though - a convenient TODO was left in the template, indicating where it needs to be added: https://github.com/Kotlin/dokka/blob/1.7.20/plugins/javadoc/src/main/resources/views/class.korte#L284

How Javadoc plugin and its templating works in beyond me, but implementing return/since/author similar to how parameters property is handled should work, see JavadocContentToTemplateMapTranslator.

For anyone wishing to contribute this fix, Developer Guides can help you get started.

[irina-turova]

Hello! I'd like to approach the issue. Is it still actual?

[danielshiplett]

It seems to be. My latest Javadoc build from my Kotlin project is still missing @returns.

[IgnatBeresnev]

@turovaia I believe it is, yes! If you find yourself stuck or just need pointers, feel free to ask questions here or in the #dokka channel in Kotlin Community Slack

[IgnatBeresnev]

The fix will be released in 1.9.0