From 64c0b9b62f81810a0accbd42671b2b542e410e46 Mon Sep 17 00:00:00 2001
From: Ashley <ashley@foxgenesis.net>
Date: Sun, 20 Aug 2023 21:51:57 -0500
Subject: [PATCH] javadoc

---
 src/net/foxgenesis/database/AbstractDatabase.java | 15 +++++++++++++++
 src/net/foxgenesis/property/Property.java         |  5 +++++
 src/net/foxgenesis/property/PropertyProvider.java |  2 ++
 .../foxgenesis/util/function/QuadFunction.java    |  4 ++++
 src/net/foxgenesis/watame/WatameBotSettings.java  |  2 ++
 src/net/foxgenesis/watame/plugin/Plugin.java      | 15 ++++++++-------
 .../foxgenesis/watame/plugin/PluginHandler.java   |  1 +
 7 files changed, 37 insertions(+), 7 deletions(-)

diff --git a/src/net/foxgenesis/database/AbstractDatabase.java b/src/net/foxgenesis/database/AbstractDatabase.java
index 99650ac..ba663b5 100644
--- a/src/net/foxgenesis/database/AbstractDatabase.java
+++ b/src/net/foxgenesis/database/AbstractDatabase.java
@@ -92,6 +92,8 @@ synchronized final void unload() {
 
 	/**
 	 * NEED_JAVADOC
+	 * 
+	 * @return Returns the new {@link Connection}
 	 *
 	 * @throws SQLException
 	 */
@@ -109,6 +111,7 @@ protected Connection openConnection() throws SQLException {
 	 *
 	 * @param id
 	 * @param func
+	 * @param flags
 	 *
 	 * @throws SQLException
 	 */
@@ -146,6 +149,10 @@ protected void prepareCallable(String id, SQLConsumer<CallableStatement> func) t
 	 * @param <U>
 	 * @param id
 	 * @param func
+	 * @param flags
+	 * 
+	 * @return Returns the result of {@code func} otherwise an empty
+	 *         {@link Optional}
 	 *
 	 * @throws SQLException
 	 */
@@ -167,6 +174,9 @@ protected <U> Optional<U> mapStatement(String id, SQLFunction<PreparedStatement,
 	 * @param <U>
 	 * @param id
 	 * @param func
+	 * 
+	 * @return Returns the result of {@code func} otherwise an empty
+	 *         {@link Optional}
 	 *
 	 * @throws SQLException
 	 */
@@ -185,6 +195,9 @@ protected <U> Optional<U> mapCallable(String id, SQLFunction<CallableStatement,
 	 * NEED_JAVADOC
 	 *
 	 * @param id
+	 * 
+	 * @return Returns {@code true} if the statement is registered. {@code false}
+	 *         otherwise
 	 */
 	protected final boolean hasStatementID(String id) {
 		return statements.containsKey(id);
@@ -194,6 +207,8 @@ protected final boolean hasStatementID(String id) {
 	 * NEED_JAVADOC
 	 *
 	 * @param id
+	 * 
+	 * @return Returns the raw SQL statement
 	 */
 	protected final String getRawStatement(String id) {
 		if (!hasStatementID(id))
diff --git a/src/net/foxgenesis/property/Property.java b/src/net/foxgenesis/property/Property.java
index 0287776..8b6ad0f 100644
--- a/src/net/foxgenesis/property/Property.java
+++ b/src/net/foxgenesis/property/Property.java
@@ -98,6 +98,7 @@ default void checkUserInput(boolean user) {
 	 * @return Returns the serialized data
 	 */
 	static byte[] serialize(@NotNull PropertyInfo info, @NotNull Serializable obj) {
+		// PLAIN TEXT
 		if (info.type() == PropertyType.PLAIN) {
 			if (obj.getClass().isArray()) {
 				Serializable[] a = (Serializable[]) obj;
@@ -112,6 +113,8 @@ static byte[] serialize(@NotNull PropertyInfo info, @NotNull Serializable obj) {
 
 			return obj.toString().getBytes();
 		}
+
+		// NUMBERS
 		if (info.type() == PropertyType.NUMBER) {
 			if (obj instanceof Integer i)
 				return ByteBuffer.allocate(Integer.SIZE / Byte.SIZE).putInt(i).array();
@@ -128,6 +131,8 @@ else if (obj instanceof Boolean f)
 			else if (obj instanceof Byte b)
 				return new byte[] { b };
 		}
+
+		// JAVA OBJECTS
 		return SerializationUtils.serialize(obj);
 	}
 }
diff --git a/src/net/foxgenesis/property/PropertyProvider.java b/src/net/foxgenesis/property/PropertyProvider.java
index fc1d199..4c4e34b 100644
--- a/src/net/foxgenesis/property/PropertyProvider.java
+++ b/src/net/foxgenesis/property/PropertyProvider.java
@@ -12,6 +12,8 @@
  *
  * @param <C> property category type
  * @param <K> property key type
+ * @param <G> lookup type
+ * @param <M> property mapping type
  *
  * @author Ashley
  */
diff --git a/src/net/foxgenesis/util/function/QuadFunction.java b/src/net/foxgenesis/util/function/QuadFunction.java
index 73c63b9..9f95f36 100644
--- a/src/net/foxgenesis/util/function/QuadFunction.java
+++ b/src/net/foxgenesis/util/function/QuadFunction.java
@@ -12,6 +12,8 @@
  *
  * @param <T> the type of the first argument to the function
  * @param <U> the type of the second argument to the function
+ * @param <V> 
+ * @param <W> 
  * @param <R> the type of the result of the function
  *
  * @see Function
@@ -25,6 +27,8 @@ public interface QuadFunction<T, U, V, W, R> {
      *
      * @param t the first function argument
      * @param u the second function argument
+     * @param v 
+     * @param w 
      * @return the function result
      */
     R apply(T t, U u, V v, W w);
diff --git a/src/net/foxgenesis/watame/WatameBotSettings.java b/src/net/foxgenesis/watame/WatameBotSettings.java
index b382845..17428ab 100644
--- a/src/net/foxgenesis/watame/WatameBotSettings.java
+++ b/src/net/foxgenesis/watame/WatameBotSettings.java
@@ -68,6 +68,8 @@ String getPBToken() {
 
 	/**
 	 * NEED_JAVADOC
+	 * 
+	 * @param filepath
 	 *
 	 * @return Returns the read token
 	 *
diff --git a/src/net/foxgenesis/watame/plugin/Plugin.java b/src/net/foxgenesis/watame/plugin/Plugin.java
index 5203f2b..521952a 100644
--- a/src/net/foxgenesis/watame/plugin/Plugin.java
+++ b/src/net/foxgenesis/watame/plugin/Plugin.java
@@ -33,12 +33,13 @@
 
 /**
  * A service providing functionality to {@link WatameBot}.
+ * <p>
+ * Providers should provide a <b>no-argument constructor</b> or a
+ * {@code public static Plugin provider()} method in accordance to
+ * {@link java.util.ServiceLoader.Provider#get() Provider.get()}
+ * </p>
  * 
  * @author Ashley
- * 
- * @implSpec Providers should provide a <b>no-argument constructor</b> or a
- *           {@code public static Plugin provider()} method in accordance to
- *           {@link java.util.ServiceLoader.Provider#get() Provider.get()}
  *
  */
 public abstract class Plugin {
@@ -100,13 +101,13 @@ public abstract class Plugin {
 	 * ServiceLoader} to load and initialize required plugin data.
 	 * <p>
 	 * Types of plugin data would include:
+	 * </p>
 	 * <ul>
 	 * <li>Configuration settings</li>
 	 * <li>Constants</li>
 	 * </ul>
 	 * Anything beyond the previous should be loaded in the {@link #preInit()}
 	 * method.
-	 * </p>
 	 * 
 	 * @throws SeverePluginException if the plugin is not in a named module or there
 	 *                               was a problem while loading the
@@ -271,8 +272,8 @@ protected final PluginProperty getProperty(String name) {
 	 * Get the provider for registering and getting {@link PluginProperty
 	 * PluginProperties}.
 	 * 
-	 * @return Returns the {@link PluginPropertyProvider} used by {@link Plugin Plugins} to
-	 *         register plugin properties
+	 * @return Returns the {@link PluginPropertyProvider} used by {@link Plugin
+	 *         Plugins} to register plugin properties
 	 */
 	protected final PluginPropertyProvider getPropertyProvider() {
 		return WatameBot.INSTANCE.getPropertyProvider();
diff --git a/src/net/foxgenesis/watame/plugin/PluginHandler.java b/src/net/foxgenesis/watame/plugin/PluginHandler.java
index 4e7e09b..a1309e2 100644
--- a/src/net/foxgenesis/watame/plugin/PluginHandler.java
+++ b/src/net/foxgenesis/watame/plugin/PluginHandler.java
@@ -81,6 +81,7 @@ public class PluginHandler<@NotNull T extends Plugin> implements Closeable {
 	 * Construct a new {@link PluginHandler} with the specified {@link ModuleLayer}
 	 * and plugin {@link Class}.
 	 * 
+	 * @param context     - instance context
 	 * @param layer       - layer the {@link ServiceLoader} should use
 	 * @param pluginClass - the plugin {@link Class} to load
 	 */