More javadoc cleanup

This commit is contained in:
Christian 2013-07-02 19:39:02 -04:00
parent aaaffda3f0
commit e45767d20a
7 changed files with 68 additions and 53 deletions

View file

@ -83,7 +83,7 @@ import cpw.mods.fml.relauncher.Side;
/**
* Handles primary communication from hooked code into the system
*
* The FML entry point is {@link #beginMinecraftLoading(Minecraft)} called from
* The FML entry point is {@link #beginMinecraftLoading(Minecraft, List)} called from
* {@link Minecraft}
*
* Obfuscated code should focus on this class and other members of the "server"
@ -137,7 +137,7 @@ public class FMLClientHandler implements IFMLSidedHandler
* Called to start the whole game off
*
* @param minecraft The minecraft instance being launched
* @param field_110449_ao
* @param resourcePackList The resource pack list we will populate with mods
*/
public void beginMinecraftLoading(Minecraft minecraft, List resourcePackList)
{

View file

@ -20,6 +20,7 @@ import java.lang.annotation.Target;
import net.minecraft.item.ItemBlock;
import net.minecraft.network.packet.Packet250CustomPayload;
import cpw.mods.fml.common.event.FMLEvent;
import cpw.mods.fml.common.event.FMLFingerprintViolationEvent;
import cpw.mods.fml.common.event.FMLInitializationEvent;
import cpw.mods.fml.common.event.FMLInterModComms;
@ -68,6 +69,7 @@ import cpw.mods.fml.common.registry.GameRegistry;
* // Do stuff in pre-init phase (read config, create blocks and items, register them)
* }
* }
* }
* </pre>
*
* @author cpw

View file

@ -40,6 +40,7 @@ import java.lang.annotation.Target;
* public class ClientProxy extends CommonProxy {
* // Override common stuff with client specific stuff here
* }
* }
* </pre>
* @author cpw
*

View file

@ -13,7 +13,17 @@
package cpw.mods.fml.relauncher;
public enum Side {
CLIENT, SERVER;
/**
* The client side. Specifically, an environment where rendering capability exists.
* Usually in the game client.
*/
CLIENT,
/**
* The server side. Specifically, an environment where NO rendering capability exists.
* Usually on the dedicated server.
*/
SERVER;
/**
* @return If this is the server environment

View file

@ -426,6 +426,7 @@ public class Delta {
"source or target is too large, max length is "
+ Integer.MAX_VALUE);
System.err.println("aborting..");
output.close();
return;
}

View file

@ -50,7 +50,7 @@ public interface DiffWriter extends Closeable {
/**
* Closes this stream.
* Note that {@link Diff} will invoke this method at the end.
* Note that {@link DiffWriter} will invoke this method at the end.
*/
public void close() throws IOException;
}

View file

@ -52,10 +52,11 @@ import java.io.RandomAccessFile;
import java.nio.ByteBuffer;
/**
* This class patches an input file with a GDIFF patch fil<EFBFBD>e.
* This class patches an input file with a GDIFF patch file.
*
* The patch file follows the GDIFF file specification available at
* {@link http://www.w3.org/TR/NOTE-gdiff-19970901.html}.
*
* <a href="http://www.w3.org/TR/NOTE-gdiff-19970901.html">http://www.w3.org/TR/NOTE-gdiff-19970901.html</a>.
*/
public class GDiffPatcher {