File: EscapedEntity.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 (34 lines) | stat: -rw-r--r-- 772 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
23
24
25
26
27
28
29
30
31
32
33
34
HTML entities used within `@code` and `@literal` tags will be interpreted
directly rather than converted to the expected characters. For example, this is
wrong:

```java
/**
 * <pre>{@code
 *   &#064;Override
 *   public boolean equals(Object o) {
 *     return false;
 *   }
 * }</pre>
 */
```

An option is to drop the {@code } tags, though this will then require escaping
any generic type parameters which may otherwise be interpreted as HTML. That is,
`List<Integer>` is the text "List" followed by the (non-existent) tag "Integer".

```java
/**
 * <pre>
 *   &#064;Override
 *   public boolean equals(Object o) {
 *     return false;
 *   }
 * </pre>
 */
```

## Suppression

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