From f9c52e6f26eed1c4a5c0455bd00dce5b450600b6 Mon Sep 17 00:00:00 2001 From: Simone Carletti Date: Fri, 18 Sep 2026 10:15:33 +0200 Subject: [PATCH] Align the endpoint Javadoc layout Use one layout for every public endpoint method: aligned @param names, capitalized @param and @return text, no blank line before @return, and @see last. The @return text names the response in the word order of the method name. --- .../java/com/dnsimple/endpoints/Billing.java | 3 ++ .../com/dnsimple/endpoints/Certificates.java | 8 +-- .../java/com/dnsimple/endpoints/Contacts.java | 4 +- .../java/com/dnsimple/endpoints/Domains.java | 18 +++---- .../com/dnsimple/endpoints/Registrar.java | 52 +++++++++---------- .../java/com/dnsimple/endpoints/Tlds.java | 8 +-- .../dnsimple/endpoints/VanityNameServers.java | 4 +- .../java/com/dnsimple/endpoints/Zones.java | 18 +++---- 8 files changed, 57 insertions(+), 58 deletions(-) diff --git a/src/main/java/com/dnsimple/endpoints/Billing.java b/src/main/java/com/dnsimple/endpoints/Billing.java index 9f601dc4..7abfcab1 100644 --- a/src/main/java/com/dnsimple/endpoints/Billing.java +++ b/src/main/java/com/dnsimple/endpoints/Billing.java @@ -17,6 +17,9 @@ public Billing(HttpEndpointClient client) { /** * Lists the billing charges for the account. * + * @param account The account ID + * @param options The options for the list request + * @return The list charges response * @see https://developer.dnsimple.com/v2/billing-charges/#listCharges */ public ListResponse listCharges(Number account, ListOptions options) { diff --git a/src/main/java/com/dnsimple/endpoints/Certificates.java b/src/main/java/com/dnsimple/endpoints/Certificates.java index d9b0cf2a..e0fdd9d5 100644 --- a/src/main/java/com/dnsimple/endpoints/Certificates.java +++ b/src/main/java/com/dnsimple/endpoints/Certificates.java @@ -96,7 +96,7 @@ public SimpleResponse getCertificatePrivateKey(Number acc * @param account The account ID * @param domain The domain name or ID * @param options The options for the certificate purchase - * @return The Let's Encrypt purchase response + * @return The purchase Let's Encrypt certificate response * @see https://developer.dnsimple.com/v2/certificates/#purchaseLetsencryptCertificate */ public SimpleResponse purchaseLetsencryptCertificate(Number account, String domain, CertificatePurchaseOptions options) { @@ -112,7 +112,7 @@ public SimpleResponse purchaseLetsencryptCertificate(Number * @param account The account ID * @param domain The domain name or ID * @param certificatePurchaseId The ID of the purchase order returned by purchaseLetsencryptCertificate - * @return The Let's Encrypt issue response + * @return The issue Let's Encrypt certificate response * @see https://developer.dnsimple.com/v2/certificates/#issueLetsencryptCertificate */ public SimpleResponse issueLetsencryptCertificate(Number account, String domain, Number certificatePurchaseId) { @@ -129,7 +129,7 @@ public SimpleResponse issueLetsencryptCertificate(Number account, S * @param domain The domain name or ID * @param certificateId The certificate ID * @param options The options for the certificate renewal - * @return The Let's Encrypt purchase renewal response + * @return The purchase Let's Encrypt certificate renewal response * @see https://developer.dnsimple.com/v2/certificates/#purchaseRenewalLetsencryptCertificate */ public SimpleResponse purchaseLetsencryptCertificateRenewal(Number account, String domain, Number certificateId, CertificateRenewalPurchaseOptions options) { @@ -146,7 +146,7 @@ public SimpleResponse purchaseLetsencryptCertificateRenewal( * @param domain The domain name or ID * @param certificateId The domain name or ID * @param certificateRenewalId The ID of the purchase order returned by purchaseLetsencryptCertificateRenewal - * @return The Let's Encrypt issue response + * @return The issue Let's Encrypt certificate renewal response * @see https://developer.dnsimple.com/v2/certificates/#issueRenewalLetsencryptCertificate */ public SimpleResponse issueLetsencryptCertificateRenewal(Number account, String domain, Number certificateId, Number certificateRenewalId) { diff --git a/src/main/java/com/dnsimple/endpoints/Contacts.java b/src/main/java/com/dnsimple/endpoints/Contacts.java index 1dbbe484..c40a29cb 100644 --- a/src/main/java/com/dnsimple/endpoints/Contacts.java +++ b/src/main/java/com/dnsimple/endpoints/Contacts.java @@ -50,7 +50,7 @@ public PaginatedResponse listContacts(Number account, ListOptions optio * Create a contact in the account. * * @param account The account ID - * @param options options to create the new contact + * @param options Options to create the new contact * @return The create contact response * @see https://developer.dnsimple.com/v2/contacts/#createContact */ @@ -75,7 +75,7 @@ public SimpleResponse getContact(Number account, Number contactId) { * * @param account The account ID * @param contactId The contact ID - * @param options options to update the contact + * @param options Options to update the contact * @return The update contact response * @see https://developer.dnsimple.com/v2/contacts/#updateContact */ diff --git a/src/main/java/com/dnsimple/endpoints/Domains.java b/src/main/java/com/dnsimple/endpoints/Domains.java index 92077193..b793fdfc 100644 --- a/src/main/java/com/dnsimple/endpoints/Domains.java +++ b/src/main/java/com/dnsimple/endpoints/Domains.java @@ -98,7 +98,7 @@ public EmptyResponse deleteDomain(Number account, String domain) { * * @param account The account ID * @param domain The domain ID or name or name - * @return The DNSSEC enable response + * @return The enable DNSSEC response * @see https://developer.dnsimple.com/v2/domains/dnssec/#enableDomainDnssec */ public SimpleResponse enableDnssec(Number account, String domain) { @@ -110,7 +110,7 @@ public SimpleResponse enableDnssec(Number account, String domain) { * * @param account The account ID * @param domain The domain ID or name or name - * @return The DNSSEC disable response + * @return The disable DNSSEC response * @see https://developer.dnsimple.com/v2/domains/dnssec/#disableDomainDnssec */ public EmptyResponse disableDnssec(Number account, String domain) { @@ -268,9 +268,9 @@ public EmptyResponse deleteEmailForward(Number account, String domain, Number em /** * Initiate a push using an account identifier. * - * @param account The account ID - * @param domain The domain name or ID - * @param newAccountIdentifier The account identifier of the target account + * @param account The account ID + * @param domain The domain name or ID + * @param newAccountIdentifier The account identifier of the target account * @return The initiate push response * @see https://developer.dnsimple.com/v2/domains/pushes/#initiateDomainPush */ @@ -334,7 +334,7 @@ public EmptyResponse acceptPush(Number account, Number push, Number contactId) { * * @param account The account ID * @param push The push ID - * @return The accept push response + * @return The reject push response * @see https://developer.dnsimple.com/v2/domains/pushes/#rejectPush */ public EmptyResponse rejectPush(Number account, Number push) { @@ -347,9 +347,9 @@ public EmptyResponse rejectPush(Number account, Number push) { * This endpoint provides information about a domain's availability status, including whether it's * available for registration, already registered, or has other restrictions. * - * @param account The account ID - * @param domainName The domain name to research - * @return The domain research status response + * @param account The account ID + * @param domainName The domain name to research + * @return The get domain research status response * @see https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus */ public SimpleResponse getDomainResearchStatus(Number account, String domainName) { diff --git a/src/main/java/com/dnsimple/endpoints/Registrar.java b/src/main/java/com/dnsimple/endpoints/Registrar.java index 5e59e35d..7bbaa0cd 100644 --- a/src/main/java/com/dnsimple/endpoints/Registrar.java +++ b/src/main/java/com/dnsimple/endpoints/Registrar.java @@ -42,8 +42,7 @@ public SimpleResponse checkDomain(Number account, String domainName * * @param account The account ID * @param domainName The domain to check the prices - * - * @return the domain prices response + * @return The get domain prices response * @see https://developer.dnsimple.com/v2/registrar/#getDomainPrices */ public SimpleResponse getDomainPrices(Number account, String domainName) { @@ -56,8 +55,7 @@ public SimpleResponse getDomainPrices(Number account, String domain * @param account The account ID * @param domainName The domain to check the registration * @param domainRegistration The domain registration ID - * - * @return the domain registration response + * @return The get domain registration response * @see https://developer.dnsimple.com/v2/registrar/#getDomainRegistration */ public SimpleResponse getDomainRegistration(Number account, String domainName, Number domainRegistration) { @@ -67,11 +65,10 @@ public SimpleResponse getDomainRegistration(Number account, /** * Get the details of an existing domain renewal. * - * @param account The account ID - * @param domainName The domain to check the renewal + * @param account The account ID + * @param domainName The domain to check the renewal * @param domainRenewal The domain renewal ID - * - * @return the domain renewal response + * @return The get domain renewal response * @see https://developer.dnsimple.com/v2/registrar/#getDomainRenewal */ public SimpleResponse getDomainRenewal(Number account, String domainName, Number domainRenewal) { @@ -84,8 +81,7 @@ public SimpleResponse getDomainRenewal(Number account, String dom * @param account The account ID * @param domain The domain name or ID * @param domainRestore The domain restore ID - * - * @return the domain restore response + * @return The get domain restore response * @see https://developer.dnsimple.com/v2/registrar/#getDomainRestore */ public SimpleResponse getDomainRestore(Number account, String domain, Number domainRestore) { @@ -124,7 +120,7 @@ public SimpleResponse transferDomain(Number account, String doma * @param account The account ID * @param domain The domain name or ID * @param domainTransferId The domain transfer ID - * @return The transfer domain response + * @return The get domain transfer response * @see https://developer.dnsimple.com/v2/registrar/#getDomainTransfer */ public SimpleResponse getDomainTransfer(Number account, String domain, Number domainTransferId) { @@ -137,7 +133,7 @@ public SimpleResponse getDomainTransfer(Number account, String d * @param account The account ID * @param domain The domain name or ID * @param domainTransferId The domain transfer ID - * @return The transfer domain response + * @return The cancel domain transfer response * @see https://developer.dnsimple.com/v2/registrar/#cancelDomainTransfer */ public SimpleResponse cancelDomainTransfer(Number account, String domain, Number domainTransferId) { @@ -175,7 +171,7 @@ public SimpleResponse restoreDomain(Number account, String domain * * @param account The account ID * @param domain The domain name or ID - * @return The transfer domain out response + * @return The authorize transfer out response * @see https://developer.dnsimple.com/v2/registrar/#authorizeDomainTransferOut */ public EmptyResponse authorizeTransferOut(Number account, String domain) { @@ -285,7 +281,7 @@ public EmptyResponse changeDomainDelegationFromVanity(Number account, String dom * * @param account The account ID * @param options List options - * @return Registrant changes + * @return The list registrant changes response * @see https://developer.dnsimple.com/v2/registrar/registrant-changes/#listRegistrantChanges */ public ListResponse listRegistrantChanges(Number account, ListOptions options) { @@ -296,8 +292,8 @@ public ListResponse listRegistrantChanges(Number account, List * Start a registrant change. * * @param account The account ID - * @param input The input parameters - * @return The registrant change response + * @param input The input parameters + * @return The create registrant change response * @see https://developer.dnsimple.com/v2/registrar/registrant-changes/#createRegistrantChange */ public SimpleResponse createRegistrantChange(Number account, CreateRegistrantChangeInput input) { @@ -308,8 +304,8 @@ public SimpleResponse createRegistrantChange(Number account, C * Retrieves the requirements of a registrant change. * * @param account The account ID - * @param input The domain and contact to check - * @return The registrant change check response + * @param input The domain and contact to check + * @return The check registrant change response * @see https://developer.dnsimple.com/v2/registrar/registrant-changes/#checkRegistrantChange */ public SimpleResponse checkRegistrantChange(Number account, CheckRegistrantChangeInput input) { @@ -319,9 +315,9 @@ public SimpleResponse checkRegistrantChange(Number accoun /** * Retrieves the details of an existing registrant change. * - * @param account The account ID + * @param account The account ID * @param registrantChange The registrant change - * @return The registrant change response + * @return The get registrant change response * @see https://developer.dnsimple.com/v2/registrar/registrant-changes/#getRegistrantChange */ public SimpleResponse getRegistrantChange(Number account, Number registrantChange) { @@ -331,9 +327,9 @@ public SimpleResponse getRegistrantChange(Number account, Numb /** * Cancel an ongoing registrant change from the account. * - * @param account The account ID + * @param account The account ID * @param registrantChange The registrant change - * @return The registrant change response + * @return The delete registrant change response * @see https://developer.dnsimple.com/v2/registrar/registrant-changes/#deleteRegistrantChange */ public EmptyResponse deleteRegistrantChange(Number account, Number registrantChange) { @@ -344,8 +340,8 @@ public EmptyResponse deleteRegistrantChange(Number account, Number registrantCha * Gets the transfer lock status for a domain. * * @param account The account ID - * @param domain The domain name or ID - * @return The transfer lock status + * @param domain The domain name or ID + * @return The get domain transfer lock response * @see https://developer.dnsimple.com/v2/registrar/transfer-lock/#getDomainTransferLock */ public SimpleResponse getDomainTransferLock(Number account, String domain) { @@ -356,8 +352,8 @@ public SimpleResponse getDomainTransferLock(Number account, * Locks the domain to prevent unauthorized transfers. * * @param account The account ID - * @param domain The domain name or ID - * @return The transfer lock status + * @param domain The domain name or ID + * @return The enable domain transfer lock response * @see https://developer.dnsimple.com/v2/registrar/transfer-lock/#enableDomainTransferLock */ public SimpleResponse enableDomainTransferLock(Number account, String domain) { @@ -368,8 +364,8 @@ public SimpleResponse enableDomainTransferLock(Number accoun * Unlocks the domain to allow domain transfers. * * @param account The account ID - * @param domain The domain name or ID - * @return The transfer lock status + * @param domain The domain name or ID + * @return The disable domain transfer lock response * @see https://developer.dnsimple.com/v2/registrar/transfer-lock/#disableDomainTransferLock */ public SimpleResponse disableDomainTransferLock(Number account, String domain) { diff --git a/src/main/java/com/dnsimple/endpoints/Tlds.java b/src/main/java/com/dnsimple/endpoints/Tlds.java index 770ca040..572de1e2 100644 --- a/src/main/java/com/dnsimple/endpoints/Tlds.java +++ b/src/main/java/com/dnsimple/endpoints/Tlds.java @@ -25,7 +25,7 @@ public Tlds(HttpEndpointClient client) { /** * Lists supported TLDs for registration * - * @return The list tlds response + * @return The list TLDs response * @see https://developer.dnsimple.com/v2/tlds/#listTlds */ public PaginatedResponse listTlds() { @@ -36,7 +36,7 @@ public PaginatedResponse listTlds() { * Lists supported TLDs for registration * * @param options The options for the list request - * @return The list tlds response + * @return The list TLDs response * @see https://developer.dnsimple.com/v2/tlds/#listTlds */ public PaginatedResponse listTlds(ListOptions options) { @@ -47,7 +47,7 @@ public PaginatedResponse listTlds(ListOptions options) { * Get details for a specific tld. * * @param tld The TLD string (i.e. "com") - * @return The get tld response + * @return The get TLD response * @see https://developer.dnsimple.com/v2/tlds/#getTld */ public SimpleResponse getTld(String tld) { @@ -58,7 +58,7 @@ public SimpleResponse getTld(String tld) { * Get extended attributes for a TLD * * @param tld The TLD to retrieve extended attributes for - * @return The list tlds response + * @return The get TLD extended attributes response * @see https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes */ public ListResponse getTldExtendedAttributes(String tld) { diff --git a/src/main/java/com/dnsimple/endpoints/VanityNameServers.java b/src/main/java/com/dnsimple/endpoints/VanityNameServers.java index 096f7a1f..246817f9 100644 --- a/src/main/java/com/dnsimple/endpoints/VanityNameServers.java +++ b/src/main/java/com/dnsimple/endpoints/VanityNameServers.java @@ -26,7 +26,7 @@ public VanityNameServers(HttpEndpointClient client) { * * @param account The account ID * @param domain The domain name or ID - * @return The enable vanity name server response + * @return The enable vanity name servers response * @see https://developer.dnsimple.com/v2/vanity/#enableVanityNameServers */ public ListResponse enableVanityNameServers(Number account, String domain) { @@ -38,7 +38,7 @@ public ListResponse enableVanityNameServers(Number account, St * * @param account The account ID * @param domain The domain name or ID - * @return The disable vanity name server response + * @return The disable vanity name servers response * @see https://developer.dnsimple.com/v2/vanity/#disableVanityNameServers */ public EmptyResponse disableVanityNameServers(Number account, String domain) { diff --git a/src/main/java/com/dnsimple/endpoints/Zones.java b/src/main/java/com/dnsimple/endpoints/Zones.java index d48c1220..b7b7c41f 100644 --- a/src/main/java/com/dnsimple/endpoints/Zones.java +++ b/src/main/java/com/dnsimple/endpoints/Zones.java @@ -29,9 +29,9 @@ public Zones(HttpEndpointClient client) { /** * Activate DNS resolution for the zone in the account. * - * @param account The account ID + * @param account The account ID * @param zoneName The zone name - * @return The zone + * @return The activate DNS response * @see https://developer.dnsimple.com/v2/zones/#activateZoneService */ public SimpleResponse activateDns(Number account, String zoneName) { @@ -41,9 +41,9 @@ public SimpleResponse activateDns(Number account, String zoneName) { /** * Deactivate DNS resolution for the zone in the account. * - * @param account The account ID + * @param account The account ID * @param zoneName The zone name - * @return The zone + * @return The deactivate DNS response * @see https://developer.dnsimple.com/v2/zones/#deactivateZoneService */ public SimpleResponse deactivateDns(Number account, String zoneName) { @@ -102,7 +102,7 @@ public SimpleResponse getZoneFile(Number account, String zone) { * * @param account The account ID * @param zone The zone name - * @return The result of the check + * @return The check zone distribution response * @see https://developer.dnsimple.com/v2/zones/#checkZoneDistribution */ public SimpleResponse checkZoneDistribution(Number account, String zone) { @@ -163,9 +163,9 @@ public SimpleResponse getZoneRecord(Number account, String zone, Num /** * Update a record in a zone. * - * @param account The account ID - * @param zone The zone name - * @param record The zone record ID + * @param account The account ID + * @param zone The zone name + * @param record The zone record ID * @param options The options to update the Zone record * @return The update zone record response * @see https://developer.dnsimple.com/v2/zones/records/#updateZoneRecord @@ -193,7 +193,7 @@ public EmptyResponse deleteZoneRecord(Number account, String zone, Number record * @param account The account ID * @param zone The zone name * @param record The zone record ID - * @return The result of the check + * @return The check zone record distribution response * @see https://developer.dnsimple.com/v2/zones/records/#checkZoneRecordDistribution */ public SimpleResponse checkZoneRecordDistribution(Number account, String zone, Number record) {