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
|
/*
* Copyright (c) 2022, 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 TestMarkdown
*/
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
import java.nio.file.Path;
import java.util.List;
public class TestMarkdown extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestMarkdown();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void testMinimal(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// Hello, _Markdown_ world!
public class C { }
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
<div class="block">Hello, <em>Markdown</em> world!</div>
""");
}
@Test
public void testMarkdownList(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// Before list.
///
/// * item 1
/// * item 2
/// * item 3
///
/// After list.
public class C { }
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOrder("p/C.html",
"""
<p>Before list.</p>
<ul>
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ul>
<p>After list.</p>
""");
}
@Test
public void testMarkdownList2(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// Before list.
///
/// - item 1
/// - item 2
/// - item 3
///
/// After list.
public class C { }
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOrder("p/C.html",
"""
<p>Before list.</p>
<ul>
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ul>
<p>After list.</p>
""");
}
@Test
public void testFont(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// Regular, `Monospace`, _italic_, and **bold** font.
public class C { }
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
Regular, <code>Monospace</code>, <em>italic</em>, and <strong>bold</strong> font.""");
}
@Test
public void testFFFC(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// First sentence. 1{@code 1}1 \ufffc 2{@code 2}2
public class C { }
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
<div class="block">First sentence. 1<code>1</code>1 \ufffc 2<code>2</code>2</div>
""");
}
@Test
public void testEscape(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
// In the following, note the need to double the escape character,
// so that the comment contains a single escape to precede the backtick.
// Also, note that because the first backtick is escaped, the comment
// is as-if there are two unmatched backticks, with an inline tag
// between them, and not a code span enclosing literal text.
"""
package p;
public class C {
/// Abc \\` def {@code xyz} ghi ` jkl.
/// More.
public void m() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkExit(Exit.OK);
checkOutput("p/C.html", true,
"""
<span class="element-name">m</span>()</div>
<div class="block">Abc ` def <code>xyz</code> ghi ` jkl.
More.</div>""");
}
@Test
public void testBacktickAt(Path base) throws Exception {
Path src = base.resolve("src");
// in the following, note that the @ following the backtick
// is just a literal character and not part of any tag
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// First sentence.
/// Abc `@' def.
/// More.
public void m() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:syntax", // enable check for "no tag after '@'
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkExit(Exit.OK);
checkOutput(Output.OUT, false,
"C.java:4: error: no tag name after '@'",
"unknown tag");
checkOutput("p/C.html", true,
"""
<div class="block">First sentence.
Abc `@' def.
More.</div>
</div>""");
}
@Test
public void testAnnos(Path base) throws Exception {
Path src = base.resolve("src");
// in the following, note that the @ following the backtick
// is just a literal character and not part of any tag
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// First sentence.
/// 1. list item
///
/// \\@Anno1 plain
///
/// abc `
/// @Anno2 in span
/// `
///
/// ```
/// @Anno3 fenced
/// ```
///
/// @Anno4 indented
///
/// end of list item
///
/// end
public void m() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:syntax", // enable check for "no tag after '@'
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkExit(Exit.OK);
checkOutput(Output.OUT, false,
"C.java:4: error: no tag name after '@'",
"unknown tag");
checkOutput("p/C.html", true,
"""
<ol>
<li>
<p>list item</p>
<p>@Anno1 plain</p>
<p>abc <code>@Anno2 in span</code></p>
<pre><code>@Anno3 fenced
</code></pre>
<pre><code>@Anno4 indented
</code></pre>
<p>end of list item</p>
</li>
</ol>
<p>end</p>
""");
}
}
|
