Explicitely document methods as to whether they deal with chunk or block coordinates. #17
Conversation
…inates or block coordinates.
|
This is more descriptive and a step in the right direction, but the changes need to be grammatically correct. You should also incorporate the note into the description. |
|
The notes are only in the descriptions (though they could do with a tag so they are in a separate line). The changes are grammatically correct, if a little jarring. In the context of Minecraft blocks and chunks are valid units. I'd welcome some less negative criticism with actual suggestions on how to improve it. |
|
Parhaps you can answer this one for me. Javadoc's short description is split out by finding the end of the first sentence, why in the javadoc are there a whole load of missing periods at the end of the first sentence. Also why do you use <p /> instead of <p>. Oracle's Javadocs notes state you you should <p> here: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format |
|
Missing periods is only one of the many reasons that the JavaDoc are in need of improvement. As for the convention that we currently use, it is merely the status quo ante. That having been said, under the html specification, the use of the self closing paragraph tag makes no sense. It makes sense to revisit the issue. EDIT: we will now use the proper html syntax when denoting paragraphs. In html 4.01 the closing tag is optional and we are keeping it at such. |
| * @param x X-coordinate of the chunk | ||
| * @param z Z-coordinate of the chunk | ||
| * @param x X-coordinate in chunks of the chunk | ||
| * @param z Z-coordinate in chunks of the chunk |
There was a problem hiding this comment.
Yeh, I know, I hate it too, please, suggest a better alternative, which conveys the unit and doesn't make me want to blow chunks. I guess "?-Coordinate in chunks, of the chunk" is a slight improvement, I still hate it.
There was a problem hiding this comment.
....in unit of chunks....
|
This is going to need to be rebased for all of the |
|
sure, no issues rebasing and squashing as/when necessary. |
|
Do you plan on updating this @cybertiger ? |
|
Not a productive use of my time, sorry, I'll close it. |
Some methods in World and Chunk are confusing as to whether they deal in terms of chunks or blocks, this should be documented.