-
Notifications
You must be signed in to change notification settings - Fork 6.1k
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
8356632: Fix remaining {@link/@linkplain} tags with refer to private/protected types in java.base #25287
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2020,7 +2020,7 @@ public Builder uses(String service) { | |
|
||
/** | ||
* Provides a service with one or more implementations. The package for | ||
* each {@link Provides#providers provider} (or provider factory) is | ||
* each {@link Provides#providers() provider} (or provider factory) is | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. okay |
||
* added to the module if not already added. | ||
* | ||
* @param p | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -131,11 +131,11 @@ | |
* (including the case where a task was cancelled without executing); | ||
* {@link #isCompletedNormally} is true if a task completed without | ||
* cancellation or encountering an exception; {@link #isCancelled} is | ||
* true if the task was cancelled (in which case {@link #getException} | ||
* true if the task was cancelled (in which case {@link #getException()} | ||
* returns a {@link CancellationException}); and | ||
* {@link #isCompletedAbnormally} is true if a task was either | ||
* cancelled or encountered an exception, in which case {@link | ||
* #getException} will return either the encountered exception or | ||
* #getException()} will return either the encountered exception or | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looks right too, the private overload of getException was added in JDK 22. |
||
* {@link CancellationException}. | ||
* | ||
* <p>The ForkJoinTask class is not usually directly subclassed. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -708,7 +708,7 @@ public Encapsulator newEncapsulator(PublicKey publicKey, SecureRandom secureRand | |
* If any extra information inside this object needs to be transmitted along | ||
* with the key encapsulation message so that the receiver is able to create | ||
* a matching decapsulator, it will be included as a byte array in the | ||
* {@link Encapsulated#params} field inside the encapsulation output. | ||
* {@link Encapsulated#params()} field inside the encapsulation output. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch. The text must have been added before we changed
|
||
* In this case, the security provider should provide an | ||
* {@code AlgorithmParameters} implementation using the same algorithm name | ||
* as the KEM. The receiver can initiate such an {@code AlgorithmParameters} | ||
|
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?
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.
They are documented in this page
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.
Okay -- if there is some link to the private serial-related methods even in a public javadoc run, I think it would be preferable if links to those methods could be resolved by javadoc. Otherwise, if the links to private methods from a private method, would be valid in a private javadoc run, I thinks more refined version of warning would let those be.
As it is, if the see tags are going to stay, I don't think
<code>foo</code>
markup should be used.Uh oh!
There was an error while loading. Please reload this page.
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.
I will revert the changes to
MethoType.java
and try to make the links to the private methods resolvable. (In a future patch)