Add documentation for game events

Author: TheMeinerLP

src/main/java/net/minestom/server/game/GameEvent.java

@@ -9,29 +9,59 @@
 
 import java.util.Collection;
 
+/**
+ * Represents a game event.
+ * Used for a wide variety of events, from weather to bed use to game mode to demo messages.
+ *
+ * @version 1.0.0
+ * @since 1.6.0
+ * @author themeinerlp
+ */
 public sealed interface GameEvent extends StaticProtocolObject permits GameEventImpl {
 
     /**
-     * Returns the entity registry.
+     * Returns the game event registry.
      *
-     * @return the entity registry or null if it was created with a builder
+     * @return the game event registry or null if not found
      */
     @Contract(pure = true)
     @Nullable
     Registry.GameEventEntry registry();
 
+    /**
+     * Gets the namespace ID of this game event.
+     *
+     * @return the namespace ID
+     */
     @Override
     @NotNull
     NamespaceID namespace();
 
+    /**
+     * Gets the game events from the registry.
+     *
+     * @return the game events
+     */
     static @NotNull Collection<@NotNull GameEvent> values() {
         return GameEventImpl.values();
     }
 
+    /**
+     * Gets a game event by its namespace ID.
+     *
+     * @param namespaceID the namespace ID
+     * @return the game event or null if not found
+     */
     static @Nullable GameEvent fromNamespaceId(@NotNull String namespaceID) {
         return GameEventImpl.getSafe(namespaceID);
     }
 
+    /**
+     * Gets a game event by its namespace ID.
+     *
+     * @param namespaceID the namespace ID
+     * @return the game event or null if not found
+     */
     static @Nullable GameEvent fromNamespaceId(@NotNull NamespaceID namespaceID) {
         return fromNamespaceId(namespaceID.asString());
     }

src/main/java/net/minestom/server/game/GameEventImpl.java

@@ -7,26 +7,63 @@
 import java.util.Collection;
 import java.util.concurrent.atomic.AtomicInteger;
 
-public record GameEventImpl(Registry.GameEventEntry registry, NamespaceID namespace, int id) implements GameEvent {
+/**
+ * Represents a game event implementation.
+ * Used for a wide variety of events, from weather to bed use to game mode to demo messages.
+ *
+ * @version 1.0.0
+ * @since 1.6.0
+ * @author themeinerlp
+ */
+record GameEventImpl(Registry.GameEventEntry registry, NamespaceID namespace, int id) implements GameEvent {
     private static final AtomicInteger INDEX = new AtomicInteger();
     private static final Registry.Container<GameEvent> CONTAINER = Registry.createStaticContainer(Registry.Resource.GAMEPLAY_TAGS, GameEventImpl::createImpl);
 
+    /**
+     * Creates a new {@link GameEventImpl} with the given namespace and properties.
+     *
+     * @param namespace the namespace
+     * @param properties the properties
+     * @return a new {@link GameEventImpl}
+     */
     private static GameEventImpl createImpl(String namespace, Registry.Properties properties) {
         return new GameEventImpl(Registry.gameEventEntry(namespace, properties));
     }
 
+    /**
+     * Creates a new {@link GameEventImpl} with the given registry.
+     *
+     * @param registry the registry
+     */
     private GameEventImpl(Registry.GameEventEntry registry) {
         this(registry, registry.namespace(), INDEX.getAndIncrement());
     }
 
+    /**
+     * Gets the game events from the registry.
+     *
+     * @return the game events
+     */
     static Collection<GameEvent> values() {
         return CONTAINER.values();
     }
 
+    /**
+     * Gets a game event by its namespace ID.
+     *
+     * @param namespace the namespace ID
+     * @return the game event or null if not found
+     */
     public static GameEvent get(@NotNull String namespace) {
         return CONTAINER.get(namespace);
     }
 
+    /**
+     * Gets a game event by its namespace ID.
+     *
+     * @param namespace the namespace ID
+     * @return the game event or null if not found
+     */
     static GameEvent getSafe(@NotNull String namespace) {
         return CONTAINER.getSafe(namespace);
     }

src/main/java/net/minestom/server/registry/StaticProtocolObject.java

@@ -6,22 +6,50 @@
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * Represents a static protocol object.
+ * Used for objects which are not dynamic and are known at compile time.
+ *
+ * @version 1.0.0
+ * @since 1.0.0
+ * @author themeinerlp
+ */
 public interface StaticProtocolObject extends ProtocolObject, Keyed {
 
+    /**
+     * Gets the namespace ID of this object.
+     *
+     * @return the namespace ID
+     */
     @Contract(pure = true)
     @NotNull NamespaceID namespace();
 
+    /**
+     * Gets the name of this object.
+     *
+     * @return the name
+     */
     @Contract(pure = true)
     default @NotNull String name() {
         return namespace().asString();
     }
 
+    /**
+     * Gets the key of this object.
+     *
+     * @return the key
+     */
     @Override
     @Contract(pure = true)
     default @NotNull Key key() {
         return namespace();
     }
 
+    /**
+     * Gets the ID of this object.
+     *
+     * @return the ID
+     */
     @Contract(pure = true)
     int id();
 }