How do you get the documentation for a constructor...

# ksp

[mkrussel]

How do you get the documentation for a constructor.

I found a class, and used the primaryConstructor to get the constructor. With the following code the constructors docString property is null.

/**
 * A fake service that needs to be removed.
 */
@MainThread
@NotThreadSafe
public class FooService @GenerateOptions
/**
 * The constructor.
 *
 * @param other The other thing
 */
public constructor(
    /**
     * The bar.
     */
    @get:MainThread public val bar: Int,

    /**
     * The id.
     */
    @get:MainThread public val id: String? = null,
    other: String? = null,
)

[Jiaxiang]

might be a bug, let me take a look later.

[Jiaxiang]

In your case, the public constructor is actually the secondary constructor for the class, so if you get the doc string for primary constructor, it is an implicit one therefore has no doc strings.

[mkrussel]

I'm pretty sure that is a primary constructor. It is not declared in the body of the class, like a secondary constructor would be. When I access the primary constructor I see other as an parameter that it takes.

It follows the syntax from https://kotlinlang.org/docs/visibility-modifiers.html#constructors for how to specify the visibility of a primary constructor.

[Jiaxiang]

in your case, it should be written as public class FooService constructor() { to make it a primary constructor.

[mkrussel]

And it is except that I added public and before it with an annotation.

[Jiaxiang]

ohh, I didn’t notice it is still the same line, on my screen it is truncated to the second line making it loos like secondary constructor.

[mkrussel]

It is on different lines but not inside the class body (no {). That should make it still be a primary constructor. Like I said everything about the constructor except for the kdoc is found with the primary constructor property of the class.

[Jiaxiang]

yes it is still a primary constructor as long as it is on the class header.

[Jiaxiang]

I need to think about the case though, because in this case the document comment is technically on the class, shadows the primary constructor itself.