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

8252830: Correct missing javadoc comments in java.rmi module #79

Closed

Conversation

RogerRiggs
Copy link
Contributor

@RogerRiggs RogerRiggs commented Sep 8, 2020


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8252830: Correct missing javadoc comments in java.rmi module

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/79/head:pull/79
$ git checkout pull/79

@RogerRiggs RogerRiggs closed this Sep 8, 2020
@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Sep 8, 2020

👋 Welcome back rriggs! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@RogerRiggs RogerRiggs reopened this Sep 8, 2020
@RogerRiggs
Copy link
Contributor Author

@RogerRiggs RogerRiggs commented Sep 8, 2020

Add the missing comments where required by javadoc -Xdoclint to document public and serializable classes, methods, and fields.

@openjdk
Copy link

@openjdk openjdk bot commented Sep 8, 2020

@RogerRiggs The following label will be automatically applied to this pull request: core-libs.

When this pull request is ready to be reviewed, an RFR email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label (add|remove) "label" command.

@openjdk openjdk bot added the core-libs label Sep 8, 2020
@RogerRiggs RogerRiggs changed the title Added missing comments in java.rmi 8252830: Added missing javadoc comments in java.rmi Sep 8, 2020
@openjdk openjdk bot added the rfr label Sep 8, 2020
@RogerRiggs
Copy link
Contributor Author

@RogerRiggs RogerRiggs commented Sep 8, 2020

/csr

@openjdk openjdk bot added the csr label Sep 8, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Sep 8, 2020

@RogerRiggs has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@RogerRiggs please create a CSR request and add link to it in JDK-8252830. This pull request cannot be integrated until the CSR request is approved.

@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 8, 2020

Webrevs

@RogerRiggs RogerRiggs changed the title 8252830: Added missing javadoc comments in java.rmi 8252830: Correct missing javadoc comments in java.rmi Sep 8, 2020
@RogerRiggs RogerRiggs changed the title 8252830: Correct missing javadoc comments in java.rmi 8252830: Correct missing javadoc comments in java.rmi module Sep 8, 2020
* @param in the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*
*/
private void readObject(ObjectInputStream in)
Copy link
Member

@dfuch dfuch Sep 8, 2020

Choose a reason for hiding this comment

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

