From 3388f4bbefa8d05e510c2d65af4dec119b4f9a97 Mon Sep 17 00:00:00 2001
From: Christopher Eby <kreed@kreed.org>
Date: Sun, 16 May 2010 14:37:13 -0500
Subject: [PATCH] Document PreferencesActivity and VolumePreference

---
 src/org/kreed/vanilla/PreferencesActivity.java | 9 +++++++++
 src/org/kreed/vanilla/VolumePreference.java    | 6 ++++++
 2 files changed, 15 insertions(+)

diff --git a/src/org/kreed/vanilla/PreferencesActivity.java b/src/org/kreed/vanilla/PreferencesActivity.java
index 09e9e165..b3028c08 100644
--- a/src/org/kreed/vanilla/PreferencesActivity.java
+++ b/src/org/kreed/vanilla/PreferencesActivity.java
@@ -24,7 +24,13 @@ import android.os.Bundle;
 import android.preference.PreferenceActivity;
 import android.view.KeyEvent;
 
+/**
+ * The preferences activity in which one can change application preferences.
+ */
 public class PreferencesActivity extends PreferenceActivity {
+	/**
+	 * Initialize the activity, loading the preference specifications.
+	 */
 	@Override
 	protected void onCreate(Bundle savedInstanceState)
 	{
@@ -40,6 +46,9 @@ public class PreferencesActivity extends PreferenceActivity {
 		ContextApplication.removeActivity(this);
 	}
 
+	/**
+	 * Implement the long-press-back-quits-application behavior.
+	 */
 	@Override
 	public boolean onKeyLongPress(int keyCode, KeyEvent event)
 	{
diff --git a/src/org/kreed/vanilla/VolumePreference.java b/src/org/kreed/vanilla/VolumePreference.java
index 09bc8e36..cec5f55b 100644
--- a/src/org/kreed/vanilla/VolumePreference.java
+++ b/src/org/kreed/vanilla/VolumePreference.java
@@ -26,6 +26,12 @@ import android.view.ViewGroup;
 import android.widget.LinearLayout;
 import android.widget.SeekBar;
 
+/**
+ * A preference that provides a volume slider dialog.
+ *
+ * The position in the slider is saved as float ranging from 0 to 3 on a
+ * roughly exponential scale.
+ */
 public class VolumePreference extends DialogPreference implements SeekBar.OnSeekBarChangeListener {
 	public VolumePreference(Context context, AttributeSet attrs)
 	{