File: InheritDoc.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 (16 lines) | stat: -rw-r--r-- 360 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
The `@inheritDoc` tag should only be used on classes/interfaces which extend or
implement another and methods which override a method from a superclass.

```java
class Frobnicator {
  /** {@inheritDoc} */
  public void frobnicate() {
    // ...
  }
}
```

## Suppression

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