[cleanup][functions] Fix some javadoc issues (apache#16128)

felixYyu · Jun 24, 2022 · 61b9601 · 61b9601
1 parent b06e78e
commit 61b9601
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/Context.java b/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/Context.java
@@ -57,7 +57,7 @@ public interface Context extends BaseContext {
     /**
      * Access the record associated with the current input value.
      *
-     * @return
+     * @return the current record
      */
     Record<?> getCurrentRecord();
 
@@ -107,8 +107,8 @@ public interface Context extends BaseContext {
     /**
      * Get any user-defined key/value or a default value if none is present.
      *
-     * @param key
-     * @param defaultValue
+     * @param key the config key to retrieve
+     * @param defaultValue value returned if the key is not found
      * @return Either the user config value associated with a given key or a supplied default value
      */
     Object getUserConfigValueOrDefault(String key, Object defaultValue);
@@ -147,19 +147,19 @@ public interface Context extends BaseContext {
      *
      * @param topicName The name of the topic for output message
      * @param schema provide a way to convert between serialized data and domain objects
-     * @param <X>
+     * @param <X> the type of message
      * @return the message builder instance
-     * @throws PulsarClientException
+     * @throws PulsarClientException if an error occurs
      */
     <X> TypedMessageBuilder<X> newOutputMessage(String topicName, Schema<X> schema) throws PulsarClientException;
 
     /**
      * Create a ConsumerBuilder with the schema.
      *
      * @param schema provide a way to convert between serialized data and domain objects
-     * @param <X>
+     * @param <X> the message type of the consumer
      * @return the consumer builder instance
-     * @throws PulsarClientException
+     * @throws PulsarClientException if an error occurs
      */
     <X> ConsumerBuilder<X> newConsumerBuilder(Schema<X> schema) throws PulsarClientException;
 

diff --git a/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/Function.java b/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/Function.java
@@ -44,14 +44,14 @@ public interface Function<X, T> {
      *
      * @param context The Function context
      *
-     * @throws Exception
+     * @throws Exception if an error occurs
      */
     default void initialize(Context context) throws Exception {}
 
     /**
      * Called once to properly close resources when function instance is stopped.
      *
-     * @throws Exception
+     * @throws Exception if an error occurs
      */
     default void close() throws Exception {}
 }
diff --git a/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/StateStore.java b/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/StateStore.java
@@ -56,7 +56,7 @@ public interface StateStore extends AutoCloseable {
     /**
      * Initialize the state store.
      *
-     * @param ctx
+     * @param ctx the state store context
      */
     void init(StateStoreContext ctx);
 

diff --git a/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/WindowContext.java b/pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api/WindowContext.java
@@ -158,8 +158,8 @@ public interface WindowContext {
     /**
      * Get any user-defined key/value or a default value if none is present.
      *
-     * @param key
-     * @param defaultValue
+     * @param key the config key to retrieve
+     * @param defaultValue value returned if the key is not found
      * @return Either the user config value associated with a given key or a supplied default value
      */
     Object getUserConfigValueOrDefault(String key, Object defaultValue);