mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-17 11:05:40 +00:00
Javadoc cleanup
This commit is contained in:
1 parent
5ce4e31855
commit
e1c6630569
11 files changed
+25
-22
No files matched your search
@@ -2,7 +2,7 @@ package cpw.mods.fml.common;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A marker interface for retrieving a proxy to a bukkit plugin.
|
* A marker interface for retrieving a proxy to a bukkit plugin.
|
||||||
* Fields associated with {@link BukkitPluginRef} annotations should be should probably
|
* Fields associated with {@link BukkitPluginRef} annotations should
|
||||||
* declare this type and cast down if the target is available (not null)
|
* declare this type and cast down if the target is available (not null)
|
||||||
* @author cpw
|
* @author cpw
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -377,7 +377,7 @@ public class Loader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
*
|
||||||
*/
|
*/
|
||||||
private void initializeLoader()
|
private void initializeLoader()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ public @interface NetworkMod
|
|||||||
Class<? extends IPacketHandler> packetHandler() default NULL.class;
|
Class<? extends IPacketHandler> packetHandler() default NULL.class;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A tiny packet handler implementation based on {@link Packet131MapData} for "small"
|
* A tiny packet handler implementation based on {@link net.minecraft.network.packet.Packet131MapData} for "small"
|
||||||
* data packet loads.
|
* data packet loads.
|
||||||
*/
|
*/
|
||||||
Class<? extends ITinyPacketHandler> tinyPacketHandler() default NULL.class;
|
Class<? extends ITinyPacketHandler> tinyPacketHandler() default NULL.class;
|
||||||
|
|||||||
@@ -193,7 +193,7 @@ public class NetworkModHandler
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* @return
|
* @return the default {@link NetworkMod#connectionHandler()} annotation value
|
||||||
*/
|
*/
|
||||||
private Object getConnectionHandlerDefaultValue()
|
private Object getConnectionHandlerDefaultValue()
|
||||||
{
|
{
|
||||||
@@ -211,7 +211,7 @@ public class NetworkModHandler
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
* @return the default {@link NetworkMod#packetHandler()} annotation value
|
||||||
*/
|
*/
|
||||||
private Object getPacketHandlerDefaultValue()
|
private Object getPacketHandlerDefaultValue()
|
||||||
{
|
{
|
||||||
@@ -228,6 +228,9 @@ public class NetworkModHandler
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return the default {@link NetworkMod#tinyPacketHandler()} annotation value
|
||||||
|
*/
|
||||||
private Object getTinyPacketHandlerDefaultValue()
|
private Object getTinyPacketHandlerDefaultValue()
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
@@ -243,7 +246,7 @@ public class NetworkModHandler
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* @return
|
* @return the {@link NetworkMod#clientPacketHandlerSpec()} default annotation value
|
||||||
*/
|
*/
|
||||||
private Object getClientHandlerSpecDefaultValue()
|
private Object getClientHandlerSpecDefaultValue()
|
||||||
{
|
{
|
||||||
@@ -260,7 +263,7 @@ public class NetworkModHandler
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* @return
|
* @return the default {@link NetworkMod#serverPacketHandlerSpec()} annotation value
|
||||||
*/
|
*/
|
||||||
private Object getServerHandlerSpecDefaultValue()
|
private Object getServerHandlerSpecDefaultValue()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ public class NetworkRegistry
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Get the packet 250 channel registration string
|
* Get the packet 250 channel registration string
|
||||||
* @return
|
* @return the {@link Packet250CustomPayload} channel registration string
|
||||||
*/
|
*/
|
||||||
byte[] getPacketRegistry(Side side)
|
byte[] getPacketRegistry(Side side)
|
||||||
{
|
{
|
||||||
@@ -81,8 +81,8 @@ public class NetworkRegistry
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* register a channel to a mod
|
* register a channel to a mod
|
||||||
* @param container
|
* @param handler the packet handler
|
||||||
* @param channelName
|
* @param channelName the channel name to register it with
|
||||||
*/
|
*/
|
||||||
public void registerChannel(IPacketHandler handler, String channelName)
|
public void registerChannel(IPacketHandler handler, String channelName)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -145,7 +145,7 @@ public class GameRegistry
|
|||||||
/**
|
/**
|
||||||
* Private and not yet working properly
|
* Private and not yet working properly
|
||||||
*
|
*
|
||||||
* @return
|
* @return a block id
|
||||||
*/
|
*/
|
||||||
private static int findSpareBlockId()
|
private static int findSpareBlockId()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -58,8 +58,8 @@ public class TickRegistry
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param side
|
* @param side the side to get the tick queue for
|
||||||
* @return
|
* @return the queue for the effective side
|
||||||
*/
|
*/
|
||||||
private static PriorityQueue<TickQueueElement> getQueue(Side side)
|
private static PriorityQueue<TickQueueElement> getQueue(Side side)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ public class VillagerRegistry
|
|||||||
private List<Integer> newVillagerIds = Lists.newArrayList();
|
private List<Integer> newVillagerIds = Lists.newArrayList();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Allow access to the {@link StructureVillagePieces} array controlling new village
|
* Allow access to the {@link net.minecraft.world.gen.structure.StructureVillagePieces} array controlling new village
|
||||||
* creation so you can insert your own new village pieces
|
* creation so you can insert your own new village pieces
|
||||||
*
|
*
|
||||||
* @author cpw
|
* @author cpw
|
||||||
@@ -46,7 +46,7 @@ public class VillagerRegistry
|
|||||||
public interface IVillageCreationHandler
|
public interface IVillageCreationHandler
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Called when {@link MapGenVillage} is creating a new village
|
* Called when {@link net.minecraft.world.gen.structure.MapGenVillage} is creating a new village
|
||||||
*
|
*
|
||||||
* @param random
|
* @param random
|
||||||
* @param i
|
* @param i
|
||||||
@@ -60,7 +60,7 @@ public class VillagerRegistry
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build an instance of the village component {@link StructureVillagePieces}
|
* Build an instance of the village component {@link net.minecraft.world.gen.structure.StructureVillagePieces}
|
||||||
* @param villagePiece
|
* @param villagePiece
|
||||||
* @param startPiece
|
* @param startPiece
|
||||||
* @param pieces
|
* @param pieces
|
||||||
|
|||||||
@@ -177,7 +177,7 @@ public class FMLRelauncher
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
* @return the location of the client home
|
||||||
*/
|
*/
|
||||||
private File computeExistingClientHome()
|
private File computeExistingClientHome()
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -401,8 +401,8 @@ public class RelaunchLibraryManager
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param mcDir
|
* @param mcDir the minecraft home directory
|
||||||
* @return
|
* @return the lib directory
|
||||||
*/
|
*/
|
||||||
private static File setupLibDir(File mcDir)
|
private static File setupLibDir(File mcDir)
|
||||||
{
|
{
|
||||||
@@ -427,8 +427,8 @@ public class RelaunchLibraryManager
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param mcDir
|
* @param mcDir the minecraft home directory
|
||||||
* @return
|
* @return the coremod directory
|
||||||
*/
|
*/
|
||||||
private static File setupCoreModDir(File mcDir)
|
private static File setupCoreModDir(File mcDir)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ import cpw.mods.fml.relauncher.Side;
|
|||||||
* Handles primary communication from hooked code into the system
|
* Handles primary communication from hooked code into the system
|
||||||
*
|
*
|
||||||
* The FML entry point is {@link #beginServerLoading(MinecraftServer)} called from
|
* The FML entry point is {@link #beginServerLoading(MinecraftServer)} called from
|
||||||
* {@link net.minecraft.shared.DedicatedServer}
|
* {@link net.minecraft.server.dedicated.DedicatedServer}
|
||||||
*
|
*
|
||||||
* Obfuscated code should focus on this class and other members of the "server"
|
* Obfuscated code should focus on this class and other members of the "server"
|
||||||
* (or "client") code
|
* (or "client") code
|
||||||
|
|||||||
Reference in new issue
Block a user