Fix javadoc description and package groups (Azure#4074)

* Fix javadoc description and package groups

* Include unit test coverage for identity

* re-order javadoc package groups

appconfiguration/client/src/main/java/com/azure/data/appconfiguration/credentials/package-info.java

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 /**
- * This package contains classes used to authenticate with Azure Application Configuration service.
+ * Package containing classes used to authenticate with Azure Application Configuration service.
  */
 package com.azure.data.appconfiguration.credentials;

appconfiguration/client/src/main/java/com/azure/data/appconfiguration/implementation/package-info.java

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 /**
- * This package contains implementation classes for communicating with Azure Application Configuration service.
+ * Package containing implementation classes for communicating with Azure Application Configuration service.
  * Should not be used.
  */
 package com.azure.data.appconfiguration.implementation;

appconfiguration/client/src/main/java/com/azure/data/appconfiguration/models/package-info.java

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 /**
- * This package contains classes used for creating and selecting configuration settings in Azure Application
+ * Package containing classes used for creating and selecting configuration settings in Azure Application
  * Configuration service.
  */
 package com.azure.data.appconfiguration.models;

appconfiguration/client/src/main/java/com/azure/data/appconfiguration/package-info.java

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 /**
- * This package contains the classes for creating a {@link com.azure.data.appconfiguration.ConfigurationAsyncClient} to
+ * Package containing classes for creating a {@link com.azure.data.appconfiguration.ConfigurationAsyncClient} to
  * perform operations on Azure Application Configuration service.
  */
 package com.azure.data.appconfiguration;

appconfiguration/client/src/main/java/com/azure/data/appconfiguration/policy/package-info.java

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 /**
- * This package contains policies used by Azure Application Configuration service.
+ * Package containing policies used by Azure Application Configuration service.
  */
 package com.azure.data.appconfiguration.policy;

core/azure-core-amqp/src/main/java/com/azure/core/amqp/exception/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * Package contains classes related to AMQP exceptions.
+ * Package containing classes related to AMQP exceptions.
  */
 package com.azure.core.amqp.exception;

core/azure-core-amqp/src/main/java/com/azure/core/amqp/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * Package contains classes common to AMQP protocol.
+ * Package containing classes common to AMQP protocol.
  */
 package com.azure.core.amqp;

core/azure-core-auth/src/main/java/com/azure/core/auth/credentials/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * The package provides credential classes for Azure authentication purposes.
+ * Package containing credential classes for Azure authentication purposes.
  */
 package com.azure.core.auth.credentials;

core/azure-core-management/src/main/java/com/azure/core/management/annotations/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * Annotations used on Swagger generated interfaces that are specific to Azure ARM REST APIs.
+ * Package containing annotations used on Swagger generated interfaces that are specific to Azure ARM REST APIs.
  */
 package com.azure.core.management.annotations;

core/azure-core-management/src/main/java/com/azure/core/management/serializer/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * The package contains classes that handle serialization and deserialization for the REST call payloads in Azure ARM.
+ * Package containing classes that handle serialization and deserialization for the REST call payloads in Azure ARM.
  */
 package com.azure.core.management.serializer;

eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecks.java

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 package com.azure.tools.checkstyle.checks;
 
 import com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter;
@@ -90,6 +93,9 @@ public void visitToken(DetailAST token) {
                     addExceptionMapping(token);
                 }
                 break;
+            default:
+                // Checkstyle complains if there's no default block in switch
+                break;
         }
     }
 
@@ -259,6 +265,9 @@ private void verifyUncheckedThrowJavadoc(DetailAST throwToken) {
             }
         } else if (methodCallToken != null) {
             // Throwing a method call.
+            // Checkstyle complains about empty blocks.
+            // TODO: Should we ignore this checkstyle error?
+            return;
         } else {
             // Throwing an un-casted variable.
             String throwIdent = throwExprToken.findFirstToken(TokenTypes.IDENT).getText();

eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 package com.azure.tools.checkstyle.checks;
 
 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
@@ -102,6 +105,9 @@ public void visitToken(DetailAST ast) {
                     }
                 }
                 break;
+            default:
+                // Checkstyle complains if there's no default block in switch
+                break;
         }
 
     }

eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientChecks.java

@@ -96,6 +96,9 @@ public void visitToken(DetailAST token) {
                     this.hasStaticBuilder = true;
                 }
                 break;
+            default:
+                // Checkstyle complains if there's no default block in switch
+                break;
         }
     }
 

eng/code-quality-reports/src/test/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecksTests.java

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 package com.azure.tools.checkstyle.checks;
 
 import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;

eng/jacoco-test-coverage/pom.xml

@@ -81,6 +81,11 @@
       <artifactId>tracing-opentelemetry</artifactId>
       <version>${version}</version>
     </dependency>
