You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by "Jakob Homan (JIRA)" <ji...@apache.org> on 2014/06/18 22:32:25 UTC
[jira] [Updated] (SAMZA-35) Write Javadocs for all samza-api
interfaces
[ https://issues.apache.org/jira/browse/SAMZA-35?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jakob Homan updated SAMZA-35:
-----------------------------
Attachment: SAMZA-35.patch
Patch to add javadoc to pretty much everything in the api package.
Didn't add any to ReadableMetricsRegistryListener as I don't entirely understand what's intention was. [~criccomini], any clues? Looks like it may be related to the unused MetricsType and DataType classes.
> 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: Jakob Homan
> Fix For: 0.7.0
>
> Attachments: SAMZA-35.patch
>
>
> 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)