Update Javadoc of premium SDK for azure-resourcemanager-dns (#43600)

Author: v-hongli1

sdk/resourcemanager/azure-resourcemanager-dns/pom.xml

@@ -45,7 +45,6 @@
 
       --add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
     </javaModulesSurefireArgLine>
-    <doclintMissingInclusion>-</doclintMissingInclusion>
   </properties>
 
   <developers>

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/DnsZoneManager.java

@@ -85,7 +85,11 @@ private DnsZoneManager(HttpPipeline httpPipeline, AzureProfile profile) {
                 .buildClient());
     }
 
-    /** @return entry point to DNS zone manager zone management */
+    /**
+     * Gets entry point to DNS zone manager zone management.
+     *
+     * @return entry point to DNS zone manager zone management
+     */
     public DnsZones zones() {
         if (this.zones == null) {
             this.zones = new DnsZonesImpl(this);

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/ARecordSet.java

@@ -8,6 +8,10 @@
 /** An immutable client-side representation of a A (IPv4) record set in Azure DNS Zone. */
 @Fluent
 public interface ARecordSet extends DnsRecordSet {
-    /** @return the IP v4 addresses of A records in this record set */
+    /**
+     * Gets the IP v4 addresses of A records in this record set.
+     *
+     * @return the IP v4 addresses of A records in this record set
+     */
     List<String> ipv4Addresses();
 }

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/AaaaRecordSet.java

@@ -8,6 +8,10 @@
 /** An immutable client-side representation of a AAAA (IPv6) record set in Azure DNS Zone. */
 @Fluent
 public interface AaaaRecordSet extends DnsRecordSet {
-    /** @return the IPv6 addresses of AAAA records in this record set */
+    /**
+     * Gets the IPv6 addresses of AAAA records in this record set.
+     *
+     * @return the IPv6 addresses of AAAA records in this record set
+     */
     List<String> ipv6Addresses();
 }

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/CaaRecordSet.java

@@ -8,6 +8,10 @@
 /** An immutable client-side representation of an CAA (service) record set in Azure DNS Zone. */
 @Fluent
 public interface CaaRecordSet extends DnsRecordSet {
-    /** @return the CAA records in this record set */
+    /**
+     * Gets the CAA records in this record set.
+     *
+     * @return the CAA records in this record set
+     */
     List<CaaRecord> records();
 }

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/CnameRecordSet.java

@@ -7,6 +7,10 @@
 /** An immutable client-side representation of a CNAME (canonical name) record set in Azure DNS Zone. */
 @Fluent
 public interface CnameRecordSet extends DnsRecordSet {
-    /** @return the canonical name (without a terminating dot) of CName record in this record set */
+    /**
+     * Gets the canonical name (without a terminating dot) of CName record in this record set.
+     *
+     * @return the canonical name (without a terminating dot) of CName record in this record set
+     */
     String canonicalName();
 }

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/DnsRecordSet.java

@@ -15,19 +15,39 @@
 @Fluent
 public interface DnsRecordSet extends ExternalChildResource<DnsRecordSet, DnsZone>, HasInnerModel<RecordSetInner> {
 
-    /** @return the type of records in this record set */
+    /**
+     * Gets the type of records in this record set.
+     *
+     * @return the type of records in this record set
+     */
     RecordType recordType();
 
-    /** @return TTL of the records in this record set */
+    /**
+     * Gets TTL of the records in this record set.
+     *
+     * @return TTL of the records in this record set
+     */
     long timeToLive();
 
-    /** @return the metadata associated with this record set. */
+    /**
+     * Gets the metadata associated with this record set.
+     *
+     * @return the metadata associated with this record set.
+     */
     Map<String, String> metadata();
 
-    /** @return the fully qualified domain name of the record set. */
+    /**
+     * Gets the fully qualified domain name of the record set.
+     *
+     * @return the fully qualified domain name of the record set.
+     */
     String fqdn();
 
-    /** @return the etag associated with the record set. */
+    /**
+     * Gets the etag associated with the record set.
+     *
+     * @return the etag associated with the record set.
+     */
     String etag();
 
     /**

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/DnsZone.java

@@ -18,27 +18,53 @@
 @Fluent
 public interface DnsZone
     extends GroupableResource<DnsZoneManager, ZoneInner>, Refreshable<DnsZone>, Updatable<DnsZone.Update> {
-    /** @return the maximum number of record sets that can be created in this zone. */
+    /**
+     * Gets the maximum number of record sets that can be created in this zone.
+     *
+     * @return the maximum number of record sets that can be created in this zone.
+     */
     long maxNumberOfRecordSets();
 
-    /** @return the current number of record sets in this zone. */
+    /**
+     * Gets the current number of record sets in this zone.
+     *
+     * @return the current number of record sets in this zone.
+     */
     long numberOfRecordSets();
 
-    /** @return the etag associated with this zone. */
+    /**
+     * Gets the etag associated with this zone.
+     *
+     * @return the etag associated with this zone.
+     */
     String etag();
 
-    /** @return the access type of this zone (Private or Public). */
+    /**
+     * Gets the access type of this zone (Private or Public).
+     *
+     * @return the access type of this zone (Private or Public).
+     */
     ZoneType accessType();
 
     /**
+     * Gets a list of references to virtual networks that register hostnames in this DNS zone for Private DNS zone.
+     *
      * @return a list of references to virtual networks that register hostnames in this DNS zone for Private DNS zone.
      */
     List<String> registrationVirtualNetworkIds();
 
-    /** @return a list of references to virtual networks that resolve records in this DNS zone for Private DNS zone. */
+    /**
+     * Gets a list of references to virtual networks that resolve records in this DNS zone for Private DNS zone.
+     *
+     * @return a list of references to virtual networks that resolve records in this DNS zone for Private DNS zone.
+     */
     List<String> resolutionVirtualNetworkIds();
 
-    /** @return the record sets in this zone. */
+    /**
+     * Gets the record sets in this zone.
+     *
+     * @return the record sets in this zone.
+     */
     PagedIterable<DnsRecordSet> listRecordSets();
 
     /**
@@ -67,37 +93,81 @@ public interface DnsZone
      */
     PagedIterable<DnsRecordSet> listRecordSets(String recordSetNameSuffix, int pageSize);
 
-    /** @return name servers assigned for this zone. */
+    /**
+     * Gets name servers assigned for this zone.
+     *
+     * @return name servers assigned for this zone.
+     */
     List<String> nameServers();
 
-    /** @return entry point to manage record sets in this zone containing A (IPv4 address) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing A (IPv4 address) records.
+     *
+     * @return entry point to manage record sets in this zone containing A (IPv4 address) records
+     */
     ARecordSets aRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing AAAA (IPv6 address) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing AAAA (IPv6 address) records.
+     *
+     * @return entry point to manage record sets in this zone containing AAAA (IPv6 address) records
+     */
     AaaaRecordSets aaaaRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing Caa (canonical name) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing Caa (canonical name) records.
+     *
+     * @return entry point to manage record sets in this zone containing Caa (canonical name) records
+     */
     CaaRecordSets caaRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing CNAME (canonical name) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing CNAME (canonical name) records.
+     *
+     * @return entry point to manage record sets in this zone containing CNAME (canonical name) records
+     */
     CnameRecordSets cNameRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing MX (mail exchange) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing MX (mail exchange) records.
+     *
+     * @return entry point to manage record sets in this zone containing MX (mail exchange) records
+     */
     MxRecordSets mxRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing NS (name server) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing NS (name server) records.
+     *
+     * @return entry point to manage record sets in this zone containing NS (name server) records
+     */
     NsRecordSets nsRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing PTR (pointer) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing PTR (pointer) records.
+     *
+     * @return entry point to manage record sets in this zone containing PTR (pointer) records
+     */
     PtrRecordSets ptrRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing SRV (service) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing SRV (service) records.
+     *
+     * @return entry point to manage record sets in this zone containing SRV (service) records
+     */
     SrvRecordSets srvRecordSets();
 
-    /** @return entry point to manage record sets in this zone containing TXT (text) records */
+    /**
+     * Gets entry point to manage record sets in this zone containing TXT (text) records.
+     *
+     * @return entry point to manage record sets in this zone containing TXT (text) records
+     */
     TxtRecordSets txtRecordSets();
 
-    /** @return the record set containing SOA (start of authority) record associated with this DNS zone */
+    /**
+     * Gets the record set containing SOA (start of authority) record associated with this DNS zone.
+     *
+     * @return the record set containing SOA (start of authority) record associated with this DNS zone
+     */
     SoaRecordSet getSoaRecordSet();
 
     /** The entirety of the DNS zone definition. */

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/MxRecordSet.java

@@ -8,6 +8,10 @@
 /** An immutable client-side representation of an MX (mail exchange) record set in an Azure DNS Zone. */
 @Fluent
 public interface MxRecordSet extends DnsRecordSet {
-    /** @return the MX records in this record set */
+    /**
+     * Gets the MX records in this record set.
+     *
+     * @return the MX records in this record set
+     */
     List<MxRecord> records();
 }

sdk/resourcemanager/azure-resourcemanager-dns/src/main/java/com/azure/resourcemanager/dns/models/NsRecordSet.java

@@ -8,6 +8,10 @@
 /** An immutable client-side representation of an NS (name server) record set in Azure DNS Zone. */
 @Fluent
 public interface NsRecordSet extends DnsRecordSet {
-    /** @return the name server names of NS (name server) records in this record set */
+    /**
+     * Gets the name server names of NS (name server) records in this record set.
+     *
+     * @return the name server names of NS (name server) records in this record set
+     */
     List<String> nameServers();
 }