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
|
/*
* 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 TestMarkdownInheritDoc
*/
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
import java.nio.file.Path;
import java.util.List;
public class TestMarkdownInheritDoc extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestMarkdownInheritDoc();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void testInherit_md_md(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class Base {
/// Markdown comment.
/// @throws Exception Base _Markdown_
public void m() throws Exception { }
}""",
"""
package p;
public class Derived extends Base {
/// Markdown comment.
/// @throws {@inheritDoc}
public void m() throws Exception { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkOutput("p/Derived.html", true,
"""
<dt>Throws:</dt>
<dd><code>java.lang.Exception</code> - Base <em>Markdown</em></dd>
""");
}
@Test
public void testInherit_md_plain(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class Base {
/// Markdown comment.
/// @throws Exception Base _Markdown_
public void m() throws Exception { }
}""",
"""
package p;
public class Derived extends Base {
/**
* Plain comment.
* @throws {@inheritDoc}
*/
public void m() throws Exception { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkOutput("p/Derived.html", true,
"""
<dt>Throws:</dt>
<dd><code>java.lang.Exception</code> - Base <em>Markdown</em></dd>
""");
}
@Test
public void testInherit_plain_md(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p;
public class Base {
/**
* Plain comment.
* @throws Exception Base _Not Markdown_
*/
public void m() throws Exception { }
}""",
"""
package p;
public class Derived extends Base {
/// Markdown comment.
/// @throws {@inheritDoc}
public void m() throws Exception { }
}
""");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--no-platform-links",
"--source-path", src.toString(),
"p");
checkOutput("p/Derived.html", true,
"""
<dt>Throws:</dt>
<dd><code>java.lang.Exception</code> - Base _Not Markdown_</dd>
""");
}
}
|
