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

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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

mercurial