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

Valerie Peng valeriep at openjdk.org
Wed Oct 23 21:42:05 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

src/java.base/share/classes/java/security/Key.java line 89:

> 87:  * of the <cite>Java Object Serialization Specification</cite> for more information.
> 88:  *
> 89:  * @spec serialization/index.html Java Object Serialization Specification

How about "Java Security Standard Algorithm Names Specification"? Should its reference be covered by @spec tag?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/21326#discussion_r1813681574


More information about the security-dev mailing list