MismatchedJavadocCode

Reports parts of method specification written in English that contradict with the method declaration. This includes:

• Method specified to return true or false but its return type is not boolean.
• Method specified to return null but it's annotated as @NotNull or its return type is primitive.
• Method specified to return list but its return type is set or array.
• And so on.

Example:

/**
   * @return true if user is found, false otherwise
   */
  User findUser(String name);

Note that false-positives are possible, as this inspection tries to interpret a human language. However, if the inspection reports incorrectly, it's still possible that the description is confusing and should be rewritten.

New in 2022.3