Update Javadoc of premium SDK for azure-resourcemanager-authorization (#43489)

Author: v-hongli1

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

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

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/AuthorizationManager.java

@@ -128,72 +128,110 @@ private AuthorizationManager(HttpPipeline httpPipeline, AzureProfile profile) {
     }
 
     /**
+     * Gets wrapped inner authorization client.
+     *
      * @return wrapped inner authorization client providing direct access to auto-generated API implementation, based on
      *     Azure REST API
      */
     public AuthorizationManagementClient roleServiceClient() {
         return authorizationManagementClient;
     }
 
-    /** @return the tenant ID the graph client is associated with */
+    /**
+     * Gets the tenant ID the graph client is associated with.
+     *
+     * @return the tenant ID the graph client is associated with
+     */
     public String tenantId() {
         return tenantId;
     }
 
-    /** @return the environment the graph client is associated with */
+    /**
+     * Gets the environment the graph client is associated with.
+     *
+     * @return the environment the graph client is associated with
+     */
     public AzureEnvironment environment() {
         return environment;
     }
 
-    /** @return the {@link ResourceManagerUtils.InternalRuntimeContext} associated with this manager */
+    /**
+     * Gets the {@link ResourceManagerUtils.InternalRuntimeContext} associated with this manager.
+     *
+     * @return the {@link ResourceManagerUtils.InternalRuntimeContext} associated with this manager
+     */
     public ResourceManagerUtils.InternalRuntimeContext internalContext() {
         if (internalContext == null) {
             internalContext = new ResourceManagerUtils.InternalRuntimeContext();
         }
         return internalContext;
     }
 
-    /** @return the Active Directory user management API entry point */
+    /**
+     * Gets the Active Directory user management API entry point.
+     *
+     * @return the Active Directory user management API entry point
+     */
     public ActiveDirectoryUsers users() {
         if (activeDirectoryUsers == null) {
             activeDirectoryUsers = new ActiveDirectoryUsersImpl(this);
         }
         return activeDirectoryUsers;
     }
 
-    /** @return the Active Directory group management API entry point */
+    /**
+     * Gets the Active Directory group management API entry point.
+     *
+     * @return the Active Directory group management API entry point
+     */
     public ActiveDirectoryGroups groups() {
         if (activeDirectoryGroups == null) {
             activeDirectoryGroups = new ActiveDirectoryGroupsImpl(this);
         }
         return activeDirectoryGroups;
     }
 
-    /** @return the service principal management API entry point */
+    /**
+     * Gets the service principal management API entry point.
+     *
+     * @return the service principal management API entry point
+     */
     public ServicePrincipals servicePrincipals() {
         if (servicePrincipals == null) {
             servicePrincipals = new ServicePrincipalsImpl(this);
         }
         return servicePrincipals;
     }
 
-    /** @return the application management API entry point */
+    /**
+     * Gets the application management API entry point.
+     *
+     * @return the application management API entry point
+     */
     public ActiveDirectoryApplications applications() {
         if (applications == null) {
             applications = new ActiveDirectoryApplicationsImpl(this);
         }
         return applications;
     }
 
-    /** @return the role assignment management API entry point */
+    /**
+     * Gets the role assignment management API entry point.
+     *
+     * @return the role assignment management API entry point
+     */
     public RoleAssignments roleAssignments() {
         if (roleAssignments == null) {
             roleAssignments = new RoleAssignmentsImpl(this);
         }
         return roleAssignments;
     }
 
-    /** @return the role definition management API entry point */
+    /**
+     * Gets the role definition management API entry point.
+     *
+     * @return the role definition management API entry point
+     */
     public RoleDefinitions roleDefinitions() {
         if (roleDefinitions == null) {
             roleDefinitions = new RoleDefinitionsImpl(this);

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/ActiveDirectoryApplication.java

@@ -18,7 +18,11 @@
 @Fluent
 public interface ActiveDirectoryApplication extends ActiveDirectoryObject,
     HasInnerModel<MicrosoftGraphApplicationInner>, Updatable<ActiveDirectoryApplication.Update> {
-    /** @return the application ID */
+    /**
+     * Gets the application ID.
+     *
+     * @return the application ID
+     */
     String applicationId();
 
     /**
@@ -29,23 +33,45 @@ public interface ActiveDirectoryApplication extends ActiveDirectoryObject,
     boolean availableToOtherTenants();
 
     /**
+     * Gets the application account type.
+     *
      * @return the application account type
      */
     ApplicationAccountType accountType();
 
-    /** @return a collection of URIs for the application */
+    /**
+     * Gets a collection of URIs for the application.
+     *
+     * @return a collection of URIs for the application
+     */
     Set<String> identifierUris();
 
-    /** @return a collection of reply URLs for the application */
+    /**
+     * Gets a collection of reply URLs for the application.
+     *
+     * @return a collection of reply URLs for the application
+     */
     Set<String> replyUrls();
 
-    /** @return the home page of the application */
+    /**
+     * Gets the home page of the application.
+     *
+     * @return the home page of the application
+     */
     URL signOnUrl();
 
-    /** @return the mapping of password credentials from their names */
+    /**
+     * Gets the mapping of password credentials from their names.
+     *
+     * @return the mapping of password credentials from their names
+     */
     Map<String, PasswordCredential> passwordCredentials();
 
-    /** @return the mapping of certificate credentials from their names */
+    /**
+     * Gets the mapping of certificate credentials from their names.
+     *
+     * @return the mapping of certificate credentials from their names
+     */
     Map<String, CertificateCredential> certificateCredentials();
 
     /**************************************************************

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/ActiveDirectoryGroup.java

@@ -17,10 +17,18 @@
 @Fluent
 public interface ActiveDirectoryGroup
     extends ActiveDirectoryObject, HasInnerModel<MicrosoftGraphGroupInner>, Updatable<ActiveDirectoryGroup.Update> {
-    /** @return security enabled field. */
+    /**
+     * Check whether security enabled field.
+     *
+     * @return security enabled field.
+     */
     boolean securityEnabled();
 
-    /** @return mail field. */
+    /**
+     * Gets mail field.
+     *
+     * @return mail field.
+     */
     String mail();
 
     /**

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/ActiveDirectoryUser.java

@@ -15,16 +15,32 @@
 @Fluent
 public interface ActiveDirectoryUser
     extends ActiveDirectoryObject, HasInnerModel<MicrosoftGraphUserInner>, Updatable<ActiveDirectoryUser.Update> {
-    /** @return user principal name */
+    /**
+     * Gets user principal name.
+     *
+     * @return user principal name
+     */
     String userPrincipalName();
 
-    /** @return user mail */
+    /**
+     * Gets user mail.
+     *
+     * @return user mail
+     */
     String mail();
 
-    /** @return the mail alias for the user */
+    /**
+     * Gets the mail alias for the user.
+     *
+     * @return the mail alias for the user
+     */
     String mailNickname();
 
-    /** @return the usage location of the user */
+    /**
+     * Gets the usage location of the user.
+     *
+     * @return the usage location of the user
+     */
     CountryIsoCode usageLocation();
 
     /**************************************************************

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/ApplicationAccountType.java

@@ -23,6 +23,15 @@ public final class ApplicationAccountType extends ExpandableStringEnum<Applicati
     /** Users with a personal Microsoft account only. */
     public static final ApplicationAccountType PERSONAL_MICROSOFT_ACCOUNT = fromString("PersonalMicrosoftAccount");
 
+    /**
+     * Creates a new instance of ApplicationAccountType value.
+     *
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public ApplicationAccountType() {
+    }
+
     /**
      * Creates or finds a ApplicationAccountType from its string representation.
      *
@@ -33,7 +42,11 @@ public static ApplicationAccountType fromString(String name) {
         return fromString(name, ApplicationAccountType.class);
     }
 
-    /** @return known ApplicationAccountType values. */
+    /**
+     * Gets known ApplicationAccountType values.
+     *
+     * @return known ApplicationAccountType values.
+     */
     public static Collection<ApplicationAccountType> values() {
         return values(ApplicationAccountType.class);
     }

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/BuiltInRole.java

@@ -234,6 +234,15 @@ public final class BuiltInRole extends ExpandableStringEnum<BuiltInRole> {
     /** Read and create quota requests, get quota request status, and create support tickets. */
     public static final BuiltInRole QUOTA_REQUEST_OPERATOR = BuiltInRole.fromString("Quota Request Operator");
 
+    /**
+     * Creates a new instance of BuiltInRole value.
+     *
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public BuiltInRole() {
+    }
+
     /**
      * Finds or creates a role instance based on the specified name.
      *
@@ -244,7 +253,10 @@ public static BuiltInRole fromString(String name) {
         return fromString(name, BuiltInRole.class);
     }
 
-    /** @return known roles */
+    /**
+     * Gets known roles.
+     *
+     * @return known roles */
     public static Collection<BuiltInRole> values() {
         return values(BuiltInRole.class);
     }

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/CertificateCredential.java

@@ -122,7 +122,11 @@ interface WithDuration<ParentT> {
             WithAttach<ParentT> withDuration(Duration duration);
         }
 
-        /** A credential definition stage allowing exporting the auth file for the service principal. */
+        /**
+         * A credential definition stage allowing exporting the auth file for the service principal.
+         *
+         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
+         */
         interface WithAuthFile<ParentT> {
             /**
              * Export the information of this service principal into an auth file.
@@ -135,7 +139,10 @@ interface WithAuthFile<ParentT> {
             WithAuthFileCertificate<ParentT> withAuthFileToExport(OutputStream outputStream);
         }
 
-        /** A credential definition stage allowing specifying the private key for exporting an auth file. */
+        /** A credential definition stage allowing specifying the private key for exporting an auth file.
+         *
+         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
+         */
         interface WithAuthFileCertificate<ParentT> {
             /**
              * Export the information of this service principal into an auth file.
@@ -149,6 +156,8 @@ interface WithAuthFileCertificate<ParentT> {
         /**
          * A credential definition stage allowing specifying the password for the private key for exporting an auth
          * file.
+         *
+         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
          */
         interface WithAuthFileCertificatePassword<ParentT> {
             /**

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/CertificateType.java

@@ -15,6 +15,15 @@ public final class CertificateType extends ExpandableStringEnum<CertificateType>
     /** Static value Symmetric for CertificateType. */
     public static final CertificateType SYMMETRIC = CertificateType.fromString("Symmetric");
 
+    /**
+     * Creates a new instance of CertificateType value.
+     *
+     * @deprecated Use the {@link #fromString(String)} factory method.
+     */
+    @Deprecated
+    public CertificateType() {
+    }
+
     /**
      * Finds or creates a certificate type instance based on the specified name.
      *
@@ -25,7 +34,11 @@ public static CertificateType fromString(String name) {
         return fromString(name, CertificateType.class);
     }
 
-    /** @return known certificate types */
+    /**
+     * Gets known certificate types.
+     *
+     * @return known certificate types
+     */
     public static Collection<CertificateType> values() {
         return values(CertificateType.class);
     }

sdk/resourcemanager/azure-resourcemanager-authorization/src/main/java/com/azure/resourcemanager/authorization/models/Credential.java

@@ -12,12 +12,24 @@
 /** An immutable client-side representation of an Azure AD credential. */
 @Fluent
 public interface Credential extends Indexable, HasId, HasName {
-    /** @return start date. */
+    /**
+     * Gets start date.
+     *
+     * @return start date.
+     */
     OffsetDateTime startDate();
 
-    /** @return end date. */
+    /**
+     * Gets end date.
+     *
+     * @return end date.
+     */
     OffsetDateTime endDate();
 
-    /** @return key value. */
+    /**
+     * Gets key value.
+     *
+     * @return key value.
+     */
     String value();
 }