Several questions concerning Dokka behaviors

1

Hi all,

I’m using the last version of Kotlin and Dokka (1.5.31) and its maven plugin. I have difficulties to understand some Dokka behaviors when I’m generating the javadoc (mvn dokka:javadoc) :

  • If I document a class like that
/**
 * Represents an RNA molecule.
 *
 * @param [name] the name of the RNA molecule
 *
 */
class RNA(var name:String="A")

In the javadoc, the description for the parameter is located in the constructor details (which is fine). But I have no documentation for its generated getter and setter. If I change for @property, the description for the parameter is neither in the constructor details, nor in its generated getter and setter.

  • If i document a property like that:
/**
* the sequence of the RNA
*/
var seq:String

The documentation will be the same for the getter and the setter. How to be more specific without the need to explicitly write the get and set methods like:

var seq:String
        /**
         * Sets the sequence of the RNA
         */
        set(value) {
            
        }
        /**
         * Returns the sequence of the RNA
         */
        get() {
            
        }
  • last question. when I document a function with @return or @throw, they are not generated in my javadoc. For example:
/**
     * Returns a residue for a given position
     *
     * @param [pos] the absolute position for the residue to get
     *
     * @return the name of the residue
     *
     * @throws [RuntimeException] if the [pos] is outside the ends of the RNA molecule
     *
     */

Thank you for your help.

Best,
Fabrice