• Home
• io.github.erroraway
• sonar-erroraway-sonar-plugin
• 2.2.0
• source code
• UnescapedEntity.md

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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 of prime numbers. */
Iterable generatePrimes();
```

Prefer writing generic types as `{@code Iterable}` (or `{@link }`).

## Suppression

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