Edited documentation

Author: nmanoogian

.gitignore

@@ -1,3 +1,4 @@
 *.class
 testing
 doc
+Pixelife.sublime*

ConformingPix.java

@@ -1,3 +1,8 @@
+/**
+ * Class ConformingPix
+ * @author Nic Manoogian <[email protected]>
+ * @author Mike Lyons
+ */
 public class ConformingPix extends Pix
 {
 
@@ -10,6 +15,6 @@ public ConformingPix()
 
 	public void interact(Pix p)
 	{
-		
+
 	}
 }

DirectedPix.java

@@ -1,3 +1,9 @@
+/**
+ * Class Directed Pix
+ * Pixel only move in one direction
+ * @author Nic Manoogian <[email protected]>
+ * @author Mike Lyons
+ */
 
 public class DirectedPix extends Pix
 {
@@ -20,7 +26,9 @@ public void setDir(int dir)
 	}
 
 	/**
-	 * Updates this specific pix, moving it in it's direction
+	 * Updates specific Pix, moving it in it's direction using its location
+	 * @param i x location
+	 * @param j y location
 	 */
 	public void update(int i, int j)
 	{

Pix.java

@@ -286,7 +286,9 @@ public void trans(Pix[][] grid, int ix, int iy, int x, int y)
 	}
 
 	/**
-	 * Updates this specific pix, moving it randomly
+	 * Updates this specific Pix, choosing a direction and moving it randomly
+	 * @param i x location
+	 * @param j y location
 	 */
 	public void update(int i, int j)
 	{
@@ -297,6 +299,10 @@ public void update(int i, int j)
 
 	/**
 	 * Moves the direction given (N S E W)
+	 * @param grid PixGrid object
+	 * @param dirNum direction to move
+	 * @param i x location of pixel
+	 * @param j y location of pixel
 	 */
 	public void moveDir(Pix[][] grid, int dirNum, int i, int j)
 	{

Pixelife.java

@@ -35,8 +35,11 @@ public Pixelife(int w, int h, int n)
 		height = h;
 
 		myGrid = new PixGrid(w, h, n);
-		//line_spawner = new Spawner(DirectedPix.class, myGrid, 0, h/2);
-		spawner = new Spawner(PulsePix.class, myGrid);
+		Spawner vline_spawner = new Spawner(DirectedPix.class, myGrid, 2, h/2);
+		vline_spawner.spawn(5);
+		Spawner hline_spawner = new Spawner(DirectedPix.class, myGrid, 0, h/2);
+		hline_spawner.spawn(5);
+		spawner = new Spawner(NonconformingPix.class, myGrid);
 		spawner.spawn(10);
 	}
 

Spawner.java

@@ -56,14 +56,22 @@ public Spawner(Class<?> c)
 	/**
 	 * Creates a Spawner that will spawn a given class to a given grid
 	 * @param c Class to spawn (PulsePix.class)
-	 * @param grid pixgrid112
+	 * @param grid PixGrid object
 	 */
 	public Spawner(Class<?> c, PixGrid grid)
 	{
 		this();
 		this.spawnClass = c;
 		this.grid = grid;
 	}
+
+	/**
+	 * Creates a Spawner with a give class, grid and x and y velocities
+	 * @param c Class to spawn
+	 * @param grid PixGrid object
+	 * @param dx x velocity
+	 * @param dy y velocity
+	 */
 	public Spawner(Class<?> c, PixGrid grid, int dx, int dy)
 	{
 		this(c, grid);
@@ -74,6 +82,9 @@ public Spawner(Class<?> c, PixGrid grid, int dx, int dy)
 		this.defaultY = dy;
 	}
 
+	/**
+	 * Spawns random instances of the spawn class to the grid
+	 */
 	public void spawn()
 	{
 		if(Pix.class.isAssignableFrom(spawnClass))
@@ -97,6 +108,11 @@ public void spawn()
 			System.out.println("Class not found");
 		}
 	}
+
+	/**
+	 * Spawns a number of instances of the spawn class to the grid
+	 * @param num number of instances to spawn
+	 */
 	public void spawn(int num)
 	{
 		if(Pix.class.isAssignableFrom(spawnClass))
@@ -119,6 +135,12 @@ public void spawn(int num)
 		}
 	}
 
+	/**
+	 * Spawns a specific instance of a class to a specific x and y location
+	 * @param c class to spawn
+	 * @param x x location to spawn
+	 * @param y y location to spawn
+	 */
 	public static void spawnXY(Class<?> c, int x, int y)
 	{
 		if(Pix.class.isAssignableFrom(c))
@@ -135,6 +157,9 @@ public static void spawnXY(Class<?> c, int x, int y)
 		}
 	}
 
+	/**
+	 * Determines if a spawn is necessary, otherwise, increase counter
+	 */
 	public void update()
 	{
 		if( respawnMax != -1 )