langtools/test/com/sun/javadoc/testParamTaglet/TestParamTaglet.java
author jjg
Tue, 22 Apr 2014 17:57:40 -0700
changeset 24072 e7549dcbc4af
parent 24071 b0845717434e
child 24399 af1a0220d0fa
permissions -rw-r--r--
8040903: Clean up use of BUG_ID in javadoc tests Reviewed-by: ksrini
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
     2
 * Copyright (c) 2003, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2216
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2216
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2216
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
21478
fa4c7cda1b41 8026567: Use meaningful style names for strong and italic styles.
bpatel
parents: 17566
diff changeset
    26
 * @bug      4802275 4967243 8026567
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Make sure param tags are still printed even though they do not
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           match up with a real parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           Make sure inheritDoc cannot be used in an invalid param tag.
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @author   jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @library  ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @build    JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @build    TestParamTaglet
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @run main TestParamTaglet
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
public class TestParamTaglet extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
    //Javadoc arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String[] ARGS = new String[] {
24072
e7549dcbc4af 8040903: Clean up use of BUG_ID in javadoc tests
jjg
parents: 24071
diff changeset
    41
        "-d", OUTPUT_DIR, "-sourcepath", SRC_DIR, "pkg"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    //Input for string search tests.
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
        //Regular param tags.
24072
e7549dcbc4af 8040903: Clean up use of BUG_ID in javadoc tests
jjg
parents: 24071
diff changeset
    47
        { "pkg/C.html",
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    48
            "<span class=\"paramLabel\">Parameters:</span></dt>\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    49
            "<dd><code>param1</code> - testing 1 2 3.</dd>\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    50
                "<dd><code>param2</code> - testing 1 2 3."
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
        //Param tags that don't match with any real parameters.
24072
e7549dcbc4af 8040903: Clean up use of BUG_ID in javadoc tests
jjg
parents: 24071
diff changeset
    53
        { "pkg/C.html",
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    54
            "<span class=\"paramLabel\">Parameters:</span></dt>\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    55
            "<dd><code><I>p1</I></code> - testing 1 2 3.</dd>\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    56
                "<dd><code><I>p2</I></code> - testing 1 2 3."
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
        //{@inherit} doc misuse does not cause doclet to throw exception.
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        // Param is printed with nothing inherited.
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
        //XXX: in the future when Configuration is available during doc inheritence,
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
        //print a warning for this mistake.
24072
e7549dcbc4af 8040903: Clean up use of BUG_ID in javadoc tests
jjg
parents: 24071
diff changeset
    62
        { "pkg/C.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    63
            "<code><I>inheritBug</I></code> -"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        TestParamTaglet tester = new TestParamTaglet();
24071
b0845717434e 8041253: Avoid redundant synonyms of NO_TEST
jjg
parents: 24065
diff changeset
    74
        tester.run(ARGS, TEST, NO_TEST);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
}