Code Documentation (JavaDocs)

[mastercoms]

Glowstone is sorely lacking in the documentation department. Improvements to in-code JavaDocs and comments are possible, and it might be worth writing up some separate code documentation or user guides on the GitHub wiki.

Methods which override or implement Bukkit interfaces do not need separate documentation unless there is an important note or exception to be made; otherwise, omit JavaDoc entirely and refer to implemented method JavaDoc.

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[BSFishy]

There is a way to make checkstyle require most methods and classes to have a Javadoc. Of course, this is very customizable so you can set whether you want it to only happen with public methods, classes, and interfaces, etc. This would be useful if anyone wanted to take the time to add Javadocs to everything, but personally, I would not want to take on such a task 😝

[mastercoms]

We don't want to require Javadocs.

[BSFishy]

Just throwing that out there.