TestParamTaglet.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2003, 2015, 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 */
23
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 * @modules jdk.javadoc
33 * @build    JavadocTester
34 * @run main TestParamTaglet
35 */
36
37public class TestParamTaglet extends JavadocTester {
38
39    public static void main(String... args) throws Exception {
40        TestParamTaglet tester = new TestParamTaglet();
41        tester.runTests();
42    }
43
44    @Test
45    void test() {
46        javadoc("-d", "out",
47                "-sourcepath", testSrc,
48                "pkg");
49        checkExit(Exit.FAILED);
50
51        checkOutput("pkg/C.html", true,
52                //Regular param tags.
53                "<span class=\"paramLabel\">Parameters:</span></dt>\n"
54                + "<dd><code>param1</code> - testing 1 2 3.</dd>\n"
55                + "<dd><code>param2</code> - testing 1 2 3.",
56                //Param tags that don't match with any real parameters.
57                "<span class=\"paramLabel\">Parameters:</span></dt>\n"
58                + "<dd><code>p1</code> - testing 1 2 3.</dd>\n"
59                + "<dd><code>p2</code> - testing 1 2 3.",
60                //{@inherit} doc misuse does not cause doclet to throw exception.
61                // Param is printed with nothing inherited.
62                //XXX: in the future when Configuration is available during doc inheritence,
63                //print a warning for this mistake.
64                "<code>inheritBug</code> -");
65    }
66}
67