test/com/sun/javadoc/testTagMisuse/TestTagMisuse.java

Wed, 01 Dec 2010 11:02:38 -0800

author
bpatel
date
Wed, 01 Dec 2010 11:02:38 -0800
changeset 766
90af8d87741f
parent 554
9d9f26857129
child 1490
fc4cb1577ad6
permissions
-rw-r--r--

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

     1 /*
     2  * Copyright (c) 2001, 2002, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.
     8  *
     9  * This code is distributed in the hope that it will be useful, but WITHOUT
    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    12  * version 2 for more details (a copy is included in the LICENSE file that
    13  * accompanied this code).
    14  *
    15  * You should have received a copy of the GNU General Public License version
    16  * 2 along with this work; if not, write to the Free Software Foundation,
    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    18  *
    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    20  * or visit www.oracle.com if you need additional information or have any
    21  * questions.
    22  */
    24 /**
    25  * @test
    26  * @bug 0000000
    27  * @summary Determine if proper warning messages are printed when know.
    28  * @author jamieh
    29  * @library ../lib/
    30  * @build JavadocTester
    31  * @build TestTagMisuse
    32  * @run main TestTagMisuse
    33  */
    34 public class TestTagMisuse extends JavadocTester {
    36     private static final String BUG_ID = "no-bug-id";
    37     private static final String[][] TEST = {
    38         {WARNING_OUTPUT, "warning - Tag @param cannot be used in field documentation."},
    39         {WARNING_OUTPUT, "warning - Tag @throws cannot be used in field documentation."},
    40         {WARNING_OUTPUT, "warning - Tag @return cannot be used in constructor documentation."},
    41         {WARNING_OUTPUT, "warning - Tag @throws cannot be used in inline documentation."},
    42     };
    43     private static final String[][] NEGATED_TEST = NO_TEST;
    44     private static final String[] ARGS = new String[] {
    45         "-d", BUG_ID, SRC_DIR + FS + "TestTagMisuse.java"
    46     };
    48     /**
    49      * The entry point of the test.
    50      * @param args the array of command line arguments.
    51      */
    52     public static void main(String[] args) {
    53         TestTagMisuse tester = new TestTagMisuse();
    54         run(tester, ARGS, TEST, NEGATED_TEST);
    55         tester.printSummary();
    56     }
    58     /**
    59      * {@inheritDoc}
    60      */
    61     public String getBugId() {
    62         return BUG_ID;
    63     }
    65     /**
    66      * {@inheritDoc}
    67      */
    68     public String getBugName() {
    69         return getClass().getName();
    70     }
    72     /**
    73      * {@throws blah}
    74      * Here is a bad field tag:
    75      * @throws foo
    76      * @param foo.
    77      */
    78     public int field;
    80     /**
    81      * Here is a bad constructor tag:
    82      * @return blah
    83      */
    84     public TestTagMisuse(){}
    86 }

mercurial