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