mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-08-29 07:03:37 +07:00
Leonid Shalupovandintellij-monorepo-bot
40795fe787
GitOrigin-RevId: 8b2b63fc6db476ca0c2cfe5cadd84db6c4236d0f
43 lines
882 B
HTML
43 lines
882 B
HTML
<html>
|
|
<body>
|
|
Reports the following Javadoc comment flaws:
|
|
<ul>
|
|
<li>No Javadoc where it is required</li>
|
|
<li>Required tag is missing</li>
|
|
<li>Invalid or incomplete tag</li>
|
|
<li>Javadoc description is missing or incomplete</li>
|
|
</ul>
|
|
<p>Example:</p>
|
|
<pre><code>
|
|
class Main {
|
|
}
|
|
</code></pre>
|
|
<p>After the quick-fix is applied:</p>
|
|
<pre><code>
|
|
/**
|
|
*
|
|
*/
|
|
class Main {
|
|
}
|
|
</code></pre>
|
|
<p>Example:</p>
|
|
<pre><code>
|
|
String id(String value) {
|
|
return value;
|
|
}
|
|
</code></pre>
|
|
<p>After the quick-fix is applied:</p>
|
|
<pre><code>
|
|
/**
|
|
* @param value
|
|
* @return
|
|
*/
|
|
String id(String value) {
|
|
return value;
|
|
}
|
|
</code></pre>
|
|
<!-- tooltip end -->
|
|
Use the tabs and corresponding inspection options to define visibility scope in which Javadoc is required, as well as the
|
|
required Javadoc tags for classes, methods, fields, and inner classes.
|
|
</body>
|
|
</html> |