Mon, 23 Jan 2017 17:03:12 -0800
Merge
1 /*
2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
24 /*
25 * @test
26 * @bug 4490068
27 * @summary Warn when a return tag is used on a method without a return type.
28 * @author jamieh
29 * @library ../lib/
30 * @build JavadocTester
31 * @build TestReturnTag
32 * @run main TestReturnTag
33 */
35 public class TestReturnTag extends JavadocTester {
37 //Test information.
38 private static final String BUG_ID = "4490068";
40 //Javadoc arguments.
41 private static final String[] ARGS = new String[] {
42 "-Xdoclint:none", "-d", BUG_ID, "-sourcepath", SRC_DIR, SRC_DIR + FS + "TestReturnTag.java"
43 };
45 //Input for string search tests.
46 private static final String[][] TEST = {
47 {WARNING_OUTPUT,
48 "warning - @return tag cannot be used in method with void return type."}
49 };
50 private static final String[][] NEGATED_TEST = NO_TEST;
52 /**
53 * Trigger warning message when return tag is used on a void method.
54 *
55 * @return I really don't return anything.
56 */
57 public void method() {}
59 /**
60 * The entry point of the test.
61 * @param args the array of command line arguments.
62 */
63 public static void main(String[] args) {
64 TestReturnTag tester = new TestReturnTag();
65 run(tester, ARGS, TEST, NEGATED_TEST);
66 tester.printSummary();
67 }
69 /**
70 * {@inheritDoc}
71 */
72 public String getBugId() {
73 return BUG_ID;
74 }
76 /**
77 * {@inheritDoc}
78 */
79 public String getBugName() {
80 return getClass().getName();
81 }
82 }