From 92ed470d1a8cc29a9de816efa2f385d1890a1d48 Mon Sep 17 00:00:00 2001
From: bspeice <bspeice@uncc.edu>
Date: Sun, 1 Dec 2013 09:51:59 -0500
Subject: [PATCH] Add documentation for the Retrofit adapter, and Twitter API
 client

---
 src/com/uncc/gameday/rest/GamedayService.java   | 1 +
 src/com/uncc/gameday/twitter/TwitterClient.java | 3 +++
 2 files changed, 4 insertions(+)

diff --git a/src/com/uncc/gameday/rest/GamedayService.java b/src/com/uncc/gameday/rest/GamedayService.java
index aaafc4a..40f3d3f 100644
--- a/src/com/uncc/gameday/rest/GamedayService.java
+++ b/src/com/uncc/gameday/rest/GamedayService.java
@@ -16,6 +16,7 @@ import com.uncc.gameday.registration.Attendee;
 // TODO: Auto-generated Javadoc
 /**
  * The Interface GamedayService.
+ * Used by Retrofit to make a super-simple REST adapter for Java.
  */
 public interface GamedayService {
 	
diff --git a/src/com/uncc/gameday/twitter/TwitterClient.java b/src/com/uncc/gameday/twitter/TwitterClient.java
index c60a0c9..038e717 100644
--- a/src/com/uncc/gameday/twitter/TwitterClient.java
+++ b/src/com/uncc/gameday/twitter/TwitterClient.java
@@ -13,6 +13,9 @@ import twitter4j.conf.ConfigurationBuilder;
 
 /**
  * The Class TwitterClient.
+ * Client used to interface with the Twitter API.
+ * Note that while it should be secure to store a Consumer Secret in this
+ * class, there is likely a better solution.
  */
 public class TwitterClient {