You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@samza.apache.org by "Chris Riccomini (JIRA)" <ji...@apache.org> on 2013/08/21 04:48:51 UTC

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

Chris Riccomini created SAMZA-35:
------------------------------------

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


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 is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira