Issue menacher#2 removed prepending I from documentation.

menacher · menacher · commit 3a39bc2da3ed · 2012-12-26T06:53:53.000+05:30
diff --git a/jetclient/src/main/java/org/menacheri/jetclient/communication/MessageBuffer.java b/jetclient/src/main/java/org/menacheri/jetclient/communication/MessageBuffer.java
@@ -296,7 +296,7 @@ public interface MessageBuffer<T>
 
 	/**
 	 * Returns the actual buffer implementation that is wrapped in this
-	 * IMessageBuffer instance.
+	 * MessageBuffer instance.
 	 * 
 	 * @return This method will return the underlying buffer. For Netty that
 	 *         would be a {@link ChannelBuffer}, for a core java implementation
diff --git a/jetclient/src/main/java/org/menacheri/jetclient/event/impl/DefaultNetworkEvent.java b/jetclient/src/main/java/org/menacheri/jetclient/event/impl/DefaultNetworkEvent.java
@@ -19,7 +19,7 @@ public class DefaultNetworkEvent extends DefaultEvent implements NetworkEvent
 	private static final long serialVersionUID = 1L;
 	
 	/**
-	 * Default constructor which will set the IDeliveryGuaranty to RELIABLE. It
+	 * Default constructor which will set the {@link DeliveryGuaranty} to RELIABLE. It
 	 * will also set the type of the event to {@link Events#NETWORK_MESSAGE}.
 	 */
 	public DefaultNetworkEvent()
diff --git a/jetserver/src/main/java/org/menacheri/jetserver/app/impl/SimpleGame.java b/jetserver/src/main/java/org/menacheri/jetserver/app/impl/SimpleGame.java
@@ -5,7 +5,7 @@
 
 /**
  * Domain object representing a game. This is a convenience implementation of
- * the IGame interface so that simple games need not implement their own.
+ * the {@link Game} interface so that simple games need not implement their own.
  * <b>Note</b> This implementation will throw exception if any of the setter
  * methods are invoked. All variables are final in this class and expected to be
  * set at object construction.
diff --git a/jetserver/src/main/java/org/menacheri/jetserver/communication/MessageBuffer.java b/jetserver/src/main/java/org/menacheri/jetserver/communication/MessageBuffer.java
@@ -296,7 +296,7 @@ public interface MessageBuffer<T> {
 
 	/**
 	 * Returns the actual buffer implementation that is wrapped in this
-	 * IMessageBuffer instance.
+	 * MessageBuffer instance.
 	 * 
 	 * @return This method will return the underlying buffer. For Netty that
 	 *         would be a {@link ChannelBuffer}, for a core java implementation
diff --git a/jetserver/src/main/java/org/menacheri/jetserver/event/AbstractEventHandler.java b/jetserver/src/main/java/org/menacheri/jetserver/event/AbstractEventHandler.java
@@ -1,26 +1,26 @@
-package org.menacheri.jetserver.event;
-
-/**
- * Abstract event handler is a helper class which must be overriden by classes
- * which need to implement the IEventHandler interface. The
- * {@link #onEvent(Event)} method needs to be implemented by such classes.
- * 
- * @author Abraham Menacherry
- * 
- */
-public abstract class AbstractEventHandler implements EventHandler
-{
-	private final int EVENT_TYPE;
-	
-	public AbstractEventHandler(int eventType)
-	{
-		this.EVENT_TYPE = eventType;
-	}
-	
-	@Override
-	public int getEventType()
-	{
-		return EVENT_TYPE;
-	}
-
-}
+package org.menacheri.jetserver.event;
+
+/**
+ * Abstract event handler is a helper class which must be overriden by classes
+ * which need to implement the {@link EventHandler} interface. The
+ * {@link #onEvent(Event)} method needs to be implemented by such classes.
+ * 
+ * @author Abraham Menacherry
+ * 
+ */
+public abstract class AbstractEventHandler implements EventHandler
+{
+	private final int EVENT_TYPE;
+	
+	public AbstractEventHandler(int eventType)
+	{
+		this.EVENT_TYPE = eventType;
+	}
+	
+	@Override
+	public int getEventType()
+	{
+		return EVENT_TYPE;
+	}
+
+}
diff --git a/jetserver/src/main/java/org/menacheri/jetserver/event/impl/DefaultNetworkEvent.java b/jetserver/src/main/java/org/menacheri/jetserver/event/impl/DefaultNetworkEvent.java
@@ -2,8 +2,8 @@
 
 import org.menacheri.jetserver.communication.DeliveryGuaranty;
 import org.menacheri.jetserver.communication.DeliveryGuaranty.DeliveryGuarantyOptions;
-import org.menacheri.jetserver.event.Events;
 import org.menacheri.jetserver.event.Event;
+import org.menacheri.jetserver.event.Events;
 import org.menacheri.jetserver.event.NetworkEvent;
 
 /**
@@ -19,8 +19,9 @@ public class DefaultNetworkEvent extends DefaultEvent implements NetworkEvent
 	private static final long serialVersionUID = 6486454029499527617L;
 
 	/**
-	 * Default constructor which will set the IDeliveryGuaranty to RELIABLE. It
-	 * will also set the type of the event to {@link Events#NETWORK_MESSAGE}.
+	 * Default constructor which will set the {@link DeliveryGuaranty} to
+	 * RELIABLE. It will also set the type of the event to
+	 * {@link Events#NETWORK_MESSAGE}.
 	 */
 	public DefaultNetworkEvent()
 	{

Original file line number	Diff line number	Diff line change
`@@ -296,7 +296,7 @@ public interface MessageBuffer<T>`
`296`	`296`
`297`	`297`	`/**`
`298`	`298`	`* Returns the actual buffer implementation that is wrapped in this`
`299`		`- * IMessageBuffer instance.`
	`299`	`+ * MessageBuffer instance.`
`300`	`300`	`*`
`301`	`301`	`* @return This method will return the underlying buffer. For Netty that`
`302`	`302`	`* would be a {@link ChannelBuffer}, for a core java implementation`