How to reference the name of a val in a Object class in scaladoc?

Question

Is there a way that I can reference the name of a val in a Object class using scaladoc, similar to

{@value #STATIC_FIELD} 

in javadoc.

Answer 1

you can do it two ways:

package your.package_path


object SomeObject extends App {

  val someList: List[Int] = List.empty[Int]

  /**
   * @see [[your.package_path.SomeObject#someList]]
   * @see [[someList]]
   * ...
   */
  def bar(): String = ???
}