Fixes javadoc warnings

kamlesh1988 · Apr 9, 2014 · fe22ebb · fe22ebb
1 parent f29e7cf
commit fe22ebb
Show file tree

Hide file tree

Showing 59 changed files with 186 additions and 413 deletions.
diff --git a/build.gradle b/build.gradle
@@ -26,10 +26,17 @@ allprojects {
     }
     if (project.hasProperty("lint")) {
       // gradle -Plint ...
-      tasks.withType(Compile) { 
+      tasks.withType(JavaCompile) {
         options.compilerArgs << "-Xlint" 
       } 
     }
+
+    if (JavaVersion.current().isJava8Compatible()) {
+        tasks.withType(Javadoc) {
+          options.addStringOption('Xdoclint:none', '-quiet')
+        }
+    }
+
     def pomConfig = {
         name 'jPOS Project'
         description """

diff --git a/compat_1_5_2/src/main/java/org/jpos/core/CardAgentLookup.java b/compat_1_5_2/src/main/java/org/jpos/core/CardAgentLookup.java
@@ -85,7 +85,7 @@ synchronized public static CardAgent[] getAgents (CardTransaction t) {
     }
     /**
      * locate an agent giving its class Name
-     * @param class name
+     * @param name
      * @return given agent
      * @exception CardAgentNotFoundException
      */
@@ -138,7 +138,7 @@ synchronized public static CardAgent getAgent (byte[] b)
 
     /**
      * locate an agent of a given class
-     * @param class 
+     * @param t
      * @return given agent
      * @exception CardAgentNotFoundException
      */

diff --git a/compat_1_5_2/src/main/java/org/jpos/space/TransientSpace.java b/compat_1_5_2/src/main/java/org/jpos/space/TransientSpace.java
@@ -25,15 +25,11 @@
  * @author Alejandro Revilla
  * @version $Revision$ $Date$
  * @since 2.0
- * @jmx:mbean description "TransientSpace"
  */
 public class TransientSpace implements LocalSpace, TransientSpaceMBean {
     protected Map map;
     static LocalSpace defaultSpace = new TransientSpace ();
 
-    /**
-     * @jmx:managed-constructor description="Default Constructor"
-     */
     public TransientSpace () {
         super();
         map = new HashMap ();
@@ -234,7 +230,6 @@ public static final LocalSpace getSpace (String spaceName) {
     }
     /**
      * @return set of keys present in the Space
-     * @jmx:managed-attribute description="Keys in Space"
      */
     public Set getKeySet () {
         Set keySet;
@@ -261,9 +256,6 @@ public String getKeys () {
      * same as Space.out (key,value)
      * @param key Key
      * @param value value
-     * @jmx:managed-operation description="Write value to key"
-     * @jmx:managed-operation-parameter position="0" name="key" description="Space Key"
-     * @jmx:managed-operation-parameter position="1" name="value" description="Value to write"
      */
     public void write (String key, String value) {
         out (key, value);
@@ -273,8 +265,6 @@ public void write (String key, String value) {
      * same as (String) Space.rdp (key)
      * @param key Key
      * @return value.toString()
-     * @jmx:managed-operation description="Read value from key"
-     * @jmx:managed-operation-parameter position="0" name="key" description="Space Key"
      */
     public String read (String key) {
         Object o = rdp (key);

diff --git a/jpos/src/main/java/org/jpos/core/CardHolder.java b/jpos/src/main/java/org/jpos/core/CardHolder.java
@@ -88,7 +88,6 @@ public CardHolder (String track2)
 
     /**
      * creates a new CardHolder based on pan and exp
-     * @param track2 cards track2
      * @exception InvalidCardException
      */
     public CardHolder (String pan, String exp) 

diff --git a/jpos/src/main/java/org/jpos/core/NodeConfigurable.java b/jpos/src/main/java/org/jpos/core/NodeConfigurable.java
@@ -28,7 +28,6 @@
  */
 public interface NodeConfigurable {
    /**
-    * @param cfg Configuration object
     * @throws ConfigurationException
     */
     public void setConfiguration (Node node)

diff --git a/jpos/src/main/java/org/jpos/core/ReadableConfiguration.java b/jpos/src/main/java/org/jpos/core/ReadableConfiguration.java
@@ -28,7 +28,7 @@
  */
 public interface ReadableConfiguration {
    /**
-    * @returns cfg Configuration object
+    * @return cfg Configuration object
     */
     public Configuration getConfiguration ();
 }

diff --git a/jpos/src/main/java/org/jpos/iso/AsciiHexInterpreter.java b/jpos/src/main/java/org/jpos/iso/AsciiHexInterpreter.java
@@ -37,7 +37,6 @@ public class AsciiHexInterpreter implements BinaryInterpreter
 
     /**
      * Converts the binary data into ASCII hex digits.
-     * @see org.jpos.iso.BinaryInterpreter#interpret(byte[], byte[], int)
      */
     public void interpret(byte[] data, byte[] b, int offset)
     {
@@ -49,7 +48,6 @@ public void interpret(byte[] data, byte[] b, int offset)
 
     /**
      * Converts the ASCII hex digits into binary data.
-     * @see org.jpos.iso.BinaryInterpreter#uninterpret(byte[], int, int)
      */
     public byte[] uninterpret(byte[] rawData, int offset, int length)
     {
@@ -63,11 +61,10 @@ public byte[] uninterpret(byte[] rawData, int offset, int length)
 
     /**
      * Returns double nBytes because the hex representation of 1 byte needs 2 hex digits.
-     * 
-     * @see org.jpos.iso.BinaryInterpreter#getPackedLength(int)
+     *
      */
     public int getPackedLength(int nBytes)
     {
         return nBytes * 2;
     }
-}
+}
diff --git a/jpos/src/main/java/org/jpos/iso/AsciiInterpreter.java b/jpos/src/main/java/org/jpos/iso/AsciiInterpreter.java
@@ -35,9 +35,8 @@ public class AsciiInterpreter implements Interpreter
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#interpret(java.lang.String)
-	 */
+	 *
+     */
     public void interpret(String data, byte[] b, int offset)
     {
         try {
@@ -49,9 +48,8 @@ public void interpret(String data, byte[] b, int offset)
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#uninterpret(byte[])
-	 */
+	 *
+     */
     public String uninterpret (byte[] rawData, int offset, int length) {
         byte[] ret = new byte[length];
         try {
@@ -69,9 +67,8 @@ public String uninterpret (byte[] rawData, int offset, int length) {
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#getPackedLength(int)
-	 */
+	 *
+     */
     public int getPackedLength(int nDataUnits)
     {
         return nDataUnits;

diff --git a/jpos/src/main/java/org/jpos/iso/BCDInterpreter.java b/jpos/src/main/java/org/jpos/iso/BCDInterpreter.java
@@ -47,9 +47,8 @@ private BCDInterpreter(boolean leftPadded, boolean fPadded) {
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#interpret(java.lang.String)
-	 */
+	 *
+     */
     public void interpret(String data, byte[] b, int offset)
     {
         ISOUtil.str2bcd(data, leftPadded, b, offset);
@@ -65,9 +64,8 @@ public void interpret(String data, byte[] b, int offset)
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#uninterpret(byte[])
-	 */
+	 *
+     */
     public String uninterpret(byte[] rawData, int offset, int length)
     {
         return ISOUtil.bcd2str (rawData, offset, length, leftPadded);
@@ -76,9 +74,8 @@ public String uninterpret(byte[] rawData, int offset, int length)
     /**
 	 * Each numeric digit is packed into a nibble, so 2 digits per byte, plus the
      * possibility of padding.
-	 * 
-	 * @see org.jpos.iso.Interpreter#getPackedLength(int)
-	 */
+	 *
+     */
     public int getPackedLength(int nDataUnits)
     {
         return (nDataUnits + 1) / 2;

diff --git a/jpos/src/main/java/org/jpos/iso/BcdPrefixer.java b/jpos/src/main/java/org/jpos/iso/BcdPrefixer.java
@@ -61,9 +61,6 @@ public BcdPrefixer(int nDigits)
         this.nDigits = nDigits;
     }
 
-    /**
-	 * @see org.jpos.iso.Prefixer#encodeLength(int, byte[])
-	 */
     public void encodeLength(int length, byte[] b)
     {
         for (int i = getPackedLength() - 1; i >= 0; i--) {
@@ -73,9 +70,6 @@ public void encodeLength(int length, byte[] b)
         }
     }
 
-    /**
-	 * @see org.jpos.iso.Prefixer#decodeLength(byte[], int)
-	 */
     public int decodeLength(byte[] b, int offset)
     {
         int len = 0;
@@ -95,4 +89,4 @@ public int getPackedLength()
     {
         return (nDigits + 1) >> 1;
     }
-}
+}
diff --git a/jpos/src/main/java/org/jpos/iso/EbcdicBinaryInterpreter.java b/jpos/src/main/java/org/jpos/iso/EbcdicBinaryInterpreter.java
@@ -30,18 +30,14 @@ public class EbcdicBinaryInterpreter implements BinaryInterpreter {
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.BinaryInterpreter#interpret(byte[],byte[],int)
-	 */
+	 *
+     */
     public void interpret(byte[] data, byte[] b, int offset)
     {
         ISOUtil.asciiToEbcdic(data, b, offset);
     }
 
-   /**
-    * @see org.jpos.iso.BinaryInterpreter#uninterpret(byte[],int,int)
-    */
-    public byte[] uninterpret(byte[] rawData, int offset, int length)
+   public byte[] uninterpret(byte[] rawData, int offset, int length)
     {
         return ISOUtil.ebcdicToAsciiBytes(rawData, offset, length);
     }

diff --git a/jpos/src/main/java/org/jpos/iso/EbcdicHexInterpreter.java b/jpos/src/main/java/org/jpos/iso/EbcdicHexInterpreter.java
@@ -39,7 +39,6 @@ public class EbcdicHexInterpreter implements BinaryInterpreter
 
     /**
      * Converts the binary data into EBCDIC hex digits.
-     * @see org.jpos.iso.BinaryInterpreter#interpret(byte[], byte[], int)
      */
     public void interpret(byte[] data, byte[] b, int offset)
     {
@@ -51,7 +50,6 @@ public void interpret(byte[] data, byte[] b, int offset)
 
     /**
      * Converts the EBCDIC hex digits into binary data.
-     * @see org.jpos.iso.BinaryInterpreter#uninterpret(byte[], int, int)
      */
     public byte[] uninterpret(byte[] rawData, int offset, int length)
     {
@@ -70,8 +68,7 @@ public byte[] uninterpret(byte[] rawData, int offset, int length)
 
     /**
      * Returns double nBytes because the hex representation of 1 byte needs 2 hex digits.
-     * 
-     * @see org.jpos.iso.BinaryInterpreter#getPackedLength(int)
+     *
      */
     public int getPackedLength(int nBytes)
     {

diff --git a/jpos/src/main/java/org/jpos/iso/EbcdicInterpreter.java b/jpos/src/main/java/org/jpos/iso/EbcdicInterpreter.java
@@ -32,31 +32,28 @@ public class EbcdicInterpreter implements Interpreter
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#interpret(java.lang.String)
-	 */
+	 *
+     */
     public void interpret(String data, byte[] b, int offset)
     {
         ISOUtil.asciiToEbcdic(data, b, offset);
     }
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#uninterpret(byte[])
-	 */
+	 *
+     */
     public String uninterpret(byte[] rawData, int offset, int length)
     {
         return ISOUtil.ebcdicToAscii(rawData, offset, length);
     }
 
     /**
 	 * (non-Javadoc)
-	 * 
-	 * @see org.jpos.iso.Interpreter#getPackedLength(int)
-	 */
+	 *
+     */
     public int getPackedLength(int nDataUnits)
     {
         return nDataUnits;
     }
-}
+}
diff --git a/jpos/src/main/java/org/jpos/iso/GenericSSLSocketFactory.java b/jpos/src/main/java/org/jpos/iso/GenericSSLSocketFactory.java
@@ -331,9 +331,6 @@ public String[] getEnabledCipherSuites() {
     }
 
 
-    /**
-     * @see org.jpos.core.Configurable#setConfiguration(org.jpos.core.Configuration)
-     */
     public void setConfiguration(Configuration cfg) throws ConfigurationException {
         this.cfg = cfg;
         keyStore = cfg.get("keystore");

diff --git a/jpos/src/main/java/org/jpos/iso/HexNibblesPrefixer.java b/jpos/src/main/java/org/jpos/iso/HexNibblesPrefixer.java
@@ -34,9 +34,6 @@ public HexNibblesPrefixer(int nDigits) {
         this.nDigits = nDigits;
     }
 
-    /**
-	 * @see org.jpos.iso.Prefixer#encodeLength(int, byte[])
-	 */
     public void encodeLength(int length, byte[] b) {
         length <<= 1;
         for (int i = getPackedLength() - 1; i >= 0; i--) {
@@ -46,9 +43,6 @@ public void encodeLength(int length, byte[] b) {
         }
     }
 
-    /**
-	 * @see org.jpos.iso.Prefixer#decodeLength(byte[], int)
-	 */
     public int decodeLength(byte[] b, int offset) {
         int len = 0;
         for (int i = 0; i < (nDigits + 1) / 2; i++)

diff --git a/jpos/src/main/java/org/jpos/iso/IF_UNUSED.java b/jpos/src/main/java/org/jpos/iso/IF_UNUSED.java
@@ -31,8 +31,6 @@
  */
 public class IF_UNUSED extends ISOFieldPackager {
     /**
-     * @param len - field len
-     * @param description symbolic descrption
      */
     public IF_UNUSED () {
         super(0, "<dummy>");

diff --git a/jpos/src/main/java/org/jpos/iso/ISOAmountFieldPackager.java b/jpos/src/main/java/org/jpos/iso/ISOAmountFieldPackager.java
@@ -105,8 +105,7 @@ public void setPrefixer(Prefixer prefixer)
 
     /**
      * Returns the prefixer's packed length and the interpreter's packed length.
-	 * @see org.jpos.iso.ISOFieldPackager#getMaxPackedLength()
-	 */
+     */
     public int getMaxPackedLength()
     {
         return prefixer.getPackedLength() + interpreter.getPackedLength(getLength());

diff --git a/jpos/src/main/java/org/jpos/iso/ISOBinaryFieldPackager.java b/jpos/src/main/java/org/jpos/iso/ISOBinaryFieldPackager.java
@@ -87,9 +87,6 @@ public void setPrefixer(Prefixer prefixer)
         this.prefixer = prefixer;
     }
 
-    /**
-	 * @see org.jpos.iso.ISOFieldPackager#getMaxPackedLength()
-	 */
     public int getMaxPackedLength()
     {
         return prefixer.getPackedLength() + interpreter.getPackedLength(getLength());
@@ -121,10 +118,6 @@ public byte[] pack(ISOComponent c) throws ISOException
         }
     }
 
-    /**
-	 * @see org.jpos.iso.ISOFieldPackager#unpack(org.jpos.iso.ISOComponent,
-	 *      byte[], int)
-	 */
     public int unpack(ISOComponent c, byte[] b, int offset) throws ISOException
     {
         try