MovingBlocks

Add Javadocs to SegmentedPaths

SegmentedPaths is the module that generically describes paths. Each full path is divided into segments. Each segment at the moment is described by a Bezier curve. Example usages of this module can be seen in rails.

At the moment this module does not have any form of 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'

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 a comment to the issue on which you are starting
  • Look at existing documented code in the Engine and other modules for example
  • Read over the javadoc guide

See also

Task tags

  • rails
  • documentation
  • java
  • javadocs
  • module

Students who completed this task

Jindřich Dítě, eviltak, Aleksander Wójtowicz, Max Borsch

Task type

  • chrome_reader_mode Documentation / Training
  • done_all Quality Assurance
close

2017