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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
/*
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8298405
* @summary Markdown support in the standard doclet
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestMarkdownCodeSpans
*/
import java.nio.file.Path;
import java.util.Locale;
import java.util.stream.Collectors;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
/**
* Tests Markdown code spans.
*
* Code spans are enclosed within a matching sequence of one or more backtick ({@code `})
* characters and provide a way to specify "literal text" within a block,
* such as a paragraph, list item, or block quote. Code spans may span multiple lines
* but not cross block boundaries: if a sequence of backtick characters is not matched within
* a block, the sequence is treated as literal text, even if there is a matching sequence
* in a subsequent block.
*
* In the various test cases, javadoc tags are used as a way to determine
* if the parser is correctly interpreting the text in its surrounding context.
* Within a code span, character sequences resembling a tag are treated as
* literal text, and appear "as is" in the generated output. Outside a
* code span, character sequences resembling a tag are treated as tags and
* are translated as appropriate in the generated output.
*
* A primary consideration in the test cases is the use and handling of lines
* that may or may not be part of the same block. As such, the source for
* each test case can be considered to be in two parts, each containing a backtick,
* and which may or may not represent a code span. Note that only some kinds
* of lines (for paragraphs, list items and block quotes) may contain code spans.
* All kinds of lines either continue a block or terminate it.
*/
public class TestMarkdownCodeSpans extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestMarkdownCodeSpans();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void testCodeSpans(Path base) throws Exception {
// Test cases provide a fragment of content for a documentation comment
// and a corresponding fragment of content to be found in the generated output.
// The name of each member is used to generate the name of a declaration
// with which the documentation comment is associated.
//
// In the source fragments:
// - when "{@code TEXT}" appears, it is expected it will appear "as is" in the output
// enclosed within an HTML <code> element
// - when "{@code TAG}" appears, it is expected it will be treated as a tag
// and will appear in the output as "<code>TAG</code>"
// Thus, the character sequence "{@code TAG}" should never appear in any output.
//
// Note: for test cases involving ATX and setext headings, care must be taken to
// ensure that the content is such that the auto-generated ids are unique,
// so that we do not depend on the doclet to disambiguate the ids, based on the
// order in which the headings are generated.
enum TestCase {
SIMPLE_PARA(
"""
abc `p {@code TEXT} q` def
end""",
"""
<p>abc <code>p {@code TEXT} q</code> def</p>
<p>end</p>"""),
// a multi-line code span
PARA_PARA(
"""
abc `p {@code TEXT}
q` def
end""",
"""
<p>abc <code>p {@code TEXT} q</code> def</p>
<p>end</p>"""),
// a paragraph with a heavily indented continuation line,
// including a multi-line code span
PARA_INDENT(
"""
abc `p {@code TEXT}
q` def
end""",
"""
<p>abc <code>p {@code TEXT} q</code> def</p>
<p>end</p>"""),
// blank line after a paragraph; no code spans, the tag is processed
PARA_BLANK(
"""
abc `p {@code TAG}
q` def
end""",
"""
<p>abc `p <code>TAG</code></p>
<p>q` def</p>
<p>end</p>"""),
// thematic break after a paragraph; no code spans, the tag is processed
PARA_THEMATIC_BREAK_DASH(
"""
abc `p {@code TAG}
- - - - - - - - - - - -
q` def
end""",
"""
<p>abc `p <code>TAG</code></p>
<hr />
<p>q` def</p>
<p>end</p>"""),
// thematic break after a paragraph; no code spans, the tag is processed
PARA_THEMATIC_BREAK_ASTERISK(
"""
abc `p {@code TAG}
* * * * * * * * * *
q` def
end""",
"""
<p>abc `p <code>TAG</code></p>
<hr />
<p>q` def</p>
<p>end</p>"""),
// ATX heading after a paragraph; no code spans, the tag is processed
PARA_ATX(
"""
abc `p1 {@code TAG}
# q1` def
end""",
"""
<p>abc `p1 <code>TAG</code></p>
<h4 id="q1-def-heading">q1` def</h4>
<p>end</p>"""),
// setext heading; no code spans, the tag is processed
PARA_SETEXT(
"""
abc `p {@code TAG}
===================
q` def
end""",
"""
<h4 id="abc-p--heading">abc `p <code>TAG</code></h4>
<p>q` def</p>
<p>end</p>"""),
SIMPLE_LIST(
"""
* abc `p {@code TEXT} q` def
end""",
"""
<ul>
<li>abc <code>p {@code TEXT} q</code> def</li>
</ul>
<p>end</p>"""),
// two list items; no code spans, the tag is processed
LIST_LIST(
"""
* abc `p {@code TAG}
* q` def
end""",
"""
<ul>
<li>abc `p <code>TAG</code></li>
<li>q` def</li>
</ul>
<p>end</p>"""),
// a multi-line code span in a multi-line list item
LIST_PARA(
"""
* abc `p {@code TEXT}
q` def
end""",
"""
<ul>
<li>abc <code>p {@code TEXT} q</code> def</li>
</ul>
<p>end</p>"""),
// a list item with a heavily indented continuation line,
// including a multi-line code span
LIST_INDENT(
"""
* abc `p {@code TEXT}
q` def
end""",
"""
<ul>
<li>abc <code>p {@code TEXT} q</code> def</li>
</ul>
<p>end</p>"""),
SIMPLE_BLOCKQUOTE(
"""
> abc `p {@code TEXT} q` def
end""",
"""
<blockquote>
<p>abc <code>p {@code TEXT} q</code> def</p>
</blockquote>
<p>end</p>"""),
// a multi-line code span in a multi-line block quote
BLOCKQUOTE_BLOCKQUOTE(
"""
> abc `p {@code TEXT}
> q` def
end""",
"""
<blockquote>
<p>abc <code>p {@code TEXT} q</code> def</p>
</blockquote>
<p>end</p>"""),
// a multi-line code span in a multi-line block quote
BLOCKQUOTE_PARA(
"""
> abc `p {@code TEXT}
q` def
end""",
"""
<blockquote>
<p>abc <code>p {@code TEXT} q</code> def</p>
</blockquote>
<p>end</p>"""),
// a block quote with a heavily indented continuation line,
// including a multi-line code span
BLOCKQUOTE_INDENT(
"""
> abc `p {@code TEXT}
q` def
end""",
"""
<blockquote>
<p>abc <code>p {@code TEXT} q</code> def</p>
</blockquote>
<p>end</p>"""),
SIMPLE_ATX(
"""
# abc `p2 {@code TEXT} q2` def
end""",
"""
<h4 id="abc-p2-code-text-q2-def-heading">abc <code>p2 {@code TEXT} q2</code> def</h4>
<p>end</p>"""),
// two ATX headings; no code spans, the tag is processed
ATX_ATX(
"""
# abc `p3 {@code TAG}
# q3` def
end""",
"""
<h4 id="abc-p3--heading">abc `p3 <code>TAG</code></h4>
<h4 id="q3-def-heading">q3` def</h4>
<p>end</p>""");
final String srcFragment;
final String expect;
TestCase(String srcFragment, String expect) {
this.srcFragment = srcFragment;
this.expect = expect;
}
}
StringBuilder sb = new StringBuilder();
sb.append("""
package p;
/** Dummy. */
public class C {
private C() { }
""");
for (var tc: TestCase.values()) {
sb.append("""
/// First sentence.
#FRAG#
public void #NAME#() { }
"""
.replace("#FRAG#", tc.srcFragment.lines()
.map(l -> "/// " + l)
.collect(Collectors.joining("\n ")))
.replace("#NAME#", tc.name().toLowerCase(Locale.ROOT)));
}
sb.append("}");
Path src = base.resolve("src");
tb.writeJavaFiles(src, sb.toString());
javadoc("-d", base.resolve("api").toString(),
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkExit(Exit.OK);
// any/all instances of "{@code TAG}" should be translated to "<code>TAG</code>"
checkOutput("p/C.html", false,
"{@code TAG}");
checkOutput(Output.OUT, false,
"unknown tag");
for (var tc : TestCase.values()) {
checkOutput("p/C.html", true,
"""
<span class="element-name">#NAME#</span>()</div>
<div class="block"><p>First sentence.</p>
#FRAG#
</div>"""
.replace("#NAME#", tc.name().toLowerCase(Locale.ROOT))
.replace("#FRAG#", tc.expect));
}
}
}
|
