On 07/03/2023 08:21, Eirik Bjørsnøs wrote:
:
Seems we reached consensus that the right thing to do here is to add
an `@apiNote`
Here's a draft PR with a suggested CSR:
https://github.com/openjdk/jdk/pull/12899
<https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/12899__;!!ACWV5N9M2RV99hQ!JHKVw9-_twtqnwpDZOujHDa0DGd3b9cZnWu0dIC3RjeLReueGxSik19nbAJsNQg05qvwbGKnqEQXFfs$>
Yes, I think an apiNote is the best thing to do here.
For the note then you might want to change it to "ZipEntry e = ..."
because the reader see the trailing slash after dir so it is obviously a
directory. Also the javadoc uses "crc-32" rather than "crc" should we
should keep that consistent if we can.
-Alan