RFR: 8305406: Add @spec tags in java.base/java.* (part 2) [v2]
Hannes Wallnöfer
hannesw at openjdk.org
Tue Oct 22 14:44:18 UTC 2024
On Mon, 21 Oct 2024 15:45:09 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
>> Please review a doc update to add `@spec` tags to crypto and security APIs in `java.base`.
>>
>> This was authored and proposed as #13336 by @jonathan-gibbons as part of an effort to [add `@spec` tags and an external specifications page to API documentation][JDK-8296546]. The original PR was reviewed and approved, yet for some reason it was never integrated.
>>
>> [JDK-8296546]: https://bugs.openjdk.org/browse/JDK-8296546
>>
>> Since I couldn't reopen Jon's PR I created a new pull request based the original commits. They still apply cleanly, and I made sure all links are still valid and working. I added a commit to update the copyright header dates.
>
> Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision:
>
> Update copyright header dates
One of the reasons for adding the javadoc `@spec` tag is to create an "External Specifications" page in API docs. This feature is currently disabled in OpenJDK build (because of incomplete `@spec` tags in libraries), but I have uploaded a bundle of [API docs with this PR and the "External Specifications" page enabled](https://cr.openjdk.org/~hannesw/8305406/api.00/external-specs.html). This should make this PR somewhat easier to review as the spec URLs can be reviewed directly in the browser.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/21326#issuecomment-2429480115
More information about the security-dev
mailing list