File: MissingSummary.md

package info (click to toggle)
error-prone-java 2.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,076 kB
  • sloc: java: 171,398; xml: 1,459; sh: 34; makefile: 7
file content (22 lines) | stat: -rw-r--r-- 470 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
22
 
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.