#21 improve javadocs

kpavlov · Jan 22, 2017 · eec2511 · eec2511
1 parent f9cbeeb
commit eec2511
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/main/java/org/jreactive/iso8583/ConnectorConfiguration.java b/src/main/java/org/jreactive/iso8583/ConnectorConfiguration.java
@@ -73,6 +73,7 @@ public int getMaxFrameLength() {
     }
 
     /**
+     * @param maxFrameLength the maximum length of the frame.
      * @deprecated Use {@link Builder}
      */
     @Deprecated
@@ -82,6 +83,7 @@ public void setMaxFrameLength(int maxFrameLength) {
 
     /**
      * @deprecated Use {@link Builder}
+     * @param addLoggingHandler should logging handler be added to pipeline
      */
     @Deprecated
     public void setAddLoggingHandler(boolean addLoggingHandler) {
@@ -108,6 +110,7 @@ public boolean replyOnError() {
     }
 
     /**
+     * @param replyOnError should reply on error
      * @deprecated Use {@link Builder}
      */
     @Deprecated
@@ -128,6 +131,7 @@ public boolean logSensitiveData() {
     }
 
     /**
+     * @param logSensitiveData should log sensitive data
      * @deprecated Use {@link Builder}
      */
     @Deprecated
@@ -141,6 +145,7 @@ public boolean logFieldDescription() {
 
     /**
      * @deprecated Use {@link Builder}
+     * @param logFieldDescription Should field descriptions be printed in log. Useful for when testing system integration.
      */
     @Deprecated
     public void setLogFieldDescription(boolean logFieldDescription) {
@@ -160,6 +165,7 @@ public int[] getSensitiveDataFields() {
     }
 
     /**
+     * @param sensitiveDataFields which fields may contain sensitive data
      * @deprecated Use {@link Builder}
      */
     @Deprecated
@@ -168,7 +174,7 @@ public void setSensitiveDataFields(int[] sensitiveDataFields) {
     }
 
 
-    @SuppressWarnings("unchecked")
+    @SuppressWarnings({"unchecked", "unused"})
     protected abstract static class Builder<B extends Builder> {
         private int maxFrameLength = DEFAULT_MAX_FRAME_LENGTH;