[SAMZA-35] Write Javadocs for all samza-api interfaces

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.6.0
• Fix Version/s: 0.7.0
• Component/s: docs
• Assignee: Jakob Homan
• Reporter: Chris Riccomini
• Created: 21/Aug/13 02:48
• Updated: 19/Jun/14 01:02
• Resolved: 19/Jun/14 01:02

Description

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.

Issue Links

• is required by: SAMZA-279 0.7 release tasks