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

Tue, 25 May 2010 15:54:51 -0700

author
ohair
date
Tue, 25 May 2010 15:54:51 -0700
changeset 554
9d9f26857129
parent 233
5240b1120530
child 766
90af8d87741f
permissions
-rw-r--r--

6943119: Rebrand source copyright notices
Reviewed-by: darcy

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

mercurial