Clarified a few javadocs.

ClubObsidian · Oct 21, 2023 · dfa55eb · dfa55eb
1 parent 9de2a59
commit dfa55eb
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 15 deletions.
diff --git a/api/src/main/java/com/clubobsidian/dynamicgui/api/effect/SoundWrapper.java b/api/src/main/java/com/clubobsidian/dynamicgui/api/effect/SoundWrapper.java
@@ -68,7 +68,7 @@ public static class SoundData {
         /**
          * Creates a SoundData object from a string
          * @param str The string to create the SoundData object from
-         * @return
+         * @return SoundData object from the string
          */
         public static SoundData fromString(@NotNull String str) {
             Objects.requireNonNull(str);

diff --git a/api/src/main/java/com/clubobsidian/dynamicgui/api/function/Function.java b/api/src/main/java/com/clubobsidian/dynamicgui/api/function/Function.java
@@ -160,11 +160,6 @@ public Function clone() {
         }
     }
 
-    /**
-     * Checks if the function is equal to another object
-     * @param o
-     * @return true if the function is equal to another object
-     */
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
@@ -173,10 +168,6 @@ public boolean equals(Object o) {
         return async == function.async && name.equals(function.name) && aliases.equals(function.aliases);
     }
 
-    /**
-     * Gets the hashcode of the function
-     * @return the hashcode of the function
-     */
     @Override
     public int hashCode() {
         return Objects.hash(name, async, aliases);

diff --git a/api/src/main/java/com/clubobsidian/dynamicgui/api/world/LocationWrapper.java b/api/src/main/java/com/clubobsidian/dynamicgui/api/world/LocationWrapper.java
@@ -66,9 +66,9 @@ public int getZ() {
     }
 
     /**
-     * Gets the WoldWrapper for the location
+     * Gets the WorldWrapper for the location
      *
-     * @return wold of the location
+     * @return world of the location
      */
     public WorldWrapper<T> getWorld() {
         return this.world;

diff --git a/api/src/main/java/com/clubobsidian/dynamicgui/api/world/WorldWrapper.java b/api/src/main/java/com/clubobsidian/dynamicgui/api/world/WorldWrapper.java
@@ -43,16 +43,16 @@ public String getName() {
     public abstract T getWorld();
 
     /**
-     * Sets the game rule of the world to the specified value
+     * Sets the gamerule key of the world to the specified gamerule value
      * @param key
      * @param value
      */
     public abstract void setGameRule(String key, String value);
 
     /**
-     * Gets value of the game rule for the world
+     * Gets value of the gamerule for the world
      * @param rule
-     * @return
+     * @return gamerule value
      */
     public abstract String getGameRule(String rule);