errorprone.bugpattern.javadoc.MissingSummary.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-erroraway-sonar-plugin Show documentation

The newest version!

Javadocs on private and protected elements are required to contain a short
summary line. This is often the only part of the Javadoc that others will see
surfaced in various tools.

```java
/** @return deserialised proto */
public Proto parse(byte[] bytes) {
  ...
}
```

```java
/** Returns deserialised proto. */
public Proto parse(byte[] bytes) {
  ...
}
```

## Suppression

Suppress by applying `@SuppressWarnings("MissingSummary")` to the element being
documented.