Hi Roger, you could take this opportunity to add the @Serial annotation to this method (here and in the other files you modified as well.

@@ -228,6 +228,9 @@ public boolean equals(Object obj) {
* java.rmi.server.RemoteObject RemoteObject}
* <code>writeObject</code> method <b>serialData</b>
* specification.
*
* @param out the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
**/
private void writeObject(ObjectOutputStream out)
Copy link
Member

@dfuch dfuch Sep 8, 2020

Choose a reason for hiding this comment

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

Same comment as above...

Copy link
Contributor

@LanceAndersen LanceAndersen left a comment

Hi Roger,

The combined changes to both commits look good

@openjdk
Copy link

@openjdk openjdk bot commented Sep 8, 2020

@RogerRiggs This change now passes all automated pre-integration checks. In addition to the automated checks, the change must also fulfill all project specific requirements

After integration, the commit message will be:

8252830: Correct missing javadoc comments in java.rmi module

Reviewed-by: dfuchs, lancea, smarks, chegar
  • If you would like to add a summary, use the /summary command.
  • To credit additional contributors, use the /contributor command.
  • To add additional solved issues, use the /issue command.

Since the source branch of this PR was last updated there have been 44 commits pushed to the master branch:

  • 41d29b7: 8252774: remove jdk.test.lib.FileInstaller action from graalunit tests
  • 5b30a83: 8252778: remove jdk.test.lib.FileInstaller action from compiler/c2/stemmer test
  • 8db3335: 8247928: Refactor G1ConcurrentMarkThread for mark abort
  • 7ccf435: 8252846: Fix ppc/s390 after "8231441: AArch64: Initial SVE backend su…
  • d236cf4: 8252995: Non-PCH builds broken by JDK-8250961
  • 6a00534: 8250961: Move Universe::update_heap_info_at_gc to CollectedHeap
  • f78f780: 8252889: Obsolete -XX:+InsertMemBarAfterArraycopy
  • f933961: 8252980: comment only changes extracted from JDK-8247281
  • 4333942: 8250217: com.sun.tools.javac.api.JavacTaskImpl swallows compiler exceptions potentially producing false positive test results
  • 5166094: 8252957: Wrong comment in CgroupV1Subsystem::cpu_quota
  • ... and 34 more: https://git.openjdk.java.net/jdk/compare/5d2e79e2c38ff79c1d5712aa77d5ac98eef9f97c...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid automatic rebasing, please merge master into your branch, and then specify the current head hash when integrating, like this: /integrate 41d29b752b3b5835399bc5f119e4ba3aedc1d046.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready label Sep 8, 2020
dfuch
dfuch approved these changes Sep 8, 2020
Copy link
Member

@dfuch dfuch left a comment

Otherwise looks good.

@@ -228,6 +229,9 @@ public boolean equals(Object obj) {
* java.rmi.server.RemoteObject RemoteObject}
* <code>writeObject</code> method <b>serialData</b>
* specification.
*
* @param out the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
**/
private void writeObject(ObjectOutputStream out)
Copy link
Member

@dfuch dfuch Sep 8, 2020

Choose a reason for hiding this comment

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

one @Serial still missing here?

dfuch
dfuch approved these changes Sep 8, 2020
*/
@java.io.Serial
private void writeObject(java.io.ObjectOutputStream out)
throws java.io.IOException
Copy link
Member

@stuart-marks stuart-marks Sep 8, 2020

Choose a reason for hiding this comment

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

It's a little odd to see an import of java.io.IOException (which is used by the @throws tag) but not to have it used here. There's another occurrence down below. These files have a mixture of imports and fully qualified names, which I find irritating, which might be nice to clean up. But you might find beyond the scope of this change. So, clean up as much of this as you like, or none if you prefer, no big deal.

@RogerRiggs
Copy link
Contributor Author

@RogerRiggs RogerRiggs commented Sep 9, 2020

@openjdk openjdk bot removed the csr label Sep 9, 2020
@RogerRiggs
Copy link
Contributor Author

@RogerRiggs RogerRiggs commented Sep 10, 2020

/integrate

@openjdk openjdk bot closed this Sep 10, 2020
@openjdk openjdk bot added integrated and removed ready rfr labels Sep 10, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Sep 10, 2020

@RogerRiggs Since your change was applied there have been 44 commits pushed to the master branch:

  • 41d29b7: 8252774: remove jdk.test.lib.FileInstaller action from graalunit tests
  • 5b30a83: 8252778: remove jdk.test.lib.FileInstaller action from compiler/c2/stemmer test
  • 8db3335: 8247928: Refactor G1ConcurrentMarkThread for mark abort
  • 7ccf435: 8252846: Fix ppc/s390 after "8231441: AArch64: Initial SVE backend su…
  • d236cf4: 8252995: Non-PCH builds broken by JDK-8250961
  • 6a00534: 8250961: Move Universe::update_heap_info_at_gc to CollectedHeap
  • f78f780: 8252889: Obsolete -XX:+InsertMemBarAfterArraycopy
  • f933961: 8252980: comment only changes extracted from JDK-8247281
  • 4333942: 8250217: com.sun.tools.javac.api.JavacTaskImpl swallows compiler exceptions potentially producing false positive test results
  • 5166094: 8252957: Wrong comment in CgroupV1Subsystem::cpu_quota
  • ... and 34 more: https://git.openjdk.java.net/jdk/compare/5d2e79e2c38ff79c1d5712aa77d5ac98eef9f97c...master

Your commit was automatically rebased without conflicts.

Pushed as commit 418e4a2.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@RogerRiggs RogerRiggs deleted the 8252830-java.rmi-missing-comment branch Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs integrated
5 participants