[1.17.x Omnibus] Fix typos and javadocs across code base (#8144)

This commit is contained in:
sciwhiz12 authored and GitHub committed 2021-11-25 13:09:56 -08:00
1 parent df8954869a
commit b4feee8046
163 files changed
+708 -454

No files matched your search

@@ -24,7 +24,7 @@ import com.mojang.math.Transformation;
import net.minecraft.client.resources.model.ModelState;
/**
* An {@link IModelTransform} that combines the transforms from two child {@link IModelTransform}.
* An {@link ModelState} that combines the transforms from two child {@link ModelState}.
*/
public class CompositeModelState implements ModelState
{
@@ -25,6 +25,7 @@ import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonObject;
import com.mojang.datafixers.util.Pair;
import net.minecraft.client.renderer.RenderType;
import net.minecraft.client.renderer.block.model.ItemModelGenerator;
import net.minecraft.client.renderer.texture.TextureAtlasSprite;
import com.mojang.blaze3d.vertex.VertexFormat;
import com.mojang.blaze3d.vertex.VertexFormatElement;
@@ -55,7 +56,7 @@ import net.minecraft.client.resources.model.UnbakedModel;
/**
* Forge reimplementation of vanilla {@link ItemModelGenerator}, i.e. builtin/generated models,
* with the following changes:
* - Represented as a true {@link IUnbakedModel} so it can be baked as usual instead of using
* - Represented as a true {@link UnbakedModel} so it can be baked as usual instead of using
* special-case logic like vanilla does.
* - Various fixes in the baking logic.
* - Not limited to 4 layers maximum.
@@ -44,7 +44,7 @@ public final class ItemTextureQuadConverter
* Takes a texture and converts it into BakedQuads.
* The conversion is done by scanning the texture horizontally and vertically and creating "strips" of the texture.
* Strips that are of the same size and follow each other are converted into one bigger quad.
* </br>
* <br/>
* The resulting list of quads is the texture represented as a list of horizontal OR vertical quads,
* depending on which creates less quads. If the amount of quads is equal, horizontal is preferred.
*
@@ -35,6 +35,7 @@ import net.minecraft.core.Direction;
import net.minecraft.util.GsonHelper;
import net.minecraft.resources.ResourceLocation;
import com.mojang.math.Transformation;
import net.minecraftforge.client.event.ModelRegistryEvent;
import net.minecraftforge.client.model.geometry.IModelGeometry;
import net.minecraftforge.client.model.geometry.ISimpleModelGeometry;
import net.minecraftforge.client.model.obj.OBJLoader;
@@ -97,7 +98,7 @@ public class ModelLoaderRegistry
// Minecraft recreates the ModelBakery on resource reload, but this should only run once during init.
if (!registryFrozen)
{
net.minecraftforge.fml.ModLoader.get().postEvent(new net.minecraftforge.client.event.ModelRegistryEvent());
net.minecraftforge.fml.ModLoader.get().postEvent(new ModelRegistryEvent());
registryFrozen = true;
}
}
@@ -45,7 +45,7 @@ import net.minecraftforge.common.property.Properties;
import net.minecraftforge.common.util.LazyOptional;
/**
* Generic {@link TileGameRenderer} that works with the Forge model system and animations.
* Generic {@link BlockEntityRenderer} that works with the Forge model system and animations.
*/
public class AnimationBlockEntityRenderer<T extends BlockEntity> implements BlockEntityRenderer<T>, IEventHandler<T>
{
@@ -31,7 +31,7 @@ import net.minecraft.client.resources.model.BakedModel;
import net.minecraft.core.Direction;
/**
* Convenience interface with default implementation of {@link IBakedModel#getQuads(net.minecraft.block.BlockState, net.minecraft.util.Direction, java.util.Random)}.
* Convenience interface with default implementation of {@link BakedModel#getQuads(BlockState, Direction, Random, IModelData)}.
*/
public interface IDynamicBakedModel extends BakedModel
{
@@ -93,7 +93,7 @@ public final class ConfiguredModel {
*
* @throws NullPointerException if {@code model} is {@code null}
* @throws IllegalArgumentException if x and/or y rotation are not valid (see
* {@link ModelRotation})
* {@link BlockModelRotation})
* @throws IllegalArgumentException if weight is less than or equal to zero
*/
public ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock, int weight) {
@@ -118,7 +118,7 @@ public final class ConfiguredModel {
*
* @throws NullPointerException if {@code model} is {@code null}
* @throws IllegalArgumentException if x and/or y rotation are not valid (see
* {@link ModelRotation})
* {@link BlockModelRotation})
*/
public ConfiguredModel(ModelFile model, int rotationX, int rotationY, boolean uvLock) {
this(model, rotationX, rotationY, uvLock, DEFAULT_WEIGHT);
@@ -228,7 +228,7 @@ public final class ConfiguredModel {
* @param value the x-rotation value
* @return this builder
* @throws IllegalArgumentException if {@code value} is not a valid x-rotation
* (see {@link ModelRotation})
* (see {@link BlockModelRotation})
*/
public Builder<T> rotationX(int value) {
checkRotation(value, rotationY);
@@ -242,7 +242,7 @@ public final class ConfiguredModel {
* @param value the y-rotation value
* @return this builder
* @throws IllegalArgumentException if {@code value} is not a valid y-rotation
* (see {@link ModelRotation})
* (see {@link BlockModelRotation})
*/
public Builder<T> rotationY(int value) {
checkRotation(rotationX, value);
@@ -137,7 +137,7 @@ public class VariantBlockStateBuilder implements IGeneratedBlockstate {
*
* @param state The {@link PartialBlockstate partial state} for which to set
* the models
* @param models A set of models to assign to this state
* @param model A set of models to assign to this state
* @return this builder
* @throws IllegalArgumentException if {@code state} has already been configured
* @see #addModels(PartialBlockstate, ConfiguredModel...)
@@ -38,7 +38,7 @@ import net.minecraft.client.resources.model.ModelState;
import net.minecraft.client.resources.model.UnbakedModel;
/**
* General interface for any model that can be baked, superset of vanilla {@link net.minecraft.client.renderer.model.IUnbakedModel}.
* General interface for any model that can be baked, superset of vanilla {@link UnbakedModel}.
* Models can be baked to different vertex formats and with different state.
*/
public interface IModelGeometry<T extends IModelGeometry<T>>