-
Notifications
You must be signed in to change notification settings - Fork 5.8k
8356632: Fix remaining {@link/@linkplain} tags with refer to private/protected types in java.base #25287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
8356632: Fix remaining {@link/@linkplain} tags with refer to private/protected types in java.base #25287
Conversation
👋 Welcome back nbenalla! A progress list of the required criteria for merging this PR into |
❗ This change is not yet ready to be integrated. |
@nizarbenalla The following labels will be automatically applied to this pull request:
When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command. |
@@ -4890,7 +4890,7 @@ private static MethodHandle identityOrVoid(Class<?> type) { | |||
* @param type the type of the desired method handle | |||
* @return a constant method handle of the given type, which returns a default value of the given return type | |||
* @throws NullPointerException if the argument is null | |||
* @see MethodHandles#primitiveZero | |||
* @see <code>primitiveZero(Wrapper)</code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just #zero(Class)
should be sufficient. This is probably changed by intellij during my original work to consolidate zero and constant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From #23706 (comment):
* @see <code>primitiveZero(Wrapper)</code> | |
* @see MethodHandles#zero |
* @see #readResolve | ||
* @see #writeObject | ||
* @see <code>MethodType.readResolve()</code> | ||
* @see <code>MethodType.writeObject(ObjectOutputStream s)</code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is already not generated by the javadoc as this method is private. Why is this check against a private method?
Please review this patch to fix some
javadoc
bugs injava.base
.Certain
@link
tags used to refer to private fields instead of public APIs.A couple of
@see
tags in the serialization page 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
Progress
Issue
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/25287/head:pull/25287
$ git checkout pull/25287
Update a local copy of the PR:
$ git checkout pull/25287
$ git pull https://git.openjdk.org/jdk.git pull/25287/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 25287
View PR using the GUI difftool:
$ git pr show -t 25287
Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/25287.diff