[
https://issues.apache.org/jira/browse/BEAM-1413?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15856909#comment-15856909
]
ASF GitHub Bot commented on BEAM-1413:
--------------------------------------
GitHub user kennknowles opened a pull request:
https://github.com/apache/beam/pull/1940
[BEAM-1413] Fix some DoFn javadoc literals
Be sure to do all of the following to help us incorporate your contribution
quickly and easily:
- [x] Make sure the PR title is formatted like:
`[BEAM-<Jira issue #>] Description of pull request`
- [x] Make sure tests pass via `mvn clean verify`. (Even better, enable
Travis-CI on your fork and ensure the whole test matrix passes).
- [x] Replace `<Jira issue #>` in the title with the actual Jira issue
number, if there is one.
- [x] If this contribution is large, please file an Apache
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.txt).
---
@dhalperi and @davorbonaci are familiar with the pain here... I tried my
best to make it legible both in source and in target. The problem is actually
mostly related to multi-line use of javadoc tags, which javadoc simply
processes incorrectly. This seems like a fairly brain-dead reproducible format
for such blocks.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/kennknowles/beam DoFn-javadoc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam/pull/1940.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1940
----
----
> DoFn javadoc has @literal where it shouldn't
> --------------------------------------------
>
> Key: BEAM-1413
> URL: https://issues.apache.org/jira/browse/BEAM-1413
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Reporter: Kenneth Knowles
> Assignee: Kenneth Knowles
>
> In particular, the docs for StateId and TimerId annotations have an extra
> layer.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
