Uploaded image for project: 'Samza'
  1. Samza
  2. SAMZA-35

Write Javadocs for all samza-api interfaces

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 0.6.0
    • Fix Version/s: 0.7.0
    • Component/s: docs
    • Labels:
      None

      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.

        Attachments

        1. SAMZA-35.patch
          46 kB
          Jakob Homan
        2. SAMZA-35-1.patch
          46 kB
          Jakob Homan
        3. SAMZA-35-2.patch
          47 kB
          Jakob Homan

          Issue Links

            Activity

              People

              • Assignee:
                jghoman Jakob Homan
                Reporter:
                criccomini Chris Riccomini
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: