Update Javadoc of premium SDK for azure-resourcemanager-trafficmanager (#43637)

Author: v-hongli1

sdk/resourcemanager/azure-resourcemanager-trafficmanager/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-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/TrafficManager.java

@@ -84,7 +84,11 @@ private TrafficManager(HttpPipeline httpPipeline, AzureProfile profile) {
                 .buildClient());
     }
 
-    /** @return entry point to traffic manager profile management */
+    /**
+     * Gets entry point to traffic manager profile management.
+     *
+     * @return entry point to traffic manager profile management
+     */
     public TrafficManagerProfiles profiles() {
         if (this.profiles == null) {
             this.profiles = new TrafficManagerProfilesImpl(this);

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/CheckProfileDnsNameAvailabilityResult.java

@@ -19,19 +19,29 @@ public CheckProfileDnsNameAvailabilityResult(TrafficManagerNameAvailabilityInner
     }
 
     /**
+     * Checks whether the DNS name is available to use.
+     *
      * @return true if the DNS name is available to use, false if the name has already been taken or invalid and cannot
      *     be used.
      */
     public boolean isAvailable() {
         return inner.nameAvailable();
     }
 
-    /** @return the reason that the DNS name could not be used */
+    /**
+     * Gets the reason that the DNS name could not be used.
+     *
+     * @return the reason that the DNS name could not be used
+     */
     public ProfileDnsNameUnavailableReason reason() {
         return new ProfileDnsNameUnavailableReason(inner.reason());
     }
 
-    /** @return an error message explaining the reason value in more detail */
+    /**
+     * Gets an error message explaining the reason value in more detail.
+     *
+     * @return an error message explaining the reason value in more detail
+     */
     public String message() {
         return inner.message();
     }

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/EndpointType.java

@@ -41,7 +41,11 @@ public String toString() {
         return this.value;
     }
 
-    /** @return the local name of the endpoint type */
+    /**
+     * Gets the local name of the endpoint type.
+     *
+     * @return the local name of the endpoint type
+     */
     public String localName() {
         if (this.value != null) {
             return this.value.substring(this.value.lastIndexOf('/') + 1);

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/GeographicHierarchies.java

@@ -8,6 +8,10 @@
 
 /** Entry point to Azure traffic manager geographic hierarchy management API in Azure. */
 public interface GeographicHierarchies extends HasManager<TrafficManager> {
-    /** @return the root of the Geographic Hierarchy used by the Geographic traffic routing method. */
+    /**
+     * Gets the root of the Geographic Hierarchy used by the Geographic traffic routing method.
+     *
+     * @return the root of the Geographic Hierarchy used by the Geographic traffic routing method.
+     */
     GeographicLocation getRoot();
 }

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/GeographicLocation.java

@@ -9,12 +9,24 @@
 
 /** Type representing Geographic Hierarchy region (location). */
 public interface GeographicLocation extends HasName, HasInnerModel<Region> {
-    /** @return the location code. */
+    /**
+     * Gets the location code.
+     *
+     * @return the location code.
+     */
     String code();
 
-    /** @return list of immediate child locations grouped under this location in the Geographic Hierarchy. */
+    /**
+     * Gets list of immediate child locations grouped under this location in the Geographic Hierarchy.
+     *
+     * @return list of immediate child locations grouped under this location in the Geographic Hierarchy.
+     */
     List<GeographicLocation> childLocations();
 
-    /** @return list of all descendant locations grouped under this location in the Geographic Hierarchy. */
+    /**
+     * Gets list of all descendant locations grouped under this location in the Geographic Hierarchy.
+     *
+     * @return list of all descendant locations grouped under this location in the Geographic Hierarchy.
+     */
     List<GeographicLocation> descendantLocations();
 }

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/TrafficManagerAzureEndpoint.java

@@ -5,9 +5,17 @@
 
 /** An immutable client-side representation of an Azure traffic manager profile Azure endpoint. */
 public interface TrafficManagerAzureEndpoint extends TrafficManagerEndpoint {
-    /** @return the resource id of the target Azure resource. */
+    /**
+     * Gets the resource id of the target Azure resource.
+     *
+     * @return the resource id of the target Azure resource.
+     */
     String targetAzureResourceId();
 
-    /** @return the type of the target Azure resource. */
+    /**
+     * Gets the type of the target Azure resource.
+     *
+     * @return the type of the target Azure resource.
+     */
     TargetAzureResourceType targetResourceType();
 }

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/TrafficManagerEndpoint.java

@@ -17,34 +17,62 @@
 /** An immutable client-side representation of an Azure traffic manager profile endpoint. */
 public interface TrafficManagerEndpoint
     extends ExternalChildResource<TrafficManagerEndpoint, TrafficManagerProfile>, HasInnerModel<EndpointInner> {
-    /** @return the endpoint type */
+    /**
+     * Gets the endpoint type.
+     *
+     * @return the endpoint type
+     */
     EndpointType endpointType();
 
-    /** @return the monitor status of the endpoint */
+    /**
+     * Gets the monitor status of the endpoint.
+     *
+     * @return the monitor status of the endpoint
+     */
     EndpointMonitorStatus monitorStatus();
 
-    /** @return true if the endpoint is enabled, false otherwise */
+    /**
+     * Checks whether the endpoint is enabled.
+     *
+     * @return true if the endpoint is enabled, false otherwise
+     */
     boolean isEnabled();
 
     /**
+     * Gets the weight of the endpoint which is used when traffic manager profile is configured.
+     *
      * @return the weight of the endpoint which is used when traffic manager profile is configured with Weighted
      *     traffic-routing method
      */
     long routingWeight();
 
     /**
+     * Gets the priority of the endpoint which is used when traffic manager profile is configured.
+     *
      * @return the priority of the endpoint which is used when traffic manager profile is configured with Priority
      *     traffic-routing method
      */
     long routingPriority();
 
-    /** @return the geographic location codes indicating the locations to which traffic will be distributed. */
+    /**
+     * Gets the geographic location codes indicating the locations to which traffic will be distributed.
+     *
+     * @return the geographic location codes indicating the locations to which traffic will be distributed.
+     */
     Set<String> geographicLocationCodes();
 
-    /** @return the list of subnets, IP addresses, and/or address ranges mapped to this endpoint. */
+    /**
+     * gets the list of subnets, IP addresses, and/or address ranges mapped to this endpoint.
+     *
+     * @return the list of subnets, IP addresses, and/or address ranges mapped to this endpoint.
+     */
     Collection<EndpointPropertiesSubnetsItem> subnets();
 
-    /** @return custom headers associated with the endpoint as key-value pair. */
+    /**
+     * Gets custom headers associated with the endpoint as key-value pair.
+     *
+     * @return custom headers associated with the endpoint as key-value pair.
+     */
     Map<String, String> customHeaders();
 
     /**

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/TrafficManagerExternalEndpoint.java

@@ -7,9 +7,17 @@
 
 /** An immutable client-side representation of an Azure traffic manager profile external endpoint. */
 public interface TrafficManagerExternalEndpoint extends TrafficManagerEndpoint {
-    /** @return the fully qualified DNS name of the external endpoint */
+    /**
+     * Gets the fully qualified DNS name of the external endpoint.
+     *
+     * @return the fully qualified DNS name of the external endpoint
+     */
     String fqdn();
 
-    /** @return the location of the traffic that the endpoint handles */
+    /**
+     * Gets the location of the traffic that the endpoint handles.
+     *
+     * @return the location of the traffic that the endpoint handles
+     */
     Region sourceTrafficLocation();
 }

sdk/resourcemanager/azure-resourcemanager-trafficmanager/src/main/java/com/azure/resourcemanager/trafficmanager/models/TrafficManagerNestedProfileEndpoint.java

@@ -7,12 +7,24 @@
 
 /** An immutable client-side representation of an Azure traffic manager profile nested profile endpoint. */
 public interface TrafficManagerNestedProfileEndpoint extends TrafficManagerEndpoint {
-    /** @return the nested traffic manager profile resource id */
+    /**
+     * Gets the nested traffic manager profile resource id.
+     *
+     * @return the nested traffic manager profile resource id
+     */
     String nestedProfileId();
 
-    /** @return the number of child endpoints to be online to consider nested profile as healthy */
+    /**
+     * Gets the number of child endpoints to be online to consider nested profile as healthy.
+     *
+     * @return the number of child endpoints to be online to consider nested profile as healthy
+     */
     long minimumChildEndpointCount();
 
-    /** @return the location of the traffic that the endpoint handles */
+    /**
+     * Gets the location of the traffic that the endpoint handles.
+     *
+     * @return the location of the traffic that the endpoint handles
+     */
     Region sourceTrafficLocation();
 }