Add javadocs as required to publish to Maven central (#49)

Author: ctran

.gitignore

@@ -2,12 +2,16 @@ bin
 dist
 build
 doc/apidoc
+release.properties
 target
+.DS_Store
 .settings
 .classpath
 .project
 .flattened-pom.xml
 
+*.releaseBackup
+
 # IntelliJ IDEA
 *.iml
 .idea/*

pom.xml

@@ -119,6 +119,23 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>3.3.1</version>
+				<executions>
+					<execution>
+						<id>attach-javadocs</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+						<configuration>
+							<failOnWarnings>false</failOnWarnings>
+							<failOnError>false</failOnError>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 

src/main/java/org/tinyradius/attribute/RadiusAttribute.java

@@ -96,8 +96,6 @@ public void setAttributeValue(String value) {
 	 * Gets the value of this attribute as a string.
 	 * 
 	 * @return value
-	 * @exception RadiusException
-	 *                if the value is invalid
 	 */
 	public String getAttributeValue() {
 		return RadiusUtil.getHexString(getAttributeData());
@@ -167,8 +165,10 @@ public byte[] writeAttribute() {
 
 	/**
 	 * Reads in this attribute from the passed byte array.
-	 * 
-	 * @param data
+	 * @param data  data buffer
+	 * @param offset the offset to read
+	 * @param length the amount of data to read
+	 * @throws RadiusException when length is less than 2
 	 */
 	public void readAttribute(byte[] data, int offset, int length) throws RadiusException {
 		if (length < 2)

src/main/java/org/tinyradius/packet/CoaRequest.java

@@ -6,7 +6,7 @@
 
 /**
  * CoA packet. Thanks to Michael Krastev.
- * @author Michael Krastev <[email protected]>
+ * @author Michael Krastev
  */
 public class CoaRequest extends RadiusPacket {
 

src/main/java/org/tinyradius/proxy/RadiusProxy.java

@@ -105,8 +105,7 @@ public void setProxyPort(int proxyPort) {
 	 * Sets the socket timeout.
 	 * 
 	 * @param socketTimeout
-	 *            socket timeout, >0 ms
-	 * @throws SocketException
+	 * @throws SocketException when socket timeout, >0 ms
 	 */
 	public void setSocketTimeout(int socketTimeout) throws SocketException {
 		super.setSocketTimeout(socketTimeout);
@@ -214,7 +213,7 @@ protected void proxyPacketReceived(RadiusPacket packet, InetSocketAddress remote
 	 * 
 	 * @param packet
 	 *            the packet to proxy
-	 * @param proxyCon
+	 * @param proxyConnection
 	 *            the RadiusProxyConnection for this packet
 	 * @throws IOException
 	 */

src/main/java/org/tinyradius/test/TestClient.java

@@ -18,7 +18,8 @@ public class TestClient {
 
 	/**
 	 * Radius command line client.
-	 * <br/>Usage: TestClient <i>hostName sharedSecret userName password</i>
+	 *
+	 * Usage: TestClient <i>hostName sharedSecret userName password</i>
 	 * @param args arguments
 	 * @throws Exception
 	 */

src/main/java/org/tinyradius/util/RadiusClient.java

@@ -207,7 +207,7 @@ public int getRetryCount() {
 	 * Sets the retry count for failed transmissions.
 	 * 
 	 * @param retryCount
-	 *            retry count, >0
+	 * @throws IllegalArgumentException when retry count is not positive
 	 */
 	public void setRetryCount(int retryCount) {
 		if (retryCount < 1)

src/main/java/org/tinyradius/util/RadiusServer.java

@@ -224,13 +224,12 @@ public int getSocketTimeout() {
 	/**
 	 * Sets the socket timeout.
 	 * 
-	 * @param socketTimeout
-	 *            socket timeout, >0 ms
-	 * @throws SocketException
+	 * @param socketTimeout when socket timeout, >0 ms
+	 * @throws SocketException when socketTime is not positive
 	 */
 	public void setSocketTimeout(int socketTimeout) throws SocketException {
 		if (socketTimeout < 1)
-			throw new IllegalArgumentException("socket tiemout must be positive");
+			throw new IllegalArgumentException("socket timeout must be positive");
 		this.socketTimeout = socketTimeout;
 		if (authSocket != null)
 			authSocket.setSoTimeout(socketTimeout);
@@ -279,7 +278,7 @@ public long getDuplicateInterval() {
 	 * same address.
 	 * 
 	 * @param duplicateInterval
-	 *            duplicate interval (ms), >0
+	 * @throws IllegalArgumentException when duplicateInterval (ms), >0
 	 */
 	public void setDuplicateInterval(long duplicateInterval) {
 		if (duplicateInterval <= 0)
@@ -341,8 +340,6 @@ protected void copyProxyState(RadiusPacket request, RadiusPacket answer) {
 	 * Returns when stop() is called.
 	 * 
 	 * @throws SocketException
-	 * @throws InterruptedException
-	 * 
 	 */
 	protected void listenAuth() throws SocketException {
 		listen(getAuthSocket());
@@ -353,7 +350,6 @@ protected void listenAuth() throws SocketException {
 	 * Returns when stop() is called.
 	 * 
 	 * @throws SocketException
-	 * @throws InterruptedException
 	 */
 	protected void listenAcct() throws SocketException {
 		listen(getAcctSocket());