apache / datasketches-java

A software library of stochastic streaming algorithms, a.k.a. sketches.
https://datasketches.apache.org
Apache License 2.0
893 stars 209 forks source link

Improved javadocs for main code. #553

Closed leerho closed 5 months ago

leerho commented 5 months ago

I have had my Eclipse javadoc warning settings turned off for quite a while because there was no way to have these warnings just apply to the main code and not the test code. -- Well, I discovered that with new versions of Eclipse it is now possible to disable warnings for "all optional errors" for the entire test tree.

So now that I have enabled these warnings again for the main tree, alas, I have found numerous places where the Javadocs for the main code was either missing or incomplete and could be improved. So this PR represents fixing these Javadoc issues for the entire java repo. I realize it is 26 files, but it is just javadocs. No substantive code changes.

At this moment, no one has voted on the java 6.0.0-RC1 candidate, so I have an option to create an RC2 and proceed with this release or let it go and do a 6.1.0 later. Thoughts?