The idea of this pull request is to make JavaDoc compile without errors (the latest doclint seems to randomly treat some very minor details as errors).
I simply completed the @params and @return tags with some boilerplate in order to make JavaDoc compile without warnings.
Also fix some minor typos I happen to see.
In time I'll try and actually improve the JavaDocs, but for that I really need to understand what the methods actually do... so I think I'll attempt to tackle this one class/package at a time.
The idea of this pull request is to make
JavaDoccompile without errors (the latestdoclintseems to randomly treat some very minor details as errors).I simply completed the
@paramsand@returntags with some boilerplate in order to makeJavaDoccompile without warnings.Also fix some minor typos I happen to see.
In time I'll try and actually improve the
JavaDocs, but for that I really need to understand what the methods actually do... so I think I'll attempt to tackle this one class/package at a time.