SAMZA-712: Fix javadoc warnings

Telesia · Jun 22, 2015 · e2906c8 · e2906c8
1 parent d2de9db
commit e2906c8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/samza-api/src/main/java/org/apache/samza/task/TaskContext.java b/samza-api/src/main/java/org/apache/samza/task/TaskContext.java
@@ -48,6 +48,10 @@ public interface TaskContext {
    * will have no effect.
    *
    * NOTE: this feature is experimental, and the API may change in a future release.
+   *
+   * @param ssp {@link org.apache.samza.system.SystemStreamPartition} whose offset should be set
+   * @param offset to set for the given {@link org.apache.samza.system.SystemStreamPartition}
+   *
    */
   void setStartingOffset(SystemStreamPartition ssp, String offset);
 }
diff --git a/...log4j/src/main/java/org/apache/samza/logging/log4j/serializers/LoggingEventJsonSerde.java b/...log4j/src/main/java/org/apache/samza/logging/log4j/serializers/LoggingEventJsonSerde.java
@@ -153,6 +153,11 @@ public static Map<String, Object> encodeToMap(LoggingEvent loggingEvent, boolean
 
   /**
    * This method is not currently implemented.
+   *
+   * @param loggingEventMap a map of logging events
+   *
+   * @return {@link LoggingEvent} decoded from the given logging event map.<br>
+   *     Currently it throws an {@link UnsupportedOperationException} as the method is not implemented yet!
    */
   public static LoggingEvent decodeFromMap(Map<String, Object> loggingEventMap) {
     throw new UnsupportedOperationException("Unable to decode LoggingEvents.");