[
https://issues.apache.org/jira/browse/KAFKA-3440?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Matthias J. Sax updated KAFKA-3440:
-----------------------------------
Description:
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.
was:
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.
> 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)
