duke@1: /*
ohair@554:  * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: /*
duke@1:  * @test
duke@1:  * @bug      4802275 4967243
duke@1:  * @summary  Make sure param tags are still printed even though they do not
duke@1:  *           match up with a real parameters.
duke@1:  *           Make sure inheritDoc cannot be used in an invalid param tag.
duke@1:  * @author   jamieh
duke@1:  * @library  ../lib/
duke@1:  * @build    JavadocTester
duke@1:  * @build    TestParamTaglet
duke@1:  * @run main TestParamTaglet
duke@1:  */
duke@1: 
duke@1: public class TestParamTaglet extends JavadocTester {
duke@1: 
duke@1:     //Test information.
duke@1:     private static final String BUG_ID = "4802275-4967243";
duke@1: 
duke@1:     //Javadoc arguments.
duke@1:     private static final String[] ARGS = new String[] {
duke@1:         "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg"
duke@1:     };
duke@1: 
duke@1:     //Input for string search tests.
duke@1:     private static final String[][] TEST = {
duke@1:         //Regular param tags.
duke@1:         {BUG_ID + FS + "pkg" + FS + "C.html",
bpatel@233:             "<STRONG>Parameters:</STRONG></DT><DD><CODE>param1</CODE> - testing 1 2 3.</DD>" +
duke@1:                 "<DD><CODE>param2</CODE> - testing 1 2 3."
duke@1:         },
duke@1:         //Param tags that don't match with any real parameters.
duke@1:         {BUG_ID + FS + "pkg" + FS + "C.html",
bpatel@233:             "<STRONG>Parameters:</STRONG></DT><DD><CODE><I>p1</I></CODE> - testing 1 2 3.</DD>" +
duke@1:                 "<DD><CODE><I>p2</I></CODE> - testing 1 2 3."
duke@1:         },
duke@1:         //{@inherit} doc misuse does not cause doclet to throw exception.
duke@1:         // Param is printed with nothing inherited.
duke@1:         //XXX: in the future when Configuration is available during doc inheritence,
duke@1:         //print a warning for this mistake.
duke@1:         {BUG_ID + FS + "pkg" + FS + "C.html",
duke@1:             "<CODE><I>inheritBug</I></CODE> -"
duke@1:         },
duke@1: 
duke@1:     };
duke@1:     private static final String[][] NEGATED_TEST = NO_TEST;
duke@1: 
duke@1:     /**
duke@1:      * The entry point of the test.
duke@1:      * @param args the array of command line arguments.
duke@1:      */
duke@1:     public static void main(String[] args) {
duke@1:         TestParamTaglet tester = new TestParamTaglet();
duke@1:         run(tester, ARGS, TEST, NEGATED_TEST);
duke@1:         tester.printSummary();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public String getBugId() {
duke@1:         return BUG_ID;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public String getBugName() {
duke@1:         return getClass().getName();
duke@1:     }
duke@1: }