Comments

9 files changed, 55 insertions, 13 deletions

diff --git a/app/src/main/java/com/camilstaps/rushhour/Car.java b/app/src/main/java/com/camilstaps/rushhour/Car.java
index daf25d5..8c81f3c 100755
--- a/app/src/main/java/com/camilstaps/rushhour/Car.java
+++ b/app/src/main/java/com/camilstaps/rushhour/Car.java
@@ -49,6 +49,12 @@ public class Car {
 
     ImageView iv;
 
+    /**
+     * The start coordinate should be to the north west of the end coordinate
+     * Default colour: black
+     * @param start
+     * @param end
+     */
     public Car(Coordinate start, Coordinate end) {
         startCoordinate = start;
         endCoordinate = end;
@@ -61,12 +67,6 @@ public class Car {
         this.colour = colour;
     }
 
-    public Car(Car car) {
-        startCoordinate = car.startCoordinate;
-        endCoordinate = car.endCoordinate;
-        colour = car.colour;
-    }
-
     public void setMoveListener(MoveListener listener) {
         moveListener = listener;
     }
@@ -77,6 +77,12 @@ public class Car {
         iv.setLayoutParams(marginParams);
     }
 
+    /**
+     * Give the car a random imageview
+     * @param context
+     * @param widthPerCell
+     * @return
+     */
     public ImageView getImageView(Context context, float widthPerCell) {
 
         this.widthPerCell = widthPerCell - MARGIN;
@@ -149,6 +155,7 @@ public class Car {
 
         return (float)degrees;
     }
+
     private int getCarLength()
     {
         if(startCoordinate.getX() == endCoordinate.getX())
@@ -189,6 +196,11 @@ public class Car {
         setLayoutParams();
     }
 
+    /**
+     * Coordinate the car would move to if it would move with the specified offset
+     * @param offset
+     * @return
+     */
     public Coordinate wouldMoveTo(int offset) {
         Coordinate movedCoordinate;
         if (offset < 0) {
@@ -204,10 +216,21 @@ public class Car {
         return movedCoordinate;
     }
 
+    /**
+     * Whether the car occupies c or not
+     * @param c
+     * @return
+     */
     public boolean occupies(Coordinate c) {
-        return c.getX() >= startCoordinate.getX() && c.getX() <= endCoordinate.getX() && c.getY() >= startCoordinate.getY() && c.getY() <= endCoordinate.getY();
+        return c.getX() >= startCoordinate.getX()
+                && c.getX() <= endCoordinate.getX()
+                && c.getY() >= startCoordinate.getY()
+                && c.getY() <= endCoordinate.getY();
     }
 
+    /**
+     * Request to move on swipe
+     */
     private class GestureListener extends GestureDetector.SimpleOnGestureListener {
         private static final int SWIPE_MIN_DISTANCE = SIZE;
         private static final int SWIPE_THRESHOLD_VELOCITY = SIZE;
diff --git a/app/src/main/java/com/camilstaps/rushhour/Coordinate.java b/app/src/main/java/com/camilstaps/rushhour/Coordinate.java
index aeaede7..90f6c76 100644
--- a/app/src/main/java/com/camilstaps/rushhour/Coordinate.java
+++ b/app/src/main/java/com/camilstaps/rushhour/Coordinate.java
@@ -19,6 +19,7 @@
 package com.camilstaps.rushhour;
 
 /**
+ * This is pretty straightforward.
  * Created by camilstaps on 16-4-15.
  */
 public class Coordinate {
diff --git a/app/src/main/java/com/camilstaps/rushhour/FinishedActivity.java b/app/src/main/java/com/camilstaps/rushhour/FinishedActivity.java
index f7f7450..1312f1f 100644
--- a/app/src/main/java/com/camilstaps/rushhour/FinishedActivity.java
+++ b/app/src/main/java/com/camilstaps/rushhour/FinishedActivity.java
@@ -40,6 +40,7 @@ public class FinishedActivity extends ActionBarActivity {
 
         final HighScoreList list = new HighScoreList(this);
 
+        // If there is a score, we add a new highscore (user can enter name)
         final int score = getIntent().getIntExtra("score", -1);
         if (score != -1) {
             TheSoundPool.getSoundPool(getBaseContext()).play(TheSoundPool.soundVictoryId, 1, 1, 1, 0, 1);
@@ -58,10 +59,9 @@ public class FinishedActivity extends ActionBarActivity {
                     .show();
         }
 
+        // Populate listview with highscores
         ListView highscoresListView = (ListView) findViewById(R.id.highscoresListView);
-
         HighScoreAdapter arrayAdapter = new HighScoreAdapter(this, R.layout.highscore_item, list.getList());
-
         highscoresListView.setAdapter(arrayAdapter);
     }
 
diff --git a/app/src/main/java/com/camilstaps/rushhour/GamePlayActivity.java b/app/src/main/java/com/camilstaps/rushhour/GamePlayActivity.java
index 90c5a63..529ca10 100755
--- a/app/src/main/java/com/camilstaps/rushhour/GamePlayActivity.java
+++ b/app/src/main/java/com/camilstaps/rushhour/GamePlayActivity.java
@@ -45,6 +45,9 @@ public class GamePlayActivity extends Activity implements Board.SolveListener {
         setupBoard();
     }
 
+    /**
+     * Create board, initialise listeners etc.
+     */
     private void setupBoard() {
         InputStream input = getResources().openRawResource(R.raw.level);
 
@@ -102,6 +105,10 @@ public class GamePlayActivity extends Activity implements Board.SolveListener {
         startActivityForResult(intent, 0);
     }
 
+    /**
+     * Just set up everything again for a reset
+     * @param v
+     */
     public void onClickHandler(View v) {
         switch (v.getId()) {
             case R.id.action_reset:
diff --git a/app/src/main/java/com/camilstaps/rushhour/HighScore.java b/app/src/main/java/com/camilstaps/rushhour/HighScore.java
index 0c12222..1ddeb0f 100644
--- a/app/src/main/java/com/camilstaps/rushhour/HighScore.java
+++ b/app/src/main/java/com/camilstaps/rushhour/HighScore.java
@@ -22,6 +22,7 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 /**
+ * Highscore exists of name and score (amount of moves; so lower is better)
  * Created by camilstaps on 23-4-15.
  * Edited by Halzyn on 23-4-15.
  */
diff --git a/app/src/main/java/com/camilstaps/rushhour/HighScoreList.java b/app/src/main/java/com/camilstaps/rushhour/HighScoreList.java
index 9576a52..81ebb17 100644
--- a/app/src/main/java/com/camilstaps/rushhour/HighScoreList.java
+++ b/app/src/main/java/com/camilstaps/rushhour/HighScoreList.java
@@ -36,10 +36,6 @@ public class HighScoreList {
     private final String PREFERENCES_KEY = "highscores";
     
     private ArrayList<HighScore> list;
-    
-    public HighScoreList (ArrayList<HighScore> some_list) {
-        this.list = some_list;
-    }
 
     /**
      * Get highscores from sharedpreferences
diff --git a/app/src/main/java/com/camilstaps/rushhour/MainActivity.java b/app/src/main/java/com/camilstaps/rushhour/MainActivity.java
index 1e578ca..f3e7ad3 100644
--- a/app/src/main/java/com/camilstaps/rushhour/MainActivity.java
+++ b/app/src/main/java/com/camilstaps/rushhour/MainActivity.java
@@ -29,6 +29,10 @@ import android.view.View;
  */
 public class MainActivity extends ActionBarActivity {
 
+    /**
+     * Set contentView and start music
+     * @param savedInstanceState
+     */
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
@@ -37,6 +41,10 @@ public class MainActivity extends ActionBarActivity {
         TheSoundPool.getSoundPool(this);
     }
 
+    /**
+     * Handler for Start & Highscores button
+     * @param v
+     */
     public void onClickHandler(View v) {
         Intent intent;
         switch (v.getId()) {
diff --git a/app/src/main/java/com/camilstaps/rushhour/MoveListener.java b/app/src/main/java/com/camilstaps/rushhour/MoveListener.java
index 441564b..c65cf01 100644
--- a/app/src/main/java/com/camilstaps/rushhour/MoveListener.java
+++ b/app/src/main/java/com/camilstaps/rushhour/MoveListener.java
@@ -22,5 +22,6 @@ package com.camilstaps.rushhour;
  * Created by camilstaps on 16-4-15.
  */
 public abstract class MoveListener {
+    // Called when a car moves
     public abstract void onMove(Car car, int offset);
 }
diff --git a/app/src/main/java/com/camilstaps/rushhour/TheSoundPool.java b/app/src/main/java/com/camilstaps/rushhour/TheSoundPool.java
index 5713136..4c58d01 100644
--- a/app/src/main/java/com/camilstaps/rushhour/TheSoundPool.java
+++ b/app/src/main/java/com/camilstaps/rushhour/TheSoundPool.java
@@ -13,6 +13,11 @@ public class TheSoundPool {
     private static SoundPool soundPool;
     public static int soundBackgroundId, soundCarDriveId, soundCantMoveId, soundVictoryId;
 
+    /**
+     * Initialise everything if not done yet
+     * @param context
+     * @return
+     */
     public static SoundPool getSoundPool(Context context) {
         if (soundPool == null) {
             soundPool = new SoundPool(2, AudioManager.STREAM_MUSIC, 0);