MovingBlocks
Add javadocs to BlockNetworks
BlockNetwork is the module that describes networks of blocks.
This module already has some javadocs but some key methods are mising javadocs. Having some proper javadocs will 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 BlockNetworks 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 - post what you're starting on to the issue
- Look at existing documented code in the Engine and other modules for example
- Read over the javadoc guide
See also
- The task to add javadoc to SegmentedPaths
Task tags
Students who completed this task
Jenna McClellan, eviltak, Soundwave, Jason Huang, Rajat Patel