mirror of
https://gitflic.ru/project/openide/openide.git
synced 2025-12-16 14:23:28 +07:00
33 lines
855 B
HTML
33 lines
855 B
HTML
<html>
|
|
<body>
|
|
Reports Javadoc comments that contain only an <code>{@inheritDoc}</code>
|
|
tag. Since Javadoc copies the super class' comment if no comment is present, a
|
|
comment containing only <code>{@inheritDoc}</code> adds nothing.
|
|
<p>Also, it reports the <code>{@inheritDoc}</code> usages in invalid locations, for example, in fields.</p>
|
|
<p>Suggests removing the unnecessary Javadoc comment.</p>
|
|
<p><b>Example:</b></p>
|
|
<pre><code>
|
|
class Example implements Comparable<Example> {
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
@Override
|
|
public int compareTo(Example o) {
|
|
return 0;
|
|
}
|
|
}
|
|
</code></pre>
|
|
<p>After the quick-fix is applied:</p>
|
|
<pre><code>
|
|
class Example implements Comparable<Example> {
|
|
@Override
|
|
public int compareTo(Example o) {
|
|
return 0;
|
|
}
|
|
}
|
|
</code></pre>
|
|
<!-- tooltip end -->
|
|
<p>
|
|
|
|
</body>
|
|
</html> |