[
https://issues.apache.org/jira/browse/FLINK-2559?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14976832#comment-14976832
]
ASF GitHub Bot commented on FLINK-2559:
---------------------------------------
Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/1298#discussion_r43158439
--- Diff:
flink-contrib/flink-storm/src/main/java/org/apache/flink/storm/util/SplitStreamType.java
---
@@ -20,10 +20,11 @@
import org.apache.flink.streaming.api.datastream.DataStream;
/**
- * Used by {@link org.apache.flink.storm.wrappers.AbstractStormCollector
AbstractStormCollector} to wrap
+ * Used by org.apache.flink.storm.wrappers.AbstractStormCollector to wrap
--- End diff --
Sounds good to me.
> 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)
