You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Aljoscha Krettek (JIRA)" <ji...@apache.org> on 2015/08/21 14:09:45 UTC
[jira] [Created] (FLINK-2559) Fix Javadoc Code Examples
Aljoscha Krettek created FLINK-2559:
---------------------------------------
Summary: 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
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)