From b3ba48b28e302926784dbe90670753c300a0dc2d Mon Sep 17 00:00:00 2001
From: James Sanford <jsanford@froop.com>
Date: Thu, 25 Oct 2012 18:38:13 -0700
Subject: [PATCH] Add some helpful comments.

---
 src/com/froop/app/kegs/KegsKeyboard.java | 1 +
 src/com/froop/app/kegs/KegsThread.java   | 3 +++
 src/com/froop/app/kegs/KegsTouch.java    | 2 ++
 src/com/froop/app/kegs/KegsView.java     | 2 ++
 src/com/froop/app/kegs/KegsViewGL.java   | 2 ++
 5 files changed, 10 insertions(+)

diff --git a/src/com/froop/app/kegs/KegsKeyboard.java b/src/com/froop/app/kegs/KegsKeyboard.java
index eff441c..bfa4e05 100644
--- a/src/com/froop/app/kegs/KegsKeyboard.java
+++ b/src/com/froop/app/kegs/KegsKeyboard.java
@@ -6,6 +6,7 @@ import android.view.KeyEvent;
 import java.util.concurrent.ConcurrentLinkedQueue;
 
 class KegsKeyboard {
+  // These are ADB keycodes.
   public final static int KEY_ESCAPE = 0x35;
   public final static int KEY_RETURN = 0x24;
   public final static int KEY_BACKSPACE = 0x33;  // 0x75 == delete
diff --git a/src/com/froop/app/kegs/KegsThread.java b/src/com/froop/app/kegs/KegsThread.java
index 3c99507..904ae84 100644
--- a/src/com/froop/app/kegs/KegsThread.java
+++ b/src/com/froop/app/kegs/KegsThread.java
@@ -39,12 +39,14 @@ class KegsThread extends Thread {
     mUpdateScreen = update;
   }
 
+  // Called by native thread.  Sometimes called by UI thread.
   protected void updateScreen() {
     if (mUpdateScreen != null) {
       mUpdateScreen.updateScreen();
     }
   }
 
+  // Called by native thread.
   private void checkForPause() {
     if (mPaused) {
       mPauseLock.lock();
@@ -53,6 +55,7 @@ class KegsThread extends Thread {
     }
   }
 
+  // Called by native thread.
   private String getConfigFile() {
     return mConfigFile;
   }
diff --git a/src/com/froop/app/kegs/KegsTouch.java b/src/com/froop/app/kegs/KegsTouch.java
index 294732d..7fdfd97 100644
--- a/src/com/froop/app/kegs/KegsTouch.java
+++ b/src/com/froop/app/kegs/KegsTouch.java
@@ -8,6 +8,8 @@ import android.view.MotionEvent;
 import android.view.ViewConfiguration;
 import java.util.concurrent.ConcurrentLinkedQueue;
 
+// Translate onTouchEvent calls into mouse pointer movement.
+
 class KegsTouch {
   private ConcurrentLinkedQueue mEventQueue;
   private int mButton1 = 0;
diff --git a/src/com/froop/app/kegs/KegsView.java b/src/com/froop/app/kegs/KegsView.java
index 36fc165..6381b1b 100644
--- a/src/com/froop/app/kegs/KegsView.java
+++ b/src/com/froop/app/kegs/KegsView.java
@@ -11,6 +11,8 @@ import android.view.SurfaceHolder;
 import android.view.SurfaceView;
 import android.view.View;
 
+// This is the old software renderer that uses BitmapThread.
+
 class KegsView extends SurfaceView implements KegsThread.UpdateScreen, SurfaceHolder.Callback {
   // Reported area of this view, see updateScreenSize()
   private int mWidth = 0;
diff --git a/src/com/froop/app/kegs/KegsViewGL.java b/src/com/froop/app/kegs/KegsViewGL.java
index 337db21..5f7726f 100644
--- a/src/com/froop/app/kegs/KegsViewGL.java
+++ b/src/com/froop/app/kegs/KegsViewGL.java
@@ -8,6 +8,8 @@ import android.view.inputmethod.EditorInfo;
 import android.view.inputmethod.InputConnection;
 import android.opengl.GLSurfaceView;
 
+// All the interesting OpenGL stuff is in the KegsRenderer class.
+
 class KegsViewGL extends GLSurfaceView implements KegsThread.UpdateScreen {
   // Reported area of this view, see updateScreenSize()
   private int mWidth = 0;