Updated javadocs

android/src/gov/nasa/arc/geocam/talk/activity/GeoCamTalkLogon.java

@@ -17,7 +17,6 @@
 
 
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class GeoCamTalkLogon.
  */

android/src/gov/nasa/arc/geocam/talk/activity/GeoCamTalkMapActivity.java

@@ -22,7 +22,6 @@
 import com.google.android.maps.Overlay;
 import com.google.android.maps.OverlayItem;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class GeoCamTalkMapActivity.
  */

android/src/gov/nasa/arc/geocam/talk/activity/SettingsActivity.java

@@ -4,7 +4,6 @@
 import roboguice.activity.RoboPreferenceActivity;
 import android.os.Bundle;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class SettingsActivity.
  */

android/src/gov/nasa/arc/geocam/talk/bean/GeoCamTalkMessage.java

@@ -8,8 +8,6 @@
 import com.j256.ormlite.field.DatabaseField;
 import com.j256.ormlite.table.DatabaseTable;
 
-
-// TODO: Auto-generated Javadoc
 /**
  * The Class GeoCamTalkMessage.
  */

android/src/gov/nasa/arc/geocam/talk/bean/ServerResponse.java

@@ -7,7 +7,6 @@
 
 import org.apache.http.HttpResponse;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class ServerResponse is an object which provides 
  * easy access to the HTTP response code and content 

android/src/gov/nasa/arc/geocam/talk/bean/TalkServerIntent.java

@@ -1,41 +1,44 @@
 package gov.nasa.arc.geocam.talk.bean;
 
