Update .gitlab-ci.yml: Adjust apidocs path, and enhance documentation in ResultInfo and CfDnsClientBuilder.

.gitlab-ci.yml

@@ -32,7 +32,7 @@ build:
     - mkdir public
     - cp -rv docs/* public/
     - mkdir public/apidocs
-    - cp -rv target/apidocs public/
+    - cp -rv target/reports/apidocs public/
   artifacts:
     paths:
       - target/surefire-reports/*.xml

src/main/java/codes/thischwa/cf/CfDnsClientBuilder.java

@@ -11,7 +11,11 @@ import org.jetbrains.annotations.Nullable;
  */
 public class CfDnsClientBuilder {
 
+  /**
+   * The default base URL for the Cloudflare v4 API requests made by the {@code CfDnsClient}.
+   */
   public static final String DEFAULT_BASEURL = "https://api.cloudflare.com/client/v4";
+
   private boolean emptyResultThrowsException;
   private CfAuth auth;
 

src/main/java/codes/thischwa/cf/model/ResultInfo.java

@@ -6,15 +6,12 @@ package codes.thischwa.cf.model;
  * <p>This class contains information about the current page, page size, total pages, and result
  * counts, which can be utilized in managing and navigating through paginated data.
  *
- * <ul>
- *   <li><b>page:</b> The current page number.
- *   <li><b>perPage:</b> The number of results per page.
- *   <li><b>totalPages:</b> The total number of pages available.
- *   <li><b>count:</b> The number of results on the current page.
- *   <li><b>totalCount:</b> The total number of results across all pages.
- * </ul>
+ * @param page The current page number.
+ * @param perPage The number of results per page.
+ * @param totalPages The total number of pages available.
+ * @param count The number of results on the current page.
+ * @param totalCount The total number of results across all pages.
  */
-
 public record ResultInfo(int page, int perPage, int totalPages, int count, int totalCount) {
 
   /**