test/com/sun/javadoc/testTagMisuse/TestTagMisuse.java

Mon, 23 Jan 2017 17:03:12 -0800

author
asaha
date
Mon, 23 Jan 2017 17:03:12 -0800
changeset 3376
26c9abc6c440
parent 1859
36e8bc1907a2
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Merge

duke@1 1 /*
jjg@1490 2 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation.
duke@1 8 *
duke@1 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 13 * accompanied this code).
duke@1 14 *
duke@1 15 * You should have received a copy of the GNU General Public License version
duke@1 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 18 *
ohair@554 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 20 * or visit www.oracle.com if you need additional information or have any
ohair@554 21 * questions.
duke@1 22 */
duke@1 23
bpatel@1859 24 /*
duke@1 25 * @test
duke@1 26 * @summary Determine if proper warning messages are printed when know.
duke@1 27 * @author jamieh
duke@1 28 * @library ../lib/
duke@1 29 * @build JavadocTester
duke@1 30 * @build TestTagMisuse
duke@1 31 * @run main TestTagMisuse
duke@1 32 */
duke@1 33 public class TestTagMisuse extends JavadocTester {
duke@1 34
duke@1 35 private static final String BUG_ID = "no-bug-id";
duke@1 36 private static final String[][] TEST = {
duke@1 37 {WARNING_OUTPUT, "warning - Tag @param cannot be used in field documentation."},
duke@1 38 {WARNING_OUTPUT, "warning - Tag @throws cannot be used in field documentation."},
duke@1 39 {WARNING_OUTPUT, "warning - Tag @return cannot be used in constructor documentation."},
duke@1 40 {WARNING_OUTPUT, "warning - Tag @throws cannot be used in inline documentation."},
duke@1 41 };
duke@1 42 private static final String[][] NEGATED_TEST = NO_TEST;
duke@1 43 private static final String[] ARGS = new String[] {
jjg@1490 44 "-Xdoclint:none", "-d", BUG_ID, SRC_DIR + FS + "TestTagMisuse.java"
duke@1 45 };
duke@1 46
duke@1 47 /**
duke@1 48 * The entry point of the test.
duke@1 49 * @param args the array of command line arguments.
duke@1 50 */
duke@1 51 public static void main(String[] args) {
duke@1 52 TestTagMisuse tester = new TestTagMisuse();
duke@1 53 run(tester, ARGS, TEST, NEGATED_TEST);
duke@1 54 tester.printSummary();
duke@1 55 }
duke@1 56
duke@1 57 /**
duke@1 58 * {@inheritDoc}
duke@1 59 */
duke@1 60 public String getBugId() {
duke@1 61 return BUG_ID;
duke@1 62 }
duke@1 63
duke@1 64 /**
duke@1 65 * {@inheritDoc}
duke@1 66 */
duke@1 67 public String getBugName() {
duke@1 68 return getClass().getName();
duke@1 69 }
duke@1 70
duke@1 71 /**
duke@1 72 * {@throws blah}
duke@1 73 * Here is a bad field tag:
duke@1 74 * @throws foo
duke@1 75 * @param foo.
duke@1 76 */
duke@1 77 public int field;
duke@1 78
duke@1 79 /**
duke@1 80 * Here is a bad constructor tag:
duke@1 81 * @return blah
duke@1 82 */
duke@1 83 public TestTagMisuse(){}
duke@1 84
duke@1 85 }

mercurial