[KAFKA-3440] Add Javadoc for KTable (changelog stream) and KStream (record stream)

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.10.0.0
• Fix Version/s: 0.10.0.0
• Component/s: streams
• Labels: docs
• Assignee: Matthias J. Sax
• Reporter: Guozhang Wang
• Reviewer: Ewen Cheslack-Postava
• Created: 21/Mar/16 19:05
• Updated: 22/Feb/17 01:05
• Resolved: 29/Apr/16 19:53

Description

Currently we only have a 1-liner in

KTable

and

KStream

class describing the changelog and record streams. We'd better have a more detailed explanation as in the web docs in Javadocs as well.

Also we want to have some more description in windowed

KTable

.

As a side tasks: I am many classes, method JavaDoc lack the @return tag which should be used always.

Issue Links

• contains: KAFKA-3574 Add missing @returns tags for JavaDoc