Files
openide/java/java-impl/resources/inspectionDescriptions/UnnecessaryJavaDocLink.html
Leonid Shalupov 40795fe787 IJI-2422: community/java: move resources under resources root
GitOrigin-RevId: 8b2b63fc6db476ca0c2cfe5cadd84db6c4236d0f
2025-02-05 04:43:28 +00:00

31 lines
1005 B
HTML

<html>
<body>
Reports Javadoc <code>@see</code>,
<code>{@link}</code>, and <code>{@linkplain}</code>
tags that refer to the method owning the comment, the super method of the
method owning the comment, or the class containing the comment.
<p>Such links are unnecessary and can be safely removed with this inspection's quick-fix. The
quick-fix will remove the entire Javadoc comment if the tag is its only content.</p>
<p><b>Example:</b></p>
<pre><code>
class Example {
/**
* @see Example#method
*/
public void method() { }
}
</code></pre>
<p>After the quick-fix is applied:</p>
<pre><code>
class Example {
public void method() { }
}
</code></pre>
<!-- tooltip end -->
<p>
Use the checkbox below to ignore inline links (<code>{@link}</code> and <code>{@linkplain}</code>)
to super methods. Although a link to all super methods is automatically added by the
Javadoc tool, an inline link to the super method may sometimes be needed in texts of the Javadoc comments.
</body>
</html>