-
Notifications
You must be signed in to change notification settings - Fork 2k
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
add javadoc for storage queue and messaging #27532
Conversation
API changes have been detected in |
API changes have been detected in |
API changes have been detected in |
There was a problem hiding this 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(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
either is okay
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
As subject, to resolve API review issues.