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
|
Javadocs are interpreted as HTML, so special characters such as `<`, `>`, and
`&` must be escaped.
Text within `@code`, `@literal` and `@link` tags is exempt from this.
```java
/** Returns whether n > 3. */
boolean greaterThanThree(int n);
```
Could be rendered as one of these instead:
```java
/** Returns whether n > 3. */
boolean greaterThanThree(int n);
/** Returns whether {@code n > 3}. */
boolean greaterThanThree(int n);
```
A common pitfall is type parameters. The following Javadoc is valid, but
contains an unknown HTML tag (`Integer`):
```java
/** Returns an Iterable<Integer> of prime numbers. */
Iterable<Integer> generatePrimes();
```
Prefer writing generic types as `{@code Iterable<Integer>}` (or `{@link }`).
## Suppression
Suppress by applying `@SuppressWarnings("UnescapedEntity")` to the element being
documented.
|
