langtools/test/jdk/javadoc/tool/enum/docComments/Main.java
author ksrini
Wed, 10 Aug 2016 16:19:09 -0700
changeset 40310 a979695d72a1
parent 35426 374342e56a56
permissions -rw-r--r--
8152054: fix @ignored langtools/test/jdk/javadoc/tool/ tests Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
40310
a979695d72a1 8152054: fix @ignored langtools/test/jdk/javadoc/tool/ tests
ksrini
parents: 35426
diff changeset
     2
 * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2985
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2985
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2985
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug 4421066
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Verify the comments in an enum type.
40310
a979695d72a1 8152054: fix @ignored langtools/test/jdk/javadoc/tool/ tests
ksrini
parents: 35426
diff changeset
    28
 * @ignore 8152313 convert to doclet test framework
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @library ../../lib
30730
d3ce7619db2c 8076543: Add @modules as needed to the langtools tests
akulyakh
parents: 5520
diff changeset
    30
 * @modules jdk.javadoc
2985
f43e1241e7fb 6843761: Update langtools tests to remove unncessary -source and -target options
darcy
parents: 10
diff changeset
    31
 * @compile  ../../lib/Tester.java Main.java
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @run main Main
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
import java.io.IOException;
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    36
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
import com.sun.javadoc.*;
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    38
import jdk.javadoc.doclet.DocletEnvironment;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
public class Main extends Tester.Doclet {
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    private static final Tester tester =
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
            new Tester("Main", "-package", "pkg1");
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    public static void main(String[] args) throws IOException {
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
        tester.run();
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 30730
diff changeset
    49
    public static boolean run(DocletEnvironment root) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
        ClassDoc operation = root.classes()[0];
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
        boolean ok =
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
            checkComment(operation.commentText(), "Arithmetic operations.");
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
        for (FieldDoc f : operation.fields()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
            if (f.name().equals("plus")) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
                ok = checkComment(f.commentText(), "Addition") && ok;
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
                for (MethodDoc m : operation.methods()) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
                    if (m.name().equals("eval")) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
                        ok = checkComment(m.commentText(),
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
                                          "Perform arithmetic operation " +
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
                                          "represented by this constant.") &&
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
                            ok;
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
                        break;
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
                    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
                }
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
                break;
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
            }
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
        if (!ok) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
            throw new Error("Comments don't match expectations.");
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
        } else {
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
            return true;
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    private static boolean checkComment(String found, String expected) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        System.out.println("expected: \"" + expected + "\"");
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        System.out.println("found:    \"" + found + "\"");
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        return expected.equals(found);
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
}