Mercurial > jdk8-mips64-public > langtools / annotate
test/com/sun/javadoc/testValueTag/TestValueTag.java@fc4cb1577ad6 (annotated)
test/com/sun/javadoc/testValueTag/TestValueTag.java
Thu, 10 Jan 2013 19:38:57 -0800
- author
- jjg
- date
- Thu, 10 Jan 2013 19:38:57 -0800
- changeset 1490
- fc4cb1577ad6
- parent 798
- 4868a36f6fd8
- child 1743
- 6a5288a298fd
- permissions
- -rw-r--r--
8004834: Add doclint support into javadoc
Reviewed-by: darcy
| duke@1 | 1 | /* |
| jjg@1490 | 2 | * Copyright (c) 2003, 2013, 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 4764045 |
| duke@1 | 27 | * @summary This test ensures that the value tag works in all |
| duke@1 | 28 | * use cases. The explainations for each test case are written below. |
| duke@1 | 29 | * @author jamieh |
| duke@1 | 30 | * @library ../lib/ |
| duke@1 | 31 | * @build JavadocTester |
| duke@1 | 32 | * @build TestValueTag |
| duke@1 | 33 | * @run main TestValueTag |
| duke@1 | 34 | */ |
| duke@1 | 35 | |
| duke@1 | 36 | public class TestValueTag extends JavadocTester { |
| duke@1 | 37 | |
| duke@1 | 38 | //Test information. |
| duke@1 | 39 | private static final String BUG_ID = "4764045"; |
| duke@1 | 40 | |
| duke@1 | 41 | //Javadoc arguments. |
| duke@1 | 42 | private static final String[] ARGS = |
| duke@1 | 43 | new String[] { |
| jjg@1490 | 44 | "-Xdoclint:none", |
| duke@1 | 45 | "-d", BUG_ID, "-sourcepath", SRC_DIR, "-tag", |
| duke@1 | 46 | "todo", "pkg1", "pkg2" |
| duke@1 | 47 | }; |
| duke@1 | 48 | |
| duke@1 | 49 | //Input for string search tests. |
| duke@1 | 50 | private static final String[][] TEST = { |
| duke@1 | 51 | //Base case: using @value on a constant. |
| duke@1 | 52 | {BUG_ID + FS + "pkg1" + FS + "Class1.html", |
| duke@1 | 53 | "Result: \"Test 1 passes\""}, |
| duke@1 | 54 | //Retrieve value of constant in same class. |
| duke@1 | 55 | {BUG_ID + FS + "pkg1" + FS + "Class1.html", |
| bpatel@766 | 56 | "Result: <a href=\"../pkg1/Class1.html#TEST_2_PASSES\">\"Test 2 passes\"</a>"}, |
| duke@1 | 57 | {BUG_ID + FS + "pkg1" + FS + "Class1.html", |
| bpatel@766 | 58 | "Result: <a href=\"../pkg1/Class1.html#TEST_3_PASSES\">\"Test 3 passes\"</a>"}, |
| duke@1 | 59 | {BUG_ID + FS + "pkg1" + FS + "Class1.html", |
| bpatel@766 | 60 | "Result: <a href=\"../pkg1/Class1.html#TEST_4_PASSES\">\"Test 4 passes\"</a>"}, |
| duke@1 | 61 | {BUG_ID + FS + "pkg1" + FS + "Class1.html", |
| bpatel@766 | 62 | "Result: <a href=\"../pkg1/Class1.html#TEST_5_PASSES\">\"Test 5 passes\"</a>"}, |
| duke@1 | 63 | {BUG_ID + FS + "pkg1" + FS + "Class1.html", |
| bpatel@766 | 64 | "Result: <a href=\"../pkg1/Class1.html#TEST_6_PASSES\">\"Test 6 passes\"</a>"}, |
| duke@1 | 65 | //Retrieve value of constant in different class. |
| duke@1 | 66 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 67 | "Result: <a href=\"../pkg1/Class1.html#TEST_7_PASSES\">\"Test 7 passes\"</a>"}, |
| duke@1 | 68 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 69 | "Result: <a href=\"../pkg1/Class1.html#TEST_8_PASSES\">\"Test 8 passes\"</a>"}, |
| duke@1 | 70 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 71 | "Result: <a href=\"../pkg1/Class1.html#TEST_9_PASSES\">\"Test 9 passes\"</a>"}, |
| duke@1 | 72 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 73 | "Result: <a href=\"../pkg1/Class1.html#TEST_10_PASSES\">\"Test 10 passes\"</a>"}, |
| duke@1 | 74 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 75 | "Result: <a href=\"../pkg1/Class1.html#TEST_11_PASSES\">\"Test 11 passes\"</a>"}, |
| duke@1 | 76 | //Retrieve value of constant in different package |
| duke@1 | 77 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 78 | "Result: <a href=\"../pkg2/Class3.html#TEST_12_PASSES\">\"Test 12 passes\"</a>"}, |
| duke@1 | 79 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 80 | "Result: <a href=\"../pkg2/Class3.html#TEST_13_PASSES\">\"Test 13 passes\"</a>"}, |
| duke@1 | 81 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 82 | "Result: <a href=\"../pkg2/Class3.html#TEST_14_PASSES\">\"Test 14 passes\"</a>"}, |
| duke@1 | 83 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 84 | "Result: <a href=\"../pkg2/Class3.html#TEST_15_PASSES\">\"Test 15 passes\"</a>"}, |
| duke@1 | 85 | {BUG_ID + FS + "pkg1" + FS + "Class2.html", |
| bpatel@766 | 86 | "Result: <a href=\"../pkg2/Class3.html#TEST_16_PASSES\">\"Test 16 passes\"</a>"}, |
| duke@1 | 87 | //Retrieve value of constant from a package page |
| duke@1 | 88 | {BUG_ID + FS + "pkg2" + FS + "package-summary.html", |
| bpatel@766 | 89 | "Result: <a href=\"../pkg2/Class3.html#TEST_17_PASSES\">\"Test 17 passes\"</a>"}, |
| duke@1 | 90 | //Test @value tag used with custom tag. |
| duke@1 | 91 | {BUG_ID + FS + "pkg1" + FS + "CustomTagUsage.html", |
| bpatel@766 | 92 | "<dt><span class=\"strong\">Todo:</span></dt>" + NL + |
| bpatel@766 | 93 | " <dd>the value of this constant is 55.</dd>"}, |
| duke@1 | 94 | //Test @value warning printed when used with non-constant. |
| duke@1 | 95 | {WARNING_OUTPUT,"warning - @value tag (which references nonConstant) " + |
| duke@1 | 96 | "can only be used in constants." |
| duke@1 | 97 | }, |
| duke@1 | 98 | //Test warning printed for bad reference. |
| duke@1 | 99 | {WARNING_OUTPUT,"warning - UnknownClass#unknownConstant (referenced by " + |
| duke@1 | 100 | "@value tag) is an unknown reference." |
| duke@1 | 101 | }, |
| duke@1 | 102 | }; |
| duke@1 | 103 | private static final String[][] NEGATED_TEST = NO_TEST; |
| duke@1 | 104 | |
| duke@1 | 105 | /** |
| duke@1 | 106 | * The entry point of the test. |
| duke@1 | 107 | * @param args the array of command line arguments. |
| duke@1 | 108 | */ |
| duke@1 | 109 | public static void main(String[] args) { |
| duke@1 | 110 | TestValueTag tester = new TestValueTag(); |
| duke@1 | 111 | run(tester, ARGS, TEST, NEGATED_TEST); |
| duke@1 | 112 | tester.printSummary(); |
| duke@1 | 113 | } |
| duke@1 | 114 | |
| duke@1 | 115 | /** |
| duke@1 | 116 | * {@inheritDoc} |
| duke@1 | 117 | */ |
| duke@1 | 118 | public String getBugId() { |
| duke@1 | 119 | return BUG_ID; |
| duke@1 | 120 | } |
| duke@1 | 121 | |
| duke@1 | 122 | /** |
| duke@1 | 123 | * {@inheritDoc} |
| duke@1 | 124 | */ |
| duke@1 | 125 | public String getBugName() { |
| duke@1 | 126 | return getClass().getName(); |
| duke@1 | 127 | } |
| duke@1 | 128 | } |
