squash remaining javadoc warnings (JDK7 level)

Mumfrey
1 parent 859ec481
Showing 38 changed files with 29 additions and 95 deletions
java/client/com/mumfrey/liteloader/client/ClientPluginChannelsClient.java
java/client/com/mumfrey/liteloader/client/LiteLoaderEventBrokerClient.java
java/client/com/mumfrey/liteloader/client/gui/GuiLiteLoaderPanel.java
java/client/com/mumfrey/liteloader/client/gui/GuiPanel.java
java/client/com/mumfrey/liteloader/client/gui/GuiPanelConfigContainer.java
java/client/com/mumfrey/liteloader/client/gui/GuiPanelLiteLoaderLog.java
java/client/com/mumfrey/liteloader/client/gui/ModListEntry.java
java/client/com/mumfrey/liteloader/client/gui/startup/LoadingBar.java
java/client/com/mumfrey/liteloader/client/transformers/LiteLoaderEventInjectionTransformer.java
java/common/com/mumfrey/liteloader/api/manager/APIRegistry.java
java/common/com/mumfrey/liteloader/core/EnabledModsList.java
java/common/com/mumfrey/liteloader/core/InterfaceRegistrationDelegate.java
java/common/com/mumfrey/liteloader/core/LiteLoader.java
java/common/com/mumfrey/liteloader/core/LiteLoaderBootstrap.java
java/common/com/mumfrey/liteloader/core/LiteLoaderEnumerator.java
java/common/com/mumfrey/liteloader/core/LiteLoaderInterfaceManager.java
java/common/com/mumfrey/liteloader/core/LiteLoaderMods.java
java/common/com/mumfrey/liteloader/core/LiteLoaderUpdateSite.java
java/common/com/mumfrey/liteloader/core/Mod.java
java/common/com/mumfrey/liteloader/core/ServerPluginChannels.java
@@ -99,8 +99,7 @@ public class ClientPluginChannelsClient extends ClientPluginChannels
 	}
  
 	/**
-	 * @param channel
-	 * @param data
+	 * @param payload
 	 */
 	static boolean dispatch(C17PacketCustomPayload payload)
 	{
@@ -278,8 +278,8 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
 	/**
 	 * Callback from the tick hook, post render entities
 	 * 
+	 * @param partialTicks
 	 * @param timeSlice 
-	 * @param partialTicks2 
 	 */
 	void postRenderEntities(float partialTicks, long timeSlice)
 	{
@@ -289,8 +289,8 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
 	/**
 	 * Callback from the tick hook, post render
 	 * 
+	 * @param partialTicks 
 	 * @param timeSlice 
-	 * @param partialTicks2 
 	 */
 	void postRender(float partialTicks, long timeSlice)
 	{
@@ -366,8 +366,6 @@ public class LiteLoaderEventBrokerClient extends LiteLoaderEventBroker&lt;Minecraft
  
 	/**
 	 * Callback from the tick hook, ticks all tickable mods
-	 * 
-	 * @param clock True if this is a new tick (otherwise it's just a new frame)
 	 */
 	void onTick()
 	{
@@ -631,7 +631,6 @@ public class GuiLiteLoaderPanel extends GuiScreen
 	/**
 	 * @param partialTicks
 	 * @param active
-	 * @return
 	 */
 	private float calcTween(float partialTicks, boolean active)
 	{
@@ -764,10 +763,10 @@ public class GuiLiteLoaderPanel extends GuiScreen
 	}
  
 	/**
-	 * @param resource
 	 * @param x
 	 * @param y
 	 * @param icon
+	 * @param alpha
 	 */
 	static void glDrawTexturedRect(int x, int y, Icon icon, float alpha)
 	{
@@ -142,7 +142,6 @@ public abstract class GuiPanel extends Gui
 	/**
 	 * @param mouseX
 	 * @param mouseY
-	 * @return
 	 */
 	boolean mouseOverPanel(int mouseX, int mouseY)
 	{
@@ -39,7 +39,6 @@ class GuiPanelConfigContainer extends GuiPanel implements ConfigPanelHost
 	private int totalHeight = -1;
  
 	/**
-	 * @param parent
 	 * @param minecraft
 	 * @param panel
 	 * @param mod
@@ -53,7 +52,7 @@ class GuiPanelConfigContainer extends GuiPanel implements ConfigPanelHost
 	}
  
 	/**
-	 * @return
+	 * 
 	 */
 	String getPanelTitle()
 	{
@@ -54,10 +54,8 @@ class GuiPanelLiteLoaderLog extends GuiPanel implements ScrollPanelContent
 	private int debugInfoTimer = 0;
  
 	/**
-	 * @param parent
 	 * @param minecraft
-	 * @param panel
-	 * @param mod
+	 * @param parent
 	 */
 	GuiPanelLiteLoaderLog(Minecraft minecraft, GuiLiteLoaderPanel parent)
 	{
@@ -69,9 +69,13 @@ public class ModListEntry
  
 	/**
 	 * Mod list entry for an ACTIVE mod
+	 * 
+	 * @param mods
+	 * @param environment
 	 * @param fontRenderer
+	 * @param brandColour
+	 * @param decorators
 	 * @param modInfo
-	 * @param enabledMods
 	 */
 	ModListEntry(LiteLoaderMods mods, LoaderEnvironment environment, FontRenderer fontRenderer, int brandColour, List<ModInfoDecorator> decorators, ModInfo<?> modInfo)
 	{
@@ -410,7 +410,6 @@ public class LoadingBar extends LoadingProgress
 	 * Pad LSB with 1's if any MSB are 1 (effectively a bitwise ceil() function)
 	 * 
 	 * @param component
-	 * @return
 	 */
 	private int padComponent(int component)
 	{
@@ -118,14 +118,6 @@ public class LiteLoaderEventInjectionTransformer extends EventInjectionTransform
 		return this.add(event, targetMethod, injectionPoint, callback, Obf.CallbackProxyClient);
 	}
  
-	/**
-	 * @param event
-	 * @param targetMethod
-	 * @param injectionPoint
-	 * @param callback
-	 * @param proxy
-	 * @return
-	 */
 	private Event add(Event event, MethodInfo targetMethod, InjectionPoint injectionPoint, String callback, Obf proxy)
 	{
 		return this.addEvent(event, targetMethod, injectionPoint).addListener(new MethodInfo(proxy, callback));
@@ -71,7 +71,6 @@ public final class APIRegistry
  
 	/**
 	 * @param apiClassName
-	 * @return
 	 */
 	private LiteAPI spawnAPI(String apiClassName)
 	{
@@ -108,7 +107,7 @@ public final class APIRegistry
 	}
  
 	/**
-	 * @return
+	 * Populate and return the API instance array
 	 */
 	private LiteAPI[] getAllAPIs()
 	{
@@ -123,7 +123,6 @@ public class EnabledModsList
 	 * Internal method which returns the map for the specified profile
 	 * 
 	 * @param profileName
-	 * @return
 	 */
 	private Map<String, Boolean> getProfile(String profileName)
 	{
@@ -49,7 +49,7 @@ public class InterfaceRegistrationDelegate
 	}
  
 	/**
-	 * @return
+	 * 
 	 */
 	List<InterfaceHandler> getHandlers()
 	{
@@ -178,9 +178,10 @@ public final class LiteLoader
 	private Input input;
  
 	/**
-	 * LiteLoader constructor
-	 * @param profile 
-	 * @param modNameFilter 
+	 * ctor
+	 * 
+	 * @param environment
+	 * @param properties
 	 */
 	private LiteLoader(LoaderEnvironment environment, LoaderProperties properties)
 	{
@@ -426,7 +426,6 @@ class LiteLoaderBootstrap implements LoaderBootstrap, LoaderEnvironment, LoaderP
 	 * Get the properties stream either from the jar or from the properties file
 	 * in the minecraft folder
 	 * 
-	 * @return
 	 * @throws FileNotFoundException
 	 */
 	private InputStream getLocalPropertiesStream() throws FileNotFoundException
@@ -143,7 +143,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
  
 	/**
 	 * @param environment
-	 * @return
 	 */
 	private String[] getSupportedPrefixes(LoaderEnvironment environment)
 	{
@@ -308,7 +307,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
  
 	/**
 	 * @param identifier
-	 * @return
 	 */
 	private LoadableMod<?> getContainerById(String identifier)
 	{
@@ -329,7 +327,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
  
 	/**
 	 * @param modClass
-	 * @return
 	 */
 	private LoadableMod<?> getContainerForMod(Class<? extends LiteMod> modClass)
 	{
@@ -671,7 +668,6 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
 	 * class
 	 * 
 	 * @param superClass
-	 * @return
 	 */
 	private static <T> LinkedList<Class<? extends T>> getSubclassesFor(LoadableMod<?> container, ClassLoader classloader, Class<T> superClass, String[] supportedPrefixes)
 	{
@@ -93,7 +93,6 @@ public class LiteLoaderInterfaceManager implements InterfaceRegistry
 		/**
 		 * @param provider
 		 * @param interfaceType
-		 * @return
 		 */
 		@SuppressWarnings("unchecked")
 		private Method findRegistrationMethod(InterfaceProvider provider, Class<? extends Listener> interfaceType)
@@ -399,8 +399,6 @@ public class LiteLoaderMods
  
 	/**
 	 * Create mod instances from the enumerated classes
-	 * 
-	 * @param modsToLoad List of mods to load
 	 */
 	void loadMods()
 	{
@@ -651,7 +649,6 @@ public class LiteLoaderMods
 	 * for inclusion in the properties file
 	 * 
 	 * @param modName
-	 * @return
 	 */
 	String getModNameForConfig(Class<? extends LiteMod> modClass, String modName)
 	{
@@ -47,7 +47,7 @@ public class LiteLoaderUpdateSite extends UpdateSite
 	}
  
 	/**
-	 * @return
+	 * 
 	 */
 	private boolean findJarFile()
 	{
@@ -68,7 +68,6 @@ class Mod extends ModInfo&lt;LoadableMod&lt;?&gt;&gt;
 	/**
 	 * Called by the mod manager to instance the mod
 	 * 
-	 * @return
 	 * @throws InstantiationException
 	 * @throws IllegalAccessException
 	 */
@@ -72,10 +72,6 @@ public class ServerPluginChannels extends PluginChannels&lt;ServerPluginChannelList
 		super.addPluginChannelListener(pluginChannelListener);
 	}
  
-	/**
-	 * @param netHandler
-	 * @param loginPacket
-	 */
 	void onServerStartup()
 	{
 		this.clearPluginChannels(null);
@@ -87,10 +83,6 @@ public class ServerPluginChannels extends PluginChannels&lt;ServerPluginChannelList
 		}
 	}
  
-	/**
-	 * @param netHandler
-	 * @param loginPacket
-	 */
 	void onPlayerJoined(EntityPlayerMP player)
 	{
 		this.sendRegisteredPluginChannels(player);
@@ -190,7 +182,7 @@ public class ServerPluginChannels extends PluginChannels&lt;ServerPluginChannelList
 	}
  
 	/**
-	 * @param netHandler
+	 * @param recipient
 	 * @param registrationData
 	 */
 	private void sendRegistrationData(EntityPlayerMP recipient, PacketBuffer registrationData)
@@ -240,8 +232,8 @@ public class ServerPluginChannels extends PluginChannels&lt;ServerPluginChannelList
 	}
  
 	/**
-	 * @param channel
-	 * @param data
+	 * @param recipient
+	 * @param payload
 	 */
 	static boolean dispatch(EntityPlayerMP recipient, S3FPacketCustomPayload payload)
 	{
@@ -240,9 +240,6 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
 		return this.getMetaValue(descriptionKey, this.getMetaValue("description", ""));
 	}
  
-	/**
-	 * @return
-	 */
 	private String compileMissingAPIList()
 	{
 		StringBuilder missingAPIList = new StringBuilder();
@@ -596,7 +596,7 @@ public class HandlerList&lt;T&gt; extends LinkedList&lt;T&gt; implements FastIterableDeque&lt;T
  
 		/**
 		 * @param type
-		 * @param size
+		 * @param logicOp
 		 */
 		HandlerListClassLoader(Class<T> type, ReturnLogicOp logicOp)
 		{
@@ -995,7 +995,6 @@ public class HandlerList&lt;T&gt; extends LinkedList&lt;T&gt; implements FastIterableDeque&lt;T
 		/**
 		 * @param baseName
 		 * @param typeName
-		 * @return
 		 */
 		private static String getNextClassName(String baseName, String typeName)
 		{
@@ -1004,7 +1003,6 @@ public class HandlerList&lt;T&gt; extends LinkedList&lt;T&gt; implements FastIterableDeque&lt;T
  
 		/**
 		 * @param name
-		 * @return
 		 * @throws IOException
 		 */
 		private static byte[] getInterfaceBytes(String name) throws IOException
@@ -357,7 +357,6 @@ public abstract class ClassPathUtilities
 	 * @param classLoader
 	 * @param fileName
 	 * @param removeFromClassPath
-	 * @return
 	 * @throws MalformedURLException
 	 */
 	@SuppressWarnings("unchecked")
@@ -275,10 +275,10 @@ public class LiteLoaderTweaker implements ITweaker
 	}
  
 	/**
+	 * @param args
 	 * @param gameDirectory
 	 * @param assetsDirectory
 	 * @param profile
-	 * @param apisToLoad
 	 */
 	private void onPrepare(List<String> args, File gameDirectory, File assetsDirectory, String profile)
 	{
@@ -554,7 +554,6 @@ public class LiteLoaderTweaker implements ITweaker
  
 	/**
 	 * @param clazz
-	 * @return
 	 */
 	@SuppressWarnings("unchecked")
 	private static boolean isTweakAlreadyEnqueued(String clazz)
@@ -156,7 +156,6 @@ public class MessageBus implements InterfaceProvider
 	 * Get messengers for the specified channel
 	 * 
 	 * @param channel
-	 * @return
 	 */
 	private FastIterable<Messenger> getMessengerList(String channel)
 	{
@@ -269,7 +269,6 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	 * @param exposable
 	 * @param strategy
 	 * @param fileName
-	 * @return
 	 */
 	static ExposableConfigWriter create(Exposable exposable, ConfigStrategy strategy, String fileName, boolean aggressive)
 	{
@@ -163,7 +163,7 @@ public class PermissionsManagerClient implements PermissionsManager, PluginChann
 	 * Register a new client mod with this manager
 	 * 
 	 * @param modName Mod name
-	 * @param modVersion Mod version
+	 * @param mod Mod instance
 	 */
 	private void registerClientMod(String modName, Permissible mod)
 	{
@@ -60,7 +60,6 @@ public class InternalResourcePack implements IResourcePack
  
 	/**
 	 * @param resourceLocation
-	 * @return
 	 */
 	private InputStream getResourceStream(ResourceLocation resourceLocation)
 	{
@@ -320,7 +320,6 @@ public class Callback
  
 	/**
 	 * @param obfType
-	 * @param sb
 	 * @param arg
 	 */
 	private static String toDescriptor(int obfType, Object arg)
@@ -124,7 +124,6 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
 	/**
 	 * @param basicClass
 	 * @param profilerMappings
-	 * @return
 	 */
 	private byte[] injectCallbacks(byte[] basicClass, Map<String, Callback> profilerMappings, Map<String, Callback> mappings)
 	{
@@ -240,7 +239,6 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
 	 * @param classType
 	 * @param methodNode
 	 * @param callback
-	 * @return
 	 */
 	private InsnList genCallbackInsns(String classType, MethodNode methodNode, Callback callback)
 	{
@@ -254,7 +252,6 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
 	 * @param methodNode
 	 * @param callback
 	 * @param returnNumber
-	 * @return
 	 */
 	private InsnList genCallbackInsns(String classType, MethodNode methodNode, Callback callback, int returnNumber)
 	{
@@ -267,7 +264,6 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
 	 * @param methodNode
 	 * @param callback
 	 * @param returnNumber
-	 * @return
 	 */
 	private InsnList genCallbackInsns(InsnList injected, String classType, MethodNode methodNode, Callback callback, int returnNumber)
 	{
@@ -320,7 +316,6 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
  
 	/**
 	 * @param method
-	 * @return
 	 */
 	private static String getMethodArgs(MethodNode method)
 	{
@@ -334,7 +329,6 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
 	 * @param invokeName
 	 * @param invokeSig
 	 * @param section
-	 * @return
 	 */
 	private static String generateSignature(String className, String methodName, String methodSignature, String invokeName, String invokeSig, String section)
 	{
@@ -345,10 +339,7 @@ public abstract class CallbackInjectionTransformer extends ClassTransformer
 	 * @param className
 	 * @param methodName
 	 * @param methodSignature
-	 * @param invokeName
-	 * @param invokeSig
-	 * @param section
-	 * @return
+	 * @param callbackType
 	 */
 	private static String generateSignature(String className, String methodName, String methodSignature, Callback.CallbackType callbackType)
 	{
@@ -95,12 +95,12 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
 	private final String targetClassName;
  
 	/**
-	 * Fields which get a different name from an {@link Obfuscate} annotation
+	 * Fields which get a different name from an {@link Obfuscated} annotation
 	 */
 	private final Map<String, String> renamedFields = new HashMap<String, String>();
  
 	/**
-	 * Methods which get a different name from an {@link Obfuscate} annotation
+	 * Methods which get a different name from an {@link Obfuscated} annotation
 	 */
 	private final Map<String, String> renamedMethods = new HashMap<String, String>();
  
@@ -177,7 +177,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
 	 * 
 	 * @param transformedName
 	 * @param basicClass
-	 * @return
 	 */
 	private byte[] remapClass(String transformedName, byte[] basicClass)
 	{
@@ -481,7 +480,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
  
 	/**
 	 * @param transformedName
-	 * @return
 	 * @throws InvalidOverlayException
 	 */
 	private ClassNode loadOverlayClass(String transformedName, boolean runTransformers)
@@ -514,7 +512,6 @@ public abstract class ClassOverlayTransformer extends ClassTransformer
 	 * 
 	 * @param name
 	 * @param basicClass
-	 * @return
 	 */
 	private byte[] applyTransformers(String name, byte[] basicClass)
 	{
@@ -485,7 +485,6 @@ public class Event implements Comparable&lt;Event&gt;
 	 * Get an event by name (case insensitive)
 	 * 
 	 * @param eventName
-	 * @return
 	 */
 	static Event getEvent(String eventName)
 	{
@@ -500,8 +499,7 @@ public class Event implements Comparable&lt;Event&gt;
 	 * Populates the event proxy class with delegating methods for all injected events 
 	 * 
 	 * @param classNode
-	 * @param proxyIndex TODO
-	 * @return
+	 * @param proxyIndex
 	 */
 	static ClassNode populateProxy(final ClassNode classNode, int proxyIndex)
 	{
@@ -248,7 +248,6 @@ public final class EventTransformer extends ClassTransformer
 	 * @param classNode
 	 * @param method
 	 * @param methodInjections
-	 * @return
 	 */
 	private Map<AbstractInsnNode, Injection> findInjectionPoints(ClassNode classNode, MethodNode method, Map<Event, InjectionPoint> methodInjections)
 	{
@@ -313,7 +313,6 @@ public class BeforeInvoke extends InjectionPoint
 	 * 
 	 * @param haystack
 	 * @param needle
-	 * @return
 	 */
 	private static int arrayIndexOf(String[] haystack, String needle, int pos)
 	{
@@ -91,7 +91,6 @@ public class JsonEvents implements Serializable
 	 * Parse a token name, returns the token name as a string if the token is valid, or null if the token is not valid
 	 * 
 	 * @param token
-	 * @return
 	 */
 	static String parseToken(String token)
 	{
@@ -355,7 +355,6 @@ public class UpdateSite implements Comparator&lt;Long&gt;
 	 * @param artefact
 	 * @param bestTimeStamp
 	 * @param checkOnly
-	 * @return
 	 */
 	private boolean checkAndUseRemoteArtefact(Map<?, ?> artefact, long bestTimeStamp, boolean checkOnly)
 	{
@@ -382,7 +381,6 @@ public class UpdateSite implements Comparator&lt;Long&gt;
 	/**
 	 * @param bestTimeStamp
 	 * @param remoteTimeStamp
-	 * @return
 	 */
 	private boolean compareTimeStamps(long bestTimeStamp, Long remoteTimeStamp)
 	{
@@ -391,7 +389,6 @@ public class UpdateSite implements Comparator&lt;Long&gt;
  
 	/**
 	 * @param file
-	 * @return
 	 */
 	private String createArtefactURL(String file)
 	{
@@ -308,7 +308,6 @@ public final class Input implements CoreProvider
 	 * @param controller
 	 * @param component
 	 * @param handler
-	 * @return
 	 */
 	private InputEvent addEventHandler(Controller controller, Component component, InputHandler handler)
 	{
@@ -336,7 +335,7 @@ public final class Input implements CoreProvider
 	}
  
 	/**
-	 * @return
+	 * 
 	 */
 	private Set<Controller> getActiveControllers()
 	{
@@ -49,7 +49,6 @@ public class InputEvent
 	 * Link this delegate to the specified delegate and return the start of the delegate chain
 	 * 
 	 * @param chain delegate to link to (will be null if the chain is empty)
-	 * @return
 	 */
 	InputEvent link(InputEvent chain)
 	{
@@ -61,7 +60,6 @@ public class InputEvent
 	 * Append specified delegate to the end of the delegate chain 
 	 * 
 	 * @param delegate
-	 * @return
 	 */
 	private InputEvent append(InputEvent delegate)
 	{