diff --git a/.gitignore b/.gitignore index ebf1162f..20386db5 100644 --- a/.gitignore +++ b/.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/* diff --git a/pom.xml b/pom.xml index 57ec4911..0990c4e1 100644 --- a/pom.xml +++ b/pom.xml @@ -119,6 +119,23 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + 3.3.1 + + + attach-javadocs + + jar + + + false + false + + + + diff --git a/src/main/java/org/tinyradius/attribute/RadiusAttribute.java b/src/main/java/org/tinyradius/attribute/RadiusAttribute.java index 2059b79a..f0935a06 100644 --- a/src/main/java/org/tinyradius/attribute/RadiusAttribute.java +++ b/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) diff --git a/src/main/java/org/tinyradius/packet/CoaRequest.java b/src/main/java/org/tinyradius/packet/CoaRequest.java index 0e81d238..69dbd45c 100644 --- a/src/main/java/org/tinyradius/packet/CoaRequest.java +++ b/src/main/java/org/tinyradius/packet/CoaRequest.java @@ -6,7 +6,7 @@ /** * CoA packet. Thanks to Michael Krastev. - * @author Michael Krastev + * @author Michael Krastev */ public class CoaRequest extends RadiusPacket { diff --git a/src/main/java/org/tinyradius/proxy/RadiusProxy.java b/src/main/java/org/tinyradius/proxy/RadiusProxy.java index 7e5d0261..fd5acd7f 100644 --- a/src/main/java/org/tinyradius/proxy/RadiusProxy.java +++ b/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 */ diff --git a/src/main/java/org/tinyradius/test/TestClient.java b/src/main/java/org/tinyradius/test/TestClient.java index a2d05838..dfdcd78b 100644 --- a/src/main/java/org/tinyradius/test/TestClient.java +++ b/src/main/java/org/tinyradius/test/TestClient.java @@ -18,7 +18,8 @@ public class TestClient { /** * Radius command line client. - *
Usage: TestClient hostName sharedSecret userName password + * + * Usage: TestClient hostName sharedSecret userName password * @param args arguments * @throws Exception */ diff --git a/src/main/java/org/tinyradius/util/RadiusClient.java b/src/main/java/org/tinyradius/util/RadiusClient.java index 158668b5..e9ea39b0 100644 --- a/src/main/java/org/tinyradius/util/RadiusClient.java +++ b/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) diff --git a/src/main/java/org/tinyradius/util/RadiusServer.java b/src/main/java/org/tinyradius/util/RadiusServer.java index d361e697..f5d312de 100644 --- a/src/main/java/org/tinyradius/util/RadiusServer.java +++ b/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());