From 287557c45f4b84f05b20c612ef717dd361f24018 Mon Sep 17 00:00:00 2001 From: Srikanta <51379715+srnagar@users.noreply.github.com> Date: Mon, 24 Jun 2019 14:57:14 -0700 Subject: [PATCH] Fix javadoc description and package groups (#4074) * Fix javadoc description and package groups * Include unit test coverage for identity * re-order javadoc package groups --- .../credentials/package-info.java | 2 +- .../implementation/package-info.java | 2 +- .../appconfiguration/models/package-info.java | 2 +- .../data/appconfiguration/package-info.java | 2 +- .../appconfiguration/policy/package-info.java | 2 +- .../core/amqp/exception/package-info.java | 2 +- .../com/azure/core/amqp/package-info.java | 2 +- .../core/auth/credentials/package-info.java | 2 +- .../management/annotations/package-info.java | 2 +- .../management/serializer/package-info.java | 2 +- .../checks/JavadocThrowsChecks.java | 9 +++++++++ .../checkstyle/checks/NoImplInPublicAPI.java | 6 ++++++ .../checks/ServiceClientChecks.java | 3 +++ .../checks/JavadocThrowsChecksTests.java | 3 +++ eng/jacoco-test-coverage/pom.xml | 5 +++++ .../messaging/eventhubs/package-info.java | 2 +- .../identity/credential/package-info.java | 7 +++++++ .../java/com/azure/identity/package-info.java | 7 +++++++ .../keyvault/keys/models/package-info.java | 2 +- .../keys/models/webkey/package-info.java | 2 +- .../com/azure/keyvault/keys/package-info.java | 2 +- .../azure/keyvault/models/package-info.java | 5 +++++ .../java/com/azure/keyvault/package-info.java | 2 +- pom.client.xml | 19 ++++++++++++------- 24 files changed, 72 insertions(+), 22 deletions(-) create mode 100644 identity/client/src/main/java/com/azure/identity/credential/package-info.java create mode 100644 identity/client/src/main/java/com/azure/identity/package-info.java diff --git a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/credentials/package-info.java b/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/credentials/package-info.java index 094a588c0adc..2bb81ada22b2 100644 --- a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/credentials/package-info.java +++ b/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; diff --git a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/implementation/package-info.java b/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/implementation/package-info.java index 0dc238712eee..986a8a5b6032 100644 --- a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/implementation/package-info.java +++ b/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; diff --git a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/models/package-info.java b/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/models/package-info.java index 31ae4e40cd79..9aa6a57c3316 100644 --- a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/models/package-info.java +++ b/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; diff --git a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/package-info.java b/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/package-info.java index 05c7f6a89ac8..e9a6f1efe1f7 100644 --- a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/package-info.java +++ b/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; diff --git a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/policy/package-info.java b/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/policy/package-info.java index 925b90aad443..74a7157d5eb5 100644 --- a/appconfiguration/client/src/main/java/com/azure/data/appconfiguration/policy/package-info.java +++ b/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; diff --git a/core/azure-core-amqp/src/main/java/com/azure/core/amqp/exception/package-info.java b/core/azure-core-amqp/src/main/java/com/azure/core/amqp/exception/package-info.java index c566a417b8d1..9f3e05a4b6f1 100644 --- a/core/azure-core-amqp/src/main/java/com/azure/core/amqp/exception/package-info.java +++ b/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; diff --git a/core/azure-core-amqp/src/main/java/com/azure/core/amqp/package-info.java b/core/azure-core-amqp/src/main/java/com/azure/core/amqp/package-info.java index 97b600ef1900..bad36a2ea188 100644 --- a/core/azure-core-amqp/src/main/java/com/azure/core/amqp/package-info.java +++ b/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; diff --git a/core/azure-core-auth/src/main/java/com/azure/core/auth/credentials/package-info.java b/core/azure-core-auth/src/main/java/com/azure/core/auth/credentials/package-info.java index e4b4cc6ad4de..53bdfc0d182e 100644 --- a/core/azure-core-auth/src/main/java/com/azure/core/auth/credentials/package-info.java +++ b/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; diff --git a/core/azure-core-management/src/main/java/com/azure/core/management/annotations/package-info.java b/core/azure-core-management/src/main/java/com/azure/core/management/annotations/package-info.java index 757141f3b299..cdac0bd6f9e4 100644 --- a/core/azure-core-management/src/main/java/com/azure/core/management/annotations/package-info.java +++ b/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; diff --git a/core/azure-core-management/src/main/java/com/azure/core/management/serializer/package-info.java b/core/azure-core-management/src/main/java/com/azure/core/management/serializer/package-info.java index 9c22fe454916..b955eec7235d 100644 --- a/core/azure-core-management/src/main/java/com/azure/core/management/serializer/package-info.java +++ b/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; diff --git a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecks.java b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecks.java index d03fb8576400..01fd42149ae2 100644 --- a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecks.java +++ b/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(); diff --git a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java index 51b9b173020c..3b4250c5aa2d 100644 --- a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/NoImplInPublicAPI.java +++ b/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; } } diff --git a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientChecks.java b/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientChecks.java index 47071c72491d..d5e15ce5f1f1 100644 --- a/eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/ServiceClientChecks.java +++ b/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; } } diff --git a/eng/code-quality-reports/src/test/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecksTests.java b/eng/code-quality-reports/src/test/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecksTests.java index ae98468fbab7..1e146fb115af 100644 --- a/eng/code-quality-reports/src/test/java/com/azure/tools/checkstyle/checks/JavadocThrowsChecksTests.java +++ b/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; diff --git a/eng/jacoco-test-coverage/pom.xml b/eng/jacoco-test-coverage/pom.xml index a32bd442783d..acf9d3ddf0ad 100644 --- a/eng/jacoco-test-coverage/pom.xml +++ b/eng/jacoco-test-coverage/pom.xml @@ -81,6 +81,11 @@ tracing-opentelemetry ${version} + + com.azure + azure-identity + ${version} + diff --git a/eventhubs/client/azure-eventhubs/src/main/java/com/azure/messaging/eventhubs/package-info.java b/eventhubs/client/azure-eventhubs/src/main/java/com/azure/messaging/eventhubs/package-info.java index f5c0b6ae16a2..be66de93036a 100644 --- a/eventhubs/client/azure-eventhubs/src/main/java/com/azure/messaging/eventhubs/package-info.java +++ b/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; diff --git a/identity/client/src/main/java/com/azure/identity/credential/package-info.java b/identity/client/src/main/java/com/azure/identity/credential/package-info.java new file mode 100644 index 000000000000..4a8d5f0c0063 --- /dev/null +++ b/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; diff --git a/identity/client/src/main/java/com/azure/identity/package-info.java b/identity/client/src/main/java/com/azure/identity/package-info.java new file mode 100644 index 000000000000..c2eb4440ede1 --- /dev/null +++ b/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; diff --git a/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/package-info.java b/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/package-info.java index 08639a70d40c..13d069efd7f8 100644 --- a/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/package-info.java +++ b/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; diff --git a/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/webkey/package-info.java b/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/webkey/package-info.java index b61681b8a0fe..0ee7608c73e1 100644 --- a/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/models/webkey/package-info.java +++ b/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; diff --git a/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/package-info.java b/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/package-info.java index 2008dea3203a..c21aa740e0d9 100644 --- a/keyvault/client/keys/src/main/java/com/azure/keyvault/keys/package-info.java +++ b/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; diff --git a/keyvault/client/secrets/src/main/java/com/azure/keyvault/models/package-info.java b/keyvault/client/secrets/src/main/java/com/azure/keyvault/models/package-info.java index d1027c0946d7..842fffb8fb88 100644 --- a/keyvault/client/secrets/src/main/java/com/azure/keyvault/models/package-info.java +++ b/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; diff --git a/keyvault/client/secrets/src/main/java/com/azure/keyvault/package-info.java b/keyvault/client/secrets/src/main/java/com/azure/keyvault/package-info.java index 42a06c89a18f..9b9918d0da39 100644 --- a/keyvault/client/secrets/src/main/java/com/azure/keyvault/package-info.java +++ b/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; diff --git a/pom.client.xml b/pom.client.xml index 5f1695bcfbe3..194339ebbc5f 100644 --- a/pom.client.xml +++ b/pom.client.xml @@ -272,7 +272,7 @@ package - + @@ -342,7 +342,8 @@ *.impl*: *.implementation*: com.azure.tracing*: - com.azure.core.test* + com.azure.core.test*: + com.azure.tools.checkstyle* @@ -351,18 +352,18 @@ com.azure.core:com.azure.core.annotations:com.azure.core.credentials:com.azure.core.exception:com.azure.core.http* - - Azure Core - Management - com.azure.core.management* - Azure Core - AMQP com.azure.core.amqp* - + Azure Core - Authentication com.azure.core.auth* + + Azure Core - Management + com.azure.core.management* + Azure App Configuration com.azure.data.appconfiguration* @@ -371,6 +372,10 @@ Azure Event Hubs com.azure.messaging.eventhubs* + + Azure Identity + com.azure.identity* + Azure Key Vault com.azure.keyvault*