Fixed Javadoc link #85
Conversation
|
This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation. |
| @@ -23,7 +22,7 @@ | |||
|
|
|||
| /** | |||
| * Extension point to subscribe events from GH, which plugin interested in. | |||
| * This point should return true in {@link #isApplicable(AbstractProject)} | |||
| * This point should return true in {@link #isApplicable} | |||
There was a problem hiding this comment.
I believe this is an invalid link would refer to the non-existent field isApplicable unless something has changed?
There was a problem hiding this comment.
isApplicable is a method, not a field.
There was a problem hiding this comment.
Specifically javadoc:javadoc with JDK7u80 produces
This point should return true in <a href="../../../../../org/jenkinsci/plugins/github/extension/GHEventsSubscriber.html#isApplicable(hudson.model.Job)"><code>isApplicable(hudson.model.Job<?, ?>)</code></a>as expected.
There was a problem hiding this comment.
That was my point - I thought you needed to add (argumentType) for links to methods.
I was mistaken.
|
🐝 |
|
🐝 . BTW a little 🐜 for a risk of Javadoc ambiguous method links if somebody introduces a new isApplicable() method |
|
Yes, it is a risk. On the other hand there is a risk of a link breaking if someone changes the type of a parameter, as happened here. :-) |
|
Thank you for a pull request! Please check this document for how the Jenkins project handles pull requests |
|
thx! |
Fixed Javadoc link for isApplicable method (now consumes Job instead of AbstractProject)
Fixes links orphaned by #82. @reviewbybees