Clean up comment style

Mumfrey
1 parent cf05cbea
Showing 3 changed files with 54 additions and 39 deletions
src/main/java/com/examplemod/Clock.java
src/main/java/com/examplemod/ExampleModConfigPanel.java
src/main/java/com/examplemod/LiteModExample.java
@@ -12,25 +12,29 @@ import org.lwjgl.util.ReadableColor;
 import java.util.Calendar;
 /**
- * Simple implementation of an analogue clock to demonstrate how to LiteLoader all the things 
+ * Simple implementation of an analogue clock to demonstrate how to LiteLoader
+ * all the things 
  *
  * @author Adam Mummery-Smith
  */
 public class Clock
 {
 	/**
-	 * This is the clock face resource, you need to create a resource location for any assets that you
-	 * wish to use. It is best to make these static to avoid new instances being created for every instance
-	 * of the referencing object, this also means they will only be garbage collected when the class is
-	 * garbage collected or when no instances of the class are left.
+	 * This is the clock face resource, you need to create a resource location
+	 * for any assets that you wish to use. It is best to make these static to
+	 * avoid new instances being created for every instance of the referencing
+	 * object, this also means they will only be garbage collected when the
+	 * class is garbage collected or when no instances of the class are left.
 	 * 
-	 * The first parameter for the resource location is the "domain" and this should normally be your mod's
-	 * name. The domain MUST be lower case! The second is the resource "path" and represents the path to the
-	 * resource within the domain. It is convention that the path always start with the resource type, such
-	 * as "textures" in this case.
+	 * <p>The first parameter for the resource location is the "domain" and this
+	 * should normally be your mod's name. The domain MUST be lower case! The
+	 * second is the resource "path" and represents the path to the resource
+	 * within the domain. It is convention that the path always start with the
+	 * resource type, such as "textures" in this case.</p>
 	 * 
-	 * Resources are always stored in a path of the form "assets/{domain}/{path}" which makes the appropriate
-	 * path to the CLOCKFACE resource: "/assets/example/textures/clock/face.png"
+	 * <p>Resources are always stored in a path of the form
+	 * "assets/{domain}/{path}" which makes the appropriate path to the
+	 * CLOCKFACE resource: "/assets/example/textures/clock/face.png"</p>
 	 */
 	private static final ResourceLocation CLOCKFACE = new ResourceLocation("example", "textures/clock/face.png");
@@ -228,8 +232,8 @@ public class Clock
 		float texMapScale = 0.001953125F; // 512px
-        // We use the tessellator rather than drawing individual quads because it uses vertex arrays to
-        // draw the quads more efficiently.
+        // We use the tessellator rather than drawing individual quads because
+		// it uses vertex arrays to draw the quads more efficiently.
 		Tessellator tessellator = Tessellator.getInstance();
 		BufferBuilder worldRenderer = tessellator.getBuffer();
         worldRenderer.begin(GL_QUADS, POSITION_TEX);
@@ -7,9 +7,9 @@ import com.mumfrey.liteloader.modconfig.ConfigPanelHost;
 import net.minecraft.client.resources.I18n;
 /**
- * This is a simple example of adding a config panel to a mod. Your LiteMod class should implement
- * {@link Configurable} and return this class in order to support the settings functionality of the
- * mod panel.
+ * This is a simple example of adding a config panel to a mod. Your LiteMod
+ * class should implement {@link Configurable} and return this class in order to
+ * support the settings functionality of the mod panel.
  * 
  * @author Adam Mummery-Smith
  */
@@ -25,7 +25,8 @@ public class ExampleModConfigPanel extends AbstractConfigPanel
     }
     /* (non-Javadoc)
-     * @see com.mumfrey.liteloader.modconfig.AbstractConfigPanel#addOptions(com.mumfrey.liteloader.modconfig.ConfigPanelHost)
+     * @see com.mumfrey.liteloader.modconfig.AbstractConfigPanel#addOptions(
+     *      com.mumfrey.liteloader.modconfig.ConfigPanelHost)
      */
     @Override
     protected void addOptions(ConfigPanelHost host)
@@ -46,7 +47,8 @@ public class ExampleModConfigPanel extends AbstractConfigPanel
     @Override
     public void onPanelHidden()
     {
-        // This example applies the changes immediately, however you may wish to only save changes
-        // when the user clicks "save and close". In which case you should apply your changes here
+        // This example applies the changes immediately, however you may wish to
+        // only save changes when the user clicks "save and close". In which
+        // case you should apply your changes here
     }
 }
