kafka-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ewen Cheslack-Postava (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (KAFKA-3440) Add Javadoc for KTable (changelog stream) and KStream (record stream)
Date Fri, 29 Apr 2016 19:54:12 GMT

     [ https://issues.apache.org/jira/browse/KAFKA-3440?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

Ewen Cheslack-Postava updated KAFKA-3440:
    Resolution: Fixed
      Reviewer: Ewen Cheslack-Postava
        Status: Resolved  (was: Patch Available)

> 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:
> 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

View raw message