You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Chesnay Schepler (JIRA)" <ji...@apache.org> on 2015/10/23 19:51:27 UTC
[jira] [Assigned] (FLINK-2559) Fix Javadoc Code Examples
[ https://issues.apache.org/jira/browse/FLINK-2559?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Chesnay Schepler reassigned FLINK-2559:
---------------------------------------
Assignee: Chesnay Schepler
> Fix Javadoc Code Examples
> -------------------------
>
> Key: FLINK-2559
> URL: https://issues.apache.org/jira/browse/FLINK-2559
> Project: Flink
> Issue Type: Improvement
> Reporter: Aljoscha Krettek
> Assignee: Chesnay Schepler
> 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)