[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

@@ -28,20 +28,20 @@ import java.lang.annotation.*;
* of 'Capability'
*
* Example:
* <pre>
* {@literal @}CapabilityInject(IExampleCapability.class)
* <pre>{@code
* @CapabilityInject(IExampleCapability.class)
* private static final Capability<IExampleCapability> TEST_CAP = null;
* </pre>
* }</pre>
*
* When placed on a METHOD, the method will be invoked once the
* capability is registered. This allows you to have a 'enable features'
* callback. It MUST have one parameter of type 'Capability;
*
* Example:
* <pre>
* {@literal @}CapabilityInject(IExampleCapability.class)
* <pre>{@code
* @CapabilityInject(IExampleCapability.class)
* private static void capRegistered(Capability<IExampleCapability> cap) {}
* </pre>
* }</pre>
*
* <b>Warning</b>: Capability injections are run in the thread that the capablity is registered.
* Due to parallel mod loading, this can potentially be off of the main thread.
@@ -30,8 +30,7 @@ package net.minecraftforge.common.capabilities;
* <pre>{@code
* public static Capability<IDataHolder> DATA_HOLDER_CAPABILITY
* = CapabilityManager.get(new CapabilityToken<>(){});
*
* </pre>
* }</pre>
*
*/
public abstract class CapabilityToken<T>
@@ -33,8 +33,8 @@ public interface ICapabilityProvider
* Modders are encouraged to cache this value, using the listener capabilities of the Optional to
* be notified if the requested capability get lost.
*
* @param capability The capability to check
* @param facing The Side to check from,
* @param cap The capability to check
* @param side The Side to check from,
* <strong>CAN BE NULL</strong>. Null is defined to represent 'internal' or 'self'
* @return The requested an optional holding the requested capability.
*/