apache / apache/beam

Annotations are not properly rendered in JavaDoc when using <pre>{@code}

Open
#18,111 0 comments 0 reactions 0 assignees View on GitHub
bug core java P4 runners
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

```

{@code

{@literal @}Override
}

```

Produces
```

{ @}Override

```

Instead of:
```

@Override

```

Imported from Jira [BEAM-1295](https://issues.apache.org/jira/browse/BEAM-1295). Original Jira may contain additional context.
Reported by: staslev.

Contributor guide

Open the contributing guide

Research direction

Reproduce the JavaDoc example from the issue and compare the rendered output with the expected @Override text. Then trace the JavaDoc rendering path responsible for

{@code} and {@literal @}; done means the annotation renders without the extra braces and the regression is covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.