8223607: --override-methods=summary ignores some signature changes #1734
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into |
hns
changed the title
| @@ -598,6 +602,87 @@ boolean allowInheritedMethods(ExecutableElement inheritedMethod, | |||
| return true; | |||
| } | |||
|
|
|||
| // Check whether the signature of an overriding method has any changes worth | |||
| // being documented compared to the overridden method. | |||
| private boolean overridingSignatureChanged(ExecutableElement method, ExecutableElement overriddenMethod) { | |||
There was a problem hiding this comment.
In the body of this method, can you add in:
change in abstract/non-abstract (both ways)
change in final/non-final
|
New PR created for jdk16 repository, closing this one. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change causes overriding methods to be documented in the details section under some conditions even when javadoc is run with
--override-methods=summaryand the method does not have a doc comment. Previously this already happened when the overriding method had a covariant return type (JDK-8219147). The following conditions will now trigger the same behaviour:protectedtopublicThe conditions are simple by intention as we don't want to do checks that add to much complexity (such as distinguishing between checked and unchecked exceptions) and instead want to set the bar for inclusion in the details section relatively low.
Progress
Issue
Download
$ git fetch https://git.openjdk.java.net/jdk pull/1734/head:pull/1734$ git checkout pull/1734