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
|
/*
* 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 TestMarkdownLinks
*/
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
import java.nio.file.Path;
import java.util.List;
public class TestMarkdownLinks extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestMarkdownLinks();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void testSimpleLink(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// Method m1.
/// This is different from {@link #m2()}.
public void m1() { }
/// Method m2.
/// This is different from {@link #m1()}.
public void m2() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
Method m1.
This is different from <a href="#m2()"><code>m2()</code></a>.""");
}
@Test
public void testSimpleRefLink(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// Method m1.
/// This is different from [#m2()].
public void m1() { }
/// Method m2.
/// This is different from [#m1()].
public void m2() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
Method m1.
This is different from <a href="#m2()"><code>m2()</code></a>.""");
}
@Test
public void testLinkWithDescription(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// Method m1.
/// This is different from {@linkplain #m2() _Markdown_ m2}.
public void m1() { }
/// Method m2.
/// This is different from {@linkplain #m1() _Markdown_ m1}.
public void m2() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
Method m1.
This is different from <a href="#m2()"><em>Markdown</em> m2""");
}
@Test
public void testRefLinkWithDescription(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// Method m1.
/// This is different from [_Markdown_ m2][#m2()].
public void m1() { }
/// Method m2.
/// This is different from [_Markdown_ m1][#m1()]}.
public void m2() { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
Method m1.
This is different from <a href="#m2()"><em>Markdown</em> m2""");
}
@Test
public void testLinkToHeadingAnchor(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// Method m1.
/// # Lorem Ipsum.
///
/// Lorem ipsum [reference in same comment][##lorem-ipsum--heading].
public void m1() { }
/// Method m2.
/// Lorem ipsum [reference in another comment][##lorem-ipsum--heading].
public void m2() { }
}
""",
"""
package p;
/// Lorem ipsum [reference in another class][C##lorem-ipsum--heading].
public class D {
}""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
}
@Test
public void testLinkToUserAnchor(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class C {
/// Method m1.
/// <span id="lorem-ipsum">Lorem Ipsum</span>.
///
/// Lorem ipsum [reference in same comment][##lorem-ipsum].
public void m1() { }
/// Method m2.
/// Lorem ipsum [reference in another comment][##lorem-ipsum].
public void m2() { }
}
""",
"""
package p;
/// Lorem ipsum [reference in another class][C##lorem-ipsum].
public class D {
}""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
}
@Test
public void testLinkElementKinds(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// First sentence.
///
/// * module [java.base/]
/// * package [java.util]
/// * class [String] or interface [Runnable]
/// * a field [String#CASE_INSENSITIVE_ORDER]
/// * a constructor [String#String()]
/// * a method [String#chars()]
public class C { }""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
// in the following carefully avoid checking the URL host, which is of less importance and may vary over time;
// the interesting part is the tail of the path after the host
new OutputChecker("p/C.html")
.setExpectOrdered(true)
.check("module <a href=\"https://",
"/api/java.base/module-summary.html\" class=\"external-link\"><code>java.base</code></a>",
"package <a href=\"https://",
"/api/java.base/java/util/package-summary.html\" class=\"external-link\"><code>java.util</code></a>",
"class <a href=\"https://",
"/api/java.base/java/lang/String.html\" title=\"class or interface in java.lang\" class=\"external-link\"><code>String</code></a>",
"interface <a href=\"https://",
"/api/java.base/java/lang/Runnable.html\" title=\"class or interface in java.lang\" class=\"external-link\"><code>Runnable</code></a>",
"a field <a href=\"https://",
"/api/java.base/java/lang/String.html#CASE_INSENSITIVE_ORDER\" title=\"class or interface in java.lang\" class=\"external-link\"><code>String.CASE_INSENSITIVE_ORDER</code></a>",
"a constructor <a href=\"https://",
"/api/java.base/java/lang/String.html#%3Cinit%3E()\" title=\"class or interface in java.lang\" class=\"external-link\"><code>String()</code></a></li>",
"a method <a href=\"https://",
"/api/java.base/java/lang/String.html#chars()\" title=\"class or interface in java.lang\" class=\"external-link\"><code>String.chars()</code></a>");
}
/// Test the ability to include array elements in method signatures for
/// automatic links to program elements.
@Test
public void testReferenceWithArrays(Path base) throws Exception {
Path src = base.resolve("src");
// in the following,
//
// * Link 0 is a simple control for a shortcut reference link (without any arrays)
// * Link 1a and Link 2a are negative controls, in that they are _not_ valid links
// because of the unescaped [] pair
// * Link 1b and 2b are the positive tests, showing that the square brackets
// need to be escaped in the source code, and that they are not escaped in
// the generated HTML
tb.writeJavaFiles(src,
"""
package p;
/// First sentence.
/// * Link 0 to [util.Arrays]
/// * Link 1a to [Arrays-equals][util.Arrays#equals(Object[],Object[])]
/// * Link 1b to [Arrays-equals][util.Arrays#equals(Object\\[\\],Object\\[\\])]
/// * Link 2a to [util.Arrays#equals(Object[],Object[])]
/// * Link 2b to [util.Arrays#equals(Object\\[\\],Object\\[\\])]
public class C { }""",
// simulate java.util.Arrays.equals, to avoid links to platform references
"""
package util;
public class Arrays {
public boolean equals(Object[] a, Object[] a2);
}""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p", "util");
checkExit(Exit.OK);
checkOutput("p/C.html", true,
"""
Link 0 to <a href="../util/Arrays.html" title="class in util"><code>Arrays</code></a>""",
"""
Link 1a to [Arrays-equals][util.Arrays#equals(Object[],Object[])]""",
"""
Link 1b to <a href="../util/Arrays.html#equals(java.lang.Object%5B%5D,\
java.lang.Object%5B%5D)">Arrays-equals</a>""",
"""
Link 2a to [util.Arrays#equals(Object[],Object[])]""",
"""
Link 2b to <a href="../util/Arrays.html#equals(java.lang.Object%5B%5D,\
java.lang.Object%5B%5D)"><code>Arrays.equals(Object[],Object[])</code></a>"""
);
}
@Test
public void testSee(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
/// First sentence.
/// @see "A reference"
/// @see <a href="http://www.example.com">Example</a>
/// @see D a _Markdown_ description
public class C { }
""",
"""
package p;
public class D { }""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--source-path", src.toString(),
"p");
checkOutput("p/C.html", true,
"""
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li>"A reference"</li>
<li><a href="http://www.example.com">Example</a></li>
<li><a href="D.html" title="class in p">a <em>Markdown</em> description</a></li>
</ul>
</dd>""");
}
}
|
