docs: format javadoc for registry

AllayMC · Sep 19, 2024 · b5449c1 · b5449c1
1 parent 7d82a9f
commit b5449c1
Show file tree

Hide file tree

Showing 9 changed files with 5 additions and 10 deletions.
diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/AbstractMappedRegistry.java b/Allay-API/src/main/java/org/allaymc/api/registry/AbstractMappedRegistry.java
@@ -12,7 +12,6 @@
  * @param <KEY>     the key
  * @param <VALUE>   the value
  * @param <MAPPING> the map
- *                  <p>
  *
  * @author daoge_cmd
  */

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/AbstractRegistry.java b/Allay-API/src/main/java/org/allaymc/api/registry/AbstractRegistry.java
@@ -35,8 +35,6 @@
  * though, the first parameter would be a location of some sort, such as a file path
  * where the loader will load the mappings from.
  *
- * <p>
- *
  * @param <CONTENT> the value being held by the registry
  *
  * @author GeyserMC | daoge_cmd

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/BiMappedRegistry.java b/Allay-API/src/main/java/org/allaymc/api/registry/BiMappedRegistry.java
@@ -3,6 +3,8 @@
 import com.google.common.collect.BiMap;
 
 /**
+ * A registry which use {@link BiMap} as the content.
+ *
  * @author daoge_cmd
  */
 public class BiMappedRegistry<LEFT, RIGHT> extends AbstractRegistry<BiMap<LEFT, RIGHT>> {

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/DoubleKeyMappedRegistry.java b/Allay-API/src/main/java/org/allaymc/api/registry/DoubleKeyMappedRegistry.java
@@ -4,6 +4,8 @@
 import java.util.function.Consumer;
 
 /**
+ * A registry which has two keys for one value.
+ *
  * @author daoge_cmd
  */
 public class DoubleKeyMappedRegistry<K1, K2, VALUE> extends AbstractRegistry<DoubleKeyMappedRegistry.MapPair<K1, K2, VALUE>> {

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/MappedRegistry.java b/Allay-API/src/main/java/org/allaymc/api/registry/MappedRegistry.java
@@ -7,7 +7,6 @@
  * A public registry holding a map of various registrations as defined by {@code MAPPING}.
  * The M represents the map class, which can be anything that extends {@link Map}. The
  * {@code KEY} and {@code VALUE} generics are the key and value respectively.
- * <p>
  *
  * @param <KEY>     the key
  * @param <VALUE>   the value

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/Registries.java b/Allay-API/src/main/java/org/allaymc/api/registry/Registries.java
@@ -28,9 +28,7 @@
 import java.util.function.Function;
 
 /**
- * Holds all the common registries in allay.
- *
- * <p>
+ * Registries holds all the common registries in allay.
  *
  * @author daoge_cmd
  */

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/Registry.java b/Allay-API/src/main/java/org/allaymc/api/registry/Registry.java
@@ -27,7 +27,6 @@
  * however it demonstrates a fairly basic use case of how this system works. Typically
  * though, the first parameter would be a location of some sort, such as a file path
  * where the loader will load the mappings from.
- * <p>
  *
  * @param <CONTENT> the type of the value which is being held by the registry
  *

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/RegistryLoader.java b/Allay-API/src/main/java/org/allaymc/api/registry/RegistryLoader.java
@@ -4,7 +4,6 @@
  * Represents a registry loader. {@link INPUT} is the input value, which can be anything,
  * but is commonly a file path or something similar. {@link OUTPUT} represents the output
  * type returned by this, which can also be anything.
- * <p>
  *
  * @param <INPUT>  the input to load the registry from
  * @param <OUTPUT> the output of the registry

diff --git a/Allay-API/src/main/java/org/allaymc/api/registry/SimpleRegistry.java b/Allay-API/src/main/java/org/allaymc/api/registry/SimpleRegistry.java
@@ -6,7 +6,6 @@
  * A simple registry with no defined mapping or input type. Designed to allow
  * for simple registrations of any given type without restrictions on what
  * the input or output can be.
- * <p>
  *
  * @param <CONTENT> the value being held by the registry
  *