1 /*

     2  * Copyright (c) 2003, 2016, 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  */

    23 

    24 /*

    25  * @test

    26  * @bug 4421066

    27  * @summary Verify the comments in an enum type.

    28  * @library ../../lib

    29  * @modules jdk.javadoc

    30  * @compile  ../../lib/OldToolTester.java Main.java

    31  * @run main Main

    32  */

    33 

    34 import java.io.IOException;

    35 import com.sun.javadoc.*;

    36 

    37 public class Main extends OldToolTester.Doclet {

    38 

    39     private static final OldToolTester tester =

    40             new OldToolTester("Main", "-package", "pkg1");

    41 

    42     public static void main(String[] args) throws IOException {

    43         tester.run();

    44     }

    45 

    46     public static boolean start(RootDoc root) {

    47         ClassDoc operation = root.classes()[0];

    48         boolean ok =

    49             checkComment(operation.commentText(), "Arithmetic operations.");

    50 

    51         for (FieldDoc f : operation.fields()) {

    52             if (f.name().equals("plus")) {

    53                 ok = checkComment(f.commentText(), "Addition") && ok;

    54                 for (MethodDoc m : operation.methods()) {

    55                     if (m.name().equals("eval")) {

    56                         ok = checkComment(m.commentText(),

    57                                           "Perform arithmetic operation " +

    58                                           "represented by this constant.") &&

    59                             ok;

    60                         break;

    61                     }

    62                 }

    63                 break;

    64             }

    65         }

    66         if (!ok) {

    67             throw new Error("Comments don't match expectations.");

    68         } else {

    69             return true;

    70         }

    71     }

    72 

    73     private static boolean checkComment(String found, String expected) {

    74         System.out.println("expected: \"" + expected + "\"");

    75         System.out.println("found:    \"" + found + "\"");

    76         return expected.equals(found);

    77     }

    78 }