ScalaDoc - No DRI found for query: Enum when enumeratum is used

[OndrejSpanel]

Compiler version

3.3.3

Minimized code

package my_package

import enumeratum._

sealed trait SomeEnum extends EnumEntry

case object SomeEnum extends Enum[SomeEnum] {
  val values = findValues

  case object A extends SomeEnum
  case object B extends SomeEnum
}

libraryDependencies += "com.beachape" %% "enumeratum" % "1.7.3"

Use doc in SBT

Output

[warn] -- Warning: src\main\scala\my_package\SomeEnum.scala:8:6 -----------------------
[warn] 8 |  val values = findValues
[warn]   |      ^
[warn]   |      No DRI found for query: Enum

Expectation

No warning. And if there is a warning, it should be actionable. What is DRI? Where was it not found?

[Gedochao]

Minimization could be useful, but I believe the warning message should be improved regardless.
@OndrejSpanel would you be able to try to minimize it without the enumeratum dependency?

Meanwhile, DRI seems to be internal doctool terminology and isn't really helpful in user-facing warning.
Let's try to purge it from warning/error messages and see if we find out if this warning is even valid.

[OndrejSpanel]

try to minimize it without the enumeratum dependency?

This might be possible, but it would most likely require creating some other macro source instead. The Enum symbol comes somewhere from enumerarum macros.

That said, I have little reason to pursue the issue now, as I decided not to use ScalaDoc for the task I am doing now. I am not sure if/when can I find some time for this.

[rjolly]

The meaning is that Enum is not known in the scaladoc comment below, not sure if/how it can be fixed on the library side:

https://github.com/lloydmeta/enumeratum/blob/master/enumeratum-core/src/main/scala-3/enumeratum/EnumCompat.scala

  /** The sequence of values for your [[Enum]]. You will typically want to implement this in your
    * extending class as a `val` so that `withName` and friends are as efficient as possible.
    *
    * Feel free to implement this however you'd like (including messing around with ordering, etc)
    * if that fits your needs better.
    */
  def values: IndexedSeq[A]