Permalink
Browse files

Second pass at javadocs

  • Loading branch information...
1 parent 85c7964 commit bbb9bdfa41b920f058eac800e5a3658549005808 Sam Karp committed Apr 25, 2011
@@ -20,7 +20,8 @@
// TODO: Auto-generated Javadoc
/**
- * The Class GeoCamMemoCreateActivity.
+ * The Class GeoCamMemoCreateActivity. This activity gives the
+ * user the opportunity to add a new memo
*/
public class GeoCamMemoCreateActivity extends RoboActivity {
@@ -48,18 +49,20 @@ public void onCreate(Bundle savedInstanceState) {
}
/**
- * On home click.
+ * On home click, restart the {@link GeoCamMemoHomeActivity}.
*
- * @param v the v
+ * @param v the view
*/
public void onHomeClick(View v) {
UIUtils.goHome(this);
}
/**
- * On send click.
+ * On send click, create a new {@link GeoCamMemoMessage} using the
+ * text and time stamp from the {@link GeoCamMemoCreateActivity}. Populate
+ * the location if available.
*
- * @param v the v
+ * @param v the view
*/
public void onSendClick(View v) {
CharSequence text = newMemoInput.getText();
@@ -80,7 +80,7 @@ public void onItemClick(AdapterView<?> parentView, View childView,
}
/**
- * On create memo click.
+ * On create memo click, start the {@link GeoCamMemoCreateActivity}
*
* @param v the v
*/
@@ -94,7 +94,7 @@ public void onCreate(Bundle savedInstanceState){
/**
* On home click.
*
- * @param v the v
+ * @param v the view
*/
public void onHomeClick(View v) {
UIUtils.goHome(this);
@@ -1,8 +1,8 @@
package gov.nasa.arc.geocam.memo.exception;
-// TODO: Auto-generated Javadoc
/**
- * The Class AuthenticationFailedException.
+ * The Class AuthenticationFailedException which is thrown when we can't log
+ * into the server because of a bad username and password combination.
*/
public class AuthenticationFailedException extends Exception {

0 comments on commit bbb9bdf

Please sign in to comment.