GEODE-10023: do not @link to type params (apache#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 <[email protected]>
ringles · Apr 18, 2022 · f7eb735 · f7eb735
1 parent d54083c
commit f7eb735
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 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
@@ -30,27 +30,27 @@
 @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
@@ -23,7 +23,7 @@
 
 /**
  * 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/...ement/src/main/java/org/apache/geode/management/api/ClusterManagementOperationResult.java b/...ement/src/main/java/org/apache/geode/management/api/ClusterManagementOperationResult.java
@@ -52,7 +52,7 @@ public ClusterManagementOperationResult() {}
   /**
    * 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/...ent/src/main/java/org/apache/geode/management/api/ClusterManagementRealizationResult.java b/...ent/src/main/java/org/apache/geode/management/api/ClusterManagementRealizationResult.java
@@ -35,7 +35,7 @@ public ClusterManagementRealizationResult() {}
   /**
    * 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) {