From 34cc42d3cb113dbf6732aa6b9c5cddff691c75bc Mon Sep 17 00:00:00 2001 From: Christian Date: Thu, 25 Oct 2012 16:18:42 -0400 Subject: [PATCH] Fix up some javadoc complaints --- .../cpw/mods/fml/client/FMLClientHandler.java | 5 ++-- client/net/minecraft/src/BaseMod.java | 2 +- client/net/minecraft/src/ModLoader.java | 24 +++++++++---------- .../cpw/mods/fml/common/BukkitPluginRef.java | 2 +- .../cpw/mods/fml/common/FMLCommonHandler.java | 2 +- common/cpw/mods/fml/common/Mod.java | 2 +- .../cpw/mods/fml/server/FMLServerHandler.java | 2 +- 7 files changed, 18 insertions(+), 21 deletions(-) diff --git a/client/cpw/mods/fml/client/FMLClientHandler.java b/client/cpw/mods/fml/client/FMLClientHandler.java index 4d9b177b15..db0bb3c80e 100644 --- a/client/cpw/mods/fml/client/FMLClientHandler.java +++ b/client/cpw/mods/fml/client/FMLClientHandler.java @@ -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) { diff --git a/client/net/minecraft/src/BaseMod.java b/client/net/minecraft/src/BaseMod.java index 410de23b44..7f9725276e 100644 --- a/client/net/minecraft/src/BaseMod.java +++ b/client/net/minecraft/src/BaseMod.java @@ -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 */ diff --git a/client/net/minecraft/src/ModLoader.java b/client/net/minecraft/src/ModLoader.java index 4197a49b4a..c2847a0258 100644 --- a/client/net/minecraft/src/ModLoader.java +++ b/client/net/minecraft/src/ModLoader.java @@ -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 */ diff --git a/common/cpw/mods/fml/common/BukkitPluginRef.java b/common/cpw/mods/fml/common/BukkitPluginRef.java index 9f63db5c8f..6d97f7bb62 100644 --- a/common/cpw/mods/fml/common/BukkitPluginRef.java +++ b/common/cpw/mods/fml/common/BukkitPluginRef.java @@ -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(); } diff --git a/common/cpw/mods/fml/common/FMLCommonHandler.java b/common/cpw/mods/fml/common/FMLCommonHandler.java index 3d5c06e57b..7ad4ae7c8e 100644 --- a/common/cpw/mods/fml/common/FMLCommonHandler.java +++ b/common/cpw/mods/fml/common/FMLCommonHandler.java @@ -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() { diff --git a/common/cpw/mods/fml/common/Mod.java b/common/cpw/mods/fml/common/Mod.java index a608fc7fcd..e69d0a4235 100644 --- a/common/cpw/mods/fml/common/Mod.java +++ b/common/cpw/mods/fml/common/Mod.java @@ -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 ""; /** diff --git a/common/cpw/mods/fml/server/FMLServerHandler.java b/common/cpw/mods/fml/server/FMLServerHandler.java index 5fd6458ee6..a6bbdf7a54 100644 --- a/common/cpw/mods/fml/server/FMLServerHandler.java +++ b/common/cpw/mods/fml/server/FMLServerHandler.java @@ -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