GEODE-7574: fix javadoc warnings (apache#4472)

Authored-by: Joris Melchior <[email protected]>
jiarong4 · Dec 13, 2019 · 5b1b733 · 5b1b733
1 parent 5928982
commit 5b1b733
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/geode-management/src/main/java/org/apache/geode/management/configuration/AutoSerializer.java b/geode-management/src/main/java/org/apache/geode/management/configuration/AutoSerializer.java
@@ -26,8 +26,8 @@
 import org.apache.geode.management.api.ClusterManagementService;
 
 /**
- * The configuration of a {@link org.apache.geode.pdx.ReflectionBasedAutoSerializer}
- * that is used for easy PDX serialization.
+ * The configuration of a org.apache.geode.pdx.ReflectionBasedAutoSerializer
+ * found in the geode-core module that is used for easy PDX serialization.
  * At least one pattern is required if the AutoSerializer is used for a
  * {@link ClusterManagementService#create}.
  */

diff --git a/geode-management/src/main/java/org/apache/geode/management/configuration/ClassName.java b/geode-management/src/main/java/org/apache/geode/management/configuration/ClassName.java
@@ -30,8 +30,9 @@
 
 /**
  * Used to configure an attribute that represents an instance of a java class.
- * If the class implements {@link org.apache.geode.cache.Declarable} then
- * properties can also be configured that will be used to initialize the instance.
+ * If the class implements the org.apache.geode.cache.Declarable interface from the
+ * geode-core module then properties can also be configured that will be
+ * used to initialize the instance.
  */
 public class ClassName implements Serializable {
   private static final long serialVersionUID = 1L;
@@ -60,7 +61,8 @@ public ClassName(String className) {
    *
    * @param className this class needs to have a no-arg constructor
    * @param jsonInitProperties a json representation of the initialization properties
-   *        that will be passed to {@link org.apache.geode.cache.Declarable#initialize}.
+   *        that will be passed to {@code org.apache.geode.cache.Declarable#initialize}
+   *        in the geode-core module.
    *        If the className is not Declarable, then these properties will be ignored
    * @throws IllegalArgumentException if the class name is not valid
    * @throws IllegalArgumentException if jsonInitProperties is invalid JSON
@@ -84,7 +86,8 @@ private static Properties createProperties(String jsonInitProperties) {
    * @param className the name of the class to be instantiated. This class needs to have
    *        a no-arg constructor.
    * @param properties the initialization properties
-   *        that will be passed to {@link org.apache.geode.cache.Declarable#initialize}.
+   *        that will be passed to {@code org.apache.geode.cache.Declarable#initialize}
+   *        in the geode-core module.
    *        If the className is not Declarable, then these properties will be ignored
    *
    * @throws IllegalArgumentException if classname contains illegal classname characters

diff --git a/geode-management/src/main/java/org/apache/geode/management/configuration/Pdx.java b/geode-management/src/main/java/org/apache/geode/management/configuration/Pdx.java
@@ -73,7 +73,8 @@ public Boolean isReadSerialized() {
 
   /**
    * Setting readSerialized to true causes any pdx deserialization to produce
-   * instances of {@link org.apache.geode.pdx.PdxInstance} instead of a domain class instance.
+   * instances of org.apache.geode.pdx.PdxInstance interface in the geode-core module
+   * instead of a domain class instance.
    */
   public void setReadSerialized(Boolean readSerialized) {
     this.readSerialized = readSerialized;
@@ -85,7 +86,7 @@ public ClassName getPdxSerializer() {
 
   /**
    * @param pdxSerializer the class name given must implement the
-   *        {@link org.apache.geode.pdx.PdxSerializer} interface
+   *        org.apache.geode.pdx.PdxSerializer interface from the geode-core module.
    * @throws IllegalArgumentException if an autoSerializer has already been set
    */
   public void setPdxSerializer(ClassName pdxSerializer) {