8253812: Cleanup AbstractMemberWriter #405

jonathan-gibbons · 2020-09-29T16:32:00Z

This is primarily a cosmetic cleanup for the doc comments on AbstractMemberWriter, but cleaning up some of the comments leaked into fixing up comments on overridden methods as well.

Progress

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

Issue

JDK-8253812: Cleanup AbstractMemberWriter

Reviewers

Kumar Srinivasan (@kusrinivasan - Reviewer) ⚠️ Review applies to 835e70d

Download

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

bridgekeeper · 2020-09-29T16:33:40Z

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

jonathan-gibbons · 2020-09-29T16:33:24Z

...dk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java

        boolean printedUseTableHeader = false;
-        if (members.size() > 0) {


The enclosing if statement is unnecessary.

jonathan-gibbons · 2020-09-29T16:34:04Z

...dk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java

    @Override
    public void addMemberSummary(TypeElement tElement, Element member,
-            List<? extends DocTree> firstSentenceTags) {
+            List<? extends DocTree> firstSentenceTrees) {


This use of the word tags is a hangover from an older version of javadoc

openjdk · 2020-09-29T16:34:31Z

@jonathan-gibbons The following label will be automatically applied to this pull request:

javadoc

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 pull request command.

mlbridge · 2020-09-29T16:38:24Z

Webrevs

01: Full - Incremental (138e013)
00: Full (835e70d)

kusrinivasan

Looks good.

mlbridge · 2020-09-29T21:15:02Z

Mailing list message from Kumar Srinivasan on javadoc-dev:

Hi Jon,

I approved this in github, after I approved I noticed I had logged into github with my non-openjdk ID.
I will try to fix it.

Thanks
Kumar

On Sep 29, 2020, at 9:38 AM, Jonathan Gibbons <jjg at openjdk.java.net> wrote:

This is primarily a cosmetic cleanup for the doc comments on `AbstractMemberWriter`, but cleaning up some of the
comments leaked into fixing up comments on overridden methods as well.

-------------

Commit messages:
- Cleanup AbstractMemberWriter API

Changes: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.openjdk.java.net%2Fjdk%2Fpull%2F405%2Ffiles&data=02%7C01%7Ckusrinivasan%40vmware.com%7C579d956bea354e97bce108d864966f70%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C637369944567424189&sdata=VL9f%2BSFIpktz83c%2BwnSxXzeDyGGqiSi%2BKi2mFy3kaOg%3D&reserved=0
Webrev: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwebrevs.openjdk.java.net%2F%3Frepo%3Djdk%26pr%3D405%26range%3D00&data=02%7C01%7Ckusrinivasan%40vmware.com%7C579d956bea354e97bce108d864966f70%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C637369944567424189&sdata=ilNB%2BZulVQz%2FrmBMH0lw4YJUdoHga4s7Vyr6bbXtZe0%3D&reserved=0
Issue: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fbugs.openjdk.java.net%2Fbrowse%2FJDK-8253812&data=02%7C01%7Ckusrinivasan%40vmware.com%7C579d956bea354e97bce108d864966f70%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C637369944567424189&sdata=j5wFW5y1rChsqkXPEYJZ5L6f7tIh4a%2BuAHJdvlMiLrE%3D&reserved=0
Stats: 221 lines in 2 files changed: 23 ins; 70 del; 128 mod
Patch: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.openjdk.java.net%2Fjdk%2Fpull%2F405.diff&data=02%7C01%7Ckusrinivasan%40vmware.com%7C579d956bea354e97bce108d864966f70%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C637369944567434187&sdata=63s6msfWtMi0n4hxKFmgNGQCj%2Boilsf9z7TLg7upO5s%3D&reserved=0
Fetch: git fetch https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.openjdk.java.net%2Fjdk&data=02%7C01%7Ckusrinivasan%40vmware.com%7C579d956bea354e97bce108d864966f70%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C637369944567434187&sdata=6gcb32NZ%2FqeWxugxrZ9QuuJfQbelYNEqMPL1xuTd%2FVc%3D&reserved=0 pull/405/head:pull/405

PR: https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.openjdk.java.net%2Fjdk%2Fpull%2F405&data=02%7C01%7Ckusrinivasan%40vmware.com%7C579d956bea354e97bce108d864966f70%7Cb39138ca3cee4b4aa4d6cd83d9dd62f0%7C0%7C0%7C637369944567434187&sdata=fD5eCiR8SCoDR1E3N3QDOQwODP4BVZMfJZxhSVOlvwE%3D&reserved=0

openjdk · 2020-09-30T20:03:16Z

@jonathan-gibbons 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:

8253812: Cleanup AbstractMemberWriter

Reviewed-by: ksrini

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 41 new commits pushed to the master branch:

424d7d6: 8252881: [JVMCI] ResolvedJavaType.resolveMethod fails in fastdebug when invoked with a constructor
2a406f3: 8138732: Rename @HotSpotIntrinsicCandidate to @IntrinsicCandidate and move it to the jdk.internal.vm.annotation package
4b16f8a: 8253872: ArgumentHandler must use the same delimiters as in jvmti_tools.cpp
4fb8c77: 8253733: Cleanup internal taglet API
e5ba020: 8253829: Wrong length compared in SSPI bridge
9e453d9: 8239090: Improve CPU feature support in VM_Version
8f7c9a7: 8252001: remove usage of PropertyResolvingWrapper in vmTestbase/nsk/jdi
8cf8e46: 8253700: spurious "extends Throwable" at end of Optional.orElseThrow method declaration
8b3d676: 8238737: remove DeoptimizeAllClassesRate from CTW library
709cfe5: 8253815: Remove unused HeapRegionManager::_num_committed from SA
... and 31 more: https://git.openjdk.java.net/jdk/compare/527b0e44eba9ec70cc2b3622a1d1e94b06b8017d...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.

kusrinivasan · 2020-09-30T20:01:26Z

...dk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java

     *
     * @param member the member to add the type for
-     * @param code the content tree to which the modified will be added
+     * @param code   the content tree to which the modified will be added


I think this should be modifier not modified.

Indeed; will fix

jonathan-gibbons · 2020-09-30T20:27:52Z

/integrate

openjdk · 2020-09-30T20:29:40Z

@jonathan-gibbons Since your change was applied there have been 41 commits pushed to the master branch:

424d7d6: 8252881: [JVMCI] ResolvedJavaType.resolveMethod fails in fastdebug when invoked with a constructor
2a406f3: 8138732: Rename @HotSpotIntrinsicCandidate to @IntrinsicCandidate and move it to the jdk.internal.vm.annotation package
4b16f8a: 8253872: ArgumentHandler must use the same delimiters as in jvmti_tools.cpp
4fb8c77: 8253733: Cleanup internal taglet API
e5ba020: 8253829: Wrong length compared in SSPI bridge
9e453d9: 8239090: Improve CPU feature support in VM_Version
8f7c9a7: 8252001: remove usage of PropertyResolvingWrapper in vmTestbase/nsk/jdi
8cf8e46: 8253700: spurious "extends Throwable" at end of Optional.orElseThrow method declaration
8b3d676: 8238737: remove DeoptimizeAllClassesRate from CTW library
709cfe5: 8253815: Remove unused HeapRegionManager::_num_committed from SA
... and 31 more: https://git.openjdk.java.net/jdk/compare/527b0e44eba9ec70cc2b3622a1d1e94b06b8017d...master

Your commit was automatically rebased without conflicts.

Pushed as commit 06d8cf6.

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

Cleanup AbstractMemberWriter API

835e70d

jonathan-gibbons commented Sep 29, 2020

View reviewed changes

openjdk bot added the javadoc javadoc-dev@openjdk.org label Sep 29, 2020

jonathan-gibbons changed the title ~~Cleanup AbstractMemberWriter API~~ 8253812: Cleanup AbstractMemberWriter API Sep 29, 2020

openjdk bot added the rfr Pull request is ready for review label Sep 29, 2020

kusrinivasan approved these changes Sep 29, 2020

View reviewed changes

jonathan-gibbons changed the title ~~8253812: Cleanup AbstractMemberWriter API~~ 8253812: Cleanup AbstractMemberWriter Sep 29, 2020

openjdk bot added the ready Pull request is ready to be integrated label Sep 30, 2020

kusrinivasan approved these changes Sep 30, 2020

View reviewed changes

fix typo reported in review

138e013

openjdk bot closed this Sep 30, 2020

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 30, 2020

jonathan-gibbons deleted the 8253812-AbstractMemberWriter branch November 4, 2020 00:37

8253812: Cleanup AbstractMemberWriter #405

8253812: Cleanup AbstractMemberWriter #405

jonathan-gibbons commented Sep 29, 2020 •

edited by openjdk bot

bridgekeeper bot commented Sep 29, 2020

jonathan-gibbons Sep 29, 2020

jonathan-gibbons Sep 29, 2020

openjdk bot commented Sep 29, 2020

mlbridge bot commented Sep 29, 2020 •

edited

kusrinivasan left a comment

mlbridge bot commented Sep 29, 2020

openjdk bot commented Sep 30, 2020 •

edited

kusrinivasan Sep 30, 2020

jonathan-gibbons Sep 30, 2020

jonathan-gibbons commented Sep 30, 2020

openjdk bot commented Sep 30, 2020

		boolean printedUseTableHeader = false;
		if (members.size() > 0) {

8253812: Cleanup AbstractMemberWriter #405

8253812: Cleanup AbstractMemberWriter #405

Conversation

jonathan-gibbons commented Sep 29, 2020 • edited by openjdk bot

Progress

Issue

Reviewers

Download

bridgekeeper bot commented Sep 29, 2020

jonathan-gibbons Sep 29, 2020

Choose a reason for hiding this comment

jonathan-gibbons Sep 29, 2020

Choose a reason for hiding this comment

openjdk bot commented Sep 29, 2020

mlbridge bot commented Sep 29, 2020 • edited

Webrevs

kusrinivasan left a comment

Choose a reason for hiding this comment

mlbridge bot commented Sep 29, 2020

openjdk bot commented Sep 30, 2020 • edited

kusrinivasan Sep 30, 2020

Choose a reason for hiding this comment

jonathan-gibbons Sep 30, 2020

Choose a reason for hiding this comment

jonathan-gibbons commented Sep 30, 2020

openjdk bot commented Sep 30, 2020

jonathan-gibbons commented Sep 29, 2020 •

edited by openjdk bot

mlbridge bot commented Sep 29, 2020 •

edited

openjdk bot commented Sep 30, 2020 •

edited