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

Definition of 'Done'

A pull request containing new Javadoc documentation is submitted to the Terasology engine 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! After you've done that, locate the engine project, browse through the code and find an undocumented class or method that needs documentation. 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 in the engine repo 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.