mirror-github-bspeice/UNCCGameDay
1
0
Fork 0
mirror of https://github.com/bspeice/UNCCGameDay synced 2024-11-05 15:48:13 -05:00
Code Issues Releases Wiki Activity

Add documentation for the parking package

Browse Source
This commit is contained in:
bspeice 2013-12-01 09:46:52 -05:00
parent 3d50f42f3b
commit 2910d406d9
4 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/com/uncc/gameday/parking/ParkingClient.java
View File

@ -14,13 +14,13 @@ import com.uncc.gameday.rest.GamedayService;
*/ */
public class ParkingClient { public class ParkingClient {
/** The gds. */ /** The GamedayService reference */
private GamedayService gds; private GamedayService gds;
/** /**
* Instantiates a new parking client. * Instantiates a new parking client.
* *
* @param c the c * @param c - The context used to access the Resource file
*/ */
public ParkingClient(Context c) { public ParkingClient(Context c) {
RestAdapter ra = new RestAdapter.Builder() RestAdapter ra = new RestAdapter.Builder()
@ -30,7 +30,7 @@ public class ParkingClient {
} }
/** /**
* List lots. * List all parking lots
* *
* @return the list * @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 * @param p the p
* @return the parking lot * @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 * @param c the c
* @return the parking lot * @return the parking lot

3
src/com/uncc/gameday/parking/ParkingLot.java
View File

@ -1,8 +1,9 @@
package com.uncc.gameday.parking; package com.uncc.gameday.parking;
// TODO: Auto-generated Javadoc
/** /**
* The Class ParkingLot. * The Class ParkingLot.
* Basic POJO used for communicating information about each Parking lot
* between the Gameday app and server-side implementation
*/ */
public class ParkingLot { public class ParkingLot {

6
src/com/uncc/gameday/parking/ParkingLotCallback.java
View File

@ -5,9 +5,11 @@ import retrofit.Callback;
import retrofit.RetrofitError; import retrofit.RetrofitError;
import retrofit.client.Response; 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> { public class ParkingLotCallback implements Callback<ParkingLot> {

8
src/com/uncc/gameday/parking/RatingChoices.java
View File

@ -6,16 +6,16 @@ package com.uncc.gameday.parking;
*/ */
public enum RatingChoices { public enum RatingChoices {
/** The emp. */ /** An Empty rating (0% full) */
EMP ("EMPTY"), EMP ("EMPTY"),
/** The sct. */ /** A Scattered rating (33% full) */
SCT ("SCATTERED"), SCT ("SCATTERED"),
/** The bsy. */ /** A Busy rating (66% full) */
BSY ("BUSY"), BSY ("BUSY"),
/** The fll. */ /** A Full rating (100% full) */
FLL ("FULL"); FLL ("FULL");
/** The choice. */ /** The choice. */