RFR: 8026127: Deflater/Inflater documentation incomplete/misleading [v3]

Jaikiran Pai jpai at openjdk.org
Thu Jun 6 14:02:03 UTC 2024


> Can I please get a review of this doc-only change which proposes to improve the code snippet that's in `java.util.zip.Deflater` and `java.util.zip.Inflater` to better explain the usage of those classes? This addresses https://bugs.openjdk.org/browse/JDK-8026127.
> 
> The commit in the PR cleans up the snippet to correctly compress/decompress till the `Deflater` and `Inflater` are `finished()`.  Additionally, the snippet also shows that the `Deflater` and `Inflater` are expected to be closed when their usage it done, to release the resources held by those instances.
> 
> I've run `make docs-image` locally to verify that the generated snippet content as well as the link from `Inflater` work fine in the rendered javadoc HTML.

Jaikiran Pai has updated the pull request incrementally with two additional commits since the last revision:

 - minor change to the comment
 - move the snippet to an external snippet

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/19507/files
  - new: https://git.openjdk.org/jdk/pull/19507/files/098212a6..7a72a760

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=19507&range=02
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=19507&range=01-02

  Stats: 158 lines in 3 files changed: 97 ins; 58 del; 3 mod
  Patch: https://git.openjdk.org/jdk/pull/19507.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/19507/head:pull/19507

PR: https://git.openjdk.org/jdk/pull/19507


More information about the core-libs-dev mailing list