Fix up some javadoc complaints

This commit is contained in:
Christian 2012-10-25 16:18:42 -04:00
parent f7403a509f
commit 1a31cd0886
7 changed files with 18 additions and 21 deletions

View File

@ -113,10 +113,9 @@ public class FMLClientHandler implements IFMLSidedHandler
private DuplicateModsFoundException dupesFound;
/**
* Called to start the whole game off from
* {@link MinecraftServer#startServer}
* Called to start the whole game off
*
* @param minecraftServer
* @param minecraft The minecraft instance being launched
*/
public void beginMinecraftLoading(Minecraft minecraft)
{

View File

@ -299,7 +299,7 @@ public abstract class BaseMod implements cpw.mods.fml.common.modloader.BaseModPr
/**
* Only implemented on the client side
* {@link #serverChat(EntityPlayer, Packet3Chat)}
* {@link #serverChat(NetServerHandler, String)}
*
* @param text
*/

View File

@ -69,7 +69,7 @@ public class ModLoader
/**
* This method is a call in hook from modified external code. Implemented elsewhere.
*
* {@link GameRegistry#getFuelValue(ItemStack))}
* {@link GameRegistry#getFuelValue(ItemStack)}
*
* @param id The Item ID
* @param metadata The Item Metadata
@ -95,9 +95,9 @@ public class ModLoader
/**
* Adds a new prefix to the armor texture list
*
* {@link RenderingRegistry#addNewArmourRendererPrefix(String))}
*
*
* {@link RenderingRegistry#addNewArmourRendererPrefix(String)}
*
* @param armor The new armor prefix
* @return The new armor index
*/
@ -173,13 +173,13 @@ public class ModLoader
}
/**
* Attempts to register a small image to be applied to a larger texture image,
* Attempts to register a small image to be applied to a larger texture image,
* typically how old ModLoader mods add custom Item/Block textures.
*
*
* Forge mods should use setTextureFile in Item/Block
*
*
* Will return the icon index it was applied to.
*
*
* Unimplemented on the server as it does not render textures
*
* @param fileToOverride The texture to apply the new image to
@ -193,11 +193,11 @@ public class ModLoader
}
/**
* Attempts to register a small image to be applied to a larger texture image,
* Attempts to register a small image to be applied to a larger texture image,
* typically how old ModLoader mods add custom Item/Block textures.
*
*
* Forge mods should use setTextureFile in Item/Block
*
*
* Unimplemented on the server as it does not render textures
*
* @param path The texture to apply the new image to
@ -563,7 +563,6 @@ public class ModLoader
/**
* This method is a call in hook from modified external code. Implemented elsewhere.
* {@link FMLNetworkHandler#handlePacket250(Packet250CustomPayload, NetworkManager, NetHandler)}
*
* @param packet
*/
@ -767,7 +766,6 @@ public class ModLoader
}
/**
* Send a chat message to the server
* {@link FMLNetworkHandler#handleChatMessage(NetHandler, Packet3Chat)}
*
* @param text
*/

View File

@ -23,7 +23,7 @@ public @interface BukkitPluginRef
* specification. If this is a bukkit enabled environment the field annotated by this
* will be populated with a {@link BukkitProxy} instance if possible. This proxy will be gotten by
* reflectively calling the "getModProxy" method on the bukkit plugin instance.
* @return
* @return The name of the plugin which we will inject into this field
*/
String value();
}

View File

@ -154,7 +154,7 @@ public class FMLCommonHandler
}
/**
* Get the forge mod loader logging instance (goes to the forgemodloader log file)
* @return
* @return The log instance for the FML log file
*/
public Logger getFMLLogger()
{

View File

@ -66,7 +66,7 @@ public @interface Mod
* An optional bukkit plugin that will be injected into the bukkit plugin framework if
* this mod is loaded into the FML framework and the bukkit coremod is present.
* Instances of the bukkit plugin can be obtained via the {@link BukkitPluginRef} annotation on fields.
* @return
* @return The name of the plugin to load for this mod
*/
String bukkitPlugin() default "";
/**

View File

@ -36,7 +36,7 @@ import cpw.mods.fml.common.registry.LanguageRegistry;
* Handles primary communication from hooked code into the system
*
* The FML entry point is {@link #beginServerLoading(MinecraftServer)} called from
* {@link DedicatedServer}
* {@link net.minecraft.src.DedicatedServer}
*
* Obfuscated code should focus on this class and other members of the "server"
* (or "client") code