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

28 lines
763 B
HTML

<html>
<body>
Reports missing Javadoc comments and tags.
<p>Example:</p>
<pre><code>
/**
* Missing "@param" is reported (if configured).
*/
public void sample(int param){
}
</code></pre>
<p>The quick-fixes add missing tag or missing Javadoc comment:</p>
<pre><code>
/**
* Missing "@param" is reported (if configured).
* @param param
*/
public void sample(int param){
}
</code></pre>
<!-- tooltip end -->
<p>
Inspection can be configured to ignore deprecated elements or simple accessor methods like <code>getField()</code> or <code>setField()</code>.
</p>
You can also use options below to configure required tags and minimal required visibility for the specific code elements
like method, field, class, package, module.
</body>
</html>