Gradle Targets for Tests and Documentation

[jckreg]

Added Gradle targets for tests and documentation

Tests

to run unit tests and generate the HTML report run: ./gradlew test

This will compile all unit tests then run them. Currently there is not much output on the command line however, html files are generated with the full report. These files can be found in the build/reports/tests/test folder. The file index.html is the main page for these. Using the files you can sort by classes, packages, tests and others as well as seen any outputs or errors as well as pass fail.

Documentation

to generate documentation run: ./gradlew javadoc

This will compile the source code needed and then generate the documentation html files kept at build/docs/javadoc with index.html being the main entry point.

Currently when the javadoc task is run there are many warnings shown on the console. These are primarily for methods that do not yet have javadoc comments for them and can largely be ignored. If you would like to help add to the documentation then you can run the command and work through the list adding the necessary comments

I have changed the comments in several files to be accurate to the updates to the methods so as to remove errors from the javadoc task

Misc.

• comments in the gradle config file 'build.gradle.kts' to improve understanding
• changes to the gradle file to allow ./gradlew run to compile and run the full.Driver
  • this means it is currently the same as the full command but updates are coming to address this

if having issues with any of the targets one can try ./gradlew clean to put in a clean build state. Or ./gradlew reset to remove all code generated files and objects .

[jckreg]

The runner job has also been changed to include the passing of all unit tests before the branch can be merged