Google Code-in

Just like https://codein.withgoogle.com/dashboard/tasks/4657117413769216/ but for modules!

Not every piece of code is self-documenting :) To help explain what our code does, Terasology uses Javadoc - a system of documentation that uses structured inline comments - and provides guidelines for well-formed documentation. Your task is to find a method or class in the Terasology engine where Javadoc is missing and add it!

Definition of 'Done'

A pull request containing new Javadoc documentation is submitted to any module repo containing a substantial amount of undocumented classes. At least 5 easy classes (small components and interfaces) or one harder class (a system or widget) should be documented.

Where to start?

Prepare your workspace or even run the game from source before starting! Look for interesting modules at http://github.com/Terasology and "gradlew fetchModuleX" to get the source code to your workspace. Take your time to understand what the code does, then write some Javadoc :)

Note: This is a multi-instance task - other students can pick it too and might end up documenting the same classes. Take a look at pending PRs before submitting yours - if another student has already added Javadoc to the same classes as you, you may need to change what you're documenting or wait till the earlier work is merged, then adjust what you're adding.

Please do not use the GitHub web ui for modifying classes. Use Git, ideally from inside IntelliJ, and try to finish in a single commit.