We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent d272dfa commit 21c190aCopy full SHA for 21c190a
docs/bugpattern/javadoc/NotJavadoc.md
@@ -14,6 +14,23 @@ Suggested solutions:
14
* If the comment is intended to be an implementation comment, use a
15
single-line `//` or a multi-line `/*` comment instead.
16
17
+> NOTE: Javadoc must appear before any annotations, or the compiler will fail to
18
+> recognise it as Javadoc. That is, prefer this:
19
+>
20
+> ```java
21
+> /** Might return a frobnicator. */
22
+> @Nullable
23
+> Frobnicator getFrobnicator();
24
+> ```
25
26
+> instead of this:
27
28
29
30
31
32
33
+
34
## Suppression
35
36
Suppress by applying `@SuppressWarnings("NotJavadoc")` to the enclosing element.
0 commit comments