[
https://issues.apache.org/jira/browse/BEAM-6680?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jeff Klukas closed BEAM-6680.
-----------------------------
Resolution: Duplicate
Fix Version/s: Not applicable
> Fix {@literal @} that shows up in Javadoc code examples
> -------------------------------------------------------
>
> Key: BEAM-6680
> URL: https://issues.apache.org/jira/browse/BEAM-6680
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Reporter: Jeff Klukas
> Assignee: Jeff Klukas
> Priority: Minor
> Fix For: Not applicable
>
>
> Many Beam classes include multi-line code examples. When annotations need to
> mark classes or methods in those examples, it looks like we have generally
> have tried to escape the `@` with a "@literal" tag, but those tags aren't
> working as expected and end up appearing in the rendered documentation. See
> [ParDo|https://beam.apache.org/releases/javadoc/2.10.0/org/apache/beam/sdk/transforms/ParDo.html]
> for several examples.
> Where `@` appears within a line, no escaping appears to be necessary. It gets
> a bit complicated when `@` appears as the first non-whitespace character in a
> line, as is usually the case for annotations on classes or methods. I've
> proposed a style for handling that case in
> https://github.com/apache/beam/pull/7852
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
