Add Javadoc documentation to project

[subhramit]

Closes #8

Adds javadoc documentation to all classes and methods in the project (except for obvious methods such as setters in LambdaTestTask).

I have kept the documentation thorough, including how one class is dependent on another. Please read through and let me know if any additions/removals are necessary.

[subhramit]

I'm getting code format CI errors. I'm not sure why...
Update: Nvm fixed

[navin772]

@subhramit can you take a look at the output of ./gradlew javadoc, it shows some errors which needs to be fixed.
One of the errors were - error: unknown tag: implNote, and other missing doc warnings.

Can you please fix those?

[subhramit]

@subhramit can you take a look at the output of ./gradlew javadoc, it shows some errors which needs to be fixed.
One of the errors were - error: unknown tag: implNote, and other missing doc warnings.

Can you please fix those?

@implNote (implementation note) is a common javadoc tag. I'll double check.

Findings: as per https://bugs.openjdk.org/browse/JDK-8068562, they are recognized but not considered standard (didn't know this!). I'll change them.

[subhramit]

Although @implNote expands properly in IntelliJ (if we are targeting developers to be able to navigate through the javadoc when contributing), I am changing @implnote tag to "Implementation note:" text to fix the errors.

Old (as tag):

New (as text):

[subhramit]

@navin772 let me know if anything else is needed! All errors are fixed.

[navin772]

@subhramit is there any way we can have the @implNote so it renders as tag and we can ignore the @implNote specific errors. Or any other tag that can be used here?

[subhramit]

@subhramit is there any way we can have the @implNote so it renders as tag and we can ignore the @implNote specific errors. Or any other tag that can be used here?

Good point. Will do some reading on this and get back.

[subhramit]

@navin772 Explored a couple of options. This (dcd1533) seems to be the best fit.

[navin772]

LGTM!