test/tools/javadoc/enum/docComments/Main.java

Mon, 23 Sep 2013 17:27:38 +0400

author
kizune
date
Mon, 23 Sep 2013 17:27:38 +0400
changeset 2048
809a50f24d6f
parent 554
9d9f26857129
child 2525
2eb010b6cb22
permissions
-rw-r--r--

7154966: CRs found to be in Fixed state with no test and no noreg- keyword.
Reviewed-by: ksrini

     1 /*
     2  * Copyright (c) 2003, 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 4421066
    27  * @summary Verify the comments in an enum type.
    28  * @library ../../lib
    29  * @compile  ../../lib/Tester.java Main.java
    30  * @run main Main
    31  */
    33 import java.io.IOException;
    34 import com.sun.javadoc.*;
    36 public class Main extends Tester.Doclet {
    38     private static final Tester tester =
    39             new Tester("Main", "-package", "pkg1");
    41     public static void main(String[] args) throws IOException {
    42         tester.run();
    43     }
    45     public static boolean start(RootDoc root) {
    46         ClassDoc operation = root.classes()[0];
    47         boolean ok =
    48             checkComment(operation.commentText(), "Arithmetic operations.");
    50         for (FieldDoc f : operation.fields()) {
    51             if (f.name().equals("plus")) {
    52                 ok = checkComment(f.commentText(), "Addition") && ok;
    53                 for (MethodDoc m : operation.methods()) {
    54                     if (m.name().equals("eval")) {
    55                         ok = checkComment(m.commentText(),
    56                                           "Perform arithmetic operation " +
    57                                           "represented by this constant.") &&
    58                             ok;
    59                         break;
    60                     }
    61                 }
    62                 break;
    63             }
    64         }
    65         if (!ok) {
    66             throw new Error("Comments don't match expectations.");
    67         } else {
    68             return true;
    69         }
    70     }
    72     private static boolean checkComment(String found, String expected) {
    73         System.out.println("expected: \"" + expected + "\"");
    74         System.out.println("found:    \"" + found + "\"");
    75         return expected.equals(found);
    76     }
    77 }

mercurial