From 2910d406d9c442bfedb7247536db1ec0e223ddc4 Mon Sep 17 00:00:00 2001
From: bspeice <bspeice@uncc.edu>
Date: Sun, 1 Dec 2013 09:46:52 -0500
Subject: [PATCH] Add documentation for the parking package

---
 src/com/uncc/gameday/parking/ParkingClient.java      | 10 +++++-----
 src/com/uncc/gameday/parking/ParkingLot.java         |  3 ++-
 src/com/uncc/gameday/parking/ParkingLotCallback.java |  6 ++++--
 src/com/uncc/gameday/parking/RatingChoices.java      |  8 ++++----
 4 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/src/com/uncc/gameday/parking/ParkingClient.java b/src/com/uncc/gameday/parking/ParkingClient.java
index 2c9bb14..2d6774f 100644
--- a/src/com/uncc/gameday/parking/ParkingClient.java
+++ b/src/com/uncc/gameday/parking/ParkingClient.java
@@ -14,13 +14,13 @@ import com.uncc.gameday.rest.GamedayService;
  */
 public class ParkingClient {
 
-	/** The gds. */
+	/** The GamedayService reference */
 	private GamedayService gds;
 	
 	/**
 	 * Instantiates a new parking client.
 	 *
-	 * @param c the c
+	 * @param c - The context used to access the Resource file
 	 */
 	public ParkingClient(Context c) {
 		RestAdapter ra = new RestAdapter.Builder()
@@ -30,7 +30,7 @@ public class ParkingClient {
 	}
 	
 	/**
-	 * List lots.
+	 * List all parking lots
 	 *
 	 * @return the list
 	 */
@@ -81,7 +81,7 @@ public class ParkingClient {
 	}
 	
 	/**
-	 * List lot location.
+	 * Get the coordinates for a specific parking lot
 	 *
 	 * @param p the p
 	 * @return the parking lot
@@ -93,7 +93,7 @@ public class ParkingClient {
 	}
 	
 	/**
-	 * List lot location.
+	 * Get the coordinates for a specific parking lot
 	 *
 	 * @param c the c
 	 * @return the parking lot
diff --git a/src/com/uncc/gameday/parking/ParkingLot.java b/src/com/uncc/gameday/parking/ParkingLot.java
index cd086dd..5bfb98b 100644
--- a/src/com/uncc/gameday/parking/ParkingLot.java
+++ b/src/com/uncc/gameday/parking/ParkingLot.java
@@ -1,8 +1,9 @@
 package com.uncc.gameday.parking;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class ParkingLot.
+ * Basic POJO used for communicating information about each Parking lot
+ * between the Gameday app and server-side implementation
  */
 public class ParkingLot {
 	
diff --git a/src/com/uncc/gameday/parking/ParkingLotCallback.java b/src/com/uncc/gameday/parking/ParkingLotCallback.java
index c5f4fa4..427863d 100644
--- a/src/com/uncc/gameday/parking/ParkingLotCallback.java
+++ b/src/com/uncc/gameday/parking/ParkingLotCallback.java
@@ -5,9 +5,11 @@ import retrofit.Callback;
 import retrofit.RetrofitError;
 import retrofit.client.Response;
 
-// TODO: Auto-generated Javadoc
 /**
- * The Class ParkingLotCallback.
+ * Utility class used by Retrofit for implementing a callback on POST.
+ * Why they can't use a synchronous POST is beyond me.
+ * This class is likely un-needed, but allows for easy change in the future
+ * if needed.
  */
 public class ParkingLotCallback implements Callback<ParkingLot> {
 
diff --git a/src/com/uncc/gameday/parking/RatingChoices.java b/src/com/uncc/gameday/parking/RatingChoices.java
index b916efb..05ba86f 100644
--- a/src/com/uncc/gameday/parking/RatingChoices.java
+++ b/src/com/uncc/gameday/parking/RatingChoices.java
@@ -6,16 +6,16 @@ package com.uncc.gameday.parking;
  */
 public enum RatingChoices {
 	
-	/** The emp. */
+	/** An Empty rating (0% full) */
 	EMP ("EMPTY"),
 	
-	/** The sct. */
+	/** A Scattered rating (33% full) */
 	SCT ("SCATTERED"),
 	
-	/** The bsy. */
+	/** A Busy rating (66% full) */
 	BSY ("BUSY"),
 	
-	/** The fll. */
+	/** A Full rating (100% full) */
 	FLL ("FULL");
 	
 	/** The choice. */