Fix a couple API javadoc compiler errors

This commit is contained in:
James Seibel
2023-06-26 07:26:50 -05:00
parent 048b745be0
commit 7c9301745a
5 changed files with 10 additions and 9 deletions
@@ -90,7 +90,7 @@ public interface IDhApiWorldGenerator extends Closeable, IDhApiOverrideable
* Please run your generator in game at least once to confirm the objects you are returning are correct. <br><br>
*
* Consumer expected inputs for each minecraft version (in order): <br>
* <strong>1.18:</strong> {@link net.minecraft.world.level.chunk.ChunkAccess} and {@link net.minecraft.world.level.LevelReader} <br>
* <strong>1.18:</strong> [net.minecraft.world.level.chunk.ChunkAccess] and [net.minecraft.world.level.LevelReader] <br>
*/
CompletableFuture<Void> generateChunks(int chunkPosMinX, int chunkPosMinZ,
byte granularity, byte targetDataDetail, EDhApiDistantGeneratorMode generatorMode,
@@ -21,8 +21,9 @@ public interface IDhApiCancelableEvent<T> extends IDhApiEvent<T>
* The {@link IDhApiCancelableEvent#fireEvent(DhApiCancelableEventParam)} method should be used instead.
* This override method is present to prevent API users from having to implement it themselves.
*
* @implNote Is there a better way to format the {@link IDhApiEvent} classes so we don't need this method?
* It would be better to completely hide this method so it isn't possible to accidentally call.
* @deprecated marked as deprecated to warn that this method shouldn't be used. <br>
* <strong>DH Internal Note:</strong> Is there a better way to format the {@link IDhApiEvent} classes so we don't need this method?
* It would be better to completely hide this method so it isn't possible to accidentally call.
*/
@Deprecated
@Override
@@ -10,7 +10,7 @@ import com.seibel.distanthorizons.coreapi.util.converters.DefaultConverter;
*
* When using this object you need to explicitly define the generic types,
* otherwise Intellij won't do any type checking and the wrong types can be used. <br>
* For example a method returning IDhApiConfig<Integer> when the config should be a Boolean.
* For example a method returning {@literal IDhApiConfig<Integer> } when the config should be a Boolean.
*
* @param <apiType> The datatype you, an API dev will use.
* @param <coreType> The datatype Distant Horizons uses in the background; implementing developers can ignore this.
@@ -50,7 +50,7 @@ public interface IDependencyInjector<BindableType extends IBindable>
* Returns a dependency of type T if one has been bound. <br>
* Returns null if a dependency hasn't been bound. <br> <br>
*
* If the handler's {@link #allowDuplicateBindings} is true this returns the first bound dependency.
* If the handler allows duplicate bindings, this will return the first bound dependency.
*
* @param <T> class of the dependency
* (inferred from the interfaceClass parameter)
@@ -11,14 +11,14 @@ public class BitShiftUtil
{
/**
* Equivalent to: <br>
* 1 << value, <br>
* {@literal 1 << value0, } <br>
* 2^value, <br>
* Math.pow(2, value) <br><br>
*
* Note: Math.pow() isn't identical for large values where bits would be lost in the shift, however for medium to small values they function the same. <br><br>
*
* Can also be used to replace bit shifts in the format: <br>
* multiplier << value; <br>
* {@literal multiplier << value; } <br>
* multiplier * powerOfTwo(value);
*/
public static int powerOfTwo(int value) { return 1 << value; }
@@ -52,7 +52,7 @@ public class BitShiftUtil
/**
* Equivalent to: <br>
* value << 1, <br>
* {@literal value << 1, } <br>
* value^2, <br>
* Math.pow(value, 2) <br><br>
*
@@ -65,7 +65,7 @@ public class BitShiftUtil
/**
* Equivalent to: <br>
* value << power, <br>
* {@literal value << power, } <br>
* value^power, <br>
* Math.pow(value, power) <br><br>
*