summaryrefslogtreecommitdiff
path: root/test/scaladoc/run/t7767.scala
blob: 433fc5c0c40564589285f0d6616e17da777bf33a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest

object Test extends ScaladocModelTest {

  override def code = """
    class CEarly extends { /**CEarly_Doc_foo*/ val foo = 0 } with AnyRef
    trait TEarly extends { /**TEarly_Doc_foo*/ val foo = 0 } with AnyRef
    class C {
      /**C_Doc_sigInferred*/ val sigInferred = 0
      /**C_Doc_const*/ final val const = 0
      /**C_Doc_varr*/ var varr: Any = null
      /**C_Doc_abs*/ val abs: Int
      /**C_Doc_absVar*/ var absVar: Any
      /**C_Doc_lazyValInferred*/ lazy val lazyValInferred = 0
      /**C_Doc_lazyValConst*/ final lazy val lazyValConst = 0
      /**C_Doc_lazyValUnit*/ lazy val lazyValUnit: Unit = println()
      /**C_Doc_lazyVal*/ lazy val lazyVal: Int = 0
    }
    trait T {
      /**T_Doc_sigInferred*/ val sigInferred = 0
      /**T_Doc_const*/ final val const = 0
      /**T_Doc_varr*/ var varr: Any = null
      /**T_Doc_abs*/ val abs: Int
      /**T_Doc_absVar*/ var absVar: Any
      /**T_Doc_lazyValInferred*/ lazy val lazyValInferred = 0
      /**T_Doc_lazyValConst*/ final lazy val lazyValConst = 0
      /**T_Doc_lazyValUnit*/ lazy val lazyValUnit: Unit = println()
      /**T_Doc_lazyVal*/ lazy val lazyVal: Int = 0
    }"""

  // no need for special settings
  def scaladocSettings = ""

  def assertDoc(classEntity: DocTemplateEntity, valName: String) = {
    import access._
    val comment = classEntity._value(valName).comment.map(_.body.toString.trim).getOrElse("")
    val className = classEntity.name
    val marker = s"${className}_Doc_${valName}"
    assert(comment.contains(marker), s"Expected $marker in comment for $valName in $className, found: $comment.")
  }

  def testModel(rootPackage: Package) = {
    import access._
    assertDoc(rootPackage._class("CEarly"), "foo")
    assertDoc(rootPackage._trait("TEarly"), "foo")

    val valNames = List("sigInferred", "const", "varr", "abs", "absVar", "lazyValInferred", "lazyValConst", "lazyValUnit", "lazyVal")
    val entities = List(rootPackage._class("C"), rootPackage._trait("T"))
    for (e <- entities; vn <- valNames) assertDoc(e, vn)
  }
}