RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Nizar Benalla
Please review this PR that aims to add all the remaining needed `@since` tags in `java.base`, and group them into a single fix. This is related to #18934 and my work around the `@since` checker feature. Explicit `@since` tags are needed for some overriding methods for the purpose of the checker.

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Chen Liang
On Thu, 25 Apr 2024 14:29:27 GMT, Nizar Benalla wrote: > Please review this PR that aims to add all the remaining needed `@since` tags > in `java.base`, and group them into a single fix. > This is related to #18934 and my work around the `@since` checker feature. > Explicit `@since` tags are nee

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Nizar Benalla
On Thu, 25 Apr 2024 16:43:50 GMT, Chen Liang wrote: > I think your changes mostly group in these categories: > > 1. New API methods provided in superclasses/superinterfaces, this class > provides a more concrete implementation: >Examples being `CompletableFuture`, `FileInputStream`, `DelayQ

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Nizar Benalla
On Thu, 25 Apr 2024 14:29:27 GMT, Nizar Benalla wrote: > Please review this PR that aims to add all the remaining needed `@since` tags > in `java.base`, and group them into a single fix. > This is related to #18934 and my work around the `@since` checker feature. > Explicit `@since` tags are nee

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Chen Liang
On Fri, 26 Apr 2024 09:30:23 GMT, Nizar Benalla wrote: > We will effectively enforce javadoc comment for some method overrides with > the checker Those overriding methods don't even appear on the javadoc output. If you go to search for `CompletableFuture.resultNow` on https://docs.oracle.com/

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Nizar Benalla
On Fri, 26 Apr 2024 14:52:08 GMT, Chen Liang wrote: > > We will effectively enforce javadoc comment for some method overrides with > > the checker > > Those overriding methods don't even appear on the javadoc output. If you go > to search for `CompletableFuture.resultNow` on > https://docs.or

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Pavel Rappo
On Sat, 27 Apr 2024 10:33:42 GMT, Nizar Benalla wrote: > Also have you looked at the output documentation? Without the `@inheritDoc` > tags the content will only have a since tag, which is definitely wrong. This is not how I remember it. Unless written around, `{@inheritDoc}` in a main descrip

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Pavel Rappo
On Mon, 29 Apr 2024 22:54:47 GMT, Chen Liang wrote: > would be nice if you can share more about these (also about the behaviors of > inheriting `@throws` etc. I hope this document explains it well; if it doesn't, we should fix it: https://docs.oracle.com/en/java/javase/22/docs/specs/javadoc/do

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Chen Liang
On Mon, 29 Apr 2024 20:02:32 GMT, Pavel Rappo wrote: >>> > We will effectively enforce javadoc comment for some method overrides >>> > with the checker >>> >>> Those overriding methods don't even appear on the javadoc output. If you go >>> to search for `CompletableFuture.resultNow` on >>> ht

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Chen Liang
On Mon, 29 Apr 2024 16:07:14 GMT, Pavel Rappo wrote: >> Please review this PR that aims to add all the remaining needed `@since` >> tags in `java.base`, and group them into a single fix. >> This is related to #18934 and my work around the `@since` checker feature. >> Explicit `@since` tags are n

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Pavel Rappo
On Thu, 25 Apr 2024 14:29:27 GMT, Nizar Benalla wrote: > Please review this PR that aims to add all the remaining needed `@since` tags > in `java.base`, and group them into a single fix. > This is related to #18934 and my work around the `@since` checker feature. > Explicit `@since` tags are nee

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Nizar Benalla
On Mon, 29 Apr 2024 17:26:53 GMT, Chen Liang wrote: >> src/java.base/share/classes/java/io/FileInputStream.java line 345: >> >>> 343: * @throwsIllegalArgumentException {@inheritDoc} >>> 344: * @throwsIOException {@inheritDoc} >>> 345: * @throwsOutOfMemoryError {@inheri

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Pavel Rappo
On Mon, 29 Apr 2024 17:46:24 GMT, Nizar Benalla wrote: > Pavel, can I simply change the PR/issue title to be more descriptive? As I > want to include the the inherit doc because of the unchecked exceptions, > rather than clean this up in a different PR I suggest dropping all the changes that a

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Chen Liang
On Thu, 25 Apr 2024 14:29:27 GMT, Nizar Benalla wrote: > Please review this PR that aims to add all the remaining needed `@since` tags > in `java.base`, and group them into a single fix. > This is related to #18934 and my work around the `@since` checker feature. > Explicit `@since` tags are nee

Re: RFR: 8330954: Fix remaining `@since` tags in `java.base`

2024-05-05 Thread Nizar Benalla
On Thu, 25 Apr 2024 14:29:27 GMT, Nizar Benalla wrote: > Please review this PR that aims to add all the remaining needed `@since` tags > in `java.base`, and group them into a single fix. > This is related to #18934 and my work around the `@since` checker feature. > Explicit `@since` tags are nee