Parameter tag has no description JAVA-D1005

This method/constructor has a parameter tag with no description.

Consider adding a description to the tag. If the parameter's name is clear enough, consider removing the parameter tag entirely.

Bad Practice

In the example below, there is an @param tag for the parameter someParam, but it does not attempt to describe the parameter itself. An @param tag without a description is no better than omitting the tag entirely.

/**
 * Some method.
 *
 * @param someParam
 */
String someMethod(int someParam) {
    // ...

Recommended

Add a description to the tag.

/**
 * Some method.
 *
 * @param someParam - Does something.
 *
 */
String someMethod(int someParam) {
    // ...

References

• Oracle technical blog - How to write JavaDoc comments