Address javadoc violations

This commit is contained in:
NotMyFault
2021-09-21 17:40:53 +02:00
parent 1de3a6b54a
commit 3617a29ba8
17 changed files with 22 additions and 25 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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