Fix incorrect or incomplete Javadoc in public APIs

[jxblum]

Many of the classes (and APIs) in the Spring Data Commons core codebase have incomplete or incorrect Javadoc.

[aml8801]

Is this Issue still open? Could you give me hint about the standard, which should be used?

[jxblum]

Fixing Javadoc in Spring Data Commons will most likely be a multi-part development effort.

A good first step would be to simply make sure that any Javadoc on a class or method is complete, i.e. does not have empty Javadoc tags for type parameter(s)/variable(s), method parameters (@param), @return values, @throws clauses, etc. A informative and proper description should be added wherever there are missing Javadoc, which the IDE flags as a warning.

Here is 1 such example.

This (here) is incomplete. This is, it does not "describe" the entity.

Here is another example.

These type of Javadoc problems are littered throughout the codebase.

[ukasus]

Hi , is this issue still open?

[jxblum]

Yes, this is an ongoing effort. As a team, we decided to make changes to the Javadoc as we go, addressing issues or enhancements in the codebase along the way. Therefore, I would expect it would take sometime before all the Javadoc is completely reviewed and edited since it is not a focused effort.