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
|
/*
* Copyright (c) 2022, 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 8252717 8307377
* @summary Integrate/merge legacy standard doclet diagnostics and doclint
* @library ../../lib /tools/lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestDocLintDocletMessages
*/
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
/**
* Some conditions may be detected by both DocLint and the Standard Doclet.
* This test is to verify that in such cases, only one of those generates
* a message.
*/
public class TestDocLintDocletMessages extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestDocLintDocletMessages();
tester.runTests();
}
final ToolBox tb = new ToolBox();
@Test
public void testSyntaxError(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
/**
* Comment.
* Bad < HTML.
* End of comment.
*/
public class C {
private C() { }
}
""");
var doclintResult = new Result(Exit.ERROR,"C.java:3: error: malformed HTML");
var docletResult = new Result(Exit.OK, "C.java:3: warning: invalid input: '<'");
testSingle(base, "syntax", doclintResult, docletResult);
}
@Test
public void testReferenceNotFoundError(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
/**
* Comment.
* @see DoesNotExist
*/
public class C {
private C() { }
}
""");
var doclintResult = new Result(Exit.ERROR, "C.java:3: error: reference not found");
var docletResult = new Result(Exit.OK, "C.java:3: warning: reference not found: DoesNotExist");
testSingle(base, "reference", doclintResult, docletResult);
}
@Test
public void testParamNotFoundError(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
/**
* Comment.
*/
public class C {
/**
* Comment.
* @param y wrong name
*/
public C(int x) { }
}
""");
var doclintResult = new Result(Exit.ERROR, "C.java:7: error: @param name not found");
var docletResult = new Result(Exit.OK, "C.java:7: warning: @param argument \"y\" is not a parameter name.");
testSingle(base, "reference", doclintResult, docletResult);
}
@Test
public void testParamDuplicateError(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
/**
* Comment.
*/
public class C {
/**
* Comment.
* @param x first
* @param x second
*/
public C(int x) { }
}
""");
var doclintResult = new Result(Exit.OK, "C.java:8: warning: @param \"x\" has already been specified");
var docletResult = new Result(Exit.OK, "C.java:8: warning: Parameter \"x\" is documented more than once.");
testSingle(base, "reference", doclintResult, docletResult);
}
@Test
public void testReturnOnVoid(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
/**
* Comment.
*/
public class C {
private C() { }
/**
* Comment.
* @return nothing
*/
public void m() { }
}
""");
var doclintResult = new Result(Exit.ERROR, "C.java:8: error: invalid use of @return");
var docletResult = new Result(Exit.OK, "C.java:10: warning: @return tag cannot be used in method with void return type.");
testSingle(base, "reference", doclintResult, docletResult);
}
/** Captures an expected exit code and diagnostic message. */
record Result(Exit exit, String message) { }
void testSingle(Path base, String group, Result doclintResult, Result docletResult) {
int index = 1;
// test options that should trigger the doclint message
for (String o : List.of("", "-Xdoclint", "-Xdoclint:" + group)) {
testSingle(base, index++, o.isEmpty() ? List.of() : List.of(o), doclintResult, docletResult);
}
// test options that should trigger the doclet message
for (String o : List.of("-Xdoclint:none", "-Xdoclint:all,-" + group)) {
testSingle(base, index++, List.of(o), docletResult, doclintResult);
}
}
void testSingle(Path base, int index, List<String> options, Result expect, Result doNotExpect) {
var allOptions = new ArrayList<String>();
allOptions.addAll(List.of("-d", base.resolve("out-" + index).toString()));
allOptions.addAll(options);
allOptions.addAll(List.of("-noindex", "-nohelp")); // omit unnecessary files
allOptions.add(base.resolve("src").resolve("C.java").toString());
javadoc(allOptions.toArray(String[]::new));
checkExit(expect.exit);
checkOutput(Output.OUT, true, expect.message);
// allow that the "other" result might be the same as the main result
if (!doNotExpect.message.equals(expect.message)) {
checkOutput(Output.OUT, false, doNotExpect.message);
}
}
}
|
