1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/test/com/sun/javadoc/testTagMisuse/TestTagMisuse.java Sat Dec 01 00:00:00 2007 +0000 1.3 @@ -0,0 +1,86 @@ 1.4 +/* 1.5 + * Copyright 2001-2002 Sun Microsystems, Inc. All Rights Reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. 1.11 + * 1.12 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.14 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.15 + * version 2 for more details (a copy is included in the LICENSE file that 1.16 + * accompanied this code). 1.17 + * 1.18 + * You should have received a copy of the GNU General Public License version 1.19 + * 2 along with this work; if not, write to the Free Software Foundation, 1.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.21 + * 1.22 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.23 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.24 + * have any questions. 1.25 + */ 1.26 + 1.27 +/** 1.28 + * @test 1.29 + * @bug 0000000 1.30 + * @summary Determine if proper warning messages are printed when know. 1.31 + * @author jamieh 1.32 + * @library ../lib/ 1.33 + * @build JavadocTester 1.34 + * @build TestTagMisuse 1.35 + * @run main TestTagMisuse 1.36 + */ 1.37 +public class TestTagMisuse extends JavadocTester { 1.38 + 1.39 + private static final String BUG_ID = "no-bug-id"; 1.40 + private static final String[][] TEST = { 1.41 + {WARNING_OUTPUT, "warning - Tag @param cannot be used in field documentation."}, 1.42 + {WARNING_OUTPUT, "warning - Tag @throws cannot be used in field documentation."}, 1.43 + {WARNING_OUTPUT, "warning - Tag @return cannot be used in constructor documentation."}, 1.44 + {WARNING_OUTPUT, "warning - Tag @throws cannot be used in inline documentation."}, 1.45 + }; 1.46 + private static final String[][] NEGATED_TEST = NO_TEST; 1.47 + private static final String[] ARGS = new String[] { 1.48 + "-d", BUG_ID, SRC_DIR + FS + "TestTagMisuse.java" 1.49 + }; 1.50 + 1.51 + /** 1.52 + * The entry point of the test. 1.53 + * @param args the array of command line arguments. 1.54 + */ 1.55 + public static void main(String[] args) { 1.56 + TestTagMisuse tester = new TestTagMisuse(); 1.57 + run(tester, ARGS, TEST, NEGATED_TEST); 1.58 + tester.printSummary(); 1.59 + } 1.60 + 1.61 + /** 1.62 + * {@inheritDoc} 1.63 + */ 1.64 + public String getBugId() { 1.65 + return BUG_ID; 1.66 + } 1.67 + 1.68 + /** 1.69 + * {@inheritDoc} 1.70 + */ 1.71 + public String getBugName() { 1.72 + return getClass().getName(); 1.73 + } 1.74 + 1.75 + /** 1.76 + * {@throws blah} 1.77 + * Here is a bad field tag: 1.78 + * @throws foo 1.79 + * @param foo. 1.80 + */ 1.81 + public int field; 1.82 + 1.83 + /** 1.84 + * Here is a bad constructor tag: 1.85 + * @return blah 1.86 + */ 1.87 + public TestTagMisuse(){} 1.88 + 1.89 +}