Google Code-in

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 or any module where Javadoc is missing and add it!

Definition of 'Done'

• A pull request containing new Javadoc documentation that is submitted to the engine or any module repo. 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 and use groovyw get module <name> to get the source code to your workspace. Take your time to understand what the code does, then write some Javadoc.
• Ask mentors on IRC if you're not quite sure how some code works or where to find lots of undocumented code to dig through.

See also

• The GCI documentation page on the Terasology wiki for general info

Note: This is a multi-instance task and other students may claim it as well, they might even end up trying to document the same thing. Please look on GitHub in the target repo for any pending PRs that may already cover code you were interested in documenting.