[jira] [Commented] (FLINK-2559) Fix Javadoc (e.g. Code Examples)

["Maximilian Michels (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-2559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14980360#comment-14980360 ] 

Maximilian Michels commented on FLINK-2559:
-------------------------------------------

Nice work! :)

Before:
{noformat}
2419 warnings
{noformat}

After:
{noformat}
101 warnings
{noformat}

> Fix Javadoc (e.g. 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)