-// TODO: Auto-generated Javadoc
+import gov.nasa.arc.geocam.talk.service.IMessageStore;
+import gov.nasa.arc.geocam.talk.service.ISiteAuth;
+import gov.nasa.arc.geocam.talk.service.ITalkServer;
+
 /**
- * The Enum TalkServerIntent.
+ * Intent identifiers for various django server actions.
  */
 public enum TalkServerIntent {
 
 
-	/** The INTENT_new_messages. */
+	/** Intent to announce to activities that new messages are available in an {@link IMessageStore} object */
 	INTENT_NEW_MESSAGES("gov.nasa.arc.geocam.talk.NEW_MESSAGE"),
 
-	/** The INTENT_synchronize. */
+	/** Intent to request that a {@link ITalkServer synchronize with the django server */	
 	INTENT_SYNCHRONIZE("gov.nasa.arc.geocam.talk.syncrhonize"),
 
-	/** The INTENT_store_c2dm_id. */
+	/** Intent to store the C2DM Registration id to the django server */
 	INTENT_STORE_C2DM_ID("gov.nasa.arc.geocam.talk.c2dm_id_store"),
 
-	/** The INTENT_pushed_message. */
+	/** Intent to signal a pushed message to listening activities */
 	INTENT_PUSHED_MESSAGE("gov.nasa.arc.geocam.talk.pushed_message"),
 
-	/** The INTENT_login_failed. */
+	/** Intent to alert current activity that authentication with the service has failed */
 	INTENT_LOGIN_FAILED("gov.nasa.arc.geocam.talk.login_failed"),
 
-	/** The INTENT_login. */
+	/** Intent to attempt manual login by an {@link ISiteAuth} object. */
 	INTENT_LOGIN("gov.nasa.arc.geocam.talk.login"),
 
-	/** The EXTRA message_id. */
+	/** The intent extra, message_id. */
 	EXTRA_MESSAGE_ID("message_id"),
 
-	/** The EXTRa_registration_id. */
+	/** The intent extra, registration_id. */
 	EXTRA_REGISTRATION_ID("registration_id");
 
 	/** The value. */
 	private String value;
 
 	/**
-	 * Instantiates a new talk server intent.
+	 * Instantiates a new talk server intent identifier from the enum.
 	 *
 	 * @param value the value
 	 */

android/src/gov/nasa/arc/geocam/talk/service/GeoCamSynchronizationTimerTask.java

@@ -4,7 +4,6 @@
 
 import com.google.inject.Inject;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class GeoCamSynchronizationTimerTask.
  */

android/src/gov/nasa/arc/geocam/talk/service/GeoLocationListener.java

@@ -5,53 +5,67 @@
 import android.os.Bundle;
 import android.util.Log;
 
-// TODO: Auto-generated Javadoc
 /**
- * The listener interface for receiving geoLocation events.
- * The class that is interested in processing a geoLocation
- * event implements this interface, and the object created
- * with that class is registered with a component using the
+ * The listener interface for receiving geoLocation events. The class that is
+ * interested in processing a geoLocation event implements this interface, and
+ * the object created with that class is registered with a component using the
  * component's <code>addGeoLocationListener<code> method. When
  * the geoLocation event occurs, that object's appropriate
  * method is invoked.
- *
+ * 
  * @see GeoLocationEvent
  */
 public class GeoLocationListener implements LocationListener {
 
 	/** The cur location. */
 	private Location curLocation;
-
-	/* (non-Javadoc)
-	 * @see android.location.LocationListener#onLocationChanged(android.location.Location)
+
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see
+	 * android.location.LocationListener#onLocationChanged(android.location.
+	 * Location)
 	 */
 	@Override
 	public void onLocationChanged(Location location) {
 		curLocation = location;
 		Log.d("location", "location listened");
 	}
 
-	/* (non-Javadoc)
-	 * @see android.location.LocationListener#onProviderDisabled(java.lang.String)
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see
+	 * android.location.LocationListener#onProviderDisabled(java.lang.String)
 	 */
 	@Override
-	public void onProviderDisabled(String provider) { }
+	public void onProviderDisabled(String provider) {
+	}
 
-	/* (non-Javadoc)
-	 * @see android.location.LocationListener#onProviderEnabled(java.lang.String)
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see
+	 * android.location.LocationListener#onProviderEnabled(java.lang.String)
 	 */
 	@Override
-	public void onProviderEnabled(String provider) { }
+	public void onProviderEnabled(String provider) {
+	}
 
-	/* (non-Javadoc)
-	 * @see android.location.LocationListener#onStatusChanged(java.lang.String, int, android.os.Bundle)
+	/*
+	 * (non-Javadoc)
+	 * 
+	 * @see android.location.LocationListener#onStatusChanged(java.lang.String,
+	 * int, android.os.Bundle)
 	 */
 	@Override
-	public void onStatusChanged(String provider, int status, Bundle extras) { }
+	public void onStatusChanged(String provider, int status, Bundle extras) {
+	}
 
 	/**
 	 * Gets the location.
-	 *
+	 * 
 	 * @return the location
 	 */
 	public Location getLocation() {

android/src/gov/nasa/arc/geocam/talk/service/IntentHelper.java

@@ -10,8 +10,6 @@
 
 import com.google.inject.Inject;
 
-
-// TODO: Auto-generated Javadoc
 /**
  * The Class IntentHelper.
  */

android/src/gov/nasa/arc/geocam/talk/service/MessageStore.java

@@ -18,7 +18,6 @@
 import com.j256.ormlite.stmt.QueryBuilder;
 import com.j256.ormlite.stmt.SelectArg;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class MessageStore.
  */

android/src/gov/nasa/arc/geocam/talk/service/SiteAuthCookie.java

@@ -36,7 +36,6 @@
 
 import com.google.inject.Inject;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class SiteAuthCookie.
  */

android/src/gov/nasa/arc/geocam/talk/service/TalkJsonConverter.java

@@ -14,7 +14,6 @@
 import com.google.gson.JsonParser;
 import com.google.gson.reflect.TypeToken;
 
-// TODO: Auto-generated Javadoc
 /**
  * The Class TalkJsonConverter.
  */

android/src/gov/nasa/arc/geocam/talk/service/TalkMapOverlay.java

@@ -7,7 +7,7 @@
 import com.google.android.maps.ItemizedOverlay;
 import com.google.android.maps.OverlayItem;
 
-// TODO: Auto-generated Javadoc
+
 /**
  * The Class TalkMapOverlay which creates a marker on the 
  * Talk map where the Talk Message was sent from..

android/src/gov/nasa/arc/geocam/talk/service/TalkServer.java

@@ -24,7 +24,7 @@
 
 import com.google.inject.Inject;
 
-// TODO: Auto-generated Javadoc
+
 /**
  * The Class TalkServer.
  */
@@ -70,7 +70,7 @@ public class TalkServer extends RoboIntentService implements ITalkServer {
 	@Inject
 	IAudioPlayer audioPlayer;
 
-	/** The geo cam synchronization timer task. */
+	/** The geo cam synchronization timer task responsible for periodically forcing a synch with the server. */
 	@Inject
 	IGeoCamSynchronizationTimerTask geoCamSynchronizationTimerTask;
 
@@ -84,13 +84,13 @@ public TalkServer() {
 		super("DjangoTalkService");
 	}
 
-	/** The max message id. */
+	/** The largest message id that this instance is aware of existing on the server. */
 	private static int maxMessageId = 0;
 
 	/**
-	 * Gets the talk messages.
+	 * Gets the talk messages from the server.
 	 *
-	 * @return the talk messages
+	 * @return the talk messages found on the server
 	 * @throws SQLException the sQL exception
 	 * @throws ClientProtocolException the client protocol exception
 	 * @throws AuthenticationFailedException the authentication failed exception
@@ -128,7 +128,7 @@ public void getTalkMessages() throws SQLException, ClientProtocolException,
 	}
 
 	/**
-	 * Creates the talk message.
+	 * Creates a talk message on the server
 	 *
 	 * @param message the message
 	 * @throws ClientProtocolException the client protocol exception
@@ -194,7 +194,7 @@ protected void onHandleIntent(Intent intent) {
 	}
 
 	/**
-	 * Handle login.
+	 * Handle login intent.
 	 */
 	private void handleLogin() {
 		try {
@@ -246,7 +246,7 @@ private void handleStoreRegistrationIdIntent(String registrationId) { // assumed
 	}
 
 	/**
-	 * Handle the pushed mess.
+	 * Handle the pushed message intent
 	 *
 	 * @param messageId the message id
 	 */