test/com/sun/javadoc/testReturnTag/TestReturnTag.java

Wed, 28 Nov 2012 14:07:26 -0800

author
katleman
date
Wed, 28 Nov 2012 14:07:26 -0800
changeset 1425
20230f8b0eef
parent 554
9d9f26857129
child 1490
fc4cb1577ad6
permissions
-rw-r--r--

Merge

duke@1 1 /*
ohair@554 2 * Copyright (c) 2003, 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
duke@1 24 /*
duke@1 25 * @test
duke@1 26 * @bug 4490068
duke@1 27 * @summary Warn when a return tag is used on a method without a return type.
duke@1 28 * @author jamieh
duke@1 29 * @library ../lib/
duke@1 30 * @build JavadocTester
duke@1 31 * @build TestReturnTag
duke@1 32 * @run main TestReturnTag
duke@1 33 */
duke@1 34
duke@1 35 public class TestReturnTag extends JavadocTester {
duke@1 36
duke@1 37 //Test information.
duke@1 38 private static final String BUG_ID = "4490068";
duke@1 39
duke@1 40 //Javadoc arguments.
duke@1 41 private static final String[] ARGS = new String[] {
duke@1 42 "-d", BUG_ID, "-sourcepath", SRC_DIR, SRC_DIR + FS + "TestReturnTag.java"
duke@1 43 };
duke@1 44
duke@1 45 //Input for string search tests.
duke@1 46 private static final String[][] TEST = {
duke@1 47 {WARNING_OUTPUT,
duke@1 48 "warning - @return tag cannot be used in method with void return type."}
duke@1 49 };
duke@1 50 private static final String[][] NEGATED_TEST = NO_TEST;
duke@1 51
duke@1 52 /**
duke@1 53 * Trigger warning message when return tag is used on a void method.
duke@1 54 *
duke@1 55 * @return I really don't return anything.
duke@1 56 */
duke@1 57 public void method() {}
duke@1 58
duke@1 59 /**
duke@1 60 * The entry point of the test.
duke@1 61 * @param args the array of command line arguments.
duke@1 62 */
duke@1 63 public static void main(String[] args) {
duke@1 64 TestReturnTag tester = new TestReturnTag();
duke@1 65 run(tester, ARGS, TEST, NEGATED_TEST);
duke@1 66 tester.printSummary();
duke@1 67 }
duke@1 68
duke@1 69 /**
duke@1 70 * {@inheritDoc}
duke@1 71 */
duke@1 72 public String getBugId() {
duke@1 73 return BUG_ID;
duke@1 74 }
duke@1 75
duke@1 76 /**
duke@1 77 * {@inheritDoc}
duke@1 78 */
duke@1 79 public String getBugName() {
duke@1 80 return getClass().getName();
duke@1 81 }
duke@1 82 }

mercurial