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

This commit is contained in:
2026-01-25 18:59:02 +01:00
parent c435a80966
commit f12f5d6db1
3 changed files with 10 additions and 9 deletions
+1 -1
View File
@@ -32,7 +32,7 @@ build:
- mkdir public - mkdir public
- cp -rv docs/* public/ - cp -rv docs/* public/
- mkdir public/apidocs - mkdir public/apidocs
- cp -rv target/apidocs public/ - cp -rv target/reports/apidocs public/
artifacts: artifacts:
paths: paths:
- target/surefire-reports/*.xml - target/surefire-reports/*.xml
@@ -11,7 +11,11 @@ import org.jetbrains.annotations.Nullable;
*/ */
public class CfDnsClientBuilder { 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"; public static final String DEFAULT_BASEURL = "https://api.cloudflare.com/client/v4";
private boolean emptyResultThrowsException; private boolean emptyResultThrowsException;
private CfAuth auth; private CfAuth auth;
@@ -6,15 +6,12 @@ package codes.thischwa.cf.model;
* <p>This class contains information about the current page, page size, total pages, and result * <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. * counts, which can be utilized in managing and navigating through paginated data.
* *
* <ul> * @param page The current page number.
* <li><b>page:</b> The current page number. * @param perPage The number of results per page.
* <li><b>perPage:</b> The number of results per page. * @param totalPages The total number of pages available.
* <li><b>totalPages:</b> The total number of pages available. * @param count The number of results on the current page.
* <li><b>count:</b> The number of results on the current page. * @param totalCount The total number of results across all pages.
* <li><b>totalCount:</b> The total number of results across all pages.
* </ul>
*/ */
public record ResultInfo(int page, int perPage, int totalPages, int count, int totalCount) { public record ResultInfo(int page, int perPage, int totalPages, int count, int totalCount) {
/** /**