RFR: 8184352: Remove Sun provider information from KeyPairGenerator javadoc
Sean Mullan
mullan at openjdk.org
Fri Jan 24 14:12:47 UTC 2025
On Thu, 23 Jan 2025 20:56:25 GMT, Ben Perez <bperez at openjdk.org> wrote:
> Removed algorithm-specific information from `KeyPairGenerator` class description and instead linked out to the Sun Provider documentation
src/java.base/share/classes/java/security/KeyPairGenerator.java line 73:
> 71: * associated with each of the keys. Information about how the <i>Sun</i> prover
> 72: * handles such algorithm-specific parameters can be found in the
> 73: * <a href="https://docs.oracle.com/en/java/javase/11/security/oracle-providers.html">
You should use a link like "{@extLink security_guide_jdk_providers JDK Providers}" so that it links to the version of the guide that is the same as the JDK version. See [this](https://github.com/openjdk/jdk/blob/9768f60a945db277ded5e37ecba9ec34421d9968/src/java.base/share/classes/java/security/AlgorithmParameterGeneratorSpi.java#L43) for an example.
Also, I would make this text more generic and not specific to the Sun provider. For example:
"See the Keysize Restrictions sections of the {@extLink security_guide_jdk_providers JDK Providers}
document for information on the default keysizes used by JDK providers."
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/23280#discussion_r1928740768
More information about the security-dev
mailing list