@@ -17,8 +17,9 @@ import org.lwjgl.input.Keyboard;
 import java.io.File;
 /**
- * This is a very simple example LiteMod, it draws an analogue clock on the minecraft HUD using
- * a traditional onTick hook supplied by LiteLoader's "Tickable" interface.
+ * This is a very simple example LiteMod, it draws an analogue clock on the
+ * minecraft HUD using a traditional onTick hook supplied by LiteLoader's
+ * {@link Tickable} interface.
  *
  * @author Adam Mummery-Smith
  */
@@ -31,9 +32,11 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 	private Clock clock = new Clock(10, 10);
 	/**
-	 * This is a keybinding that we will register with the game and use to toggle the clock
+	 * This is a keybinding that we will register with the game and use to
+	 * toggle the clock
 	 * 
-	 * Notice that we specify the key name as an *unlocalised* string. The localisation is provided from the included resource file
+	 * Notice that we specify the key name as an *unlocalised* string. The
+	 * localisation is provided from the included resource file.
 	 */
 	private static KeyBinding clockKeyBinding = new KeyBinding("key.clock.toggle", Keyboard.KEY_F12, "key.categories.litemods");
@@ -46,16 +49,18 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 	private boolean clockVisible = true;
 	/**
-	 * Default constructor. All LiteMods must have a default constructor. In general you should do very little
-	 * in the mod constructor EXCEPT for initialising any non-game-interfacing components or performing
-	 * sanity checking prior to initialisation
+	 * Default constructor. All LiteMods must have a default constructor. In
+	 * general you should do very little in the mod constructor EXCEPT for
+	 * initialising any non-game-interfacing components or performing sanity
+	 * checking prior to initialisation
 	 */
 	public LiteModExample()
 	{
 	}
 	/**
-	 * getName() should be used to return the display name of your mod and MUST NOT return null
+	 * getName() should be used to return the display name of your mod and MUST
+	 * NOT return null
 	 * 
 	 * @see com.mumfrey.liteloader.LiteMod#getName()
 	 */
@@ -66,8 +71,8 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 	}
 	/**
-	 * getVersion() should return the same version string present in the mod metadata, although this is
-	 * not a strict requirement.
+	 * getVersion() should return the same version string present in the mod
+	 * metadata, although this is not a strict requirement.
 	 * 
 	 * @see com.mumfrey.liteloader.LiteMod#getVersion()
 	 */
@@ -84,16 +89,17 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 	}
 	/**
-	 * init() is called very early in the initialisation cycle, before the game is fully initialised, this
-	 * means that it is important that your mod does not interact with the game in any way at this point.
+	 * init() is called very early in the initialisation cycle, before the game
+	 * is fully initialised, this means that it is important that your mod does
+	 * not interact with the game in any way at this point.
 	 * 
 	 * @see com.mumfrey.liteloader.LiteMod#init(java.io.File)
 	 */
 	@Override
 	public void init(File configPath)
 	{
-		// The key binding declared above won't do anything unless we register it, ModUtilties provides 
-		// a convenience method for this
+		// The key binding declared above won't do anything unless we register
+	    // it, LiteLoader's Input manager provides a convenience method for this
 		LiteLoader.getInput().registerKeyBinding(LiteModExample.clockKeyBinding);
 		this.clock.setSize(this.clockSize);
@@ -101,9 +107,11 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 	}
 	/**
-	 * upgradeSettings is used to notify a mod that its version-specific settings are being migrated
+	 * upgradeSettings is used to notify a mod that its version-specific
+	 * settings are being migrated
 	 * 
-	 * @see com.mumfrey.liteloader.LiteMod#upgradeSettings(java.lang.String, java.io.File, java.io.File)
+	 * @see com.mumfrey.liteloader.LiteMod#upgradeSettings(java.lang.String,
+	 *         java.io.File, java.io.File)
 	 */
 	@Override
 	public void upgradeSettings(String version, File configPath, File oldConfigPath)
@@ -113,8 +121,9 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 	@Override
 	public void onTick(Minecraft minecraft, float partialTicks, boolean inGame, boolean clock)
 	{
-		// The three checks here are critical to ensure that we only draw the clock as part of the "HUD"
-		// and don't draw it over active GUI's or other elements
+		// The three checks here are critical to ensure that we only draw the
+	    // clock as part of the "HUD" and don't draw it over active GUI's or
+	    // other elements
 		if (inGame && minecraft.currentScreen == null && Minecraft.isGuiEnabled())
 		{
 			if (LiteModExample.clockKeyBinding.isPressed())
@@ -131,8 +140,8 @@ public class LiteModExample implements Tickable, PreRenderListener, Configurable
 					this.clockVisible = this.clock.isVisible();
 				}
-				// Our @Expose annotations control what properties get saved, this tells liteloader to
-				// actually write the properties to disk
+				// Our @Expose annotations control what properties get saved,
+				// this tells liteloader to actually write properties to disk
 				LiteLoader.getInstance().writeConfig(this);
 			}