On Sat, 1 Jun 2024 04:33:57 GMT, Jaikiran Pai <j...@openjdk.org> wrote:
> 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. This pull request has now been integrated. Changeset: d8af5894 Author: Jaikiran Pai <j...@openjdk.org> URL: https://git.openjdk.org/jdk/commit/d8af58941b5dedb9774c0971895c4924e57ac28b Stats: 155 lines in 3 files changed: 96 ins; 57 del; 2 mod 8026127: Deflater/Inflater documentation incomplete/misleading Reviewed-by: lancea ------------- PR: https://git.openjdk.org/jdk/pull/19507
