kdoc

I have a object like the following in my project object UrlUtils { private const val PARAM = "whatever" /** * Method that appends the [PARAM] parameter to the url */ fun appendParameter(url: String) { // ... } } As you can see a I wanna reference the value of the PARAM field in the KDoc comment of the appendParameter method however when looking at the comment I don't see the actual value but only the name of the field. Method that appends the PARAM parameter to the url What I want: Method that appends the whatever parameter to the url In Javadoc this works by using {@value PARAM} but there

We usually have changelog in our Java DTO's that consists of a table defined in Javadoc: /** * Changelog: * * <table> * <tr><th>Version</th><th>Description</th></tr> * <tr> * <td>2</td> * <td>Added field 'something'</td> * </tr> * <tr> * <td>3</td> * <td>Added field 'somethingElse'</td> * </tr> * </table> */ public class MyDTO { ... } This renders (in Intellij using Javadoc preview) nicely into something like this: Now we want to do the same thing for our Kotlin data classes. Reading up on the docs of KDoc where it says: For inline markup, KDoc uses the regular Markdown syntax, extended to

I have seen here , here and there references to KDoc, the JavaDoc utility equivalent for Kotlin. However, I cannot find any documentation on how to use it, let alone how to customize it or integrate it in Maven or Gradle. I know the Kotlin API doc is generated using KDoc since the page source has the following HTML comment: <!-- Generated by kdoc on Sun Jul 06 20:27:33 UTC 2014 --> So, is there any documentation I can refer to as to how to use KDoc ? monkjack It looks like Kdoc was put on the back burner in favour of Dokka. https://github.com/Kotlin/dokka Source: https://devnet.jetbrains.com

In Java's Javadoc, there is a way to inherit a method's documentation in a subclass using {@inheritDoc} tag . Is there a way to do the same in Kotlin's KDoc? Basically, what I'd like to do is the following: abstract class Base { /** * Some KDoc documentation here. */ abstract fun foo() } class Derived: Base() { /** * Here is all the documentation from Base#foo's KDoc inherited. * * And here goes something more in addition. */ override fun foo() { /* ... */ } } Dokka always copies the documentation from a base member to an inherited one if the inherited member does not have its own