Jetty 12 - Javadoc cleanup & new inspection profile #9165
Conversation
… inspection profile.
|
The inspection profile for just javadoc, suitable for import, can be found in It has more inspections than just the javadoc doclint does. For example, here's an interesting one for "Mismatch between Javadoc and code" ...
The javadoc talks about a return type as if it's a boolean, but the return type is anything but. |
| * modified April 2001 | ||
| * by Iris Van den Broeke, Daniel Deville | ||
| */ | ||
|
|
There was a problem hiding this comment.
This exact block is a duplicate of what is already present a few lines above.
| @@ -129,7 +128,7 @@ public boolean onClosed(CloseStatus closeStatus) | |||
| * </p> | |||
| * <p> | |||
| * This should only be called if there is an error directly before the call to | |||
| * {@link WebSocketCoreSession#closeConnection(CloseStatus, Callback)}. | |||
| * {@code WebSocketCoreSession.closeConnection(CloseStatus, Callback)}. | |||
There was a problem hiding this comment.
the .closeConnection(CloseStatus, Callback) is not accessible from here and cannot be a javadoc link.
| * "foo.tar.gz" "gz" | ||
| * "foo.bar" "bar" | ||
| * "foo." "" | ||
| * "foo" null | ||
| * ".bar" null | ||
| * null null | ||
| * }</code> | ||
| * }</pre> |
There was a problem hiding this comment.
This preserves the LF and whitespace
|
@gregw this good to merge? (if so, go ahead and do it on your timezone) |
There was a problem hiding this comment.
This is good on it's own, but we need to do more to document how to use this (and the style guides and the check style). Perhaps CONTRIBUTING.md should have some instructions.
Perhaps @gregpoulos you can put this on your list of documentations? Actually, working of fixing some of the javadoc issues would also be a good way for you to get a tour of the code.
|
@gregw Yep, I'll add this to my list of things to look at! |
…0.x/javadoc-inspection
Introduce importable intellij inspection profile for Javadoc.
Perform some javadoc cleanup as well.