Google Code-in

Terasology has a Thirst module that implements a basic thirst system. However, currently most of its classes are missing vital documentation and comments, which could hamper future contributors' efforts in extending this module. Your task is to add Javadoc documentation to all classes and interfaces in the module.

Definition of 'Done'

• All methods in every class or interface have a Javadoc comment.
  • Complex blocks of code in the methods should have a comment explaining what they do - use your best judgment here.
• A pull request is submitted to the Thirst module containing the aforementioned requested items. Feel free to add your GitHub nickname to the list of authors in the module.txt file!
• Bonus: Prepare a small README.md for the root of the repository with a brief high level overview, like some other module repos have

Where to start?

• Download a copy of the Thirst module using gradlew fetchModuleThirst, create a new branch, and start from there.
• Check out the Javadoc comments in the src folders of the Alchemy and Potions for a rough guideline on how to write the comments.
• An intro to Javadoc can be found on the Oracle website.