scala / bug

Scala 2 bug reports only. Please, no questions — proper bug reports only.
https://scala-lang.org
232 stars 21 forks source link

Scaladoc for uses cases of type alias should contain a section of full signature #11156

Open Atry opened 6 years ago

Atry commented 6 years ago
object UseCases {
  /**
    * @usecase type TypeAliasUseCase[A] = Any
    *
    *          This is a use case of a type alias.
    */
  type TypeAliasUseCase[A] = A

  /** 
    * @usecase def methodUseCase(): Unit = ???
    *
    *          This is a use case of a method.
    */
  def methodUseCase(): Nothing = ???
}
scaladoc -version
Scaladoc version 2.12.6 -- Copyright 2002-2018, LAMP/EPFL and Lightbend, Inc.
scaladoc UseCases.scala 
model contains 2 documentable templates
2018-09-15 14 24 37
SethTisue commented 5 years ago

note that @usecase is deprecated in 2.13