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 :)

---
 sources/events/internal/ProtocolEvent.java | 45 ++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

(limited to 'sources/events/internal/ProtocolEvent.java')

diff --git a/sources/events/internal/ProtocolEvent.java b/sources/events/internal/ProtocolEvent.java
index 0cece54..b29a828 100644
--- a/sources/events/internal/ProtocolEvent.java
+++ b/sources/events/internal/ProtocolEvent.java
@@ -1,37 +1,82 @@
+/*
+ * VS is (c) 2008 by Paul C. Buetow
+ * vs@dev.buetow.org
+ */
 package events.internal;
 
 import events.*;
 import protocols.VSProtocol;
 
+// TODO: Auto-generated Javadoc
+/**
+ * The Class ProtocolEvent.
+ */
 public class ProtocolEvent extends VSEvent {
+    
+    /** The protocol classname. */
     private String protocolClassname;
+    
+    /** The is client protocol. */
     private boolean isClientProtocol; /* true = client, false = server */
+    
+    /** The is protocol activation. */
     private boolean isProtocolActivation; /* true = activate, false = deactivate */
 
+    /* (non-Javadoc)
+     * @see events.VSEvent#onInit()
+     */
     protected void onInit() {
         setClassname(getClass().toString());
     }
 
+    /**
+     * Checks if is client protocol.
+     * 
+     * @param isClientProtocol the is client protocol
+     */
     public void isClientProtocol(boolean isClientProtocol) {
         this.isClientProtocol = isClientProtocol;
     }
 
+    /**
+     * Checks if is client protocol.
+     * 
+     * @return true, if is client protocol
+     */
     public boolean isClientProtocol() {
         return isClientProtocol;
     }
 
+    /**
+     * Checks if is protocol activation.
+     * 
+     * @param isProtocolActivation the is protocol activation
+     */
     public void isProtocolActivation(boolean isProtocolActivation) {
         this.isProtocolActivation = isProtocolActivation;
     }
 
+    /**
+     * Checks if is protocol activation.
+     * 
+     * @return true, if is protocol activation
+     */
     public boolean isProtocolActivation() {
         return isProtocolActivation;
     }
 
+    /**
+     * Sets the protocol classname.
+     * 
+     * @param protocolClassname the new protocol classname
+     */
     public void setProtocolClassname(String protocolClassname) {
         this.protocolClassname = protocolClassname;
     }
 
+    /* (non-Javadoc)
+     * @see events.VSEvent#onStart()
+     */
     public void onStart() {
         VSProtocol protocol = process.getProtocolObject(protocolClassname);
 
-- 
cgit v1.2.3