RFR: 8297129: Inflater documentation refers to 'deflate' methods
Alan Bateman
alanb at openjdk.org
Fri Nov 18 08:46:06 UTC 2022
On Fri, 18 Nov 2022 08:39:05 GMT, Jaikiran Pai <jpai at openjdk.org> wrote:
>> 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}`.
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.
-------------
PR: https://git.openjdk.org/jdk/pull/11232
More information about the core-libs-dev
mailing list