Clean up, leftovers, javadocs

Author: aromaa

src/main/java/org/spongepowered/api/advancement/Advancement.java

@@ -42,6 +42,11 @@
  */
 public interface Advancement extends DefaultedRegistryValue, ComponentLike, DataPackSerializable {
 
+    /**
+     * Creates a new {@link Builder} to create an {@link Advancement}.
+     *
+     * @return The new builder
+     */
     static Advancement.Builder builder() {
         return Sponge.game().builderProvider().provide(Advancement.Builder.class);
     }

src/main/java/org/spongepowered/api/adventure/ChatType.java

@@ -27,23 +27,44 @@
 import net.kyori.adventure.text.format.Style;
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.datapack.DataPackSerializable;
+import org.spongepowered.api.registry.DefaultedRegistryValue;
 import org.spongepowered.api.util.CopyableBuilder;
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 /**
  * A type of chat
  */
 @CatalogedBy(ChatTypes.class)
-public interface ChatType extends net.kyori.adventure.chat.ChatType, DataPackSerializable {
+public interface ChatType extends DefaultedRegistryValue, net.kyori.adventure.chat.ChatType, DataPackSerializable {
 
+    /**
+     * Creates a new {@link Builder} to create a {@link ChatType}.
+     *
+     * @return The new builder
+     */
     static Builder builder() {
         return Sponge.game().builderProvider().provide(Builder.class);
     }
 
+    /**
+     * Gets the translation key that would be used
+     * to display the chat message.
+     *
+     * @return The translation key
+     */
     String translationKey();
 
+    /**
+     * Gets the style that would be used to
+     * display the chat message.
+     *
+     * @return The style
+     */
     Style style();
 
+    /**
+     * A builder to create {@link ChatType}s.
+     */
     interface Builder extends org.spongepowered.api.util.Builder<ChatType, Builder>, CopyableBuilder<ChatType, Builder> {
 
         /**

src/main/java/org/spongepowered/api/command/Command.java

@@ -208,6 +208,7 @@ interface Raw extends Command {
          * <p>Defaults to a command with an optional string argument string that
          * is greedy.</p>
          *
+         * @param registryHolder The owning {@link RegistryHolder registry holder}.
          * @return The tree.
          */
         default CommandTreeNode.Root commandTree(RegistryHolder registryHolder) {

src/main/java/org/spongepowered/api/command/parameter/managed/ValueParameter.java

@@ -120,8 +120,23 @@ default List<CommandCompletion> complete(final CommandContext context, final Str
 
     }
 
+    /**
+     * A {@link ValueParameter} that relies on registry data
+     * and is unable to parse its results until it has been
+     * bound.
+     *
+     * @param <T> The type of object that is returned from the
+     *            {@link ValueParser} upon successful parsing.
+     */
     interface Bindable<T> extends ValueParameter<T> {
 
+        /**
+         * Creates a new {@link ValueParameter} that is bound to
+         * a specific {@link RegistryHolder registry holder}.
+         *
+         * @param registryHolder The owning {@link RegistryHolder registry holder}.
+         * @return The bound {@link ValueParameter}.
+         */
         ValueParameter<T> bind(RegistryHolder registryHolder);
     }
 }

src/main/java/org/spongepowered/api/command/registrar/CommandRegistrarType.java

@@ -51,6 +51,7 @@ public interface CommandRegistrarType<T> extends DefaultedRegistryValue {
      *
      * @param manager The {@link CommandManager} that has requested the creation
      *                of the {@link CommandRegistrar} associated with this type
+     * @param registryHolder The owning {@link RegistryHolder registry holder}.
      * @return the newly created registrar
      */
     CommandRegistrar<T> create(final CommandManager.Mutable manager, RegistryHolder registryHolder);

src/main/java/org/spongepowered/api/data/type/ArtType.java

@@ -26,6 +26,7 @@
 
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.Sponge;
+import org.spongepowered.api.datapack.DataPackSerializable;
 import org.spongepowered.api.entity.hanging.Painting;
 import org.spongepowered.api.registry.DefaultedRegistryValue;
 import org.spongepowered.api.util.Builder;
@@ -36,7 +37,7 @@
  * Represents a piece of art to be displayed by {@link Painting}s.
  */
 @CatalogedBy(ArtTypes.class)
-public interface ArtType extends DefaultedRegistryValue {
+public interface ArtType extends DefaultedRegistryValue, DataPackSerializable {
 
     static Builder builder() {
         return Sponge.game().builderProvider().provide(Builder.class);

src/main/java/org/spongepowered/api/datapack/DataPackSerializable.java

@@ -28,7 +28,17 @@
 
 import java.util.Optional;
 
+/**
+ * Represents a type that can be serialized into a {@link DataContainer}
+ * and is a valid data pack entry.
+ */
 public interface DataPackSerializable {
 
+    /**
+     * Creates a serialized representation of this type
+     * if possible. Not all types have serializable representation.
+     *
+     * @return The serialized data container.
+     */
     Optional<DataContainer> toDataPack();
 }

src/main/java/org/spongepowered/api/event/advancement/AdvancementTreeEvent.java

@@ -48,6 +48,11 @@ public interface AdvancementTreeEvent extends Event {
      */
     interface GenerateLayout extends AdvancementTreeEvent {
 
+        /**
+         * Gets the owning {@link RegistryHolder registry holder}.
+         *
+         * @return The registry holder.
+         */
         RegistryHolder registryHolder();
     }
 }

src/main/java/org/spongepowered/api/event/cause/entity/damage/DamageType.java

@@ -44,6 +44,11 @@
 @CatalogedBy(DamageTypes.class)
 public interface DamageType extends DefaultedRegistryValue, Nameable, Taggable<DamageType>, DataPackSerializable {
 
+    /**
+     * Creates a new {@link Builder} to create a {@link DamageType}.
+     *
+     * @return The new builder
+     */
     static Builder builder() {
         return Sponge.game().builderProvider().provide(Builder.class);
     }
@@ -83,6 +88,9 @@ static Builder builder() {
      */
     DamageEffect effect();
 
+    /**
+     * A builder to create {@link DamageType}s.
+     */
     interface Builder extends org.spongepowered.api.util.Builder<DamageType, Builder>, CopyableBuilder<DamageType, Builder> {
 
         /**

src/main/java/org/spongepowered/api/event/lifecycle/RegisterRegistryValueEvent.java

@@ -27,6 +27,7 @@
 import org.spongepowered.api.Engine;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.event.GenericEvent;
+import org.spongepowered.api.registry.Registry;
 import org.spongepowered.api.registry.RegistryHolder;
 import org.spongepowered.api.registry.RegistryRegistrationSet;
 import org.spongepowered.api.registry.RegistryType;
@@ -35,19 +36,79 @@
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 
+/**
+ * Lifecycle event for registering entries to a {@link Registry}.
+ *
+ * <p>This event may be called multiple times for the same layer
+ * as the registry is being appended and as dependencies become
+ * available. Plugins should only execute code inside the consumers.</p>
+ *
+ * <p><strong>Note:</strong> Layers might be reloadable!</p>
+ */
 @NoFactoryMethod
 public interface RegisterRegistryValueEvent extends LifecycleEvent {
 
+    /**
+     * <p>Register new entries against a specific {@link Registry}.</p>
+     *
+     * <p>The consumer will be called if it matches the current set of
+     * registries being created.</p>
+     *
+     * @param registryType The registry type to append.
+     * @param consumer The consumer to be called if found.
+     */
     default <T> void registry(RegistryType<T> registryType, Consumer<RegistryStep<T>> consumer) {
         this.registry(registryType, (h, r) -> consumer.accept(r));
     }
 
+    /**
+     * <p>Register new entries against a specific {@link Registry}.</p>
+     *
+     * <p>The consumer will be called if it matches the current set of
+     * registries being created.</p>
+     *
+     * @param registryType The registry type to append.
+     * @param consumer The consumer to be called if found.
+     */
     <T> void registry(RegistryType<T> registryType, BiConsumer<RegistryHolder, RegistryStep<T>> consumer);
 
+    /**
+     * <p>Register new entries against a specific {@link Registry}.</p>
+     *
+     * <p>The consumer will be called if it matches the current set of
+     * registries being created.</p>
+     *
+     * @param registryType The registry type to append.
+     * @param consumer The consumer to be called if found.
+     * @param dependencies The list of registries to create before
+     *                     invoking the consumer.
+     */
     <T> void registry(RegistryType<T> registryType, BiConsumer<RegistryHolder, RegistryStep<T>> consumer, final RegistryType<?>... dependencies);
 
+    /**
+     * <p>Register new entries against a specific {@link Registry}.</p>
+     *
+     * <p>The {@link RegistryRegistrationSet registration set} will be
+     * appended if it matches the current set of registries being created.</p>
+     *
+     * @param registrationSet The registration set.
+     */
     default <T> void register(RegistryRegistrationSet<T> registrationSet) {
-        this.registry(registrationSet.registryType(), r -> registrationSet.values().forEach((k, v) -> r.register(k, v.get())));
+        this.registry(registrationSet.registryType(), (h, r) -> registrationSet.values().forEach((k, v) -> r.register(k, v.apply(h))));
+    }
+
+    /**
+     * <p>Register new entries against a specific {@link Registry}.</p>
+     *
+     * <p>The {@link RegistryRegistrationSet registration set} will be
+     * appended if it matches the current set of registries being created.</p>
+     *
+     * @param registrationSet The registration set.
+     * @param dependencies The list of registries to create before
+     *                     appending the registration set.
+     */
+    default <T> void register(RegistryRegistrationSet<T> registrationSet, final RegistryType<?>... dependencies) {
+        this.registry(registrationSet.registryType(), (h, r) -> registrationSet.values().forEach((k, v) -> r.register(k, v.apply(h))), dependencies);
     }
 
     interface RegistryStep<T> {