[ https://issues.apache.org/jira/browse/KAFKA-3440?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15263166#comment-15263166 ]
ASF GitHub Bot commented on KAFKA-3440: --------------------------------------- GitHub user mjsax opened a pull request: https://github.com/apache/kafka/pull/1287 KAFKA-3440: update JavaDoc - add class doc for KTable, KStream, JoinWindows - add missing @return tags You can merge this pull request into a Git repository by running: $ git pull https://github.com/mjsax/kafka kafka-3440-JavaDoc Alternatively you can review and apply these changes as the patch at: https://github.com/apache/kafka/pull/1287.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #1287 ---- commit 8112f59787e6308f1007309b6eeca5d287a4e6b4 Author: Matthias J. Sax <matth...@confluent.io> Date: 2016-04-28T22:25:31Z KAFKA-3440: update JavaDoc - add class doc for KTable, KStream, JoinWindows - add missing @return tags ---- > Add Javadoc for KTable (changelog stream) and KStream (record stream) > --------------------------------------------------------------------- > > Key: KAFKA-3440 > URL: https://issues.apache.org/jira/browse/KAFKA-3440 > Project: Kafka > Issue Type: Sub-task > Components: streams > Reporter: Guozhang Wang > Assignee: Matthias J. Sax > Labels: docs > Fix For: 0.10.0.0 > > > Currently we only have a 1-liner in {code}KTable{code} and > {code}KStream{code} 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 {code}KTable{code}. > As a side tasks: I am many classes, method JavaDoc lack the {{@return}} tag > which should be used always. -- This message was sent by Atlassian JIRA (v6.3.4#6332)