{@inheritDoc}
tag. Since Javadoc copies the super class' comment if no comment is present, a
comment containing only {@inheritDoc}
adds nothing.
Also, it reports the {@inheritDoc}
usages in invalid locations, for example, in fields.
Suggests removing the unnecessary Javadoc comment.
Example:
class Example implements Comparable<Example> {
/**
* {@inheritDoc}
*/
@Override
public int compareTo(Example o) {
return 0;
}
}
After the quick-fix is applied:
class Example implements Comparable<Example> {
@Override
public int compareTo(Example o) {
return 0;
}
}