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

add javadoc for storage queue and messaging #27532

Merged
merged 1 commit into from
Mar 9, 2022

Conversation

yiliuTo
Copy link
Member

@yiliuTo yiliuTo commented Mar 9, 2022

As subject, to resolve API review issues.

@ghost ghost added the azure-spring All azure-spring related issues label Mar 9, 2022
@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-messaging-azure. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-messaging-azure-servicebus. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-messaging-azure-storage-queue. You can review API changes here

Copy link
Contributor

@backwind1233 backwind1233 left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -62,7 +62,7 @@ protected void doStart() {

@Override
protected void doStop() {
this.delegate.start();
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

Copy link
Member

Choose a reason for hiding this comment

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

good catch

@@ -52,6 +52,10 @@ public String getConnectionString() {
return connectionString;
}

/**
* Set the connection string to connect to the service.
Copy link
Contributor

Choose a reason for hiding this comment

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

better add an empty line here
image

Copy link
Member Author

Choose a reason for hiding this comment

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

Hey, I noticed that most of the setters' javadoc in our xxProperties.java don't have that empty line, need we follow that?

Copy link
Member

Choose a reason for hiding this comment

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

either is okay

Copy link
Contributor

Choose a reason for hiding this comment

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

it's up to you @yiliuTo

FYI: example

Choose a reason for hiding this comment

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

We have a lot of things to do to improve the java doc.

6 month ago, I create an issue: #24332, which is intended to do this. But this issue is closed without satisfy the requirement.

Since we are in hurry to release 4.0, we do not have enough time to improve the java doc. My current suggestions is improve the java doc's quality for new classes and new public methods.

We can get a lot of documents by searching by google. For example: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

Copy link
Member

@saragluna saragluna left a comment

Choose a reason for hiding this comment

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

LGTM.

@yiliuTo yiliuTo merged commit a93c38c into Azure:feature/azure-spring-cloud-4.0 Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
azure-spring All azure-spring related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants