Errors in javadoc fixed
authorAlex Kirhenshtein <alk@netxms.org>
Mon, 4 Jan 2016 21:29:19 +0000 (23:29 +0200)
committerAlex Kirhenshtein <alk@netxms.org>
Mon, 4 Jan 2016 21:29:19 +0000 (23:29 +0200)
src/java/client/netxms-base/pom.xml
src/java/client/netxms-base/src/main/java/org/netxms/base/EncryptedPassword.java
src/java/client/netxms-base/src/main/java/org/netxms/base/GeoLocation.java
src/java/client/netxms-base/src/main/java/org/netxms/base/InetAddressEx.java
src/java/client/netxms-base/src/main/java/org/netxms/base/NXCPMessage.java
src/java/client/netxms-base/src/main/java/org/netxms/base/NXCPMessageReceiver.java

index 43e6c5c..e6f1c79 100644 (file)
@@ -72,9 +72,6 @@
             <goals>
               <goal>jar</goal>
             </goals>
-            <configuration>
-              <additionalparam>-Xdoclint:none</additionalparam>
-            </configuration>
           </execution>
         </executions>
       </plugin>
index 4061b07..9d0a194 100644 (file)
  */
 package org.netxms.base;
 
+import javax.xml.bind.DatatypeConverter;
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.util.Arrays;
-import javax.xml.bind.DatatypeConverter;
 
 /**
  * Utility class to encrypt and decrypt passwords in same way as nxcencpasswd do.
@@ -36,9 +36,9 @@ public class EncryptedPassword
    /**
     * Encrypt password for given login.
     * 
-    * @param login
-    * @param password
-    * @return
+    * @param login login name
+    * @param password plain text password
+    * @return password obfuscated wiht ICE algorithm
     * @throws NoSuchAlgorithmException
     * @throws UnsupportedEncodingException
     */
@@ -50,9 +50,9 @@ public class EncryptedPassword
    }
    
    /**
-    * @param login
-    * @param password
-    * @return
+    * @param login login name
+    * @param password ICE-obfuscated password
+    * @return clear-text password
     * @throws NoSuchAlgorithmException
     * @throws IOException
     */
index 91b7415..420a660 100644 (file)
@@ -373,9 +373,6 @@ public class GeoLocation
       return endTimestamp;
    }
 
-   /**
-    * @param end_timestamp the end_timestamp to set
-    */
    public void setEndTimestamp(Date endTimestamp)
    {
       this.endTimestamp = endTimestamp;
index 014092f..32f28c1 100644 (file)
@@ -94,11 +94,9 @@ public class InetAddressEx
       }
       return bits;
    }
-   
+
    /**
     * Convert bit count into mask
-    * 
-    * @param bits
     * @return
     */
    public InetAddress maskFromBits()
index a1119fb..a143f5c 100644 (file)
@@ -74,11 +74,10 @@ public class NXCPMessage
 
        /**
         * Create NXCPMessage from binary NXCP message
-        *
-        * @param nxcpMessage binary NXCP message
-        * @throws java.io.IOException
-        * @throws GeneralSecurityException 
-        * @throws NXCPException 
+        * @param nxcpMessage
+        * @param ectx
+        * @throws IOException
+        * @throws NXCPException
         */
        public NXCPMessage(final byte[] nxcpMessage, EncryptionContext ectx) throws IOException, NXCPException
        {
@@ -127,12 +126,12 @@ public class NXCPMessage
                        createFromStream(inputStream, byteArrayInputStream);
                }
        }
-       
+
        /**
         * Create NXCPMessage from prepared input byte stream
-        *
-        * @param nxcpMessage binary NXCP message
-        * @throws java.io.IOException
+        * @param inputStream
+        * @param byteArrayInputStream
+        * @throws IOException
         */
        private void createFromStream(NXCPDataInputStream inputStream, ByteArrayInputStream byteArrayInputStream) throws IOException
        {
@@ -651,9 +650,7 @@ public class NXCPMessage
 
        /**
         * Set or clear raw (binary) message flag
-        * 
-        * @param isControl
-        *           true to set control message flag
+        * @param isRaw
         */
        public void setBinaryMessage(boolean isRaw)
        {
index 71ae8a3..021cdb9 100644 (file)
@@ -31,9 +31,11 @@ public class NXCPMessageReceiver
    private int maxBufferSize;
        private byte[] recvBuffer;
        private int bufferPos = 0;
-       
+
        /**
-        * @param bufferSize Size of receive buffer in bytes
+        * Constructor
+        * @param defaultBufferSize default receiving buffer size (in bytes)
+        * @param maxBufferSize maximum receiving buffer size (in bytes)
         */
        public NXCPMessageReceiver(int defaultBufferSize, int maxBufferSize)
        {