Fix javadocs warnings in the sdk-core package (#3992)

Author: sugmanue

.changes/next-release/documentation-AWSSDKforJavav2-9718507.json

@@ -0,0 +1,6 @@
+{
+    "category": "AWS SDK for Java v2", 
+    "contributor": "sugmanue", 
+    "type": "documentation", 
+    "description": "Fix javadoc warnings in the sdk-core package."
+}

core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkNumber.java

@@ -27,20 +27,23 @@
  * An in-memory representation of Number being given to a service or being returned by a service.
  * This is a SDK representation of a Number. This allows conversion to any desired numeric type by providing constructors
  * as below
- * @see #fromBigDecimal(BigDecimal) to create from a BigDecimal.
- * @see #fromBigInteger(BigInteger) to create from a BigInteger.
- * @see #fromDouble(double) to create from a double
- * @see #fromFloat(float) to create from a float.
- * @see #fromLong(long) to create from a long.
- * @see #fromShort(short) to create from a short.
- * @see #fromInteger(int) to create from an integer.
- * @see #fromString(String)  to create from a Stringl,
- * Thus by doing this, this class is able to preserve arbitrary precison of any given number.
+ * <ul>
+ *   <li>{@link #fromBigDecimal(BigDecimal)} to create from a BigDecimal.</li>
+ *   <li>{@link #fromBigInteger(BigInteger)} to create from a BigInteger.</li>
+ *   <li>{@link #fromDouble(double)} to create from a double</li>
+ *   <li>{@link #fromFloat(float)} to create from a float.</li>
+ *   <li>{@link #fromLong(long)} to create from a long.</li>
+ *   <li>{@link #fromShort(short)} to create from a short.</li>
+ *   <li>{@link #fromInteger(int)} to create from an integer.</li>
+ *   <li>{@link #fromString(String)}  to create from a String</li>
+ * </ul>
  *
+ * Thus, by doing this, this class is able to preserve arbitrary precision of any given number.
+ * <p>
  * If {@link SdkNumber} is expected in a particular number format then its corresponding getter methods can be used.
+ * <p>
  * Example for a {@link SdkNumber} created with {@link BigDecimal} the
- * @see #fromBigDecimal(BigDecimal) can be used.
-
+ * {@link #fromBigDecimal(BigDecimal)} can be used.
  */
 @SdkPublicApi
 @Immutable

core/sdk-core/src/main/java/software/amazon/awssdk/core/async/AsyncRequestBody.java

@@ -208,8 +208,8 @@ static BlockingInputStreamAsyncRequestBody forBlockingInputStream(Long contentLe
      * Creates a {@link BlockingOutputStreamAsyncRequestBody} to use for writing to the downstream service as if it's an output
      * stream. Retries are not supported for this request body.
      *
-     * <p>The caller is responsible for calling {@link OutputStream#close()} on the {@link #outputStream()} when writing is
-     * complete.
+     * <p>The caller is responsible for calling {@link OutputStream#close()} on the
+     * {@link BlockingOutputStreamAsyncRequestBody#outputStream()} when writing is complete.
      *
      * <p><b>Example Usage</b>
      * <p>

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/http/pipeline/stages/ApiCallAttemptTimeoutTrackingStage.java

@@ -56,9 +56,8 @@ public ApiCallAttemptTimeoutTrackingStage(HttpClientDependencies dependencies,
 
     /**
      * Start and end api call attempt timer around the execution of the api call attempt. It's important
-     * that the client execution task is canceled before the InterruptedException is handled by
-     * {@link ApiCallTimeoutTrackingStage#wrapped#execute(SdkHttpFullRequest)} so the interrupt status doesn't leak out to the
-     * callers code.
+     * that the client execution task is canceled before the InterruptedException is handled by the wrapped
+     * {@link RequestPipeline#execute} call so the interrupt status doesn't leak out to the callers code.
      */
     @Override
     public Response<OutputT> execute(SdkHttpFullRequest request, RequestExecutionContext context) throws Exception {

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/io/AwsChunkedEncodingInputStream.java

@@ -32,7 +32,7 @@
  * which is added at the head of each chunk.<br>
  * The default chunk size cannot be customized, since we need to calculate
  * the expected encoded stream length before reading the wrapped stream.<br>
- * This class will use the mark() & reset() of the wrapped InputStream if they
+ * This class will use the mark() &amp; reset() of the wrapped InputStream if they
  * are supported, otherwise it will create a buffer for bytes read from
  * the wrapped stream.
  */

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/retry/RateLimitingTokenBucket.java

@@ -73,7 +73,7 @@ public RateLimitingTokenBucket() {
      *
      *   _TokenBucketRefill()
      *   # Next see if we have enough capacity for the requested amount.
-     *   if amount <= current_capacity
+     *   if amount &lt;= current_capacity
      *     current_capacity = current_capacity - amount
      *   else
      *     sleep((amount - current_capacity) / fill_rate)
@@ -108,7 +108,7 @@ public boolean acquire(double amount) {
      *
      *   _TokenBucketRefill()
      *   # Next see if we have enough capacity for the requested amount.
-     *   if amount <= current_capacity
+     *   if amount &lt;= current_capacity
      *     current_capacity = current_capacity - amount
      *   else
      *     sleep((amount - current_capacity) / fill_rate)

core/sdk-core/src/main/java/software/amazon/awssdk/core/retry/backoff/BackoffStrategy.java

@@ -27,7 +27,7 @@ public interface BackoffStrategy {
 
     /**
      * Max permitted retry times. To prevent exponentialDelay from overflow, there must be 2 ^ retriesAttempted
-     * <= 2 ^ 31 - 1, which means retriesAttempted <= 30, so that is the ceil for retriesAttempted.
+     * &lt;= 2 ^ 31 - 1, which means retriesAttempted &lt;= 30, so that is the ceil for retriesAttempted.
      */
     int RETRIES_ATTEMPTED_CEILING = (int) Math.floor(Math.log(Integer.MAX_VALUE) / Math.log(2));
 

core/sdk-core/src/main/java/software/amazon/awssdk/core/traits/Trait.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.core.traits;
 
 import software.amazon.awssdk.annotations.SdkProtectedApi;
+import software.amazon.awssdk.core.SdkField;
 
 /**
  * Marker interface for traits that contain additional metadata about {@link SdkField}s.