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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
package dotty.tools
package dottydoc
import org.junit.Test
import org.junit.Assert._
import dotc.core.Contexts.{ Context, ContextBase, FreshContext }
import dotc.core.Comments.{ ContextDoc, ContextDocstrings }
import dottydoc.core.ContextDottydoc
class MarkdownTests extends DottyDocTest {
override implicit val ctx: FreshContext = {
// TODO: check if can reuse parent instead of copy-paste
val base = new ContextBase
import base.settings._
val ctx = base.initialCtx.fresh
ctx.setSetting(ctx.settings.language, List("Scala2"))
ctx.setSetting(ctx.settings.YkeepComments, true)
ctx.setSetting(ctx.settings.YnoInline, true)
// No wiki syntax!
ctx.setSetting(ctx.settings.wikiSyntax, false)
ctx.setProperty(ContextDoc, new ContextDottydoc)
ctx.setSetting(
ctx.settings.classpath,
dotty.Jars.dottyLib
)
base.initialize()(ctx)
ctx
}
@Test def simpleMarkdown = {
val source =
"""
|package scala
|
|/** *Hello*, world! */
|trait HelloWorld
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals("<p><em>Hello</em>, world!</p>", traitCmt)
}
}
@Test def outerLink = {
val source =
"""
|package scala
|
|/** [out](http://www.google.com) */
|trait HelloWorld
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals("""<p><a href="http://www.google.com">out</a></p>""", traitCmt)
}
}
@Test def relativeLink = {
val source =
"""
|package scala
|
|/** [None](./None.html) */
|trait HelloWorld
|
|trait None
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals("""<p><a href="./None.html">None</a></p>""", traitCmt)
}
}
@Test def absoluteLink = {
val source =
"""
|package scala
|
|/** [None](scala.None) */
|trait HelloWorld
|
|trait None
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals("""<p><a href="../scala/None.html">None</a></p>""", traitCmt)
}
}
@Test def handleLists = {
val source =
"""
|package scala
|
|/** - Item1
| * - Item2
| * - Item3
| */
|trait HelloWorld
|
|trait None
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals(
"""|<ul>
|<li>Item1</li>
|<li>Item2</li>
|<li>Item3</li>
|</ul>""".stripMargin, traitCmt)
}
}
@Test def handleNestedLists = {
val source =
"""
|package scala
|
|/** - Item1
| * - Item1a
| * - Item1b
| * - Item2
| * - Item3
| */
|trait HelloWorld
|
|trait None
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals(
"""|<ul>
|<li>Item1
|<ul>
|<li>Item1a</li>
|<li>Item1b</li>
|</ul>
|</li>
|<li>Item2</li>
|<li>Item3</li>
|</ul>""".stripMargin, traitCmt)
}
}
@Test def handleCodeBlock = {
val source =
"""
|package scala
|
|/** ```scala
| * val x = 1 + 5
| * ```
| */
|trait HelloWorld
|
|trait None
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals(
"""|<pre><code class="language-scala">val x = 1 + 5
|</code></pre>""".stripMargin, traitCmt)
}
}
@Test def handleCodeBlockJavaDocstring = {
// the following works, but not when the start of the codeblock is on the
// first line
val source =
"""
|package scala
|
|/**
| * ```scala
| * val x = 1 + 5
| * ```
| */
|trait HelloWorld
|
|trait None
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.body))
.get
.trim
assertEquals(
"""|<pre><code class="language-scala">val x = 1 + 5
|</code></pre>""".stripMargin, traitCmt)
}
}
@Test def docstringSummary = {
val source =
"""
|package scala
|
|/** This
| * ====
| * is a short text [that](http://google.com) should not be more than a
| * `few` lines long. This text *should* be shortened somewhere that is
| * appropriate for the **ui**. Might be here, or there or somewhere
| * else.
| */
|trait HelloWorld
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.short))
.get
.trim
assert(
traitCmt.endsWith("Might be here...\n</p>"),
s"""|docstring summary should strip the following docstring so that it ends in "Might be here..."
|
|$traitCmt""".stripMargin
)
}
}
@Test def docstringSummaryWithImage = {
val source =
"""
|package scala
|
|/** This
| * ====
| * should quit before ,
| * I shouldn't be visible.
| */
|trait HelloWorld
""".stripMargin
checkSource(source) { packages =>
val traitCmt =
packages("scala")
.children.find(_.path.mkString(".") == "scala.HelloWorld")
.flatMap(_.comment.map(_.short))
.get
.trim
assert(
!traitCmt.contains("<img") &&
!traitCmt.contains("I shouldn't be visible."),
s"""|docstring summary shouldn't contain image, error in `MarkdownShortener.scala`
|
|$traitCmt""".stripMargin)
}
}
}
|
