Incorrect Scaladoc

[eed3si9n]

steps

## Represents a diagnostic, such as a compiler error or warning.
## Diagnostic objects are only valid in the scope of a resource.
type Diagnostic {
  ## The range at which the message applies.
  range: sbt.internal.langserver.Range!

  ## The diagnostic's severity. Can be omitted. If omitted it is up to the
  ## client to interpret diagnostics as error, warning, info or hint.
  severity: Long

  ## The diagnostic's code. Can be omitted.
  code: String

  ## A human-readable string describing the source of this
  ## diagnostic, e.g. 'typescript' or 'super lint'.
  source: String

  ## The diagnostic's message.
  message: String!
}

problem

/**
 * Represents a diagnostic, such as a compiler error or warning.
 * Diagnostic objects are only valid in the scope of a resource.
 */
final class Diagnostic private (
  /** The range at which the message applies. */
  val range: sbt.internal.langserver.Range,
  /**
   * The diagnostic's severity. Can be omitted. If omitted it is up to the
   * client to interpret diagnostics as error, warning, info or hint.
   */
  val severity: Option[Long],
  /** The diagnostic's code. Can be omitted. */
  val code: Option[String],
  /**
   * A human-readable string describing the source of this
   * diagnostic, e.g. 'typescript' or 'super lint'.
   */
  val source: Option[String],
  /** The diagnostic's message. */
  val message: String) extends Serializable

This is incorrect scaladoc, and results in "Diagnostic.scala:14:3: discarding unmoored doc comment".

expectation

/**
 * Represents a diagnostic, such as a compiler error or warning.
 * Diagnostic objects are only valid in the scope of a resource.
 * 
 * @param range The range at which the message applies.
 * @param severity The diagnostic's severity. Can be omitted. If omitted it is up to the
 *        client to interpret diagnostics as error, warning, info or hint.
 * @param code The diagnostic's code. Can be omitted.
 * @param source A human-readable string describing the source of this
 *        diagnostic, e.g. 'typescript' or 'super lint'.
 * @param message The diagnostic's message.
 */
final class Diagnostic private (
  val range: sbt.internal.langserver.Range,
  val severity: Option[Long],
  val code: Option[String],
  val source: Option[String],
  val message: String) extends Serializable