From f038ad3c39d8cdaf76c8184e5447c9c24ec647a9 Mon Sep 17 00:00:00 2001 From: Sebastian Kaspari Date: Sat, 13 Mar 2010 16:54:48 +0100 Subject: [PATCH] Some more documentation --- src/org/yaaic/receiver/ChannelReceiver.java | 13 ++++++++++++- src/org/yaaic/receiver/ServerReceiver.java | 13 +++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/src/org/yaaic/receiver/ChannelReceiver.java b/src/org/yaaic/receiver/ChannelReceiver.java index d8bb598..f956c83 100644 --- a/src/org/yaaic/receiver/ChannelReceiver.java +++ b/src/org/yaaic/receiver/ChannelReceiver.java @@ -27,6 +27,11 @@ import android.content.Intent; import org.yaaic.listener.ChannelListener; import org.yaaic.model.Broadcast; +/** + * A channel receiver for receiving channel updates + * + * @author Sebastian Kaspari + */ public class ChannelReceiver extends BroadcastReceiver { public static final String TAG = "Yaaic/ChannelReceiver"; @@ -35,7 +40,7 @@ public class ChannelReceiver extends BroadcastReceiver private int serverId; /** - * Create a new channel reciever + * Create a new channel receiver * * @param serverId Only listen on channels of this server * @param listener @@ -46,6 +51,12 @@ public class ChannelReceiver extends BroadcastReceiver this.serverId = serverId; } + /** + * On receive broadcast + * + * @param context + * @param intent + */ @Override public void onReceive(Context context, Intent intent) { diff --git a/src/org/yaaic/receiver/ServerReceiver.java b/src/org/yaaic/receiver/ServerReceiver.java index c4f79e9..4c07ceb 100644 --- a/src/org/yaaic/receiver/ServerReceiver.java +++ b/src/org/yaaic/receiver/ServerReceiver.java @@ -26,15 +26,28 @@ import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; +/** + * A server receiver for receiving server updates + * + * @author Sebastian Kaspari + */ public class ServerReceiver extends BroadcastReceiver { private ServerListener listener; + /** + * Create a new server receiver + * + * @param listener + */ public ServerReceiver(ServerListener listener) { this.listener = listener; } + /** + * On receive broadcast + */ @Override public void onReceive(Context context, Intent intent) {