RFR: 8306648: Update the JavaDocs to show the NEW section and DEPRECATED versions
Nir Lisker
nlisker at openjdk.org
Thu May 25 16:34:20 UTC 2023
On Thu, 27 Apr 2023 09:02:43 GMT, Nir Lisker <nlisker at openjdk.org> wrote:
>> Notes to reviewers:
>>
>> 1. The `-since` option does not play well with the javafx one: if documentation was added on a `private` property field with the `@since` tag, it will not be included in the NEW and DEPRECATED lists. I presume that the `-since` release version comparison detects only public APIs and does not know that javafx generates public API from private members.
>>
>> As an example, the attenuation properties in `PointLight` have `@since 16`, but do not appear in the NEW page.
>>
>> 2. I started from version 9, but there are also versions "8" and "8u20" in the deprecation list, and "JavaFX 8u40" and "JavaFX 8.0" in `@since` tags. For comparison, the JDK starts from 12 (https://docs.oracle.com/en/java/javase/20/docs/api/new-list.html). I'm not sure what versions we want to include. Changing this is simply done by adding the strings that appear in the tags to the `-since` option list.
>> 3. ~~Each major release, a new version string will need to be added.~~
>
>> 3. Each major release, a new version string will need to be added.
>
> This can be solved by reading the major version directly from the properties file, but it would require to script the generation of the string that includes the versions.
>
> I pushed a commit that does this.
> @nlisker This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!
Active
-------------
PR Comment: https://git.openjdk.org/jfx/pull/1109#issuecomment-1563194576
More information about the openjfx-dev
mailing list