scalaintellij-ideascaladoc

Scaladocs: Reference values of enums


In Scala, if I have an Enumeration like this:

package myPackage.letters

object Alphabet extends Enumeration {
  val A: Value = Value("A")
  val B: Value = Value("B")
  val C: Value = Value("C")
}

Now, I want to write a ScalaDoc for a method in another package and reference the values of my Enum like this:

/**
  * Here, I want to reference my enum:
  * this works: [[myPackage.letters.Alphabet]]
  * this does not: [[myPackage.letters.Alphabet.A]]
  */
def myMethod = {}

Is this maybe an IntelliJ specific problem? Anyway I cannot seem to figure out how to correctly reference enum values or if it is even possible.


Solution

  • I figured it out: [[myPackage.letters.Alphabet#A]]