Skip to content

Commit 816bb81

Browse files
committed
fix(javadoc): weekly batch — reduce warnings from 1097 to 1032
1 parent 42241ef commit 816bb81

23 files changed

Lines changed: 149 additions & 17 deletions

jpos/src/main/java/module-info.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/** Java module definition for the jPOS core library. */
12
module org.jpos.jpos {
23
requires java.se;
34
requires jdk.jfr;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
* @since jPOS 1.1
3333
*/
3434
public class SimpleConfiguration implements Configuration, Serializable {
35+
/** Backing property store used by this configuration instance. */
3536
private Properties props;
3637

3738
/** Default constructor. */

jpos/src/main/java/org/jpos/emv/EMVConstructedTag.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@
3131
*/
3232
public class EMVConstructedTag<T> implements Serializable {
3333

34+
/** EMV tag classification and metadata. */
3435
private final EMVTagType tagType;
36+
/** TLV data format used to encode the value. */
3537
private final TLVDataFormat dataFormat;
38+
/** Numeric EMV tag identifier. */
3639
private final Integer tagNumber;
40+
/** Parsed value carried by this tag. */
3741
private final T value;
3842

3943

jpos/src/main/java/org/jpos/emv/EMVTag.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,13 @@
3434
public abstract class EMVTag<T> implements TagValue<T>, Serializable {
3535

3636
private static final long serialVersionUID = 4674858246785118615L;
37+
/** EMV tag classification and metadata. */
3738
private final EMVTagType tagType;
39+
/** TLV data format used to encode the value. */
3840
private final TLVDataFormat dataFormat;
41+
/** Numeric EMV tag identifier. */
3942
private final Integer tagNumber;
43+
/** Parsed value carried by this tag. */
4044
private final T value;
4145

4246

jpos/src/main/java/org/jpos/iso/ISOException.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ public class ISOException extends Exception implements Loggeable {
3333

3434
private static final long serialVersionUID = -777216335204861186L;
3535
/**
36-
* @serial
36+
* Nested exception wrapped by this ISOException, when present.
37+
*
38+
* @serial wrapped cause captured for legacy serialization
3739
*/
3840
Throwable nested = null;
3941

jpos/src/main/java/org/jpos/iso/ISOServerAcceptEvent.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
/** Event fired when a new client connection is accepted by ISOServer. */
2525
public final class ISOServerAcceptEvent extends EventObject implements ISOServerEvent {
26+
/** Weak reference to the accepted channel. */
2627
private WeakReference<ISOChannel> channelRef;
2728
/** Constructs the event.
2829
* @param source the ISOServer

jpos/src/main/java/org/jpos/iso/ISOServerClientDisconnectEvent.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
/** Event fired when a client disconnects from ISOServer. */
2525
public final class ISOServerClientDisconnectEvent extends EventObject implements ISOServerEvent {
26+
/** Weak reference to the disconnected channel. */
2627
private WeakReference<ISOChannel> channelRef;
2728
/** Constructs the event.
2829
* @param source the event source

jpos/src/main/java/org/jpos/iso/filter/XSLTFilter.java

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,10 @@ public XSLTFilter () throws ISOException {
6161
}
6262

6363
/**
64-
* @param xsltfile XSL Transformation file
65-
* @param reread true if you want XSLT file re-read from disk
64+
* Creates a filter backed by the supplied XSL transformation file.
65+
*
66+
* @param xsltfile XSL transformation file
67+
* @param reread true if you want the XSLT file re-read from disk
6668
* @throws ISOException on pack/unpack error
6769
*/
6870
public XSLTFilter (String xsltfile, boolean reread)
@@ -105,11 +107,13 @@ public void setConfiguration (Configuration cfg)
105107
}
106108

107109
/**
110+
* Applies the configured XSLT transformation to the supplied message.
111+
*
108112
* @param channel current ISOChannel instance
109113
* @param m ISOMsg to filter
110-
* @param evt LogEvent
111-
* @return an ISOMsg (possibly parameter m)
112-
* @throws VetoException
114+
* @param evt LogEvent collecting filter diagnostics
115+
* @return an ISOMsg, usually the same instance passed in
116+
* @throws VetoException if the transformation fails
113117
*/
114118
public ISOMsg filter (ISOChannel channel, ISOMsg m, LogEvent evt)
115119
throws VetoException

jpos/src/main/java/org/jpos/iso/gui/ISOChannelPanel.java

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,27 @@
3838
public class ISOChannelPanel extends JPanel implements Observer {
3939
private static final long serialVersionUID = -8069489863639386589L;
4040
/**
41-
* @serial
41+
* Meter widget used to visualize channel activity.
42+
*
43+
* @serial embedded child component state
4244
*/
4345
ISOMeter meter;
4446
/**
45-
* @serial
47+
* Rolling log model displayed when the meter is opened.
48+
*
49+
* @serial serialized log contents
4650
*/
4751
DefaultListModel log;
4852
/**
49-
* @serial
53+
* Human-readable channel name shown in the UI.
54+
*
55+
* @serial display name persisted with the panel
5056
*/
5157
String symbolicName;
5258

59+
/** Fields that must be protected before logging. */
5360
private int[] protectFields = null;
61+
/** Fields that must be wiped before logging. */
5462
private int[] wipeFields = null;
5563

5664
/** Maximum number of log entries to retain. */

jpos/src/main/java/org/jpos/iso/gui/ISOMeter.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ public class ISOMeter extends JComponent implements Runnable {
116116
*/
117117
int refreshPanel = 50;
118118

119+
/** Off-screen image buffer used during repaint operations. */
119120
private Image imb;
121+
/** Background thread that advances the animated meter display. */
120122
private Thread repaintThread;
121123

122124
/** Constructs an ISOMeter for the given channel panel.

0 commit comments

Comments
 (0)