+    <dependency>
+      <groupId>com.azure</groupId>
+      <artifactId>azure-identity</artifactId>
+      <version>${version}</version>
+    </dependency>
     <!-- Not required for jacoco test coverage report -->
 <!--    <dependency>-->
 <!--      <groupId>com.azure</groupId>-->

eventhubs/client/azure-eventhubs/src/main/java/com/azure/messaging/eventhubs/package-info.java

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 /**
- * This package contains the classes for creating a {@link com.azure.messaging.eventhubs.EventHubClient} to
+ * Package containing classes for creating a {@link com.azure.messaging.eventhubs.EventHubClient} to
  * perform operations on Azure Event Hubs.
  */
 package com.azure.messaging.eventhubs;

identity/client/src/main/java/com/azure/identity/credential/package-info.java

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Package containing various types of credentials
+ */
+package com.azure.identity.credential;

identity/client/src/main/java/com/azure/identity/package-info.java

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Package containing classes for retrieving access tokens from various configurations
+ */
+package com.azure.identity;

keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/package-info.java

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 /**
- * This package contains classes used for representing keys, deleted keys and their attributes in
+ * Package containing classes used for representing keys, deleted keys and their attributes in
  * Azure Key Vault.
  */
 package com.azure.keyvault.keys.models;

keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/webkey/package-info.java

@@ -2,6 +2,6 @@
 // Licensed under the MIT License.
 
 /**
- * This package contains the classes for key vault JSON web key. 
+ * Package containing classes for key vault JSON web key.
  */
 package com.azure.keyvault.keys.models.webkey;

keyvault/client/keys/src/main/java/com/azure/keyvault/keys/package-info.java

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 /**
- * This package contains the classes for creating {@link com.azure.keyvault.keys.KeyAsyncClient} and
+ * Package containing classes for creating {@link com.azure.keyvault.keys.KeyAsyncClient} and
  * {@link com.azure.keyvault.keys.KeyClient} to perform operations on Azure Key Vault.
  */
 package com.azure.keyvault.keys;

keyvault/client/secrets/src/main/java/com/azure/keyvault/models/package-info.java

@@ -6,4 +6,9 @@
  * This package contains classes used for representing secrets, deleted secrets and their attributes in the Azure
  * Key Vault.
  */
+
+/**
+ * Package containing classes used for representing secrets, deleted secrets and their attributes in
+ * Azure Key Vault.
+ */
 package com.azure.keyvault.models;

keyvault/client/secrets/src/main/java/com/azure/keyvault/package-info.java

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 /**
- * This package contains the classes for creating {@link com.azure.keyvault.SecretAsyncClient} and {@link com.azure.keyvault.SecretClient} to
+ * Package containing classes for creating {@link com.azure.keyvault.SecretAsyncClient} and {@link com.azure.keyvault.SecretClient} to
  * perform operations on Azure Key Vault.
  */
 package com.azure.keyvault;

pom.client.xml

@@ -272,7 +272,7 @@
             <phase>package</phase>
             <configuration>
               <target>
-                <copy file="${pomFile}" tofile="${packageOutputDirectory}/${project.build.finalName}.pom"/>
+                <copy file="${project.pomFile}" tofile="${packageOutputDirectory}/${project.build.finalName}.pom"/>
               </target>
             </configuration>
             <goals>
@@ -342,7 +342,8 @@
               *.impl*:
               *.implementation*:
               com.azure.tracing*:
-              com.azure.core.test*
+              com.azure.core.test*:
+              com.azure.tools.checkstyle*
             </excludePackageNames>
             <groups>
               <group>
@@ -351,18 +352,18 @@
                   com.azure.core:com.azure.core.annotations:com.azure.core.credentials:com.azure.core.exception:com.azure.core.http*
                 </packages>
               </group>
-              <group>
-                <title>Azure Core - Management</title>
-                <packages>com.azure.core.management*</packages>
-              </group>
               <group>
                 <title>Azure Core - AMQP</title>
                 <packages>com.azure.core.amqp*</packages>
-                </group>
+              </group>
               <group>
                 <title>Azure Core - Authentication</title>
                 <packages>com.azure.core.auth*</packages>
               </group>
+              <group>
+                <title>Azure Core - Management</title>
+                <packages>com.azure.core.management*</packages>
+              </group>
               <group>
                 <title>Azure App Configuration</title>
                 <packages>com.azure.data.appconfiguration*</packages>
@@ -371,6 +372,10 @@
                 <title>Azure Event Hubs</title>
                 <packages>com.azure.messaging.eventhubs*</packages>
               </group>
+              <group>
+                <title>Azure Identity</title>
+                <packages>com.azure.identity*</packages>
+              </group>
               <group>
                 <title>Azure Key Vault</title>
                 <packages>com.azure.keyvault*</packages>