From eff15c176e9fda71309efb7b3f6da2de85bc523c Mon Sep 17 00:00:00 2001
From: Felix Ableitner <me@nutomic.com>
Date: Fri, 2 May 2014 00:06:32 +0200
Subject: [PATCH] Added documentation.

---
 src/com/github/nutomic/localroute/Controller.java | 15 +++++++++++++++
 src/com/github/nutomic/localroute/Provider.java   |  7 +++++++
 2 files changed, 22 insertions(+)

diff --git a/src/com/github/nutomic/localroute/Controller.java b/src/com/github/nutomic/localroute/Controller.java
index 373ae6d..f6a5d01 100644
--- a/src/com/github/nutomic/localroute/Controller.java
+++ b/src/com/github/nutomic/localroute/Controller.java
@@ -41,6 +41,12 @@ import android.support.v7.media.MediaRouteProvider;
 import android.support.v7.media.MediaRouter.ControlRequestCallback;
 import android.util.Log;
 
+/**
+ * Receives control intents through media route and executes them on a MediaPlayer.
+ * 
+ * @author felix
+ *
+ */
 public class Controller extends MediaRouteProvider.RouteController implements 
 		MediaPlayer.OnCompletionListener, MediaPlayer.OnPreparedListener {
 	
@@ -167,12 +173,21 @@ public class Controller extends MediaRouteProvider.RouteController implements
 		callback.onResult(status);    	
     }
 
+    /**
+     * Sets state to finished. 
+     * 
+     * Note: Do not set the listener before play() is called 
+     *       (or this will be called immediately).
+     */
 	@Override
 	public void onCompletion(MediaPlayer mp) {
 		mState = MediaItemStatus.PLAYBACK_STATE_FINISHED;
 		mPlayer.setOnCompletionListener(null);
 	}
 
+	/**
+	 * Starts playback and sets completion listener.
+	 */
 	@Override
 	public void onPrepared(MediaPlayer mp) {
 		mPlayer.start();
diff --git a/src/com/github/nutomic/localroute/Provider.java b/src/com/github/nutomic/localroute/Provider.java
index c0cbd8f..9059979 100644
--- a/src/com/github/nutomic/localroute/Provider.java
+++ b/src/com/github/nutomic/localroute/Provider.java
@@ -40,6 +40,13 @@ import android.support.v7.media.MediaRouteProvider;
 import android.support.v7.media.MediaRouteProviderDescriptor;
 import android.support.v7.media.MediaRouter;
 
+/**
+ * MediaRouteProvider that details the local audio route with its 
+ * controls to the system. 
+ * 
+ * @author felix
+ *
+ */
 final class Provider extends MediaRouteProvider {
 
     private static final String ROUTE_ID = "local_route";