[
https://issues.apache.org/jira/browse/FLINK-2559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14976779#comment-14976779
]
ASF GitHub Bot commented on FLINK-2559:
---------------------------------------
Github user fhueske commented on the pull request:
https://github.com/apache/flink/pull/1298#issuecomment-151576323
Hi @hczerpak, thanks a lot for the thorough cleaning of the JavaDocs!
I spotted just a few things that should be improved.
The commit history of your PR is also a bit messy. Would you mind to rebase
it to get rid of the merge commits?
Thanks again, Fabian
> Fix Javadoc Code Examples
> -------------------------
>
> Key: FLINK-2559
> URL: https://issues.apache.org/jira/browse/FLINK-2559
> Project: Flink
> Issue Type: Improvement
> Reporter: Aljoscha Krettek
> Priority: Minor
> Labels: starter
>
> Many multiline Javadoc code examples are not correctly rendered. One of the
> problems is that an @ inside a code block breaks the rendering.
> This is an example that works:
> {code}
> * <pre>{@code
> * private static class MyIndexRequestBuilder implements
> IndexRequestBuilder<String> {
> *
> * public IndexRequest createIndexRequest(String element,
> RuntimeContext ctx) {
> * Map<String, Object> json = new HashMap<>();
> * json.put("data", element);
> *
> * return Requests.indexRequest()
> * .index("my-index")
> * .type("my-type")
> * .source(json);
> * }
> * }
> * }</pre>
> {code}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
