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

8253322 : Update the specification in the newly added constructors #315

Closed
wants to merge 3 commits into from

Conversation

@mrserb
Copy link
Member

@mrserb mrserb commented Sep 23, 2020

Looks like different people use a different style for the new constructors, it will be good to unify them.

The text "Constructor for subclasses to call." should be used in the protected constructors in the abstract classes
In all other cases the text "Constructs an {@code ClassName}." should be used
A period (full stop) to the end of all javadoc comments, should be added if it is missing

I have started from https://bugs.openjdk.java.net/browse/JDK-8252721
See
https://bugs.openjdk.java.net/browse/JDK-8252908?focusedCommentId=14370006&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-14370006

But since I already touched a bunch of classes, I decided to update some other fixes as well.

This will update the changes for:
https://bugs.openjdk.java.net/browse/JDK-8252721
https://bugs.openjdk.java.net/browse/JDK-8252195
https://bugs.openjdk.java.net/browse/JDK-8250858


Progress

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

Issue

  • JDK-8253322: Update the specification in the newly added constructors

Reviewers

Download

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Sep 23, 2020

👋 Welcome back serb! 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.

@openjdk
Copy link

@openjdk openjdk bot commented Sep 23, 2020

@mrserb The following labels will be automatically applied to this pull request: 2d awt i18n sound swing.

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

@mrserb mrserb marked this pull request as ready for review Sep 23, 2020
@openjdk openjdk bot added the rfr label Sep 23, 2020
@mrserb
Copy link
Member Author

@mrserb mrserb commented Sep 23, 2020

/csr

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

@openjdk openjdk bot commented Sep 23, 2020

@mrserb this pull request will not be integrated until the CSR request JDK-8253512 for issue JDK-8253322 has been approved.

@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 23, 2020

Webrevs

@mrserb mrserb changed the title 8253322 : Update the specification added to some of some newly added constructors 8253322 : Update the specification in the newly added constructors Sep 23, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Sep 23, 2020

@mrserb This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for more details.

After integration, the commit message for the final commit will be:

8253322: Update the specification in the newly added constructors

Reviewed-by: psadhukhan, prr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 26 new commits pushed to the master branch:

  • 24a4248: 8253615: Change to Visual Studio 2019 16.7.2 for building on Windows at Oracle
  • 8b85c3a: 8251261: CDS dumping should not clear states in live classes
  • 9ac162e: 8251999: remove usage of PropertyResolvingWrapper in vmTestbase/nsk/aod
  • 527a309: 8252722: More Swing plaf APIs that rely on default constructors
  • 3495c19: 8250855: Address reliance on default constructors in the Java 2D APIs
  • a9d0440: 8250859: Address reliance on default constructors in the Accessibility APIs
  • 89c5e49: 8253500: [REDO] JDK-8253208 Move CDS related code to a separate class
  • bf442c5: 8253539: Remove unused JavaThread functions for set_last_Java_fp/pc
  • dd2c456: 8253583: java/util/StringJoiner tests failing on 32-bit VMs after JDK-8246697
  • b1e2f02: 8253524: C2: Refactor code that clones predicates during loop unswitching
  • ... and 16 more: https://git.openjdk.java.net/jdk/compare/bddb82255cff231b635537524ebef0d3281b8273...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

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

@openjdk openjdk bot added ready and removed ready labels Sep 23, 2020
Copy link
Contributor

@prrace prrace left a comment

I don't think we should have to deduce what are all the "styles" you are proposing.
The PR AND the bug should both say things like

  1. Add a period (full stop) to the end of all javadoc comments.
    .. and so forth.

otherwise where will be the record other than the scattered changes themselves ?
Please summarise along those lines.

@mrserb
Copy link
Member Author

@mrserb mrserb commented Sep 23, 2020

otherwise where will be the record other than the scattered changes themselves ?
Please summarise along those lines.

The description is updated.

prrace
prrace approved these changes Sep 23, 2020
@openjdk openjdk bot added ready and removed csr labels Sep 24, 2020
@mrserb
Copy link
Member Author

@mrserb mrserb commented Sep 24, 2020

/integrate

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

@openjdk openjdk bot commented Sep 24, 2020

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

  • 24a4248: 8253615: Change to Visual Studio 2019 16.7.2 for building on Windows at Oracle
  • 8b85c3a: 8251261: CDS dumping should not clear states in live classes
  • 9ac162e: 8251999: remove usage of PropertyResolvingWrapper in vmTestbase/nsk/aod
  • 527a309: 8252722: More Swing plaf APIs that rely on default constructors
  • 3495c19: 8250855: Address reliance on default constructors in the Java 2D APIs
  • a9d0440: 8250859: Address reliance on default constructors in the Accessibility APIs
  • 89c5e49: 8253500: [REDO] JDK-8253208 Move CDS related code to a separate class
  • bf442c5: 8253539: Remove unused JavaThread functions for set_last_Java_fp/pc
  • dd2c456: 8253583: java/util/StringJoiner tests failing on 32-bit VMs after JDK-8246697
  • b1e2f02: 8253524: C2: Refactor code that clones predicates during loop unswitching
  • ... and 16 more: https://git.openjdk.java.net/jdk/compare/bddb82255cff231b635537524ebef0d3281b8273...master

Your commit was automatically rebased without conflicts.

Pushed as commit 8239b67.

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

@mrserb mrserb deleted the JDK-8253322 branch Sep 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants