From 8437968f88e63faef3bf42d2148fd79095b33299 Mon Sep 17 00:00:00 2001 From: bspeice Date: Sun, 1 Dec 2013 09:49:11 -0500 Subject: [PATCH] Add documentation for the registration package. --- src/com/uncc/gameday/registration/Attendee.java | 5 ++--- src/com/uncc/gameday/registration/AttendeeCallback.java | 2 ++ src/com/uncc/gameday/registration/RegistrationClient.java | 3 +++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/com/uncc/gameday/registration/Attendee.java b/src/com/uncc/gameday/registration/Attendee.java index 9fdde84..f86385a 100644 --- a/src/com/uncc/gameday/registration/Attendee.java +++ b/src/com/uncc/gameday/registration/Attendee.java @@ -3,6 +3,8 @@ package com.uncc.gameday.registration; // TODO: Auto-generated Javadoc /** * The Class Attendee. + * Basic POJO for communicating information about people registered to attend + * a game, and for sending that information to the server. */ public class Attendee { @@ -110,7 +112,4 @@ public class Attendee { public void setId(int id) { this.id = id; } - - - } diff --git a/src/com/uncc/gameday/registration/AttendeeCallback.java b/src/com/uncc/gameday/registration/AttendeeCallback.java index 1a584c4..f02b462 100644 --- a/src/com/uncc/gameday/registration/AttendeeCallback.java +++ b/src/com/uncc/gameday/registration/AttendeeCallback.java @@ -8,6 +8,8 @@ import retrofit.client.Response; // TODO: Auto-generated Javadoc /** * The Class AttendeeCallback. + * Used to implement a POST callback for Retrofit. Same deal as the ParkingCallback, + * not sure it's needed, but makes our lives easy if we need to change it later. */ public class AttendeeCallback implements Callback { diff --git a/src/com/uncc/gameday/registration/RegistrationClient.java b/src/com/uncc/gameday/registration/RegistrationClient.java index 7fc7e09..5450b9e 100644 --- a/src/com/uncc/gameday/registration/RegistrationClient.java +++ b/src/com/uncc/gameday/registration/RegistrationClient.java @@ -11,6 +11,9 @@ import com.uncc.gameday.rest.GamedayService; // TODO: Auto-generated Javadoc /** * The Class RegistrationClient. + * Client used for wrapping around the service provided by Retrofit. This way, + * all the lower-level details are handled, and we can overload some behavior + * to enable working with different classes. */ public class RegistrationClient {