updated docs and reformat

Author: vegegoku

domino-rest-client/src/main/java/org/dominokit/rest/DominoRestConfig.java

@@ -88,7 +88,9 @@ public static DominoRestConfig initDefaults() {
     return DominoRestConfig.getInstance();
   }
 
-  /** @return new instance */
+  /**
+   * @return new instance
+   */
   public static DominoRestConfig getInstance() {
     return new DominoRestConfig();
   }

domino-rest-client/src/main/java/org/dominokit/rest/js/DefaultServiceRoot.java

@@ -21,7 +21,9 @@
 /** This is the default service root which reads it from the browser location */
 public class DefaultServiceRoot {
 
-  /** @return the service root */
+  /**
+   * @return the service root
+   */
   public static String get() {
     Location location = DomGlobal.window.location;
     String protocol = location.protocol;

domino-rest-client/src/main/java/org/dominokit/rest/js/DominoSimpleEventsBus.java

@@ -27,11 +27,17 @@
 public class DominoSimpleEventsBus implements EventsBus<Event<EventProcessor>> {
   private static final Logger LOGGER = LoggerFactory.getLogger(DominoSimpleEventsBus.class);
 
+  /** The singleton instance of the event bus. */
   public static final EventsBus INSTANCE = new DominoSimpleEventsBus(new EventProcessor());
 
   private final EventBus simpleGwtEventsBus;
   private final EventProcessor eventProcessor;
 
+  /**
+   * Creates a new instance.
+   *
+   * @param eventProcessor the {@link EventProcessor} to use
+   */
   public DominoSimpleEventsBus(EventProcessor eventProcessor) {
     this.simpleGwtEventsBus = new SimpleEventBus();
     this.eventProcessor = eventProcessor;

domino-rest-client/src/main/java/org/dominokit/rest/js/JsResponse.java

@@ -32,7 +32,10 @@
 /** JS implementation for the {@link Response} */
 public class JsResponse implements Response {
 
+  /** The {@link XMLHttpRequest} instance. */
   private final XMLHttpRequest request;
+
+  /** The response bean. */
   private Object responseBean;
 
   JsResponse(XMLHttpRequest request) {
@@ -86,7 +89,9 @@ public ArrayBuffer getResponseArrayBuffer() {
     return Js.cast(request.response);
   }
 
-  /** @return the {@code XMLHttpRequest} associated with this response. */
+  /**
+   * @return the {@code XMLHttpRequest} associated with this response.
+   */
   public XMLHttpRequest getRequest() {
     return request;
   }
@@ -96,6 +101,12 @@ public byte[] getBodyAsBytes() {
     return toByteArray(getResponseArrayBuffer());
   }
 
+  /**
+   * Converts an {@link ArrayBuffer} to a byte array.
+   *
+   * @param buffer the {@link ArrayBuffer} to convert
+   * @return the resulting byte array
+   */
   public static byte[] toByteArray(ArrayBuffer buffer) {
     Int8Array view = new Int8Array(buffer); // signed bytes [-128,127]
     int len = (int) view.length;
@@ -106,7 +117,14 @@ public static byte[] toByteArray(ArrayBuffer buffer) {
     return out;
   }
 
-  /** Copy a slice (offset/length in bytes) into a Java byte[]. */
+  /**
+   * Copy a slice (offset/length in bytes) into a Java byte[].
+   *
+   * @param buffer the {@link ArrayBuffer} to copy from
+   * @param byteOffset the offset in bytes
+   * @param length the length in bytes
+   * @return the resulting byte array
+   */
   public static byte[] toByteArray(ArrayBuffer buffer, int byteOffset, int length) {
     Int8Array view = new Int8Array(buffer, byteOffset, length);
     int len = (int) view.length;
@@ -117,6 +135,11 @@ public static byte[] toByteArray(ArrayBuffer buffer, int byteOffset, int length)
     return out;
   }
 
+  /**
+   * Sets the response bean.
+   *
+   * @param responseBean the response bean to set
+   */
   public void setResponseBean(Object responseBean) {
     this.responseBean = responseBean;
   }

domino-rest-client/src/main/java/org/dominokit/rest/js/JsRestfulRequest.java

@@ -37,11 +37,22 @@
 /** JS implementation for {@link RestfulRequest} that uses {@link XMLHttpRequest} */
 public class JsRestfulRequest extends BaseRestfulRequest {
 
+  /** Content-Type header name. */
   public static final String CONTENT_TYPE = "Content-Type";
+
+  /** PDF media type. */
   public static final String APPLICATION_PDF = "application/pdf";
+
+  /** The {@link XMLHttpRequest} instance. */
   private final XMLHttpRequest request;
+
+  /** The map of parameters. */
   private final Map<String, List<String>> params = new LinkedHashMap<>();
+
+  /** The map of headers. */
   private final Map<String, String> headers = new LinkedHashMap<>();
+
+  /** The timer for handling timeouts. */
   private final Timer timer =
       new Timer() {
         @Override
@@ -50,6 +61,12 @@ public void run() {
         }
       };
 
+  /**
+   * Creates a new instance.
+   *
+   * @param uri the request URI
+   * @param method the HTTP method
+   */
   public JsRestfulRequest(String uri, String method) {
     super(uri, method);
     request = new XMLHttpRequest();

domino-rest-client/src/main/java/org/dominokit/rest/js/ServerFailedRequestEvent.java

@@ -28,9 +28,18 @@
 @SuppressWarnings({"unchecked", "rawtypes"})
 public class ServerFailedRequestEvent extends ServerFailedRequestGwtEvent implements Event {
 
+  /** The {@link ServerRequest} associated with this event. */
   protected final ServerRequest request;
+
+  /** The failed response bean. */
   private final FailedResponseBean failedResponseBean;
 
+  /**
+   * Creates a new instance.
+   *
+   * @param request the {@link ServerRequest}
+   * @param failedResponseBean the failed response bean
+   */
   ServerFailedRequestEvent(ServerRequest request, FailedResponseBean failedResponseBean) {
     this.request = request;
     this.failedResponseBean = failedResponseBean;

domino-rest-client/src/main/java/org/dominokit/rest/js/ServerFailedRequestGwtEvent.java

@@ -21,6 +21,7 @@
 /** An {@link org.gwtproject.event.shared.EventBus} failed event */
 public abstract class ServerFailedRequestGwtEvent extends Event<EventProcessor> {
 
+  /** The event type for server failed request events. */
   protected static final Event.Type<EventProcessor> SERVER_FAILED_REQUEST_EVENT_TYPE =
       new Event.Type<>();
 

domino-rest-client/src/main/java/org/dominokit/rest/js/ServerSuccessRequestEvent.java

@@ -30,9 +30,18 @@
 @SuppressWarnings({"unchecked", "rawtypes"})
 public class ServerSuccessRequestEvent<T> extends ServerSuccessRequestGwtEvent implements Event {
 
+  /** The {@link ServerRequest} associated with this event. */
   protected final ServerRequest request;
+
+  /** The response bean received from the server. */
   private final T responseBean;
 
+  /**
+   * Creates a new instance.
+   *
+   * @param request the {@link ServerRequest}
+   * @param responseBean the response bean
+   */
   public ServerSuccessRequestEvent(ServerRequest request, T responseBean) {
     this.request = request;
     this.responseBean = responseBean;

domino-rest-jvm/src/main/java/org/dominokit/rest/DominoRestConfig.java

@@ -89,7 +89,9 @@ public static DominoRestConfig initDefaults() {
     return DominoRestConfig.getInstance();
   }
 
-  /** @return new instance */
+  /**
+   * @return new instance
+   */
   public static DominoRestConfig getInstance() {
     return new DominoRestConfig();
   }

domino-rest-jvm/src/main/java/org/dominokit/rest/jvm/DefaultServiceRoot.java

@@ -18,6 +18,9 @@
 /** Default service root configuration for JVM environment. */
 public class DefaultServiceRoot {
 
+  /**
+   * @return the default service root URL
+   */
   public static String get() {
     return "http://localhost:8080/";
   }