[geode] branch develop updated: GEODE-10023: do not @link to type params (#7601)

[do...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

donalevans pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git


The following commit(s) were added to refs/heads/develop by this push:
     new f7eb7359a2 GEODE-10023: do not @link to type params (#7601)
f7eb7359a2 is described below

commit f7eb7359a229a75caa1e8c491588d138218a0144
Author: Donal Evans <do...@vmware.com>
AuthorDate: Mon Apr 18 09:19:43 2022 -0700

    GEODE-10023: do not @link to type params (#7601)
    
    Some javadocs contained @link tags pointing to type parameters. These
    should have been @code tags, as type parameters cannot be linked to
    
    Authored-by: Donal Evans <do...@vmware.com>
---
 .../src/main/java/org/apache/geode/services/result/Result.java    | 8 ++++----
 .../main/java/org/apache/geode/services/result/impl/Success.java  | 2 +-
 .../geode/management/api/ClusterManagementOperationResult.java    | 2 +-
 .../geode/management/api/ClusterManagementRealizationResult.java  | 2 +-
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/geode-core/src/main/java/org/apache/geode/services/result/Result.java b/geode-core/src/main/java/org/apache/geode/services/result/Result.java
index 350dc9b0f2..ebdd155803 100644
--- a/geode-core/src/main/java/org/apache/geode/services/result/Result.java
+++ b/geode-core/src/main/java/org/apache/geode/services/result/Result.java
@@ -30,27 +30,27 @@ import org.apache.geode.annotations.Experimental;
 @Experimental
 public interface Result<SuccessType, FailureType> {
   /**
-   * A mapping function that maps to either {@link SuccessType} or {@link FailureType} depending on
+   * A mapping function that maps to either {@code SuccessType} or {@code FailureType} depending on
    * success or
    * failure of the operation.
    *
    * @param successFunction the mapping function to map the SuccessType to the resultant type
    * @param errorFunction the mapping function to map the FailureType to the resultant error type
    * @param <T> the resultant type
-   * @return result of type {@link T}
+   * @return result of type {@code T}
    */
   <T> T map(Function<SuccessType, T> successFunction,
       Function<FailureType, T> errorFunction);
 
   /**
-   * The return message of a successful operation. The return type is of type {@link SuccessType}
+   * The return message of a successful operation. The return type is of type {@code SuccessType}
    *
    * @return the result of the operation
    */
   SuccessType getMessage();
 
   /**
-   * The return message of a failed operation. The return type is of type {@link FailureType}
+   * The return message of a failed operation. The return type is of type {@code FailureType}
    *
    * @return the failure message of why the operation did not succeed.
    */
diff --git a/geode-core/src/main/java/org/apache/geode/services/result/impl/Success.java b/geode-core/src/main/java/org/apache/geode/services/result/impl/Success.java
index 11017392d5..481e98fc42 100644
--- a/geode-core/src/main/java/org/apache/geode/services/result/impl/Success.java
+++ b/geode-core/src/main/java/org/apache/geode/services/result/impl/Success.java
@@ -23,7 +23,7 @@ import org.apache.geode.services.result.ServiceResult;
 
 /**
  * This type of {@link ServiceResult} represents a successful operation. It contains the
- * return value of type {@link SuccessType}
+ * return value of type {@code SuccessType}
  *
  * @param <SuccessType> the result type for a successful operation.
  *
diff --git a/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementOperationResult.java b/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementOperationResult.java
index 6637292daa..9a4fe20eb7 100644
--- a/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementOperationResult.java
+++ b/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementOperationResult.java
@@ -52,7 +52,7 @@ public class ClusterManagementOperationResult<A extends ClusterManagementOperati
   /**
    * normally called by {@link ClusterManagementService#start(ClusterManagementOperation)}
    *
-   * @param statusCode the {@link StatusCode} of the result
+   * @param statusCode the {@code StatusCode} of the result
    * @param message the status message to set
    * @param operationStart a {@link Date} representing the time the operation started
    * @param operationEnd a {@link Date} representing the time the operation ended
diff --git a/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementRealizationResult.java b/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementRealizationResult.java
index 56ab28a0a2..1797085521 100644
--- a/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementRealizationResult.java
+++ b/geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementRealizationResult.java
@@ -35,7 +35,7 @@ public class ClusterManagementRealizationResult extends ClusterManagementResult
   /**
    * for internal use only
    *
-   * @param statusCode the {@link StatusCode} to set
+   * @param statusCode the {@code StatusCode} to set
    * @param message the status message to set
    */
   public ClusterManagementRealizationResult(StatusCode statusCode, String message) {