From c015d586d22b69078b6da61858e5675793856b0b Mon Sep 17 00:00:00 2001
From: Paul Buetow <paul@buetow.org>
Date: Sun, 25 May 2008 08:10:13 +0000
Subject: JAutoDoc :)

---
 .../implementations/BroadcastSturmProtocol.java    | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)

(limited to 'sources/protocols/implementations/BroadcastSturmProtocol.java')

diff --git a/sources/protocols/implementations/BroadcastSturmProtocol.java b/sources/protocols/implementations/BroadcastSturmProtocol.java
index 165a2f3..9efd347 100644
--- a/sources/protocols/implementations/BroadcastSturmProtocol.java
+++ b/sources/protocols/implementations/BroadcastSturmProtocol.java
@@ -1,3 +1,7 @@
+/*
+ * VS is (c) 2008 by Paul C. Buetow
+ * vs@dev.buetow.org
+ */
 package protocols.implementations;
 
 import java.util.ArrayList;
@@ -5,21 +9,41 @@ import java.util.ArrayList;
 import core.VSMessage;
 import protocols.VSProtocol;
 
+// TODO: Auto-generated Javadoc
+/**
+ * The Class BroadcastSturmProtocol.
+ */
 public class BroadcastSturmProtocol extends VSProtocol {
+    
+    /** The sent messages. */
     private ArrayList<VSMessage> sentMessages;
+    
+    /** The broadcast count. */
     private static int broadcastCount;
 
+    /**
+     * Instantiates a new broadcast sturm protocol.
+     */
     public BroadcastSturmProtocol() {
         setClassname(getClass().toString());
         sentMessages = new ArrayList<VSMessage>();
     }
 
+    /* (non-Javadoc)
+     * @see events.VSEvent#onInit()
+     */
     protected void onInit() {
     }
 
+    /* (non-Javadoc)
+     * @see protocols.VSProtocol#onClientReset()
+     */
     protected void onClientReset() {
     }
 
+    /* (non-Javadoc)
+     * @see protocols.VSProtocol#onClientStart()
+     */
     protected void onClientStart() {
         VSMessage message = new VSMessage(getClassname());
         message.setInteger("Broadcast", broadcastCount++);
@@ -27,13 +51,22 @@ public class BroadcastSturmProtocol extends VSProtocol {
         sendMessage(message);
     }
 
+    /* (non-Javadoc)
+     * @see protocols.VSProtocol#onClientRecv(core.VSMessage)
+     */
     protected void onClientRecv(VSMessage recvMessage) {
     }
 
+    /* (non-Javadoc)
+     * @see protocols.VSProtocol#onServerReset()
+     */
     protected void onServerReset() {
         sentMessages.clear();
     }
 
+    /* (non-Javadoc)
+     * @see protocols.VSProtocol#onServerRecv(core.VSMessage)
+     */
     protected void onServerRecv(VSMessage recvMessage) {
         if (!sentMessages.contains(recvMessage)) {
             VSMessage message = new VSMessage(getClassname());
@@ -44,6 +77,9 @@ public class BroadcastSturmProtocol extends VSProtocol {
         }
     }
 
+    /* (non-Javadoc)
+     * @see protocols.VSProtocol#toString()
+     */
     public String toString() {
         return super.toString();
     }
-- 
cgit v1.2.3