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
|
/*
* Copyright (c) 2021, 2023, 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 8269722 8270866 8307377
* @summary NPE in HtmlDocletWriter, reporting errors on inherited tags
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestInherited
*/
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestInherited extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestInherited();
tester.runTests();
}
private final ToolBox tb = new ToolBox();
@Test
public void testBadInheritedParam(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
public class BadParam {
public static class Base {
/**
* @param i a < b
*/
public void m(int i) { }
}
public static class Sub extends Base {
public void m(int i) { }
}
}
""");
javadoc("-d", base.resolve("out").toString(),
"-Xdoclint:-missing", "-XDdoe",
src.resolve("BadParam.java").toString());
checkExit(Exit.OK);
checkOutput("BadParam.Base.html", true, """
<dt>Parameters:</dt>
<dd><code>i</code> - a <span class="invalid-tag">invalid input: '<'</span> b</dd>
""");
checkOutput("BadParam.Sub.html", true, """
<dt>Parameters:</dt>
<dd><code>i</code> - a <span class="invalid-tag">invalid input: '<'</span> b</dd>
""");
}
@Test
public void testBadInheritedReturn(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
public class BadReturn {
public static class Base {
/**
* @return a < b
*/
public int m() { }
}
public static class Sub extends Base {
public int m() { }
}
}
""");
javadoc("-d", base.resolve("out").toString(),
"-Xdoclint:-missing",
src.resolve("BadReturn.java").toString());
checkExit(Exit.OK);
checkOutput("BadReturn.Base.html", true, """
<dt>Returns:</dt>
<dd>a <span class="invalid-tag">invalid input: '<'</span> b</dd>
""");
checkOutput("BadReturn.Sub.html", true, """
<dt>Returns:</dt>
<dd>a <span class="invalid-tag">invalid input: '<'</span> b</dd>
""");
}
@Test
public void testBadInheritedReference(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
public class BadReference {
public interface Intf {
/**
* {@link NonExistingClass}
*/
public void m();
}
public static class Impl1 implements Intf {
public void m() { }
}
public static class Impl2 implements Intf {
/**
* {@inheritDoc}
*/
public void m() { }
}
// subclass has doc comment but inherits main description
public static class Impl3 implements Intf {
/**
* @since 1
*/
public void m() { }
}
}
""");
javadoc("-d", base.resolve("out").toString(),
"-Xdoclint:-reference",
src.resolve("BadReference.java").toString());
checkExit(Exit.OK);
checkOutput("BadReference.Intf.html", true, """
<div class="block">
<details class="invalid-tag">
<summary>invalid reference</summary>
<pre><code>NonExistingClass</code></pre>
</details>
</div>
""");
checkOutput("BadReference.Impl1.html", true, """
<div class="block">
<details class="invalid-tag">
<summary>invalid reference</summary>
<pre><code>NonExistingClass</code></pre>
</details>
</div>
""");
checkOutput("BadReference.Impl2.html", true, """
<div class="block">
<details class="invalid-tag">
<summary>invalid reference</summary>
<pre><code>NonExistingClass</code></pre>
</details>
</div>
""");
checkOutput("BadReference.Impl3.html", true, """
<div class="block">
<details class="invalid-tag">
<summary>invalid reference</summary>
<pre><code>NonExistingClass</code></pre>
</details>
</div>
""");
}
}
|
