Add documentation for the registration package.

This commit is contained in:
bspeice 2013-12-01 09:49:11 -05:00
parent 2910d406d9
commit 8437968f88
3 changed files with 7 additions and 3 deletions

View File

@ -3,6 +3,8 @@ package com.uncc.gameday.registration;
// TODO: Auto-generated Javadoc // TODO: Auto-generated Javadoc
/** /**
* The Class Attendee. * 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 { public class Attendee {
@ -110,7 +112,4 @@ public class Attendee {
public void setId(int id) { public void setId(int id) {
this.id = id; this.id = id;
} }
} }

View File

@ -8,6 +8,8 @@ import retrofit.client.Response;
// TODO: Auto-generated Javadoc // TODO: Auto-generated Javadoc
/** /**
* The Class AttendeeCallback. * 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<Attendee> { public class AttendeeCallback implements Callback<Attendee> {

View File

@ -11,6 +11,9 @@ import com.uncc.gameday.rest.GamedayService;
// TODO: Auto-generated Javadoc // TODO: Auto-generated Javadoc
/** /**
* The Class RegistrationClient. * 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 { public class RegistrationClient {