Skip to content

Commit 348b531

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent 0949b7c commit 348b531

6 files changed

Lines changed: 24 additions & 20 deletions

File tree

‎src/main/java/org/apache/bcel/classfile/PMGClass.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,14 @@ public String getPMGName() {
131131
}
132132

133133
/**
134-
* @param pmgClassIndex.
134+
* @param pmgClassIndex The class index.
135135
*/
136136
public void setPMGClassIndex(final int pmgClassIndex) {
137137
this.pmgClassIndex = pmgClassIndex;
138138
}
139139

140140
/**
141-
* @param pmgIndex.
141+
* @param pmgIndex The index.
142142
*/
143143
public void setPMGIndex(final int pmgIndex) {
144144
this.pmgIndex = pmgIndex;

‎src/main/java/org/apache/bcel/classfile/SourceFile.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public String getSourceFileName() {
119119
}
120120

121121
/**
122-
* @param sourceFileIndex.
122+
* @param sourceFileIndex The source file index to set.
123123
*/
124124
public void setSourceFileIndex(final int sourceFileIndex) {
125125
this.sourceFileIndex = sourceFileIndex;

‎src/main/java/org/apache/bcel/classfile/StackMapEntry.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public final class StackMapEntry implements Node, Cloneable {
104104
/**
105105
* DO NOT USE
106106
*
107-
* @param byteCodeOffset.
107+
* @param byteCodeOffset byte code offset.
108108
* @param numberOfLocals NOT USED.
109109
* @param typesOfLocals array of {@link StackMapType}s of locals.
110110
* @param numberOfStackItems NOT USED.
@@ -131,7 +131,7 @@ public StackMapEntry(final int byteCodeOffset, final int numberOfLocals, final S
131131
* Create an instance
132132
*
133133
* @param tag the frameType to use.
134-
* @param byteCodeOffset.
134+
* @param byteCodeOffset byte code offset.
135135
* @param typesOfLocals array of {@link StackMapType}s of locals.
136136
* @param typesOfStackItems array ot {@link StackMapType}s of stack items.
137137
* @param constantPool the constant pool.

‎src/main/java/org/apache/bcel/classfile/Synthetic.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,18 @@ public Attribute copy(final ConstantPool constantPool) {
100100
}
101101

102102
/**
103+
* Gets data bytes.
104+
*
103105
* @return data bytes.
104106
*/
105107
public byte[] getBytes() {
106108
return ArrayUtils.EMPTY_BYTE_ARRAY;
107109
}
108110

109111
/**
110-
* @param bytes.
112+
* Sets data bytes.
113+
*
114+
* @param bytes data bytes.
111115
*/
112116
public void setBytes(final byte[] bytes) {
113117
if (bytes != null) {

‎src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
public interface ConstantPushInstruction extends PushInstruction, TypedInstruction {
2929

3030
/**
31-
* Gets the value to be pushed onto the stack.
31+
* Gets the value to push onto the stack.
3232
*
33-
* @return the value to be pushed onto the stack.
33+
* @return the value to push onto the stack.
3434
*/
3535
Number getValue();
3636
}

‎src/main/java/org/apache/bcel/generic/PUSH.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public final class PUSH implements CompoundInstruction, VariableLengthInstructio
3333
* Pushes an array type constant, for example {@code int[].class}, {@code String[].class}, and so on.
3434
*
3535
* @param cp generated constant pool.
36-
* @param value to be pushed.
36+
* @param value to push.
3737
* @since 6.7.0
3838
*/
3939
public PUSH(final ConstantPoolGen cp, final ArrayType value) {
@@ -46,7 +46,7 @@ public PUSH(final ConstantPoolGen cp, final ArrayType value) {
4646

4747
/**
4848
* @param cp Constant pool.
49-
* @param value to be pushed.
49+
* @param value to push.
5050
*/
5151
public PUSH(final ConstantPoolGen cp, final boolean value) {
5252
Objects.requireNonNull(cp, "cp");
@@ -55,7 +55,7 @@ public PUSH(final ConstantPoolGen cp, final boolean value) {
5555

5656
/**
5757
* @param cp Constant pool.
58-
* @param value to be pushed.
58+
* @param value to push.
5959
*/
6060
public PUSH(final ConstantPoolGen cp, final Boolean value) {
6161
this(cp, value.booleanValue());
@@ -66,15 +66,15 @@ public PUSH(final ConstantPoolGen cp, final Boolean value) {
6666
* value parameter, as an alternative constructor will be called
6767
*
6868
* @param cp Constant pool.
69-
* @param value to be pushed.
69+
* @param value to push.
7070
*/
7171
public PUSH(final ConstantPoolGen cp, final Character value) {
7272
this(cp, value.charValue());
7373
}
7474

7575
/**
7676
* @param cp Constant pool.
77-
* @param value to be pushed.
77+
* @param value to push.
7878
*/
7979
public PUSH(final ConstantPoolGen cp, final double value) {
8080
if (value == 0.0) {
@@ -88,7 +88,7 @@ public PUSH(final ConstantPoolGen cp, final double value) {
8888

8989
/**
9090
* @param cp Constant pool.
91-
* @param value to be pushed.
91+
* @param value to push.
9292
*/
9393
public PUSH(final ConstantPoolGen cp, final float value) {
9494
if (value == 0.0) {
@@ -106,7 +106,7 @@ public PUSH(final ConstantPoolGen cp, final float value) {
106106
* This constructor also applies for values of type short, char, byte
107107
*
108108
* @param cp Constant pool.
109-
* @param value to be pushed.
109+
* @param value to push.
110110
*/
111111
public PUSH(final ConstantPoolGen cp, final int value) {
112112
if (value >= -1 && value <= 5) {
@@ -122,7 +122,7 @@ public PUSH(final ConstantPoolGen cp, final int value) {
122122

123123
/**
124124
* @param cp Constant pool.
125-
* @param value to be pushed.
125+
* @param value to push.
126126
*/
127127
public PUSH(final ConstantPoolGen cp, final long value) {
128128
if (value == 0) {
@@ -136,7 +136,7 @@ public PUSH(final ConstantPoolGen cp, final long value) {
136136

137137
/**
138138
* @param cp Constant pool.
139-
* @param value to be pushed.
139+
* @param value to push.
140140
*/
141141
public PUSH(final ConstantPoolGen cp, final Number value) {
142142
if (value instanceof Integer || value instanceof Short || value instanceof Byte) {
@@ -154,8 +154,8 @@ public PUSH(final ConstantPoolGen cp, final Number value) {
154154

155155
/**
156156
*
157-
* @param cp.
158-
* @param value.
157+
* @param cp The constant pool.
158+
* @param value to push.
159159
* @since 6.0
160160
*/
161161
public PUSH(final ConstantPoolGen cp, final ObjectType value) {
@@ -168,7 +168,7 @@ public PUSH(final ConstantPoolGen cp, final ObjectType value) {
168168

169169
/**
170170
* @param cp Constant pool.
171-
* @param value to be pushed.
171+
* @param value to push.
172172
*/
173173
public PUSH(final ConstantPoolGen cp, final String value) {
174174
if (value == null) {

0 commit comments

Comments
 (0)