Update Javadoc of premium SDK for azure-resourcemanager-resources (#43192)

* Fix ci analyze exception for resource

* Fix comments and remove doclintMissingInclusion from pom.xml

* Fix comments

* fix ci exception

* fix ci exception

* fix ci exception

* fix ci exception

* fix ci exception

* Fix ci analyze exception

* fix comments

* fix comments

* fix comments

Author: v-hongli1

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

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

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/ResourceManager.java

@@ -143,11 +143,15 @@ public ResourceManager.Authenticated authenticate(TokenCredential credential, Az
      */
     public interface Authenticated {
         /**
+         * Gets the entry point to tenant management API.
+         *
          * @return the entry point to tenant management API.
          */
         Tenants tenants();
 
         /**
+         * Gets the entry point to subscription management API.
+         *
          * @return the entry point to subscription management API.
          */
         Subscriptions subscriptions();
@@ -272,40 +276,50 @@ private ResourceManager(HttpPipeline httpPipeline, AzureProfile profile) {
     }
 
     /**
-     * @return wrapped inner feature client providing direct access to auto-generated API implementation,
+     * Gets wrapped inner feature client providing direct access to auto-generated API implementation,
      * based on Azure REST API.
+     *
+     * @return wrapped inner feature client.
      */
     public FeatureClient featureClient() {
         return featureClient;
     }
 
     /**
-     * @return wrapped inner subscription client providing direct access to auto-generated API implementation,
+     * Gets wrapped inner subscription client providing direct access to auto-generated API implementation,
      * based on Azure REST API.
+     *
+     * @return wrapped inner subscription client.
      */
     public SubscriptionClient subscriptionClient() {
         return subscriptionClient;
     }
 
     /**
-     * @return wrapped inner policy client providing direct access to auto-generated API implementation,
+     * Gets wrapped inner policy client providing direct access to auto-generated API implementation,
      * based on Azure REST API.
+     *
+     * @return wrapped inner policy client.
      */
     public PolicyClient policyClient() {
         return policyClient;
     }
 
     /**
-     * @return wrapped inner policy client providing direct access to auto-generated API implementation,
+     * Gets wrapped inner policy client providing direct access to auto-generated API implementation,
      * based on Azure REST API.
+     *
+     * @return wrapped inner policy client.
      */
     public ManagementLockClient managementLockClient() {
         return managementLockClient;
     }
 
     /**
-     * @return wrapped inner resource change client providing direct access to auto-generated API implementation,
+     * Gets wrapped inner resource change client providing direct access to auto-generated API implementation,
      * based on Azure REST API.
+     *
+     * @return wrapped inner resource change client.
      */
     public ChangesManagementClient resourceChangeClient() {
         return resourceChangeClient;
@@ -332,6 +346,8 @@ public DataBoundariesManagementClient dataBoundaryClient() {
     }
 
     /**
+     * Gets the resource group management API entry point.
+     *
      * @return the resource group management API entry point
      */
     public ResourceGroups resourceGroups() {
@@ -342,6 +358,8 @@ public ResourceGroups resourceGroups() {
     }
 
     /**
+     * Gets the generic resource management API entry point.
+     *
      * @return the generic resource management API entry point
      */
     public GenericResources genericResources() {
@@ -352,6 +370,8 @@ public GenericResources genericResources() {
     }
 
     /**
+     * Gets the deployment management API entry point.
+     *
      * @return the deployment management API entry point
      */
     public Deployments deployments() {
@@ -362,6 +382,8 @@ public Deployments deployments() {
     }
 
     /**
+     * Gets the feature management API entry point.
+     *
      * @return the feature management API entry point
      */
     public Features features() {
@@ -372,6 +394,8 @@ public Features features() {
     }
 
     /**
+     * Gets the resource provider management API entry point.
+     *
      * @return the resource provider management API entry point
      */
     public Providers providers() {
@@ -382,6 +406,8 @@ public Providers providers() {
     }
 
     /**
+     * Gets the policy definition management API entry point.
+     *
      * @return the policy definition management API entry point
      */
     public PolicyDefinitions policyDefinitions() {
@@ -392,6 +418,8 @@ public PolicyDefinitions policyDefinitions() {
     }
 
     /**
+     * Gets the policy assignment management API entry point.
+     *
      * @return the policy assignment management API entry point
      */
     public PolicyAssignments policyAssignments() {
@@ -402,6 +430,8 @@ public PolicyAssignments policyAssignments() {
     }
 
     /**
+     * Gets the subscription management API entry point.
+     *
      * @return the subscription management API entry point
      */
     public Subscriptions subscriptions() {
@@ -412,6 +442,8 @@ public Subscriptions subscriptions() {
     }
 
     /**
+     * Gets the tenant management API entry point.
+     *
      * @return the tenant management API entry point
      */
     public Tenants tenants() {
@@ -422,6 +454,8 @@ public Tenants tenants() {
     }
 
     /**
+     * Gets the locks management API entry point.
+     *
      * @return the locks management API entry point
      */
     public ManagementLocks managementLocks() {
@@ -432,6 +466,8 @@ public ManagementLocks managementLocks() {
     }
 
     /**
+     * Gets the tag management API entry point.
+     *
      * @return the tag management API entry point
      */
     public TagOperations tagOperations() {
@@ -442,6 +478,8 @@ public TagOperations tagOperations() {
     }
 
     /**
+     * Gets the ResourceManagerUtils.InternalRuntimeContext associated with this manager.
+     *
      * @return the {@link ResourceManagerUtils.InternalRuntimeContext} associated with this manager
      */
     public ResourceManagerUtils.InternalRuntimeContext internalContext() {

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/AvailabilityZoneId.java

@@ -26,6 +26,15 @@ public class AvailabilityZoneId extends ExpandableStringEnum<AvailabilityZoneId>
      */
     public static final AvailabilityZoneId ZONE_3 = fromString("3");
 
+    /**
+     * Creates a new instance of AvailabilityZoneId value.
+     * 
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public AvailabilityZoneId() {
+    }
+
     /**
      * Finds or creates an availability zone identifier based on the specified identifier in string format.
      *
@@ -37,6 +46,8 @@ public static AvailabilityZoneId fromString(String id) {
     }
 
     /**
+     * Gets known AvailabilityZoneId values.
+     *
      * @return known availability zone identifiers
      */
     public static Collection<AvailabilityZoneId> values() {

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/CountryIsoCode.java

@@ -963,6 +963,17 @@ public final class CountryIsoCode extends ExpandableStringEnum<CountryIsoCode> {
     public static final CountryIsoCode ZIMBABWE = fromString("ZW");
 
     /**
+     * Creates a new instance of CountryIsoCode value.
+     * 
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public CountryIsoCode() {
+    }
+
+    /**
+     * Gets known CountryIsoCode values.
+     *
      * @return known country ISO codes
      */
     public static Collection<CountryIsoCode> values() {

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/CountryPhoneCode.java

@@ -958,6 +958,15 @@ public final class CountryPhoneCode extends ExpandableStringEnum<CountryPhoneCod
      */
     public static final CountryPhoneCode ZIMBABWE = fromString("+263");
 
+    /**
+     * Creates a new instance of CountryPhoneCode value.
+     *
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public CountryPhoneCode() {
+    }
+
     /**
      * Creates or finds a country phone code from its string representation.
      *
@@ -969,6 +978,8 @@ public static CountryPhoneCode fromString(String code) {
     }
 
     /**
+     * Gets known CountryPhoneCode values.
+     *
      * @return known country phone codes
      */
     public static Collection<CountryPhoneCode> values() {

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/Manager.java

@@ -46,13 +46,17 @@ public InnerT serviceClient() {
     }
 
     /**
+     * Gets the ID of the subscription the manager is working with.
+     *
      * @return the ID of the subscription the manager is working with
      */
     public String subscriptionId() {
         return this.subscriptionId;
     }
 
     /**
+     * Gets the Azure environment the manager is working with.
+     *
      * @return the Azure environment the manager is working with
      */
     public AzureEnvironment environment() {
@@ -73,13 +77,17 @@ protected final void withResourceManager(ResourceManager resourceManager) {
     }
 
     /**
+     * Gets the ResourceManager associated with this manager.
+     *
      * @return the {@link ResourceManager} associated with this manager
      */
     public ResourceManager resourceManager() {
         return this.resourceManager;
     }
 
     /**
+     * Gets the HttpPipeline associated with this manager.
+     *
      * @return the {@link HttpPipeline} associated with this manager
      */
     public HttpPipeline httpPipeline() {

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/ResourceId.java

@@ -98,27 +98,35 @@ public static ResourceId fromString(String id) {
     }
 
     /**
+     * Gets the subscriptionId of the resource.
+     *
      * @return subscriptionId of the resource.
      */
     public String subscriptionId() {
         return this.subscriptionId;
     }
 
     /**
+     * Gets the resourceGroupName of the resource.
+     *
      * @return resourceGroupName of the resource.
      */
     public String resourceGroupName() {
         return this.resourceGroupName;
     }
 
     /**
+     * Gets the name of the resource.
+     *
      * @return name of the resource.
      */
     public String name() {
         return this.name;
     }
 
     /**
+     * Gets the parent resource id of the resource.
+     *
      * @return parent resource id of the resource if any, otherwise null.
      */
     public ResourceId parent() {
@@ -130,20 +138,26 @@ public ResourceId parent() {
     }
 
     /**
+     * Gets name of the provider.
+     *
      * @return name of the provider.
      */
     public String providerNamespace() {
         return this.providerNamespace;
     }
 
     /**
+     * Gets type of the resource.
+     *
      * @return type of the resource.
      */
     public String resourceType() {
         return this.resourceType;
     }
 
     /**
+     * Gets full type of the resource.
+     *
      * @return full type of the resource.
      */
     public String fullResourceType() {
@@ -155,6 +169,8 @@ public String fullResourceType() {
     }
 
     /**
+     * Gets id of the resource.
+     *
      * @return the id of the resource.
      */
     public String id() {

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/models/CheckNameAvailabilityReason.java

@@ -16,6 +16,15 @@ public final class CheckNameAvailabilityReason extends ExpandableStringEnum<Chec
     /** Static value AlreadyExists for CheckNameAvailabilityReason. */
     public static final CheckNameAvailabilityReason ALREADY_EXISTS = fromString("AlreadyExists");
 
+    /**
+     * Creates a new instance of CheckNameAvailabilityReason value.
+     * 
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public CheckNameAvailabilityReason() {
+    }
+
     /**
      * Creates or finds a CheckNameAvailabilityReason from its string representation.
      *

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/models/ExternalChildResource.java

@@ -13,6 +13,8 @@
 public interface ExternalChildResource<FluentModelT, ParentT>
     extends ChildResource<ParentT>, Refreshable<FluentModelT> {
     /**
+     * Gets the id of the external child resource.
+     *
      * @return the id of the external child resource
      */
     String id();

sdk/resourcemanager/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/arm/models/HasId.java

@@ -10,6 +10,8 @@
 @Fluent
 public interface HasId {
     /**
+     * Gets the resource ID.
+     *
      * @return the resource ID string
      */
     String id();