Code documentation

[GaussX0]

Description

Every good piece of code needs to be documented - and this is a requirement for us to meet.

Approval criteria

• the documentation needs to be generated automatically during project building,
• at least three classes must be fully documented. This means a few words on the classes purpose and functionality, as well as a description of every method and attribute (other than getX and setX).

  Known issues

• mvn site causes the build on the CI server to fail. Needs further investigation and fixing.

[GaussX0]

Commit d6736db solved the issue of documentation generation - it can now be automatically generated by invoking the mvn site command. After running the aforementioned command, a javadoc document can be found under target/site/apidocs. The documentation for every class can be found after running the index.html file in a web browser.

We still need to document classes, and, first of all, we need classes to document, so this issue still remains open.