Skip to content

Commit 0a09a45

Browse files
committed
fix(javadoc): phase 2 — reduce warnings (in progress)
Add missing Javadoc comments across ~65 files to reduce warning count: - BaseChannel: field/method comments for constructors, filter chain, header accessors, socket helpers, metrics counters (40+ warnings addressed) - BASE1Header, Base1Packager, Base1_BITMAP126, BASE24Packager: public method/constructor docs - ISOFieldPackager, ISOBasePackager: method descriptions, @param/@return gaps - ISOHeader, ISOPackager, ISOChannel, ISOSource, ServerChannel: interface method docs - Interpreter, Prefixer, BinaryInterpreter: missing @param and descriptions - AsciiPrefixer, AsciiHexInterpreter, AsciiInterpreter: private singleton constructors - LogRenderer, AuditLogEvent, AuditLogEventJsonLogRenderer, LogSource: class/method docs - AmexChannel, FilteredChannel, BaseHeader, ClientChannel, FactoryChannel: descriptions - TLV packagers (IFTA_*, IFTB_*, BERTLVFormatMapper, etc.): missing one-liner descriptions - core/: Card, CardHolder, Track1, Track2, Sequencer, VolatileSequencer, Configurable, etc. - emv/: EMVConstructedTag, EMVTagType, UnknownTagNumberException Still at 100 warnings (javadoc caps at 100/run); further iterations in progress.
1 parent 9cadd76 commit 0a09a45

File tree

66 files changed

+485
-177
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+485
-177
lines changed

jpos/src/main/java/org/jpos/bsh/BSHUI.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@
2525
import javax.swing.*;
2626

2727
/**
28-
* @author Alejandro Revilla
2928
*
3029
* UI with BSH script support
30+
*
31+
* @author Alejandro Revilla
32+
*
3133
*/
3234
public class BSHUI extends UI {
3335
protected JComponent doScript (JComponent component, Element e) {

jpos/src/main/java/org/jpos/core/Card.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@
2727
import java.util.Objects;
2828

2929
/**
30-
* @author apr@jpos.org
31-
* @since jPOS 2.0.5
3230
*
3331
* This class is based on the old 'CardHolder' class and adds support for multiple
3432
* PAN and Expiration dates taken from manual entry, track1, track2. It also corrects the name.
33+
*
34+
* @author apr@jpos.org
35+
* @since jPOS 2.0.5
36+
*
3537
*/
3638
public class Card {
3739
private String pan;

jpos/src/main/java/org/jpos/core/CardHolder.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,13 @@
2929
import java.util.StringTokenizer;
3030

3131
/**
32-
* @author apr@cs.com.uy
33-
* @since jPOS 1.1
3432
*
3533
* This class is called 'CardHolder', but a better name could have been 'Card'
3634
* At some point we'll deprecate this one and create a new 'Card' class.
35+
*
36+
* @author apr@cs.com.uy
37+
* @since jPOS 1.1
38+
*
3739
*/
3840
public class CardHolder implements Cloneable, Serializable, Loggeable {
3941
private static final long serialVersionUID = 7449770625551878435L;

jpos/src/main/java/org/jpos/core/Configurable.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@
2727
*/
2828
public interface Configurable {
2929
/**
30+
* Configures this object with the supplied {@link Configuration}.
3031
* @param cfg Configuration object
31-
* @throws ConfigurationException
32+
* @throws ConfigurationException if the configuration is invalid
3233
*/
3334
void setConfiguration(Configuration cfg)
3435
throws ConfigurationException;

jpos/src/main/java/org/jpos/core/Configuration.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@
2222
import java.util.Set;
2323

2424
/**
25+
*
26+
* CardAgents relies on a Configuration object to provide
27+
* runtime configuration parameters such as merchant number, etc.
28+
*
2529
* @author apr@cs.com.uy
2630
* @version $Id$
2731
* @since jPOS 1.1
2832
*
29-
* CardAgents relies on a Configuration object to provide
30-
* runtime configuration parameters such as merchant number, etc.
3133
*/
3234
public interface Configuration {
3335
String get(String propertyName);

jpos/src/main/java/org/jpos/core/ConfigurationException.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import org.jpos.iso.ISOException;
2222

2323
/**
24+
* Thrown when a configurable component cannot be initialised due to invalid or missing configuration.
2425
* @author <a href="mailto:apr@cs.com.uy">Alejandro P. Revilla</a>
2526
* @version $Revision$ $Date$
2627
* @see Configurable

jpos/src/main/java/org/jpos/core/InvalidCardException.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
package org.jpos.core;
2020

2121
/**
22+
* Thrown when card data (PAN, expiry, etc.) is invalid or cannot be parsed.
2223
* @author apr@cs.com.uy
2324
* @version $Id$
2425
* @since jPOS 1.1

jpos/src/main/java/org/jpos/core/Sequencer.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@
2020

2121

2222
/**
23-
* @author apr@cs.com.uy
24-
* @version $Id$
25-
* @since jPOS 1.1
2623
*
2724
* Multipurpose sequencer.<br>
2825
* CardAgents requires persistent sequence number<br>
2926
* Sequencer interface isolate from particular DB implementations
27+
*
28+
* @author apr@cs.com.uy
29+
* @version $Id$
30+
* @since jPOS 1.1
31+
*
3032
*/
3133
public interface Sequencer {
3234
int get(String counterName);

jpos/src/main/java/org/jpos/core/SimpleConfiguration.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import java.util.stream.IntStream;
2727

2828
/**
29+
* A {@link Configuration} implementation backed by a {@link java.util.Properties} object.
2930
* @author apr@cs.com.uy
3031
* @version $Id$
3132
* @since jPOS 1.1

jpos/src/main/java/org/jpos/core/Track1.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,13 @@
2525
import java.util.regex.Pattern;
2626

2727
/**
28-
* @author apr@jpos.org
29-
* @since jPOS 2.0.5
3028
*
3129
* This class is based on the old 'CardHolder' class and adds support for multiple
3230
* PAN and Expiration dates taken from manual entry, track1, track1. It also corrects the name.
31+
*
32+
* @author apr@jpos.org
33+
* @since jPOS 2.0.5
34+
*
3335
*/
3436

3537
@SuppressWarnings("unused")

0 commit comments

Comments
 (0)