[jira] [Updated] (SAMZA-35) Write Javadocs for all samza-api interfaces

["Chris Riccomini (JIRA)" <ji...@apache.org>]

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

Chris Riccomini updated SAMZA-35:
---------------------------------

    Fix Version/s: 0.7.0

> Write Javadocs for all samza-api interfaces
> -------------------------------------------
>
>                 Key: SAMZA-35
>                 URL: https://issues.apache.org/jira/browse/SAMZA-35
>             Project: Samza
>          Issue Type: Bug
>          Components: docs
>    Affects Versions: 0.6.0
>            Reporter: Chris Riccomini
>            Assignee: Martin Kleppmann
>             Fix For: 0.7.0
>
>
> We really need to do a better job of documenting the samza-api code. Especially, the classes the end-user will see frequently:
> * StreamTask
> * WindowableTask
> * ClosableTask
> * InitableTask
> * MessageCollector
> * IncomingMessageEnvelope
> * OutgoingMessageEnvelope
> * TaskContext
> * StorageEngine
> * MetricsRegistry
> * Partition
> * TaskCoordinator
> * Config
> Other classes should be documented as well, but the above are user-facing, and special care should be taken to make sure the docs are complete and accurate.



--
This message was sent by Atlassian JIRA
(v6.2#6252)