test/com/sun/javadoc/testParamTaglet/TestParamTaglet.java

Thu, 31 Aug 2017 15:17:03 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:17:03 +0800
changeset 2525
2eb010b6cb22
parent 2147
130b8c0e570e
parent 0
959103a6100f
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2003, 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 * @bug 4802275 4967243 8026567
aoqi@0 27 * @summary Make sure param tags are still printed even though they do not
aoqi@0 28 * match up with a real parameters.
aoqi@0 29 * Make sure inheritDoc cannot be used in an invalid param tag.
aoqi@0 30 * @author jamieh
aoqi@0 31 * @library ../lib/
aoqi@0 32 * @build JavadocTester
aoqi@0 33 * @build TestParamTaglet
aoqi@0 34 * @run main TestParamTaglet
aoqi@0 35 */
aoqi@0 36
aoqi@0 37 public class TestParamTaglet extends JavadocTester {
aoqi@0 38
aoqi@0 39 //Test information.
aoqi@0 40 private static final String BUG_ID = "4802275-4967243";
aoqi@0 41
aoqi@0 42 //Javadoc arguments.
aoqi@0 43 private static final String[] ARGS = new String[] {
aoqi@0 44 "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg"
aoqi@0 45 };
aoqi@0 46
aoqi@0 47 //Input for string search tests.
aoqi@0 48 private static final String[][] TEST = {
aoqi@0 49 //Regular param tags.
aoqi@0 50 {BUG_ID + FS + "pkg" + FS + "C.html",
aoqi@0 51 "<span class=\"paramLabel\">Parameters:</span></dt>" + NL + "<dd><code>param1</code> - testing 1 2 3.</dd>" +
aoqi@0 52 NL + "<dd><code>param2</code> - testing 1 2 3."
aoqi@0 53 },
aoqi@0 54 //Param tags that don't match with any real parameters.
aoqi@0 55 {BUG_ID + FS + "pkg" + FS + "C.html",
aoqi@0 56 "<span class=\"paramLabel\">Parameters:</span></dt>" + NL + "<dd><code><I>p1</I></code> - testing 1 2 3.</dd>" +
aoqi@0 57 NL + "<dd><code><I>p2</I></code> - testing 1 2 3."
aoqi@0 58 },
aoqi@0 59 //{@inherit} doc misuse does not cause doclet to throw exception.
aoqi@0 60 // Param is printed with nothing inherited.
aoqi@0 61 //XXX: in the future when Configuration is available during doc inheritence,
aoqi@0 62 //print a warning for this mistake.
aoqi@0 63 {BUG_ID + FS + "pkg" + FS + "C.html",
aoqi@0 64 "<code><I>inheritBug</I></code> -"
aoqi@0 65 },
aoqi@0 66
aoqi@0 67 };
aoqi@0 68 private static final String[][] NEGATED_TEST = NO_TEST;
aoqi@0 69
aoqi@0 70 /**
aoqi@0 71 * The entry point of the test.
aoqi@0 72 * @param args the array of command line arguments.
aoqi@0 73 */
aoqi@0 74 public static void main(String[] args) {
aoqi@0 75 TestParamTaglet tester = new TestParamTaglet();
aoqi@0 76 run(tester, ARGS, TEST, NEGATED_TEST);
aoqi@0 77 tester.printSummary();
aoqi@0 78 }
aoqi@0 79
aoqi@0 80 /**
aoqi@0 81 * {@inheritDoc}
aoqi@0 82 */
aoqi@0 83 public String getBugId() {
aoqi@0 84 return BUG_ID;
aoqi@0 85 }
aoqi@0 86
aoqi@0 87 /**
aoqi@0 88 * {@inheritDoc}
aoqi@0 89 */
aoqi@0 90 public String getBugName() {
aoqi@0 91 return getClass().getName();
aoqi@0 92 }
aoqi@0 93 }

mercurial