docs: Added some javadoc

confluentinc · Oct 29, 2019 · a35d739 · a35d739
1 parent 2090022
commit a35d739
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 0 deletions.
diff --git a/ksql-engine/src/main/java/io/confluent/ksql/function/FunctionLoaderUtils.java b/ksql-engine/src/main/java/io/confluent/ksql/function/FunctionLoaderUtils.java
@@ -46,6 +46,9 @@
 import org.apache.kafka.common.metrics.stats.WindowedCount;
 import org.apache.kafka.connect.data.Schema;
 
+/**
+ * Utility class for loading different types of user defined funcrions
+ */
 public final class FunctionLoaderUtils {
 
   private static final String UDF_METRIC_GROUP = "ksql-udf";

diff --git a/ksql-engine/src/main/java/io/confluent/ksql/function/UdafLoader.java b/ksql-engine/src/main/java/io/confluent/ksql/function/UdafLoader.java
@@ -30,6 +30,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Loads user defined aggregate functions (UDAFs)
+ */
 class UdafLoader {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(UdafLoader.class);

diff --git a/ksql-engine/src/main/java/io/confluent/ksql/function/UdfLoader.java b/ksql-engine/src/main/java/io/confluent/ksql/function/UdfLoader.java
@@ -35,6 +35,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Loads user defined functions (UDFs)
+ */
 public class UdfLoader {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(UdfLoader.class);

diff --git a/ksql-engine/src/main/java/io/confluent/ksql/function/UdtfLoader.java b/ksql-engine/src/main/java/io/confluent/ksql/function/UdtfLoader.java
@@ -32,6 +32,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Loads user defined table functions (UDTFs)
+ */
 class UdtfLoader {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(UdtfLoader.class);

diff --git a/ksql-engine/src/main/java/io/confluent/ksql/function/UserFunctionLoader.java b/ksql-engine/src/main/java/io/confluent/ksql/function/UserFunctionLoader.java
@@ -37,6 +37,10 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Coordinates the loading of UDFs, UDAFs and UDTFs. The actual loading of the functions is done in
+ * of the specific function loader classes
+ */
 public class UserFunctionLoader {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(UserFunctionLoader.class);