RFR: 8297129: Inflater documentation refers to 'deflate' methods

[Jaikiran Pai]

On Fri, 18 Nov 2022 08:33:40 GMT, Alan Bateman <alanb at openjdk.org> wrote:

>> 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.
>
> src/java.base/share/classes/java/util/zip/Inflater.java line 49:
> 
>> 47:  * sequence is provided in either byte array or byte buffer, via one of the
>> 48:  * {@code setInput()} methods. The output byte sequence is written to the
>> 49:  * output byte array or byte buffer passed to the {@code inflate()} methods.
> 
> This looks okay but probably should be a link as it's first use of inflate.

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}`.

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

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