fixed javadoc; prepared pom for release

pom.xml

@@ -19,10 +19,11 @@
 
 	<groupId>com.jfastnet</groupId>
 	<artifactId>jfastnet</artifactId>
-	<version>0.1.2-SNAPSHOT</version>
+	<version>0.1.2</version>
 	<packaging>jar</packaging>
 
 	<name>jfastnet</name>
+	<description>Fast, reliable UDP messaging for Java. Designed for games.</description>
 	<url>http://www.jfastnet.com</url>
 
 	<properties>
@@ -64,10 +65,10 @@
 
 	<developers>
 		<developer>
+			<id>klaus7</id>
 			<email>[email protected]</email>
 			<name>Klaus Pfeiffer</name>
 			<url>http://www.allpiper.com</url>
-			<id>klaus7</id>
 		</developer>
 	</developers>
 
@@ -230,9 +231,10 @@
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
 				<version>2.9.1</version>
-				<configuration>
-					<failOnError>false</failOnError>
-				</configuration>
+				<!--<configuration>-->
+					<!--<additionalparam>-Xdoclint:none</additionalparam>-->
+					<!--<failOnError>false</failOnError>-->
+				<!--</configuration>-->
 				<executions>
 					<execution>
 						<id>attach-javadocs</id>

src/main/java/com/jfastnet/Client.java

