From a4befe76a14ac13267d9f706a1cbc4054116e6ec Mon Sep 17 00:00:00 2001 From: Carlos Tribiec Date: Thu, 21 Mar 2024 08:47:14 -0400 Subject: [PATCH] docs: javadocs adjustments --- .../cl/transbank/common/IntegrationTypeHelper.java | 4 ++++ .../cl/transbank/exception/TransbankException.java | 12 ++++++++++++ src/main/java/cl/transbank/util/HttpUtilImpl.java | 1 + .../java/cl/transbank/util/WebpayApiResource.java | 5 +++++ 4 files changed, 22 insertions(+) diff --git a/src/main/java/cl/transbank/common/IntegrationTypeHelper.java b/src/main/java/cl/transbank/common/IntegrationTypeHelper.java index 0b73d78..42b5719 100644 --- a/src/main/java/cl/transbank/common/IntegrationTypeHelper.java +++ b/src/main/java/cl/transbank/common/IntegrationTypeHelper.java @@ -7,6 +7,8 @@ public class IntegrationTypeHelper { /** * Returns the Webpay integration type based on the provided integration type. + * @param integrationType The integration type. + * @return The Webpay integration URL. */ public static String getWebpayIntegrationType( IntegrationType integrationType @@ -27,6 +29,8 @@ public static String getWebpayIntegrationType( /** * Returns the Patpass integration type based on the provided integration type. + * @param integrationType The integration type. + * @return The Patpass integration URL. */ public static String getPatpassIntegrationType( IntegrationType integrationType diff --git a/src/main/java/cl/transbank/exception/TransbankException.java b/src/main/java/cl/transbank/exception/TransbankException.java index 61d04c4..f2e63df 100644 --- a/src/main/java/cl/transbank/exception/TransbankException.java +++ b/src/main/java/cl/transbank/exception/TransbankException.java @@ -27,6 +27,8 @@ public TransbankException(String message) { /** * Constructs a new TransbankException with the specified detail message and error code. + * @param code The error code. + * @param message The detail message. */ public TransbankException(int code, String message) { super(message); @@ -35,6 +37,8 @@ public TransbankException(int code, String message) { /** * Constructs a new TransbankException with the specified detail message, error code, and cause. + * @param code The error code. + * @param message The detail message. */ public TransbankException(int code, String message, Throwable cause) { super(message, cause); @@ -43,6 +47,7 @@ public TransbankException(int code, String message, Throwable cause) { /** * Constructs a new TransbankException with the specified cause. + * @param cause The cause. */ public TransbankException(Throwable cause) { super(cause); @@ -50,6 +55,8 @@ public TransbankException(Throwable cause) { /** * Constructs a new TransbankException with the specified Ccode and cause. + * @param code The error code. + * @param cause The cause. */ public TransbankException(int code, Throwable cause) { super(cause); @@ -58,6 +65,11 @@ public TransbankException(int code, Throwable cause) { /** * Constructs a new TransbankException with the specified error code and cause. + * @param code The error code. + * @param message The detail message. + * @param cause The cause. + * @param enableSuppression Whether or not suppression is enabled or disabled. + * @param writableStackTrace Whether or not the stack trace should be writable. */ public TransbankException( int code, diff --git a/src/main/java/cl/transbank/util/HttpUtilImpl.java b/src/main/java/cl/transbank/util/HttpUtilImpl.java index 3f0b1aa..0cc56f5 100644 --- a/src/main/java/cl/transbank/util/HttpUtilImpl.java +++ b/src/main/java/cl/transbank/util/HttpUtilImpl.java @@ -361,6 +361,7 @@ private HttpUtilImpl() { /** * Returns the singleton instance of HttpUtilImpl. * If the instance does not exist, it is created. + * @return The singleton instance of HttpUtilImpl. */ public static HttpUtilImpl getInstance() { if (null == instance) synchronized (HttpUtilImpl.class) { diff --git a/src/main/java/cl/transbank/util/WebpayApiResource.java b/src/main/java/cl/transbank/util/WebpayApiResource.java index 92e0c57..7237daa 100644 --- a/src/main/java/cl/transbank/util/WebpayApiResource.java +++ b/src/main/java/cl/transbank/util/WebpayApiResource.java @@ -49,6 +49,7 @@ public static Map buildHeaders(Options options) { * @param options The options for the request. * @param clazz The class of the response. * @return The response to the request. + * @throws TransbankException If an error occurs during the request. */ public static T execute( final String endpoint, @@ -66,6 +67,7 @@ public static T execute( * @param request The request body. * @param options The options for the request. * @return The response to the request. + * @throws TransbankException If an error occurs during the request. */ public static T execute( final String endpoint, @@ -84,6 +86,7 @@ public static T execute( * @param options The options for the request. * @param clazz The class of the response. * @return The response to the request. + * @throws TransbankException If an error occurs during the request. */ public static T execute( final String endpoint, @@ -130,6 +133,7 @@ public static T execute( * @param options The options for the request. * @param clazz The class of the response. * @return A list of responses to the request. + * @throws TransbankException If an error occurs during the request. */ public static List executeToList( final String endpoint, @@ -148,6 +152,7 @@ public static List executeToList( * @param options The options for the request. * @param clazz The class of the response. * @return A list of responses to the request. + * @throws TransbankException If an error occurs during the request. */ public static List executeToList( final String endpoint,