Final warning

- Address warnings generated by javadocs and mixin remaps for joml
This commit is contained in:
Jozufozu 2024-05-03 21:59:27 -07:00
parent 4094093825
commit 3f24efba8a
8 changed files with 15 additions and 22 deletions

View file

@ -17,10 +17,10 @@ public interface LitVisual extends Visual {
* *
* <p>Even if multiple sections are updated at the same time, this method will only be called once.</p> * <p>Even if multiple sections are updated at the same time, this method will only be called once.</p>
* *
* <p>The implementation is free to parallelize calls to this method, as well as call into * <p>The implementation is free to parallelize calls to this method, as well as execute the plan
* {@link DynamicVisual#beginFrame} simultaneously. It is safe to query/update light here, * returned by {@link DynamicVisual#planFrame} simultaneously. It is safe to query/update light here,
* but you must ensure proper synchronization if you want to mutate anything outside this * but you must ensure proper synchronization if you want to mutate anything outside this visual or
* visual or anything that is also mutated by {@link DynamicVisual#beginFrame}.</p> * anything that is also mutated within {@link DynamicVisual#planFrame}.</p>
*/ */
void updateLight(); void updateLight();

View file

@ -14,7 +14,7 @@ public interface SimpleDynamicVisual extends DynamicVisual {
* The implementation is free to parallelize calls to this method. * The implementation is free to parallelize calls to this method.
* You must ensure proper synchronization if you need to mutate anything outside this visual. * You must ensure proper synchronization if you need to mutate anything outside this visual.
* <br> * <br>
* This method and {@link TickableVisual#tick} will never be called simultaneously. * This method and {@link SimpleTickableVisual#tick} will never be called simultaneously.
* <br> * <br>
* {@link Instancer}/{@link Instance} creation/acquisition is safe here. * {@link Instancer}/{@link Instance} creation/acquisition is safe here.
*/ */

View file

@ -15,7 +15,7 @@ public interface SimpleTickableVisual extends TickableVisual {
* The implementation is free to parallelize calls to this method. * The implementation is free to parallelize calls to this method.
* You must ensure proper synchronization if you need to mutate anything outside this visual. * You must ensure proper synchronization if you need to mutate anything outside this visual.
* <br> * <br>
* This method and {@link DynamicVisual#beginFrame} will never be called simultaneously. * This method and {@link SimpleDynamicVisual#beginFrame} will never be called simultaneously.
* <br> * <br>
* {@link Instancer}/{@link Instance} creation/acquisition is safe here. * {@link Instancer}/{@link Instance} creation/acquisition is safe here.
*/ */

View file

@ -63,7 +63,7 @@ public class FireComponent implements EntityComponent {
/** /**
* Update the fire instances. You'd typically call this in your visual's * Update the fire instances. You'd typically call this in your visual's
* {@link com.jozufozu.flywheel.api.visual.DynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method. * {@link com.jozufozu.flywheel.lib.visual.SimpleDynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method.
* *
* @param context The frame context. * @param context The frame context.
*/ */

View file

@ -108,7 +108,7 @@ public class ShadowComponent implements EntityComponent {
/** /**
* Update the shadow instances. You'd typically call this in your visual's * Update the shadow instances. You'd typically call this in your visual's
* {@link com.jozufozu.flywheel.api.visual.DynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method. * {@link com.jozufozu.flywheel.lib.visual.SimpleDynamicVisual#beginFrame(DynamicVisual.Context) beginFrame} method.
* *
* @param context The frame context. * @param context The frame context.
*/ */

View file

@ -17,7 +17,7 @@ abstract class FixNormalScalingMixin {
* applied, which negates the matrix again, resulting in the matrix being the * applied, which negates the matrix again, resulting in the matrix being the
* same as in the beginning. * same as in the beginning.
*/ */
@Inject(method = "scale(FFF)V", at = @At(value = "INVOKE", target = "Lorg/joml/Matrix3f;scale(F)Lorg/joml/Matrix3f;", shift = Shift.AFTER), cancellable = true) @Inject(method = "scale(FFF)V", at = @At(value = "INVOKE", target = "Lorg/joml/Matrix3f;scale(F)Lorg/joml/Matrix3f;", shift = Shift.AFTER, remap = false), cancellable = true)
private void flywheel$returnAfterNegate(float x, float y, float z, CallbackInfo ci) { private void flywheel$returnAfterNegate(float x, float y, float z, CallbackInfo ci) {
ci.cancel(); ci.cancel();
} }

View file

@ -31,8 +31,8 @@ public final class VisualizationHelper {
/** /**
* Checks if the given block entity can be visualized. * Checks if the given block entity can be visualized.
* @param type The block entity to check. * @param blockEntity The block entity to check.
* @param <T> The block entity. * @param <T> The type of the block entity.
* @return {@code true} if the block entity can be visualized. * @return {@code true} if the block entity can be visualized.
*/ */
public static <T extends BlockEntity> boolean canVisualize(T blockEntity) { public static <T extends BlockEntity> boolean canVisualize(T blockEntity) {
@ -41,8 +41,8 @@ public final class VisualizationHelper {
/** /**
* Checks if the given entity can be visualized. * Checks if the given entity can be visualized.
* @param type The entity to check. * @param entity The entity to check.
* @param <T> The entity. * @param <T> The type of the entity.
* @return {@code true} if the entity can be visualized. * @return {@code true} if the entity can be visualized.
*/ */
public static <T extends Entity> boolean canVisualize(T entity) { public static <T extends Entity> boolean canVisualize(T entity) {

View file

@ -210,10 +210,7 @@ public class VisualizationManagerImpl implements VisualizationManager {
} }
/** /**
* Tick the visuals after the game has ticked: * Begin execution of the tick plan.
* <p>
* Call {@link TickableVisual#tick} on all visuals in this level.
* </p>
*/ */
public void tick() { public void tick() {
// Make sure we're done with any prior frame or tick to avoid racing. // Make sure we're done with any prior frame or tick to avoid racing.
@ -227,11 +224,7 @@ public class VisualizationManagerImpl implements VisualizationManager {
} }
/** /**
* Get ready to render a frame. * Begin execution of the frame plan.
*
* <p>Check and update the render origin.
* <br>
* Call {@link DynamicVisual#beginFrame} on all visuals in this level.</p>
*/ */
public void beginFrame(RenderContext context) { public void beginFrame(RenderContext context) {
// Make sure we're done with the last tick. // Make sure we're done with the last tick.