[
https://issues.apache.org/jira/browse/BEAM-6679?focusedWorklogId=199306&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-199306
]
ASF GitHub Bot logged work on BEAM-6679:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Feb/19 15:56
Start Date: 15/Feb/19 15:56
Worklog Time Spent: 10m
Work Description: echauchot commented on pull request #7852: [BEAM-6679]
Clean up GroupIntoBatches Javadoc
URL: https://github.com/apache/beam/pull/7852
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 199306)
Time Spent: 1.5h (was: 1h 20m)
> Fix javadoc @ litterals
> -----------------------
>
> Key: BEAM-6679
> URL: https://issues.apache.org/jira/browse/BEAM-6679
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Reporter: Jeff Klukas
> Assignee: Jeff Klukas
> Priority: Minor
> Time Spent: 1.5h
> Remaining Estimate: 0h
>
> The combination of `<pre>` for preserving line breaks and `{@code` for
> preserving angle brackets and curly brackets _mostly_ works.
> `@` is the problematic character. I see `\{@literal @}` show up in many
> classes' Javadoc, and that method doesn't do what's intended. In current Java
> 8 builds, it looks like `@` inside `\{@code}` is not a problem in the general
> case and doesn't need to be escaped. The one exception is when `@` is the
> first non-whitespace character in a line, in which case it appears that
> Javadoc thinks it's a tag like `@return` or `@param` and throws an error.
> The solution here is to end the `@code` block and start a new one on the line
> that contains '@' litteral. Note that `@code` and `@literal` blocks, while
> they will render literal curly brackets, expect curly brackets to be
> balanced. Thus, we have to end the previous code block before the `{` that
> opens the next block
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
