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