[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

@@ -19,18 +19,20 @@
package net.minecraftforge.client.settings;
import net.minecraft.client.KeyMapping;
/**
* Defines the context that a {@link KeyBinding} is used.
* Key conflicts occur when a {@link KeyBinding} has the same {@link IKeyConflictContext} and has conflicting modifiers and keyCodes.
* Defines the context that a {@link KeyMapping} is used.
* Key conflicts occur when a {@link KeyMapping} has the same {@link IKeyConflictContext} and has conflicting modifiers and keyCodes.
*/
public interface IKeyConflictContext {
/**
* @return true if conditions are met to activate {@link KeyBinding}s with this context
* @return true if conditions are met to activate {@link KeyMapping}s with this context
*/
boolean isActive();
/**
* @return true if the other context can have {@link KeyBinding} conflicts with this one.
* @return true if the other context can have {@link KeyMapping} conflicts with this one.
* This will be called on both contexts to check for conflicts.
*/
boolean conflicts(IKeyConflictContext other);
@@ -20,6 +20,7 @@
package net.minecraftforge.client.settings;
import net.minecraft.client.Minecraft;
import net.minecraft.client.gui.screens.Screen;
public enum KeyConflictContext implements IKeyConflictContext
{
@@ -42,7 +43,7 @@ public enum KeyConflictContext implements IKeyConflictContext
},
/**
* Gui key bindings are only used when a {@link GuiScreen} is open.
* Gui key bindings are only used when a {@link Screen} is open.
*/
GUI {
@Override
@@ -59,7 +60,7 @@ public enum KeyConflictContext implements IKeyConflictContext
},
/**
* In-game key bindings are only used when a {@link GuiScreen} is not open.
* In-game key bindings are only used when a {@link Screen} is not open.
*/
IN_GAME {
@Override