SP-992 Clean up warnings in JavaDoc generation

bitpay · Jul 12, 2024 · cf4e2d9 · cf4e2d9
1 parent 9c1aab9
commit cf4e2d9
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 5 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.bitpay</groupId>
     <artifactId>bitpay_sdk</artifactId>
-    <version>10.0.3</version>
+    <version>10.0.4</version>
     <packaging>jar</packaging>
 
     <name>BitPay</name>

diff --git a/src/main/java/com/bitpay/sdk/Config.java b/src/main/java/com/bitpay/sdk/Config.java
@@ -34,7 +34,7 @@ public class Config {
     /**
      * BitPay Plugin Info Version.
      */
-    public static final String BITPAY_PLUGIN_INFO = "BitPay_Java_Client_v10.0.3";
+    public static final String BITPAY_PLUGIN_INFO = "BitPay_Java_Client_v10.0.4";
     /**
      * BitPay Api Frame.
      */

diff --git a/src/main/java/com/bitpay/sdk/client/CurrencyClient.java b/src/main/java/com/bitpay/sdk/client/CurrencyClient.java
@@ -58,6 +58,7 @@ public static CurrencyClient getInstance(BitPayClient bitPayClient) throws BitPa
      *
      * @param currencyCode String Currency code for which the info will be retrieved.
      * @return Map |null
+     * @throws BitPayGenericException BitPayGenericException class
      */
     @SuppressWarnings("unchecked")
     public Map<String, Object> getInfo(String currencyCode) throws BitPayGenericException {

diff --git a/src/main/java/com/bitpay/sdk/client/RefundClient.java b/src/main/java/com/bitpay/sdk/client/RefundClient.java
@@ -79,8 +79,8 @@ public static RefundClient getInstance(
      *
      * @param refund Refund request data
      * @return Refund
-`    * @throws BitPayApiException BitPayApiException class
-     * @throws BitPayGenericException BitPayGenericException class`
+     * @throws BitPayApiException BitPayApiException class
+     * @throws BitPayGenericException BitPayGenericException class
      */
     public Refund create(final Refund refund) throws BitPayApiException, BitPayGenericException {
         if (Objects.isNull(refund)) {
@@ -146,6 +146,7 @@ public Refund getById(final String refundId) throws BitPayApiException, BitPayGe
      * @param guid Guid
      * @return Refund
      * @throws BitPayApiException BitPayException
+     * @throws BitPayGenericException BitPayGenericException class
      */
     public Refund getByGuid(final String guid) throws BitPayApiException, BitPayGenericException {
         validateRefundId(guid);

diff --git a/src/main/java/com/bitpay/sdk/util/KeyUtils.java b/src/main/java/com/bitpay/sdk/util/KeyUtils.java
@@ -66,6 +66,7 @@ public static ECKey createEcKey() {
      *
      * @param privateKey the private key
      * @return the ec key
+     * @throws BitPayGenericException BitPayGenericException class
      */
     public static ECKey createEcKeyFromHexString(String privateKey) throws BitPayGenericException {
         byte[] bytes = hexToBytes(privateKey);
@@ -78,6 +79,7 @@ public static ECKey createEcKeyFromHexString(String privateKey) throws BitPayGen
      *
      * @param privKeyFile the priv key file
      * @return the ec key
+     * @throws BitPayGenericException BitPayGenericException class
      * @throws IOException the io exception
      */
     public static ECKey createEcKeyFromHexStringFile(String privKeyFile) throws IOException, BitPayGenericException {

diff --git a/src/test/java/com/bitpay/sdk/ConfigTest.java b/src/test/java/com/bitpay/sdk/ConfigTest.java
@@ -58,7 +58,7 @@ public void it_should_returns_bitpay_api_version() {
 
     @Test
     public void it_should_returns_bitpay_plugin_info() {
-        Assertions.assertTrue(Config.BITPAY_PLUGIN_INFO.contains("BitPay_Java_Client_v10.0.3"));
+        Assertions.assertTrue(Config.BITPAY_PLUGIN_INFO.contains("BitPay_Java_Client_v10.0.4"));
     }
 
     @Test
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,7 +58,7 @@ public void it_should_returns_bitpay_api_version() { @@
         @Test
         public void it_should_returns_bitpay_plugin_info() {
-            Assertions.assertTrue(Config.BITPAY_PLUGIN_INFO.contains("BitPay_Java_Client_v10.0.3"));
+            Assertions.assertTrue(Config.BITPAY_PLUGIN_INFO.contains("BitPay_Java_Client_v10.0.4"));
         }
         @Test
@@ Expand Down @@