Thu, 10 Jan 2013 19:38:57 -0800
8004834: Add doclint support into javadoc
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1490 | 2 | * Copyright (c) 2004, 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 4515705 4804296 4702454 4697036 |
duke@1 | 27 | * @summary Make sure that first sentence warning only appears once. |
duke@1 | 28 | * Make sure that only warnings/errors are printed when quiet is used. |
duke@1 | 29 | * Make sure that links to private/unincluded methods do not cause |
duke@1 | 30 | * a "link unresolved" warning. |
duke@1 | 31 | * Make sure error message starts with "error -". |
duke@1 | 32 | * @author jamieh |
duke@1 | 33 | * @library ../lib/ |
duke@1 | 34 | * @build JavadocTester |
duke@1 | 35 | * @build TestWarnings |
duke@1 | 36 | * @run main TestWarnings |
duke@1 | 37 | */ |
duke@1 | 38 | |
duke@1 | 39 | public class TestWarnings extends JavadocTester { |
duke@1 | 40 | |
duke@1 | 41 | //Test information. |
duke@1 | 42 | private static final String BUG_ID = "4515705-4804296-4702454-4697036"; |
duke@1 | 43 | |
duke@1 | 44 | //Javadoc arguments. |
duke@1 | 45 | private static final String[] ARGS = new String[] { |
jjg@1490 | 46 | "-Xdoclint:none", "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg" |
duke@1 | 47 | }; |
duke@1 | 48 | |
duke@1 | 49 | private static final String[] ARGS2 = new String[] { |
jjg@1490 | 50 | "-Xdoclint:none", "-d", BUG_ID, "-private", "-sourcepath", SRC_DIR, "pkg" |
duke@1 | 51 | }; |
duke@1 | 52 | |
duke@1 | 53 | //Input for string search tests. |
duke@1 | 54 | private static final String[][] TEST = { |
duke@1 | 55 | {WARNING_OUTPUT, |
duke@1 | 56 | "X.java:11: warning - Missing closing '}' character for inline tag"}, |
duke@1 | 57 | {ERROR_OUTPUT, |
duke@1 | 58 | "package.html: error - Body tag missing from HTML"}, |
duke@1 | 59 | |
duke@1 | 60 | }; |
duke@1 | 61 | private static final String[][] NEGATED_TEST = { |
duke@1 | 62 | {BUG_ID + FS + "pkg" + FS + "X.html", "can't find m()"}, |
duke@1 | 63 | {BUG_ID + FS + "pkg" + FS + "X.html", "can't find X()"}, |
duke@1 | 64 | {BUG_ID + FS + "pkg" + FS + "X.html", "can't find f"}, |
duke@1 | 65 | }; |
duke@1 | 66 | |
duke@1 | 67 | private static final String[][] TEST2 = { |
bpatel@766 | 68 | {BUG_ID + FS + "pkg" + FS + "X.html", "<a href=\"../pkg/X.html#m()\"><code>m()</code></a><br/>"}, |
bpatel@766 | 69 | {BUG_ID + FS + "pkg" + FS + "X.html", "<a href=\"../pkg/X.html#X()\"><code>X()</code></a><br/>"}, |
bpatel@766 | 70 | {BUG_ID + FS + "pkg" + FS + "X.html", "<a href=\"../pkg/X.html#f\"><code>f</code></a><br/>"}, |
duke@1 | 71 | }; |
duke@1 | 72 | |
duke@1 | 73 | private static final String[][] NEGATED_TEST2 = NO_TEST; |
duke@1 | 74 | |
duke@1 | 75 | |
duke@1 | 76 | /** |
duke@1 | 77 | * The entry point of the test. |
duke@1 | 78 | * @param args the array of command line arguments. |
duke@1 | 79 | */ |
duke@1 | 80 | public static void main(String[] args) { |
duke@1 | 81 | TestWarnings tester = new TestWarnings(); |
duke@1 | 82 | run(tester, ARGS, TEST, NEGATED_TEST); |
duke@1 | 83 | run(tester, ARGS2, TEST2, NEGATED_TEST2); |
duke@1 | 84 | tester.printSummary(); |
duke@1 | 85 | } |
duke@1 | 86 | |
duke@1 | 87 | /** |
duke@1 | 88 | * {@inheritDoc} |
duke@1 | 89 | */ |
duke@1 | 90 | public String getBugId() { |
duke@1 | 91 | return BUG_ID; |
duke@1 | 92 | } |
duke@1 | 93 | |
duke@1 | 94 | /** |
duke@1 | 95 | * {@inheritDoc} |
duke@1 | 96 | */ |
duke@1 | 97 | public String getBugName() { |
duke@1 | 98 | return getClass().getName(); |
duke@1 | 99 | } |
duke@1 | 100 | } |