TestTagMisuse.java revision 2365:6207608205b8 
1/*
2 * Copyright (c) 2001, 2014, 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 */
23
24/*
25 * @test
26 * @summary Determine if proper warning messages are printed when know.
27 * @author jamieh
28 * @library ../lib/
29 * @build JavadocTester
30 * @build TestTagMisuse
31 * @run main TestTagMisuse
32 */
33public class TestTagMisuse extends JavadocTester {
34
35    private static final String BUG_ID = "no-bug-id";
36    private static final String[][] TEST = {
37        {WARNING_OUTPUT, "warning - Tag @param cannot be used in field documentation."},
38        {WARNING_OUTPUT, "warning - Tag @throws cannot be used in field documentation."},
39        {WARNING_OUTPUT, "warning - Tag @return cannot be used in constructor documentation."},
40        {WARNING_OUTPUT, "warning - Tag @throws cannot be used in inline documentation."},
41    };
42    private static final String[][] NEGATED_TEST = NO_TEST;
43    private static final String[] ARGS = new String[] {
44        "-Xdoclint:none", "-d", BUG_ID, SRC_DIR + "/TestTagMisuse.java"
45    };
46
47    /**
48     * The entry point of the test.
49     * @param args the array of command line arguments.
50     */
51    public static void main(String[] args) {
52        TestTagMisuse tester = new TestTagMisuse();
53        run(tester, ARGS, TEST, NEGATED_TEST);
54        tester.printSummary();
55    }
56
57    /**
58     * {@inheritDoc}
59     */
60    public String getBugId() {
61        return BUG_ID;
62    }
63
64    /**
65     * {@inheritDoc}
66     */
67    public String getBugName() {
68        return getClass().getName();
69    }
70
71    /**
72     * {@throws blah}
73     * Here is a bad field tag:
74     * @throws foo
75     * @param foo.
76     */
77    public int field;
78
79    /**
80     * Here is a bad constructor tag:
81     * @return blah
82     */
83    public TestTagMisuse(){}
84
85}
86