[KAFKA-5228] Revisit Streams DSL JavaDocs

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 0.10.2.1
• Fix Version/s: 1.1.0
• Component/s: streams
• Labels: beginner documentation newbie
• Assignee: Jeyhun Karimov
• Reporter: Matthias J. Sax
• Created: 12/May/17 21:02
• Updated: 04/Feb/18 20:32
• Resolved: 04/Feb/18 20:32

Description

We got some user feedback, that is it sometimes not clear from the JavaDocs, if provides Serdes are for input or output records.

For example:

...
     * @param keySerde key serdes for materializing this stream.
     *                 If not specified the default serdes defined in the configs will be used
     * @param valSerde value serdes for materializing this stream,
     *                 if not specified the default serdes defined in the configs will be used
...
    <VT, VR> KStream<K, VR> join(final KTable<K, VT> table,
                                 final ValueJoiner<? super V, ? super VT, ? extends VR> joiner,
                                 final Serde<K> keySerde,
                                 final Serde<V> valSerde);

The phrase "for this stream" means the input stream. But it is rather subtle. We should revisit the complete JavaDocs and rephrase the Serde parameter description if required. We should also rename the parameter names (in the example about, maybe from keySerde to inputKStreamKeySerde)

Issue Links

• links to: GitHub Pull Request #3047
• links to: GitHub Pull Request #3047