8241631: PropertyGetterTaglet, PropertySetterTaglet may be removed

Reviewed-by: hannesw
2020-03-27 11:24:40 -07:00 · 2020-03-27 11:24:40 -07:00 · ccc699600f
commit ccc699600f
parent c17ed6a5e5
10 changed files with 1 additions and 181 deletions
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
@ -86,8 +86,6 @@ doclet.not_standard_file_manager = Cannot set taglet path; the file manager is n
 doclet.Author=Author:
 doclet.DefaultValue=Default value:
 doclet.PropertyDescription=Property description:
-doclet.PropertyGetter=Gets the value of the property
-doclet.PropertySetter=Sets the value of the property
 doclet.PropertyGetterWithName=Gets the value of the property {0}.
 doclet.PropertySetterWithName=Sets the value of the property {0}.
 doclet.Default=Default:
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/BasePropertyTaglet.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/BasePropertyTaglet.java
@ -1,63 +0,0 @@
-/*
- * Copyright (c) 2001, 2020, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation.  Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-
-package jdk.javadoc.internal.doclets.toolkit.taglets;
-
-import java.util.EnumSet;
-import javax.lang.model.element.Element;
-
-import com.sun.source.doctree.DocTree;
-import jdk.javadoc.doclet.Taglet.Location;
-import jdk.javadoc.internal.doclets.toolkit.Content;
-
-/**
- * An abstract class that implements the {@link Taglet} interface and
- * serves as a base for JavaFX property getter and setter taglets.
- *
- *  <p><b>This is NOT part of any supported API.
- *  If you write code that depends on this, you do so at your own risk.
- *  This code and its internal interfaces are subject to change or
- *  deletion without notice.</b>
- *
- */
-public abstract class BasePropertyTaglet extends BaseTaglet {
-
-    public BasePropertyTaglet(String name) {
-        super(name, false, EnumSet.of(Location.METHOD));
-    }
-
-    /**
-     * Returns the text to be included in the documentation before the property name.
-     *
-     * @param tagletWriter the taglet-writer used by the doclet
-     * @return the text to be included in the documentation before the property name
-     */
-    abstract String getText(TagletWriter tagletWriter);
-
-    @Override
-    public Content getTagletOutput(Element element, DocTree tag, TagletWriter tagletWriter) {
-        return tagletWriter.propertyTagOutput(element, tag, getText(tagletWriter));
-    }
-}
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/PropertyGetterTaglet.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/PropertyGetterTaglet.java
@ -1,50 +0,0 @@
-/*
- * Copyright (c) 2001, 2020, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation.  Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-
-package jdk.javadoc.internal.doclets.toolkit.taglets;
-
-/**
- * A taglet that adds the initial line of documentation to the JavaFX
- * property getters.
- *
- *  <p><b>This is NOT part of any supported API.
- *  If you write code that depends on this, you do so at your own risk.
- *  This code and its internal interfaces are subject to change or
- *  deletion without notice.</b>
- */
-public class PropertyGetterTaglet extends BasePropertyTaglet {
-
-    /**
-     * Construct a new PropertyGetterTaglet.
-     */
-    public PropertyGetterTaglet () {
-        super("propertyGetter");
-    }
-
-    @Override
-    String getText(TagletWriter tagletWriter) {
-        return tagletWriter.configuration().getDocResources().getText("doclet.PropertyGetter");
-    }
-}
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/PropertySetterTaglet.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/PropertySetterTaglet.java
@ -1,50 +0,0 @@
-/*
- * Copyright (c) 2001, 2020, Oracle and/or its affiliates. All rights reserved.
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * This code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 only, as
- * published by the Free Software Foundation.  Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * This code is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
- * version 2 for more details (a copy is included in the LICENSE file that
- * accompanied this code).
- *
- * You should have received a copy of the GNU General Public License version
- * 2 along with this work; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- *
- * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
- * or visit www.oracle.com if you need additional information or have any
- * questions.
- */
-
-package jdk.javadoc.internal.doclets.toolkit.taglets;
-
-/**
- * A taglet that adds the initial line of documentation to the JavaFX
- * property setters.
- *
- *  <p><b>This is NOT part of any supported API.
- *  If you write code that depends on this, you do so at your own risk.
- *  This code and its internal interfaces are subject to change or
- *  deletion without notice.</b>
- */
-public class PropertySetterTaglet extends BasePropertyTaglet {
-
-    /**
-     * Construct a new PropertySetterTaglet.
-     */
-    public PropertySetterTaglet () {
-        super("propertySetter");
-    }
-
-    @Override
-    String getText(TagletWriter tagletWriter) {
-        return tagletWriter.configuration().getDocResources().getText("doclet.PropertySetter");
-    }
-}
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java
@ -672,8 +672,6 @@ public class TagletManager {
     * Initialize JavaFX-related tags.
     */
    private void initJavaFXTaglets() {
-        addStandardTaglet(new PropertyGetterTaglet());
-        addStandardTaglet(new PropertySetterTaglet());
        addStandardTaglet(new SimpleTaglet("propertyDescription",
                resources.getText("doclet.PropertyDescription"),
                EnumSet.of(Location.METHOD, Location.FIELD)));
--- a/test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java
+++ b/test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java
@ -78,8 +78,6 @@ public class TestJavaFX extends JavadocTester {
                "<dt>Default value:</dt>",
                "<dt>Since:</dt>\n"
                + "<dd>JavaFX 8.0</dd>",
-                "<p>Sets the value of the property <code>Property</code>",
-                "<p>Gets the value of the property <code>Property</code>",
                "<dt>Property description:</dt>",
                "<th class=\"col-second\" scope=\"row\"><code><span class=\"member-name-link\">"
                + "<a href=\"#setTestMethodProperty()\">"
--- a/test/langtools/jdk/javadoc/doclet/testJavaFX/pkg1/C.java
+++ b/test/langtools/jdk/javadoc/doclet/testJavaFX/pkg1/C.java
@ -26,13 +26,11 @@ package pkg1;
 public class C {

    /**
-     * @propertySetter Property
     * @propertyDescription PropertyDescription
     */
    public void CC() {}

    /**
-     * @propertyGetter Property
     *
     */
    public void B() {}
--- a/test/langtools/jdk/javadoc/doclet/testSearch/pkgfx/C.java
+++ b/test/langtools/jdk/javadoc/doclet/testSearch/pkgfx/C.java
@ -26,13 +26,11 @@ package pkgfx;
 public class C {

    /**
-     * @propertySetter Property
     * @propertyDescription PropertyDescription
     */
    public void CC() {}

    /**
-     * @propertyGetter Property
     *
     */
    public void B() {}
--- a/test/langtools/jdk/javadoc/doclet/testTaglets/TestTaglets.out
+++ b/test/langtools/jdk/javadoc/doclet/testTaglets/TestTaglets.out
@ -13,8 +13,6 @@
          {@literal}: ..... overview module package type constructor method field inline ........
              @param: block ........ ...... ....... type constructor method ..... ...... ........
@propertyDescription: block ........ ...... ....... .... ........... method field ...... ........
-     @propertyGetter: block ........ ...... ....... .... ........... method ..... ...... ........
-     @propertySetter: block ........ ...... ....... .... ........... method ..... ...... ........
           @provides: block ........ module ....... .... ........... ...... ..... ...... ........
             @return: block ........ ...... ....... .... ........... method ..... ...... ........
                @see: block overview module package type constructor method field ...... ........
--- a/test/langtools/jdk/javadoc/tool/sampleapi/lib/sampleapi/generator/DocCommentGenerator.java
+++ b/test/langtools/jdk/javadoc/tool/sampleapi/lib/sampleapi/generator/DocCommentGenerator.java
@ -67,8 +67,6 @@ class DocCommentGenerator {
        SERIAL("@serial", ""),
        SERIALDATA("@serialData", "The types and order of data could be here."),
        SERIALFIELD("@serialField", "\n        Serial field in special array"),
-        FX_PROPSETTER("@propertySetter", "Set the property"),
-        FX_PROPGETTER("@propertyGetter", "Get the property"),
        FX_PROPDESC("@propertyDescription", ""),
        FX_DEFVALUE("@defaultValue", ""),
        FX_TREATASPRIVATE("@treatAsPrivate", "");
@ -384,10 +382,7 @@ class DocCommentGenerator {

        if (isFxStyle) {
            // @propertySetter/Getter + Description
-            if ("void".equals(retType.toString())) {
-                buildComment += Tag.FX_PROPSETTER + "\n";
-            } else {
-                buildComment += Tag.FX_PROPGETTER + "\n";
+            if (!"void".equals(retType.toString())) {
                buildComment += Tag.FX_DEFVALUE.value(defValue(retType.toString()))
                                + "\n";
            }