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

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Done
• Fix Version/s: 0.10.0, 1.0.0
• Labels: starter
• Assignee: Unassigned
• Reporter: Aljoscha Krettek
• Created: 21/Aug/15 12:09
• Updated: 29/Oct/15 12:59
• Resolved: 29/Oct/15 12:59

Description

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:

 * <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>