RFR: 8305406: Add @spec tags in java.base/java.* (part 2) [v2]

Hannes Wallnöfer hannesw at openjdk.org
Thu Oct 24 09:14:08 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

Thanks for looking at this, Valerie. As Jon said in his comment, this PR is based on automated detection of @see and {@link} tags, and therefore not necessarily complete. 

That said I will add `@spec` for those cases you pointed out that I think are unambigous (see inline comments). Others that I think need more consideration and possibly updates of other parts of the doc comments I would prefer to be handled by the component maintainers.

-------------

PR Review: https://git.openjdk.org/jdk/pull/21326#pullrequestreview-2391602595


More information about the security-dev mailing list