Cleanup documentation and modifiers #123
Conversation
src/io/calimero/GroupAddress.java
Outdated
| @@ -207,7 +207,7 @@ public static void addressStyle(final Presentation style) | |||
| } | |||
|
|
|||
| /** | |||
| * {@return the address presentation style preset for all KNX group addresses} | |||
There was a problem hiding this comment.
It's an inline return tag, it should work fine (as well as all the others).
There was a problem hiding this comment.
The inline javadoc return statements were not properly recognized by my tooling (though technically fine) and I had not realized that you just changed it to be this way not too long ago.
| @@ -506,7 +506,7 @@ final String removeUnit(final String value) | |||
| return value.trim(); | |||
| } | |||
|
|
|||
| static final short ubyte(final int value) | |||
| static short ubyte(final int value) | |||
There was a problem hiding this comment.
Putting final on static methods prevents hiding the method, its usage is fine.
There was a problem hiding this comment.
Rolled back as requested. AFAIR there are methods only declared static without the final keyword. Not sure if this is intended then.
| @@ -982,7 +982,7 @@ else if (++day == 1) { | |||
| int dow = DAYS.length - 1; | |||
| while (dow >= 0 && !DAYS[dow].toLowerCase().startsWith(prefix)) | |||
| --dow; | |||
| final boolean anyday = dow == 0 && t.hasMoreTokens() && t.nextToken().equalsIgnoreCase("day"); | |||
| final boolean anyday = dow == 0 && t.hasMoreTokens() && "day".equalsIgnoreCase(t.nextToken()); | |||
There was a problem hiding this comment.
Switching the operands in cases like these seems unnecessary?
There was a problem hiding this comment.
Using "constant".eqals(somestringvariable) has the benefit that the string constant is never null and running equals() cannot cause a NPE. It cannot harm to write it in this order.
There was a problem hiding this comment.
That's true; the thing is, if nextToken returns null something is really really wrong. So a reversal like this basically hardens against the langspec/compiler/interpreter.
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
holgerfriedrich
force-pushed
the
cleanup
branch
from
0dfcd36 to
0d71b3a
Compare
|
Hi @bmalinowsky, sorry for replying late. I followed your advice and rolled back accordingly. Seems this PR is down to two minor changes.... |
|
Thanks for the PRs! |
Cleanup Javadoc annotations (removing brackets from {@return statements})mainly removing final from static methods, as static methods are implicitly final, but alsoorder of modifiers)