Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix javadoc description and package groups #4074

Merged
merged 3 commits into from
Jun 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Expand Down Expand Up @@ -90,6 +93,9 @@ public void visitToken(DetailAST token) {
addExceptionMapping(token);
}
break;
default:
// Checkstyle complains if there's no default block in switch
break;
}
}

Expand Down Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
@@ -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;
Expand Down Expand Up @@ -102,6 +105,9 @@ public void visitToken(DetailAST ast) {
}
}
break;
default:
// Checkstyle complains if there's no default block in switch
break;
}

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
5 changes: 5 additions & 0 deletions eng/jacoco-test-coverage/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>-->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
@@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Original file line number Diff line number Diff line change
Expand Up @@ -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;
19 changes: 12 additions & 7 deletions pom.client.xml
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,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>
Expand Down Expand Up @@ -338,25 +338,26 @@
*.impl*:
*.implementation*:
com.azure.tracing*:
com.azure.core.test*
com.azure.core.test*:
com.azure.tools.checkstyle*
</excludePackageNames>
<groups>
<group>
<title>Azure Core</title>
<packages>com.azure.core:com.azure.core.annotations:com.azure.core.credentials:com.azure.core.exception:com.azure.core.http*:com.azure.core.configuration:com.azure.core.util*</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>
Expand All @@ -365,6 +366,10 @@
<title>Azure Event Hubs</title>
<packages>com.azure.messaging.eventhubs*</packages>
</group>
<group>
<title>Azure Identity</title>
<packages>com.azure.identity*</packages>
</group>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sort these alphabetically - Identity before Key Vault

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should they be sorted based on title or package? If it's based on package, event hub will move to the bottom and if it's the title, app config will move to the top. This decides the order in which the javadocs are actually generated. So, we can say, Core will be at the top and then all client library titles are alphabetically sorted?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

<group>
<title>Azure Key Vault</title>
<packages>com.azure.keyvault*</packages>
Expand Down