File: AlmostJavadoc.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (21 lines) | stat: -rw-r--r-- 479 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
This comment contains Javadoc or HTML tags, and is in the right position for a
Javadoc, but doesn't start with a double asterisk. Should it be a Javadoc?

```java
/* Frobnicates the {@link Foo}s. */
class Frobnicator {
  Foo frobnicate(Foo foo);
}
```

```java
/** Frobnicates the {@link Foo}s. */
class Frobnicator {
  Foo frobnicate(Foo foo);
}
```

## Suppression

Suppress by applying `@SuppressWarnings("AlmostJavadoc")` to the element being
documented (or not documented).