From 3617a29ba8352f87b4071e43a9ac6c9ef83566ac Mon Sep 17 00:00:00 2001 From: NotMyFault Date: Tue, 21 Sep 2021 17:40:53 +0200 Subject: [PATCH] Address javadoc violations --- .../fastasyncworldedit/bukkit/adapter/Regenerator.java | 8 ++++---- .../fastasyncworldedit/bukkit/util/MinecraftVersion.java | 2 +- .../com/fastasyncworldedit/core/configuration/Config.java | 2 +- .../core/extension/factory/TransformFactory.java | 2 +- .../core/extension/factory/parser/FaweParser.java | 4 ++-- .../extension/factory/parser/mask/RichMaskParser.java | 2 +- .../factory/parser/transform/RichTransformParser.java | 2 +- .../com/fastasyncworldedit/core/queue/IQueueExtent.java | 6 ++---- .../core/util/collection/AdaptedSetCollection.java | 2 +- .../sk89q/worldedit/event/extent/EditSessionEvent.java | 4 ++-- .../sk89q/worldedit/extension/factory/MaskFactory.java | 2 +- .../sk89q/worldedit/extension/factory/PatternFactory.java | 2 +- .../com/sk89q/worldedit/internal/annotation/Chunk3d.java | 2 +- .../com/sk89q/worldedit/scripting/CraftScriptContext.java | 2 +- .../java/com/sk89q/worldedit/util/net/HttpRequest.java | 2 +- .../sk89q/worldedit/util/time/FileNameDateTimeParser.java | 1 - .../com/sk89q/worldedit/world/block/BlockStateHolder.java | 2 +- 17 files changed, 22 insertions(+), 25 deletions(-) diff --git a/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/adapter/Regenerator.java b/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/adapter/Regenerator.java index f28548f6c..1f58f13b3 100644 --- a/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/adapter/Regenerator.java +++ b/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/adapter/Regenerator.java @@ -37,10 +37,10 @@ import java.util.stream.Collectors; /** * Represents an abstract regeneration handler. * - * @param the type of the {@Code IChunkAccess} of the current Minecraft implementation - * @param the type of the {@Code ProtoChunk} of the current Minecraft implementation - * @param the type of the {@Code Chunk} of the current Minecraft implementation - * @param the type of the {@Code ChunkStatusWrapper} wrapping the {@Code ChunkStatus} enum + * @param the type of the {@code IChunkAccess} of the current Minecraft implementation + * @param the type of the {@code ProtoChunk} of the current Minecraft implementation + * @param the type of the {@code Chunk} of the current Minecraft implementation + * @param the type of the {@code ChunkStatusWrapper} wrapping the {@code ChunkStatus} enum */ public abstract class Regenerator> { diff --git a/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/util/MinecraftVersion.java b/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/util/MinecraftVersion.java index 60759b75a..cba863428 100644 --- a/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/util/MinecraftVersion.java +++ b/worldedit-bukkit/src/main/java/com/fastasyncworldedit/bukkit/util/MinecraftVersion.java @@ -21,7 +21,7 @@ public class MinecraftVersion implements Comparable { * Construct a new version with major, minor and release version. * * @param major Major part of the version, only {@code 1} would make sense. - * @param minor Minor part, full updates, e.g. Nether & Caves & Cliffs + * @param minor Minor part, full updates, e.g. Nether & Caves & Cliffs * @param release Release, changes for the server software during a minor update. */ public MinecraftVersion(int major, int minor, int release) { diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Config.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Config.java index 431d7ec44..55a2aa9d6 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Config.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Config.java @@ -332,7 +332,7 @@ public class Config { /** * Get the field for a specific config node and instance. * - * @apiNote As expiry can have multiple blocks there will be multiple instances + * As expiry can have multiple blocks there will be multiple instances * * @param split the node (split by period) * @param instance the instance diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/TransformFactory.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/TransformFactory.java index a87c305cc..06122c705 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/TransformFactory.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/TransformFactory.java @@ -91,7 +91,7 @@ public class TransformFactory extends AbstractFactory { /** * Parses a transform without considering parsing through the {@link RichTransformParser}, therefore not accepting - * "richer" parsing where & and , are used. Exists to prevent stack overflows. + * "richer" parsing where & and , are used. Exists to prevent stack overflows. * * @param input input string * @param context input context diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/FaweParser.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/FaweParser.java index a17149194..bcd1b0941 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/FaweParser.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/FaweParser.java @@ -21,7 +21,7 @@ public abstract class FaweParser extends InputParser implements AliasedPar /** * Parse an input into a list of {@link java.util.Map.Entry} of {@link ParseEntry} and a list of the given arguments, where - * arguments are given in square brackets, e.g. {@code #offset[2][10][2]}. Different entries may be separated by , or & + * arguments are given in square brackets, e.g. {@code #offset[2][10][2]}. Different entries may be separated by , or & * (OR and AND respectively) * * @param toParse the string to parse @@ -100,7 +100,7 @@ public abstract class FaweParser extends InputParser implements AliasedPar /** * Gives if the parsed entry was appended to the original input as an AND. * - * @return if appended to input with '&' rather than ',' + * @return if appended to input with '&' rather than ',' */ public boolean isAnd() { return and; diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/mask/RichMaskParser.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/mask/RichMaskParser.java index 2e1f122ef..ae202848f 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/mask/RichMaskParser.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/mask/RichMaskParser.java @@ -34,7 +34,7 @@ import java.util.stream.Collectors; import java.util.stream.Stream; /** - * Attempts to parse masks given rich inputs, allowing for & and ,. Also allows for nested masks + * Attempts to parse masks given rich inputs, allowing for & and ,. Also allows for nested masks */ public class RichMaskParser extends FaweParser { diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/transform/RichTransformParser.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/transform/RichTransformParser.java index 628c60e09..8d5a70026 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/transform/RichTransformParser.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/extension/factory/parser/transform/RichTransformParser.java @@ -24,7 +24,7 @@ import java.util.List; import java.util.Map; /** - * Attempts to parse transforms given rich inputs, allowing for & and ,. Also allows for nested transforms + * Attempts to parse transforms given rich inputs, allowing for & and ,. Also allows for nested transforms */ public class RichTransformParser extends FaweParser { diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/queue/IQueueExtent.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/queue/IQueueExtent.java index c3f7a0792..a5a29f170 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/queue/IQueueExtent.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/queue/IQueueExtent.java @@ -107,7 +107,7 @@ public interface IQueueExtent extends Flushable, Trimable, ICh /** * Flush all changes to the world. - * @apiNote Best to call this async, so it doesn't hang the server. + * Best to call this async, so it doesn't hang the server. */ @Override void flush(); @@ -126,9 +126,7 @@ public interface IQueueExtent extends Flushable, Trimable, ICh int size(); /** - * Returns true if this queue contains no elements. - * - * @return true if this queue contains no elements + * @return {@code true} if this queue contains no elements */ boolean isEmpty(); diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/collection/AdaptedSetCollection.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/collection/AdaptedSetCollection.java index 2690fdf99..54e11c70f 100644 --- a/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/collection/AdaptedSetCollection.java +++ b/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/collection/AdaptedSetCollection.java @@ -14,7 +14,7 @@ import java.util.stream.Stream; /** * Adapt a collection to a set. - * @apiNote It's assumed that the collection is set like, otherwise behavior will be weird + * It's assumed that the collection is set like, otherwise behavior will be weird */ public class AdaptedSetCollection implements Set { diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/event/extent/EditSessionEvent.java b/worldedit-core/src/main/java/com/sk89q/worldedit/event/extent/EditSessionEvent.java index e67c15ba9..9ec0279f0 100644 --- a/worldedit-core/src/main/java/com/sk89q/worldedit/event/extent/EditSessionEvent.java +++ b/worldedit-core/src/main/java/com/sk89q/worldedit/event/extent/EditSessionEvent.java @@ -44,7 +44,7 @@ import static com.sk89q.worldedit.EditSession.Stage; * all changes made to the world. For example, the code below would wrap the * existing extent with a custom one, and the custom extent would receive * all method calls before the extent fetched from - * {@link #getExtent()} would.

+ * {@link #getExtent()} would. * * 
  * event.setExtent(new MyExtent(event.getExtent())
@@ -61,7 +61,7 @@ import static com.sk89q.worldedit.EditSession.Stage;
  * custom {@link Extent} because that method bypasses history (and reorder).
  * It is thus recommended that loggers intercept at {@link Stage#BEFORE_CHANGE}
  * and block interceptors intercept at BOTH {@link Stage#BEFORE_CHANGE} and
- * {@link Stage#BEFORE_HISTORY}.

+ * {@link Stage#BEFORE_HISTORY}.
  */
 public class EditSessionEvent extends Event implements Cancellable {
 
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/MaskFactory.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/MaskFactory.java
index bf53d101e..863f9c1c1 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/MaskFactory.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/MaskFactory.java
@@ -178,7 +178,7 @@ public final class MaskFactory extends AbstractFactory {
 
     /**
      * Parses a mask without considering parsing through the {@link RichMaskParser}, therefore not accepting
-     * "richer" parsing where & and , are used. Exists to prevent stack overflows.
+     * "richer" parsing where & and , are used. Exists to prevent stack overflows.
      *
      * @param input   input string
      * @param context input context
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/PatternFactory.java b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/PatternFactory.java
index 0b383ba39..99d781ab6 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/PatternFactory.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/extension/factory/PatternFactory.java
@@ -181,7 +181,7 @@ public final class PatternFactory extends AbstractFactory {
 
     /**
      * Parses a pattern without considering parsing through the {@link RichPatternParser}, therefore not accepting
-     * "richer" parsing where & and , are used. Exists to prevent stack overflows.
+     * "richer" parsing where & and , are used. Exists to prevent stack overflows.
      *
      * @param input   input string
      * @param context input context
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/internal/annotation/Chunk3d.java b/worldedit-core/src/main/java/com/sk89q/worldedit/internal/annotation/Chunk3d.java
index 6de709457..4d177be95 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/internal/annotation/Chunk3d.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/internal/annotation/Chunk3d.java
@@ -30,7 +30,7 @@ import java.lang.annotation.Target;
  * Indicates that this value is for 3d-chunk compatibility.
  *
  * 

- * For vectors, this means that the vector supports 2D & 3D inputs,
+ * For vectors, this means that the vector supports 2D & 3D inputs,
  * with 2D getting a Y value of 0.
  * 

  */
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/scripting/CraftScriptContext.java b/worldedit-core/src/main/java/com/sk89q/worldedit/scripting/CraftScriptContext.java
index dd29b44ad..77a6b3354 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/scripting/CraftScriptContext.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/scripting/CraftScriptContext.java
@@ -160,7 +160,7 @@ public class CraftScriptContext extends CraftScriptEnvironment {
     /**
      * Immediately terminate execution of the script, but without a failure message.
      *
-     * @implNote This exits by throwing an exception, which if caught will prevent
+     * This exits by throwing an exception, which if caught will prevent
      *     the script from exiting
      */
     public void exit() {
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/util/net/HttpRequest.java b/worldedit-core/src/main/java/com/sk89q/worldedit/util/net/HttpRequest.java
index e9e457f8a..a5c9fdced 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/util/net/HttpRequest.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/util/net/HttpRequest.java
@@ -125,7 +125,7 @@ public class HttpRequest implements Closeable {
 
     /**
      * Execute the request.
-     * 

+     * 

      * After execution, {@link #close()} should be called.
      *
      * @return this object
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/util/time/FileNameDateTimeParser.java b/worldedit-core/src/main/java/com/sk89q/worldedit/util/time/FileNameDateTimeParser.java
index d3d4d9997..cbf973578 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/util/time/FileNameDateTimeParser.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/util/time/FileNameDateTimeParser.java
@@ -52,7 +52,6 @@ import java.util.stream.StreamSupport;
  *     
  • {@code 2019-06-15-10-20-30}
    • 
  *     
  • {@code 2019-6-1-1-2-3}
    • 
  * 
- * 
    
  */
 public class FileNameDateTimeParser implements SnapshotDateTimeParser {
 
diff --git a/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockStateHolder.java b/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockStateHolder.java
index fa554f219..e1d9fd123 100644
--- a/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockStateHolder.java
+++ b/worldedit-core/src/main/java/com/sk89q/worldedit/world/block/BlockStateHolder.java
@@ -166,7 +166,7 @@ public interface BlockStateHolder> extends TileEnt
      *
      * @param compoundTag The NBT Data to apply
      * @return The BaseBlock
-     * @apiNote This must be overridden by new subclasses. See {@link NonAbstractForCompatibility}
+     * This must be overridden by new subclasses. See {@link NonAbstractForCompatibility}
      *          for details
      */
     @NonAbstractForCompatibility(