Javadoc generation for record components is broken

[eekboom]

Currently, javadoc is generated like this:

/** Response Data with details of the user's application */
public record GetApplicationDetailsResponse(
    /** MIME-Typ of referenced schema */
    @Values(values = {"application/xml"}) @JsonProperty("mime_type") String mimeType,
) {}

IntelliJ IDEA marks the (intended) Javadoc of mimeType with a warning "Dangling Javadoc comment" - and I just learned that the IDE is correct. The standard Doclet does not generate documentation from that.

The generator should use @param tags at the class level:

/** 
 * Response Data with details of the users application
 * 
 * @param mimeType MIME-Typ of referenced schema
 */
public record GetApplicationDetailsResponse( ...

[hauner]

some more examples https://github.com/openjdk/valhalla/tree/lworld/test/langtools/jdk/javadoc/doclet/testRecordTypes/examples

Thanks for reporting :-)