Add JavaDoc to functional interface

yisiox · Feb 12, 2024 · 2a85901 · 2a85901
1 parent 6cb057b
commit 2a85901
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/main/java/earl/util/parsers/ParseFunction.java b/src/main/java/earl/util/parsers/ParseFunction.java
@@ -2,6 +2,11 @@
 
 import earl.exceptions.EarlException;
 
+/**
+ * Custom functional interface for parse functions.
+ *
+ * @param <T>  the type that the parser returns
+ */
 @FunctionalInterface
 public interface ParseFunction<T> {
     T apply(String str) throws EarlException;

diff --git a/src/main/java/earl/util/parsers/TaskStorageParser.java b/src/main/java/earl/util/parsers/TaskStorageParser.java
@@ -11,6 +11,13 @@
  */
 public class TaskStorageParser extends StorageParser<Task> {
 
+    /**
+     * Returns a {@code Task} object based on the stored string.
+     *
+     * @param entry           storage entry string
+     * @return                a {@code Task} object
+     * @throws EarlException  if the storage entry is incomprehensible
+     */
     public static Task parse(String entry) throws EarlException {
         try {
             String[] data = entry.split(",");