RFR: 8356632: Fix remaining {@link/@linkplain} tags with refer to private/protected types in java.base

Nizar Benalla nbenalla at openjdk.org
Mon May 19 16:08:04 UTC 2025


On Sun, 18 May 2025 02:18:24 GMT, Chen Liang <liach at openjdk.org> wrote:

>> Please review this patch to fix some `javadoc` bugs in `java.base`.
>> Certain `@link` tags used to refer to private fields instead of public APIs.
>> 
>> A couple of `@see` tags in the [serialization page](https://download.java.net/java/early_access/jdk25/docs/api/serialized-form.html#java.lang.invoke.MethodType) referred to private methods, I updated the javadoc in a way to not change the way it is displayed to users but also remove `@link` tags to non-included types.
>> 
>> TIA
>
> src/java.base/share/classes/java/lang/invoke/MethodType.java line 1341:
> 
>> 1339:      * @throws ClassNotFoundException if one of the component classes cannot be resolved
>> 1340:      * @see <code>MethodType.readResolve()</code>
>> 1341:      * @see <code>MethodType.writeObject(ObjectOutputStream s)</code>
> 
> This is already not generated by the javadoc as this method is private. Why is this check against a private method?

They are documented in [this page](https://download.java.net/java/early_access/jdk25/docs/api/serialized-form.html#java.lang.invoke.MethodType)

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

PR Review Comment: https://git.openjdk.org/jdk/pull/25287#discussion_r2095501605


More information about the core-libs-dev mailing list