@@ -24,7 +24,7 @@
 
 import java.net.InetSocketAddress;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class Client extends PeerController {
 

src/main/java/com/jfastnet/Config.java

@@ -34,7 +34,7 @@
 import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 @Setter
 @Accessors(chain = true)
 public class Config {

src/main/java/com/jfastnet/IMessageReceiver.java

@@ -18,7 +18,7 @@
 
 import com.jfastnet.messages.Message;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface IMessageReceiver {
 
 	/** Receive message. */

src/main/java/com/jfastnet/IMessageSender.java

@@ -19,7 +19,7 @@
 import com.jfastnet.messages.GenericMessage;
 import com.jfastnet.messages.Message;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface IMessageSender {
 
 	/**

src/main/java/com/jfastnet/IPeer.java

@@ -18,7 +18,7 @@
 
 import com.jfastnet.messages.Message;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface IPeer extends IStartStop, IMessageSender, ISimpleProcessable {
 
 	/** After the method call message.payload should be non-null.

src/main/java/com/jfastnet/IPeerController.java

@@ -18,5 +18,5 @@
 
 /** Controls a peer interface by behaving like a peer, client or server. Every
  * peer controller can send and receive messages.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IPeerController extends IMessageSender, IMessageReceiver, ISimpleProcessable, IStartStop {}

src/main/java/com/jfastnet/IServerHooks.java

@@ -17,7 +17,7 @@
 package com.jfastnet;
 
 /** Server hooks are called on various occasions.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IServerHooks {
 
 	/** Called when a client joins the server. */

src/main/java/com/jfastnet/ISimpleProcessable.java

@@ -16,7 +16,7 @@
 
 package com.jfastnet;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface ISimpleProcessable {
 	void process();
 }

src/main/java/com/jfastnet/IStartStop.java

@@ -16,7 +16,7 @@
 
 package com.jfastnet;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface IStartStop {
 
 	/** @return true if start was successful, false otherwise. */

src/main/java/com/jfastnet/MessageKey.java

@@ -20,7 +20,7 @@
 import lombok.ToString;
 
 /** Reliable mode / ClientID / MessageID - Key
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @ToString
 public class MessageKey implements Comparable<MessageKey>{
 	public Message.ReliableMode reliableMode;

src/main/java/com/jfastnet/MessageLog.java

@@ -27,10 +27,10 @@
 
 /** Logs incoming and outgoing messages. Per default only reliable messages
  * get logged and an upper bound for the message log is used.
- * <br/>
+ *
  * The reliable sequence processor will grab required messages from the message
  * log. So don't change the filter unless you know what you're doing.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class MessageLog {
 

src/main/java/com/jfastnet/NetStats.java

@@ -27,7 +27,7 @@
 import java.util.concurrent.atomic.AtomicLong;
 
 /** Statistics about the network traffic.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class NetStats {
 	public static final DateFormat FILE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss_SSS");

src/main/java/com/jfastnet/PeerController.java

@@ -29,7 +29,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class PeerController implements IPeerController {
 

src/main/java/com/jfastnet/Server.java

@@ -24,7 +24,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class Server extends PeerController {
 

src/main/java/com/jfastnet/config/SerialiserConfig.java

@@ -16,7 +16,7 @@
 
 package com.jfastnet.config;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public class SerialiserConfig {
 
 	/** Use basic Java's In-/Deflater compression. Can only be used when de-/

src/main/java/com/jfastnet/idprovider/ClientIdReliableModeIdProvider.java

@@ -24,7 +24,7 @@
 
 /** <b>Attention!</b> This won't work with Lockstepping, because the
  * lockstepping impl requires the same id for messages on all clients.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public class ClientIdReliableModeIdProvider implements IIdProvider {
 
 	private Map<Integer, Map<Message.ReliableMode, AtomicLong>> idMap = new NullsafeHashMap<Integer, Map<Message.ReliableMode, AtomicLong>>() {

src/main/java/com/jfastnet/idprovider/IIdProvider.java

@@ -22,7 +22,7 @@
 
 /** Provides the id for messages. It depends on the use case which provider
  * you should choose.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IIdProvider extends Comparator<Message> {
 
 	/** Get new id for message. */
@@ -33,7 +33,7 @@ public interface IIdProvider extends Comparator<Message> {
 
 	/** Return true, if broadcasted messages should resolve the message id
 	 * again after setting the correct receiver id.
-	 * <br/>
+	 *
 	 * Otherwise every client receives the same id for a particular message,
 	 * which is required for the lock stepping extension implementation. */
 	default boolean resolveEveryClientMessage() {

src/main/java/com/jfastnet/idprovider/ReliableModeIdProvider.java

@@ -24,7 +24,7 @@
 import java.util.concurrent.atomic.AtomicLong;
 
 /** Ids begin with 1. Every reliable mode has its stream of ids.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class ReliableModeIdProvider implements IIdProvider {
 

src/main/java/com/jfastnet/idprovider/SimpleIdProvider.java

@@ -22,7 +22,7 @@
 
 /** Provides a new id for every message. Usually not advisable to use this
  * provider.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public class SimpleIdProvider implements IIdProvider {
 
 	AtomicLong id = new AtomicLong();

src/main/java/com/jfastnet/messages/AckMessage.java

@@ -22,7 +22,7 @@
 import java.util.Collection;
 import java.util.HashSet;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class AckMessage extends Message implements IBatchable<Long>, IAckMessage {
 

src/main/java/com/jfastnet/messages/ClientTimerSyncMessage.java

@@ -22,7 +22,7 @@
 import lombok.extern.slf4j.Slf4j;
 
 /** Send the client his offsetToHost.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class ClientTimerSyncMessage extends Message implements IDontFrame {
 

src/main/java/com/jfastnet/messages/ConnectRequest.java

@@ -20,7 +20,7 @@
 import lombok.extern.slf4j.Slf4j;
 
 /** Sent from the client to the server.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class ConnectRequest extends Message implements IDontFrame {
 

src/main/java/com/jfastnet/messages/ConnectResponse.java

@@ -25,7 +25,7 @@
 import java.util.Set;
 
 /** Sent from the server to the client to confirm the connection.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class ConnectResponse extends Message implements IDontFrame, IInstantProcessable, IAckMessage {
 

src/main/java/com/jfastnet/messages/GenericMessage.java

@@ -17,7 +17,7 @@
 package com.jfastnet.messages;
 
 /** Used to send a plain object.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public class GenericMessage extends Message {
 
 	public Object object;

src/main/java/com/jfastnet/messages/IAckMessage.java

@@ -2,7 +2,7 @@
 
 import java.util.Collection;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface IAckMessage {
 
 	/** Ids that are acknowledged. */

src/main/java/com/jfastnet/messages/IBatchable.java

@@ -18,7 +18,7 @@
 
 import java.util.Collection;
 
-/** @author Klaus Pfeiffer <[email protected]> */
+/** @author Klaus Pfeiffer - [email protected] */
 public interface IBatchable<E> {
 	void set(Collection<E> batch);
 }

src/main/java/com/jfastnet/messages/IDontFrame.java

@@ -18,5 +18,5 @@
 
 /** The message implementing this marker interface will not be processed
  * within the boundaries of the lockstepping mechanism.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IDontFrame {}

src/main/java/com/jfastnet/messages/IInstantOnSendProcessable.java

@@ -19,5 +19,5 @@
 /** Marker interface to determine, that a message should be processed, before
  * sending it to the receiver. Use with caution, this will easily get you
  * into trouble when using the lockstep system.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IInstantOnSendProcessable {}

src/main/java/com/jfastnet/messages/IInstantProcessable.java

@@ -18,5 +18,5 @@
 
 /** Message will not be forwarded to the external receiver. Instead it will
  * be immediately processed.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IInstantProcessable {}

src/main/java/com/jfastnet/messages/IInstantServerProcessable.java

@@ -19,7 +19,7 @@
 /** Marker interface for instant processable actions on the server side upon receiving.
  * Be cautious with concurrency!
  * <p>Can only be transferred unreliable, because all systems are skipped.</p>
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IInstantServerProcessable {
 	void process();
 }

src/main/java/com/jfastnet/messages/IOrderedMessage.java

@@ -19,7 +19,7 @@
 /** A message that needs to be received in a particular order has to implement
  * this interface and respect the conditions.
  * <br>Usually a better way is to use a reliable sequence instead.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public interface IOrderedMessage {
 
 	/** @return the message id this message is based on. The message with this

src/main/java/com/jfastnet/messages/IsReadyMessage.java

@@ -19,7 +19,7 @@
 import lombok.extern.slf4j.Slf4j;
 
 /** Sent when client is ready.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class IsReadyMessage extends Message implements IDontFrame {
 

src/main/java/com/jfastnet/messages/LeaveRequest.java

@@ -17,7 +17,7 @@
 package com.jfastnet.messages;
 
 /** Sent from the client to the server.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public class LeaveRequest extends Message implements IDontFrame {
 
 	@Override

src/main/java/com/jfastnet/messages/Message.java

@@ -31,7 +31,7 @@
 import java.net.InetSocketAddress;
 
 /** The base class for all messages. Subclass this class for your own messages.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 @Getter
 @EqualsAndHashCode

src/main/java/com/jfastnet/messages/MessagePart.java

@@ -25,7 +25,7 @@
 import java.util.stream.Collectors;
 
 /** Used for bigger messages to be transferred in parts.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class MessagePart extends Message implements IDontFrame {
 

src/main/java/com/jfastnet/messages/RequestSeqIdsMessage.java

@@ -25,7 +25,7 @@
 import java.util.List;
 
 /** This message is used to request missing sequenced ids from the other side.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class RequestSeqIdsMessage extends Message implements IDontFrame {
 

src/main/java/com/jfastnet/messages/SequenceKeepAlive.java

@@ -20,5 +20,5 @@
  * retrieved. Without sending this message one peer could be stuck, because
  * it never retrieves the last message and also has no way of detecting,
  * because a message with an higher id is not sent.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public class SequenceKeepAlive extends Message implements IDontFrame {}

src/main/java/com/jfastnet/messages/TimerSyncMessage.java

@@ -27,7 +27,7 @@
 
 /** This message is sent from the server to the client and then back to the
  * server. It is used to measure the round trip time.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 @Slf4j
 public class TimerSyncMessage extends Message implements IInstantServerProcessable, IDontFrame {
 

src/main/java/com/jfastnet/messages/comparators/MessageExecutionPriorityComparator.java

@@ -21,7 +21,7 @@
 import java.util.Comparator;
 
 /** Higher priority messages will come first when used this comparator.
- * @author Klaus Pfeiffer <[email protected]> */
+ * @author Klaus Pfeiffer - [email protected] */
 public class MessageExecutionPriorityComparator implements Comparator<Message> {
 
 	public static final MessageExecutionPriorityComparator INSTANCE = new MessageExecutionPriorityComparator();