3
0
Mirror von https://github.com/IntellectualSites/FastAsyncWorldEdit.git synchronisiert 2024-12-24 18:10:08 +01:00

Address javadoc violations

Dieser Commit ist enthalten in:
NotMyFault 2021-09-21 17:40:53 +02:00
Ursprung 1de3a6b54a
Commit 3617a29ba8
Es konnte kein GPG-Schlüssel zu dieser Signatur gefunden werden
GPG-Schlüssel-ID: 158F5701A6AAD00C
17 geänderte Dateien mit 22 neuen und 25 gelöschten Zeilen

Datei anzeigen

@ -37,10 +37,10 @@ import java.util.stream.Collectors;
/**
* Represents an abstract regeneration handler.
*
* @param <IChunkAccess> the type of the {@Code IChunkAccess} of the current Minecraft implementation
* @param <ProtoChunk> the type of the {@Code ProtoChunk} of the current Minecraft implementation
* @param <Chunk> the type of the {@Code Chunk} of the current Minecraft implementation
* @param <ChunkStatus> the type of the {@Code ChunkStatusWrapper} wrapping the {@Code ChunkStatus} enum
* @param <IChunkAccess> the type of the {@code IChunkAccess} of the current Minecraft implementation
* @param <ProtoChunk> the type of the {@code ProtoChunk} of the current Minecraft implementation
* @param <Chunk> the type of the {@code Chunk} of the current Minecraft implementation
* @param <ChunkStatus> the type of the {@code ChunkStatusWrapper} wrapping the {@code ChunkStatus} enum
*/
public abstract class Regenerator<IChunkAccess, ProtoChunk extends IChunkAccess, Chunk extends IChunkAccess, ChunkStatus extends Regenerator.ChunkStatusWrapper<IChunkAccess>> {

Datei anzeigen

@ -21,7 +21,7 @@ public class MinecraftVersion implements Comparable<MinecraftVersion> {
* 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 &amp; Caves & Cliffs
* @param minor Minor part, full updates, e.g. Nether &amp; Caves &amp; Cliffs
* @param release Release, changes for the server software during a minor update.
*/
public MinecraftVersion(int major, int minor, int release) {

Datei anzeigen

@ -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

Datei anzeigen

@ -91,7 +91,7 @@ public class TransformFactory extends AbstractFactory<ResettableExtent> {
/**
* 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 &amp; and , are used. Exists to prevent stack overflows.
*
* @param input input string
* @param context input context

Datei anzeigen

@ -21,7 +21,7 @@ public abstract class FaweParser<T> extends InputParser<T> 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 &amp;
* (OR and AND respectively)
*
* @param toParse the string to parse
@ -100,7 +100,7 @@ public abstract class FaweParser<T> extends InputParser<T> 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 '&amp;' rather than ','
*/
public boolean isAnd() {
return and;

Datei anzeigen

@ -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 &amp; and ,. Also allows for nested masks
*/
public class RichMaskParser extends FaweParser<Mask> {

Datei anzeigen

@ -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 &amp; and ,. Also allows for nested transforms
*/
public class RichTransformParser extends FaweParser<ResettableExtent> {

Datei anzeigen

@ -107,7 +107,7 @@ public interface IQueueExtent<T extends IChunk> 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<T extends IChunk> extends Flushable, Trimable, ICh
int size();
/**
* Returns <tt>true</tt> if this queue contains no elements.
*
* @return <tt>true</tt> if this queue contains no elements
* @return {@code true} if this queue contains no elements
*/
boolean isEmpty();

Datei anzeigen

@ -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<T, V> implements Set<V> {

Datei anzeigen

@ -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 <strong>before</strong> the extent fetched from
* {@link #getExtent()} would.</p>
* {@link #getExtent()} would.
*
* <pre>
* 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}.</p>
* {@link Stage#BEFORE_HISTORY}.
*/
public class EditSessionEvent extends Event implements Cancellable {

Datei anzeigen

@ -178,7 +178,7 @@ public final class MaskFactory extends AbstractFactory<Mask> {
/**
* 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 &amp; and , are used. Exists to prevent stack overflows.
*
* @param input input string
* @param context input context

Datei anzeigen

@ -181,7 +181,7 @@ public final class PatternFactory extends AbstractFactory<Pattern> {
/**
* 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 &amp; and , are used. Exists to prevent stack overflows.
*
* @param input input string
* @param context input context

Datei anzeigen

@ -30,7 +30,7 @@ import java.lang.annotation.Target;
* Indicates that this value is for 3d-chunk compatibility.
*
* <p>
* For vectors, this means that the vector supports 2D & 3D inputs,
* For vectors, this means that the vector supports 2D &amp; 3D inputs,
* with 2D getting a Y value of 0.
* </p>
*/

Datei anzeigen

@ -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() {

Datei anzeigen

@ -125,7 +125,7 @@ public class HttpRequest implements Closeable {
/**
* Execute the request.
* <p/>
* <p>
* After execution, {@link #close()} should be called.
*
* @return this object

Datei anzeigen

@ -52,7 +52,6 @@ import java.util.stream.StreamSupport;
* <li>{@code 2019-06-15-10-20-30}</li>
* <li>{@code 2019-6-1-1-2-3}</li>
* </ul>
* </p>
*/
public class FileNameDateTimeParser implements SnapshotDateTimeParser {

Datei anzeigen

@ -166,7 +166,7 @@ public interface BlockStateHolder<B extends BlockStateHolder<B>> 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(