aboutsummaryrefslogtreecommitdiff
path: root/doc-tool/test/CommentCleanerTest.scala
blob: 5cf5614c4cfe88270c1fee3167bdbf4846c6d8d7 (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
package dotty.tools
package dottydoc

import org.junit.Test
import org.junit.Assert._

import model.comment.CommentCleaner

class CommentCleanerTest extends CommentCleaner {
  @Test def simpleOneliner = {
    assertEquals(List("lol"), clean("/** lol */"))
  }

  @Test def multiline = {
    val docstring = clean {
      """|/** First
         | *  Second
         | */
         |""".stripMargin
    }

    assertEquals(List("First", "Second", ""), docstring)
  }

  @Test def multilineBad = {
    val docstring = clean {
      """|/** First
         | *   Second
         | */
         |""".stripMargin
    }

    assertEquals(List("First", " Second", ""), docstring)
  }

  @Test def multilineWorse = {
    val docstring = clean {
      """|/** First
         | *   Second
         | *  Third
         | */
         |""".stripMargin
    }

    assertEquals(List("First", " Second", "Third", ""), docstring)
  }

  @Test def multilineFirstNoSpace = {
    val docstring = clean {
      """|/**First
         | *   Second
         | *  Third
         | */
         |""".stripMargin
    }

    assertEquals(List("First", " Second", "Third", ""), docstring)
  }

  @Test def multilineFirstTwoSpaces = {
    val docstring = clean {
      """|/**  First
         | *   Second
         | *  Third
         | */
         |""".stripMargin
    }

    assertEquals(List("First", " Second", "Third", ""), docstring)
  }

  @Test def multilineFirstThreeSpaces = {
    val docstring = clean {
      """|/**   First
         | *   Second
         | *  Third
         | */
         |""".stripMargin
    }

    assertEquals(List(" First", " Second", "Third", ""), docstring)
  }
}