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

[Jaikiran Pai]

On Thu, 6 Jun 2024 14:02:03 GMT, Jaikiran Pai <jpai at 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.
>
> 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

Thank you Lance for the review.

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

PR Comment: https://git.openjdk.org/jdk/pull/19507#issuecomment-2153639493