8297129: Inflater documentation refers to 'deflate' methods

[jaikiran]

Can I please get a review for this doc only change which fixes the javadoc of java.util.zip.Inflater class? As noted in https://bugs.openjdk.org/browse/JDK-8297129, there's a typo in the javadoc. This commit fixes that.

---

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-8297129: Inflater documentation refers to 'deflate' methods

Reviewers

• Alan Bateman (@AlanBateman - Reviewer)
• Lance Andersen (@LanceAndersen - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11232

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

Using diff file

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

[bridgekeeper]

👋 Welcome back jpai! 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]

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

[mlbridge]

Webrevs

• 00: Full (289e8586)

[AlanBateman]

This looks okay but probably should be a link as it's first use of inflate.

[jaikiran]

I had thought about it too, but I realized that it talks of inflate "methods" (there are more than one inflate methods with different parameters). So I suspect it was intentional to use {@code} instead of {@link}.

[AlanBateman]

Okay, we can leave it as a code tag. At some point I suspect the class description of both Inflater and Deflater will need to be replaced as they are missing so much.

[openjdk]

@jaikiran 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:

8297129: Inflater documentation refers to 'deflate' methods

Reviewed-by: alanb, lancea

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

• dd18d76: 8297173: usageTicks and totalTicks should be volatile to ensure that different threads get the latest ticks
• 2b6dbc7: 8293856: AArch64: Remove clear_inst_mark from aarch64_enc_java_dynamic_call
• 2f063b8: 8296846: Minor cleanup of some dead code in Flow.java
• ab6b7ef: 8296901: Do not create unsigned certificate and CRL
• 7b3984c: 8296463: Memory leak in JVM_StartThread with the integration of Virtual threads
• 373e52c: 8296785: Use realloc for CHeap-allocated BitMaps
• a53be20: 8282404: DrawStringWithInfiniteXform.java failed with "RuntimeException: drawString with InfiniteXform transform takes long time"
• 66228f7: 8297074: Use enhanced-for cycle instead of Enumeration in javax.crypto
• 819af69: 8249693: java/nio/channels/FileChannel/FileExtensionAndMap.java uses @ignore w/o bug id
• 9c432a0: 8297165: Update Pandoc to version 2.19.2 for Oracle builds
• ... and 51 more: https://git.openjdk.org/jdk/compare/499406c764ba0ce57079b1f612297be5b148e5bb...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.

[jaikiran]

Thank you Alan and Lance for the reviews.

[jaikiran]

/integrate

[openjdk]

Going to push as commit 2f2d404.
Since your change was applied there have been 61 commits pushed to the master branch:

• dd18d76: 8297173: usageTicks and totalTicks should be volatile to ensure that different threads get the latest ticks
• 2b6dbc7: 8293856: AArch64: Remove clear_inst_mark from aarch64_enc_java_dynamic_call
• 2f063b8: 8296846: Minor cleanup of some dead code in Flow.java
• ab6b7ef: 8296901: Do not create unsigned certificate and CRL
• 7b3984c: 8296463: Memory leak in JVM_StartThread with the integration of Virtual threads
• 373e52c: 8296785: Use realloc for CHeap-allocated BitMaps
• a53be20: 8282404: DrawStringWithInfiniteXform.java failed with "RuntimeException: drawString with InfiniteXform transform takes long time"
• 66228f7: 8297074: Use enhanced-for cycle instead of Enumeration in javax.crypto
• 819af69: 8249693: java/nio/channels/FileChannel/FileExtensionAndMap.java uses @ignore w/o bug id
• 9c432a0: 8297165: Update Pandoc to version 2.19.2 for Oracle builds
• ... and 51 more: https://git.openjdk.org/jdk/compare/499406c764ba0ce57079b1f612297be5b148e5bb...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jaikiran Pushed as commit 2f2d404.

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