Skip to content

Avoid duplicate kdoc for constructor parameters #26

Description

@jangalinski

When adding kdoc to constructor parameters, we get duplicate entries. The doc is written to the @param section ond to the property declaration:

/**
 * This is the data class documentation.
 *
 * @param x the x parameter
 * @param y the y parameter
 */
public data class Foo(
  /**
   * the x parameter
   */
  public val x: Int,
  /**
   * the y parameter
   */
  private val y: Long,
)

Goal: only keep the @param docs. Optional: make configurable via properties or pass to processor

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions