On Sat, 16 May 2026 07:20:03 GMT, Jaikiran Pai <[email protected]> wrote:
>> src/java.base/share/classes/java/util/zip/GZIPInputStream.java line 182:
>>
>>> 180: * @implSpec After reading a member trailer, this method calls
>>> {@link InputStream#available()}
>>> 181: * on the underlying stream to determine whether additional data
>>> is available that may represent
>>> 182: * a subsequent member.
>>
>> Who is the audience for this? Usually implSpec is aim at
>> implementers/subclasses. Here I think this note is aimed at the user of the
>> API that provides the input stream.
>
> It's for both, the users/callers of the GZIPInputStream who pass in the
> underlying InputStream when constructing the GZIPInputStream instance and for
> any libraries which may subclass this class.
>
> But to me it's always a bit of a dilemma when it comes to the usage of
> `@apiNote`, `@implSpec` (and sometimes `@implNote`). Do you suggest using
> `@apiNote` here?
For this case, I think you can drop the "implSpec" tag so that it's part of the
method description.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/30925#discussion_r3257643309
