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

JDK-8328006: refactor large anonymous inner class in HtmlDocletWriter #18252

Closed

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Mar 12, 2024

Please review a conceptually simple change, to move a large anonymous inner class to be a named inner class.

While most of the code is simply moved, two simple changes were necessary. In visitEscape and visitText the variable result from the enclosing lexical scope was accessed directly. The change is simply to use the equivalent value content which is passed to each visit... call.

No tests needed updating. All javadoc tests pass.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8328006: refactor large anonymous inner class in HtmlDocletWriter (Enhancement - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/18252/head:pull/18252
$ git checkout pull/18252

Update a local copy of the PR:
$ git checkout pull/18252
$ git pull https://git.openjdk.org/jdk.git pull/18252/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18252

View PR using the GUI difftool:
$ git pr show -t 18252

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/18252.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Mar 12, 2024

👋 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.

@openjdk openjdk bot added the rfr Pull request is ready for review label Mar 12, 2024
@openjdk
Copy link

openjdk bot commented Mar 12, 2024

@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.

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.org label Mar 12, 2024
@mlbridge
Copy link

mlbridge bot commented Mar 12, 2024

Webrevs

Copy link
Member

@hns hns left a comment

Choose a reason for hiding this comment

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

Looks good except for a duplicate semicolon.

@@ -1292,196 +1292,218 @@ public ContentBuilder add(CharSequence text) {
}
}

var docTreeVisitor = new SimpleDocTreeVisitor<Boolean, Content>() {
var docTreeVisitor = new InlineVisitor(element, tag, isLastNode, context, ch, trees);;
Copy link
Member

Choose a reason for hiding this comment

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

Duplicate semicolon

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops, fixed.

@openjdk
Copy link

openjdk bot commented Mar 13, 2024

@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 details.

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

8328006: refactor large anonymous inner class in HtmlDocletWriter

Reviewed-by: hannesw

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

  • 044f4ed: 8326979: (jdeps) improve the error message for FindException caused by InvalidModuleDescriptorException
  • 71f9c4e: 8320534: fatal error for the NMTBenchmark test run for the mainline build
  • bfba489: 8328157: Move C[XX]FLAGS_JDK[LIB/EXE] to JdkNativeCompilation.gmk
  • 42aec8c: 8328146: Set LIBCXX automatically
  • 90ab52e: 8328166: Epsilon: 'EpsilonHeap::allocate_work' misuses the parameter 'size' as size in bytes
  • bf990c8: 8328269: NonFocusablePopupMenuTest.java should be marked as headful
  • 80b98c8: 8320503: Print warning if VM reaches MallocLimit during error reporting
  • dde519d: 8328066: WhiteBoxResizeTest failure on linux-x86: Could not reserve enough space for 2097152KB object heap
  • 80ccc98: 8328075: Shenandoah: Avoid forwarding when objects don't move in full-GC
  • 5249cc0: 8328087: Automate javax/swing/JTable/TAB/TAB.java applet test
  • ... and 74 more: https://git.openjdk.org/jdk/compare/22f10e045b3decdb51a3cc7644c47f911aec753d...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 the ready Pull request is ready to be integrated label Mar 13, 2024
@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Mar 15, 2024

Going to push as commit 65a84c2.
Since your change was applied there have been 84 commits pushed to the master branch:

  • 044f4ed: 8326979: (jdeps) improve the error message for FindException caused by InvalidModuleDescriptorException
  • 71f9c4e: 8320534: fatal error for the NMTBenchmark test run for the mainline build
  • bfba489: 8328157: Move C[XX]FLAGS_JDK[LIB/EXE] to JdkNativeCompilation.gmk
  • 42aec8c: 8328146: Set LIBCXX automatically
  • 90ab52e: 8328166: Epsilon: 'EpsilonHeap::allocate_work' misuses the parameter 'size' as size in bytes
  • bf990c8: 8328269: NonFocusablePopupMenuTest.java should be marked as headful
  • 80b98c8: 8320503: Print warning if VM reaches MallocLimit during error reporting
  • dde519d: 8328066: WhiteBoxResizeTest failure on linux-x86: Could not reserve enough space for 2097152KB object heap
  • 80ccc98: 8328075: Shenandoah: Avoid forwarding when objects don't move in full-GC
  • 5249cc0: 8328087: Automate javax/swing/JTable/TAB/TAB.java applet test
  • ... and 74 more: https://git.openjdk.org/jdk/compare/22f10e045b3decdb51a3cc7644c47f911aec753d...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Mar 15, 2024
@openjdk openjdk bot closed this Mar 15, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 15, 2024
@openjdk
Copy link

openjdk bot commented Mar 15, 2024

@jonathan-gibbons Pushed as commit 65a84c2.

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

@jonathan-gibbons jonathan-gibbons deleted the 8328006.InlineVisitor branch March 15, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

2 participants