blob: 4f9a891133f8275bc3afae8a0ac0b2a75ab9fafc (
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
|
import scala.tools.nsc.doc.html.Page
import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest
object Test extends ScaladocModelTest {
override def code = """
package a
/** This comment should not appear
* @shortDescription This one should appear
*/
class Foo {
/** This comment should appear */
def foo: Int = 1
/** This comment should not appear
* @shortDescription This comment should appear
*/
def goo: Int = 2
}
"""
// no need for special settings
def scaladocSettings = ""
def testModel(rootPackage: Package) = {
import scala.tools.nsc.doc.base.comment._
import access._
val foo = rootPackage._package("a")._class("Foo")
// Assert that the class has the correct short description
val classDesc = Page.inlineToStr(foo.comment.get.short)
assert(classDesc == "This one should appear", classDesc)
// Assert that the `foo` method has the correct short description
val fooDesc = Page.inlineToStr(foo._method("foo").comment.get.short)
assert(fooDesc == "This comment should appear", fooDesc)
// Assert that the `goo` method has the correct short description
val gooDesc = Page.inlineToStr(foo._method("goo").comment.get.short)
assert(gooDesc == "This comment should appear", gooDesc)
}
}
|