chore: more javadocs

build.gradle.kts

@@ -50,6 +50,10 @@ java {
     withJavadocJar()
 }
 
+tasks.withType(Javadoc::class.java) {
+    exclude("**/mixin/**")
+}
+
 sourceSets {
     val main = this.getByName("main")
 

src/main/java/io/github/jamalam360/jamlib/JamLib.java

@@ -27,10 +27,8 @@
 import static net.minecraft.server.command.CommandManager.literal;
 
 import io.github.jamalam360.jamlib.log.JamLibLogger;
-import io.github.jamalam360.jamlib.tick.TickScheduling;
 import net.fabricmc.api.ModInitializer;
 import net.fabricmc.fabric.api.command.v2.CommandRegistrationCallback;
-import net.fabricmc.fabric.api.event.lifecycle.v1.ServerTickEvents;
 import net.fabricmc.loader.api.FabricLoader;
 import net.minecraft.text.Text;
 import org.jetbrains.annotations.ApiStatus.Internal;
@@ -43,8 +41,6 @@ public class JamLib implements ModInitializer {
 
     @Override
     public void onInitialize() {
-        ServerTickEvents.END_WORLD_TICK.register(TickScheduling::onEndTickServer);
-
         //noinspection CodeBlock2Expr
         CommandRegistrationCallback.EVENT.register((dispatcher, registryAccess, env) -> {
             dispatcher.register(

src/main/java/io/github/jamalam360/jamlib/JamLibClient.java

@@ -25,7 +25,6 @@
 package io.github.jamalam360.jamlib;
 
 import io.github.jamalam360.jamlib.keybind.JamLibKeybinds;
-import io.github.jamalam360.jamlib.tick.TickScheduling;
 import net.fabricmc.api.ClientModInitializer;
 import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;
 import org.jetbrains.annotations.ApiStatus.Internal;
@@ -35,7 +34,6 @@ public class JamLibClient implements ClientModInitializer {
 
     @Override
     public void onInitializeClient() {
-        ClientTickEvents.END_WORLD_TICK.register(TickScheduling::onEndTickClient);
         ClientTickEvents.END_CLIENT_TICK.register(JamLibKeybinds::onEndTick);
     }
 }

src/main/java/io/github/jamalam360/jamlib/Util.java

@@ -37,6 +37,7 @@ public class Util {
     /**
      * @param value    The nullable value.
      * @param consumer The consumer to run if {@code value} is not null.
+     * @param <T>      The return type.
      */
     public static <T> void ifNotNull(@Nullable T value, Consumer<T> consumer) {
         if (value != null) {
@@ -48,6 +49,7 @@ public static <T> void ifNotNull(@Nullable T value, Consumer<T> consumer) {
      * @param value        The nullable value.
      * @param consumer     The consumer to run if {@code value} is not null.
      * @param elseCallback The callback to run if {@code value} is null.
+     * @param <T>          The return type.
      */
     public static <T> void ifNotNull(@Nullable T value, Consumer<T> consumer, Runnable elseCallback) {
         if (value != null) {
@@ -62,7 +64,9 @@ public static <T> void ifNotNull(@Nullable T value, Consumer<T> consumer, Runnab
      * @param function  The function to run to calculate the return value if {@code value} is not null.
      * @param elseValue The value to return if {@code value} is null.
      * @param <T>       The value type.
-     * @param <R>       The result type.
+     * @param <R>       The return type.
+     *
+     * @return The value computed by the {@code function} if {@code value} is not null, or else the {@code elseValue}.
      */
     public static <T, R> R ifNotNull(@Nullable T value, Function<T, R> function, R elseValue) {
         if (value != null) {
@@ -77,7 +81,9 @@ public static <T, R> R ifNotNull(@Nullable T value, Function<T, R> function, R e
      * @param function     The function to run to calculate the return value if {@code value} is not null.
      * @param elseFunction The function to run to calculate the return value if {@code value} is null.
      * @param <T>          The value type.
-     * @param <R>          The result type.
+     * @param <R>          The return type.
+     *
+     * @return The value computed by the {@code function} if {@code value} is not null, or else the value computed by the {@code elseFunction}.
      */
     public static <T, R> R ifNotNull(@Nullable T value, Function<T, R> function, Supplier<R> elseFunction) {
         if (value != null) {

src/main/java/io/github/jamalam360/jamlib/compatibility/JamLibCompatibilityModuleHandler.java

@@ -34,7 +34,7 @@
  * <p>Helper class to initialize 'compatibility modules' for a mod. A compatibility module is
  * an entrypoint (that implements {@link ModInitializer}) that is only loaded when another specific mod is loaded.</p>
  *
- * <p>To define compatibility modules, create a {@code jamlib:compatibility_modules}</p> map
+ * <p>To define compatibility modules, create a {@code jamlib:compatibility_modules} map
  * in your {@code fabric.mod.json}'s {@code custom} field (or the equivalent for the Quilt toolchain). The keys of this map should be mod ID's, and the values should be
  * the fully qualified name of your compatibility module</p>
  *
@@ -56,7 +56,7 @@ public class JamLibCompatibilityModuleHandler {
     /**
      * Search for, and initialize if required, all compatibility modules under the specified {@code modId}.
      *
-     * @param modId <bold>Your mod's</bold> ID. Used to lookup the {@code jamlib:compatibility_modules}
+     * @param modId <b>Your mod's</b> ID. Used to lookup the {@code jamlib:compatibility_modules}
      *              map from the {@code fabric.mod.json} or {@code quilt.mod.json}.
      */
     public static void initialize(String modId) {

src/main/java/io/github/jamalam360/jamlib/config/JamLibConfig.java

@@ -71,7 +71,7 @@
 import net.minecraft.util.Formatting;
 
 /**
- * <p>MidnightConfig v2.1.0 by TeamMidnightDust & Motschen (adapted from Minenash/TinyConfig),
+ * <p>MidnightConfig v2.1.0 by TeamMidnightDust and Motschen (adapted from Minenash/TinyConfig),
  * adapted by Jamalam for use in JamLib</p>
  *
  * <p>Used to register config classes that are reflectively updated. Provides a ModMenu-based GUI.</p>

src/main/java/io/github/jamalam360/jamlib/event/client/MouseScrollCallback.java

@@ -31,13 +31,16 @@
 
 /**
  * <p>This event is called on the client-side when the user scrolls their
- * mouse wheel, <bold>if</bold> they <bold>don't</bold> have a screen open.</p>
+ * mouse wheel, <b>if</b> they <b>don't</b> have a screen open.</p>
  *
  * <p>Use custom packets if this event is required on the server-side.</p>
  */
 @Environment(EnvType.CLIENT)
 public interface MouseScrollCallback {
 
+    /**
+     * The {@link Event}.
+     */
     Event<MouseScrollCallback> EVENT = EventFactory.createArrayBacked(MouseScrollCallback.class, (listeners) -> (mouseX, mouseY, amount) -> {
         boolean consumed = false;
 

src/main/java/io/github/jamalam360/jamlib/network/JamLibClientNetworking.java

@@ -34,6 +34,9 @@
  */
 public class JamLibClientNetworking {
 
+    /**
+     * An {@link Map} that maps mod ID's to a list of registered channels under that mod ID.
+     */
     protected static final Map<String, List<JamLibNetworkChannel<?>>> CLIENT_CHANNELS = new HashMap<>();
 
     /**

src/main/java/io/github/jamalam360/jamlib/network/JamLibNetworkChannel.java

@@ -37,10 +37,16 @@ public JamLibNetworkChannel(Identifier identifier) {
         this.identifier = identifier;
     }
 
+    /**
+     * @return The identifier of this channel.
+     */
     protected Identifier getIdentifier() {
         return identifier;
     }
 
+    /**
+     * @return The handler that responds to packets on this channel.
+     */
     protected T getHandler() {
         return handler;
     }

src/main/java/io/github/jamalam360/jamlib/network/JamLibS2CNetworkChannel.java

@@ -50,6 +50,8 @@ public JamLibS2CNetworkChannel(Identifier identifier) {
 
     /**
      * Shorthand method for sending an empty packet to the client.
+     *
+     * @param player The player of the client the packet is to be sent to.
      */
     public void send(ServerPlayerEntity player) {
         PacketByteBuf buf = PacketByteBufs.empty();
@@ -59,6 +61,7 @@ public void send(ServerPlayerEntity player) {
     /**
      * Send a packet to the client.
      *
+     * @param player The player of the client the packet is to be sent to.
      * @param dataWriter A consumer of a {@link PacketByteBuf} which is used to write the data.
      */
     public void send(ServerPlayerEntity player, Consumer<PacketByteBuf> dataWriter) {

src/main/java/io/github/jamalam360/jamlib/network/JamLibServerNetworking.java

@@ -34,6 +34,9 @@
  */
 public class JamLibServerNetworking {
 
+    /**
+     * An {@link Map} that maps mod ID's to a list of registered channels under that mod ID.
+     */
     protected static final Map<String, List<JamLibNetworkChannel<?>>> SERVER_CHANNELS = new HashMap<>();
 
     /**