Mercurial > jdk8-mips64-public > langtools / annotate
test/com/sun/javadoc/testTagMisuse/TestTagMisuse.java@22c4c1143a3a (annotated)
test/com/sun/javadoc/testTagMisuse/TestTagMisuse.java
Wed, 15 Oct 2008 08:07:59 -0700
- author
- jjg
- date
- Wed, 15 Oct 2008 08:07:59 -0700
- changeset 140
- 22c4c1143a3a
- parent 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
6748541: javadoc should be reusable
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 2001-2002 Sun Microsystems, Inc. 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 | * |
| duke@1 | 19 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 20 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 21 | * have any questions. |
| duke@1 | 22 | */ |
| duke@1 | 23 | |
| duke@1 | 24 | /** |
| duke@1 | 25 | * @test |
| duke@1 | 26 | * @bug 0000000 |
| duke@1 | 27 | * @summary Determine if proper warning messages are printed when know. |
| duke@1 | 28 | * @author jamieh |
| duke@1 | 29 | * @library ../lib/ |
| duke@1 | 30 | * @build JavadocTester |
| duke@1 | 31 | * @build TestTagMisuse |
| duke@1 | 32 | * @run main TestTagMisuse |
| duke@1 | 33 | */ |
| duke@1 | 34 | public class TestTagMisuse extends JavadocTester { |
| duke@1 | 35 | |
| duke@1 | 36 | private static final String BUG_ID = "no-bug-id"; |
| duke@1 | 37 | private static final String[][] TEST = { |
| duke@1 | 38 | {WARNING_OUTPUT, "warning - Tag @param cannot be used in field documentation."}, |
| duke@1 | 39 | {WARNING_OUTPUT, "warning - Tag @throws cannot be used in field documentation."}, |
| duke@1 | 40 | {WARNING_OUTPUT, "warning - Tag @return cannot be used in constructor documentation."}, |
| duke@1 | 41 | {WARNING_OUTPUT, "warning - Tag @throws cannot be used in inline documentation."}, |
| duke@1 | 42 | }; |
| duke@1 | 43 | private static final String[][] NEGATED_TEST = NO_TEST; |
| duke@1 | 44 | private static final String[] ARGS = new String[] { |
| duke@1 | 45 | "-d", BUG_ID, SRC_DIR + FS + "TestTagMisuse.java" |
| duke@1 | 46 | }; |
| duke@1 | 47 | |
| duke@1 | 48 | /** |
| duke@1 | 49 | * The entry point of the test. |
| duke@1 | 50 | * @param args the array of command line arguments. |
| duke@1 | 51 | */ |
| duke@1 | 52 | public static void main(String[] args) { |
| duke@1 | 53 | TestTagMisuse tester = new TestTagMisuse(); |
| duke@1 | 54 | run(tester, ARGS, TEST, NEGATED_TEST); |
| duke@1 | 55 | tester.printSummary(); |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | /** |
| duke@1 | 59 | * {@inheritDoc} |
| duke@1 | 60 | */ |
| duke@1 | 61 | public String getBugId() { |
| duke@1 | 62 | return BUG_ID; |
| duke@1 | 63 | } |
| duke@1 | 64 | |
| duke@1 | 65 | /** |
| duke@1 | 66 | * {@inheritDoc} |
| duke@1 | 67 | */ |
| duke@1 | 68 | public String getBugName() { |
| duke@1 | 69 | return getClass().getName(); |
| duke@1 | 70 | } |
| duke@1 | 71 | |
| duke@1 | 72 | /** |
| duke@1 | 73 | * {@throws blah} |
| duke@1 | 74 | * Here is a bad field tag: |
| duke@1 | 75 | * @throws foo |
| duke@1 | 76 | * @param foo. |
| duke@1 | 77 | */ |
| duke@1 | 78 | public int field; |
| duke@1 | 79 | |
| duke@1 | 80 | /** |
| duke@1 | 81 | * Here is a bad constructor tag: |
| duke@1 | 82 | * @return blah |
| duke@1 | 83 | */ |
| duke@1 | 84 | public TestTagMisuse(){} |
| duke@1 | 85 | |
| duke@1 | 86 | } |
