Add more descriptions, examples and possible use cases to Galasa JavaDoc

[jt-nti]

Story

As a test developer, I want to understand the Galasa Java API, so that I can easily write tests and create new managers.

Background

This story is based on user feedback:

Following the meeting, it would be great to see more documentation following the kind of style seen here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics/add

With a light description, example and possible use case.

A lot of this is already done in the Javadoc, but would be greatly improved with some small code examples,
As well as some more detail into the specifics such as specifying whether x and y in setCursorPosition have zero or one- based indexing.

There are currently some examples outside the JavaDoc. For example, for the HTTP Client Manager. Keeping this kind of documentation in one accessible location would be helpful, and JavaDoc is a more natural location, which can be referred to from the galasa.dev site.

For a good example of this kind of documentation from another open-source project, see Contract JavaDoc.

Tasks

• TBC