Google Code-in

Signalling is a module that lets you send signals to other blocks. At the moment the module lacks proper javadocs. Having proper javadocs to Signalling would dramatically improve the readability of the codebase. This task is to write a full set of javadocs for one or more of the classes listed.

Definition of 'Done'

• A pull request made to the Signalling module that adds javadoc to at least one class.

Where to start

• Have a look at this issue which lists key classes missing javadocs
• Check for outstanding PR's to make sure you don't pick a class someone else is doing and post in the issue which classes you are beginning to document
• Look at existing documented code in the Engine and other modules for example
• Read over the javadoc guide

See also

• The task to add a readme to Signalling
• The task to add javadoc to BlockNetworks