This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bcel.git
The following commit(s) were added to refs/heads/master by this push:
new 348b5313 Javadoc
348b5313 is described below
commit 348b53135a1274698783f47924d92a92aeee706a
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 18 17:16:48 2026 -0500
Javadoc
---
.../java/org/apache/bcel/classfile/PMGClass.java | 4 ++--
.../java/org/apache/bcel/classfile/SourceFile.java | 2 +-
.../org/apache/bcel/classfile/StackMapEntry.java | 4 ++--
.../java/org/apache/bcel/classfile/Synthetic.java | 6 +++++-
.../bcel/generic/ConstantPushInstruction.java | 4 ++--
src/main/java/org/apache/bcel/generic/PUSH.java | 24 +++++++++++-----------
6 files changed, 24 insertions(+), 20 deletions(-)
diff --git a/src/main/java/org/apache/bcel/classfile/PMGClass.java
b/src/main/java/org/apache/bcel/classfile/PMGClass.java
index b9f174cc..7f4189ed 100644
--- a/src/main/java/org/apache/bcel/classfile/PMGClass.java
+++ b/src/main/java/org/apache/bcel/classfile/PMGClass.java
@@ -131,14 +131,14 @@ public final class PMGClass extends Attribute {
}
/**
- * @param pmgClassIndex.
+ * @param pmgClassIndex The class index.
*/
public void setPMGClassIndex(final int pmgClassIndex) {
this.pmgClassIndex = pmgClassIndex;
}
/**
- * @param pmgIndex.
+ * @param pmgIndex The index.
*/
public void setPMGIndex(final int pmgIndex) {
this.pmgIndex = pmgIndex;
diff --git a/src/main/java/org/apache/bcel/classfile/SourceFile.java
b/src/main/java/org/apache/bcel/classfile/SourceFile.java
index edbec130..c6c1fbb2 100644
--- a/src/main/java/org/apache/bcel/classfile/SourceFile.java
+++ b/src/main/java/org/apache/bcel/classfile/SourceFile.java
@@ -119,7 +119,7 @@ public final class SourceFile extends Attribute {
}
/**
- * @param sourceFileIndex.
+ * @param sourceFileIndex The source file index to set.
*/
public void setSourceFileIndex(final int sourceFileIndex) {
this.sourceFileIndex = sourceFileIndex;
diff --git a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
index b92c0be1..2dba4ec1 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
@@ -104,7 +104,7 @@ public final class StackMapEntry implements Node, Cloneable
{
/**
* DO NOT USE
*
- * @param byteCodeOffset.
+ * @param byteCodeOffset byte code offset.
* @param numberOfLocals NOT USED.
* @param typesOfLocals array of {@link StackMapType}s of locals.
* @param numberOfStackItems NOT USED.
@@ -131,7 +131,7 @@ public final class StackMapEntry implements Node, Cloneable
{
* Create an instance
*
* @param tag the frameType to use.
- * @param byteCodeOffset.
+ * @param byteCodeOffset byte code offset.
* @param typesOfLocals array of {@link StackMapType}s of locals.
* @param typesOfStackItems array ot {@link StackMapType}s of stack items.
* @param constantPool the constant pool.
diff --git a/src/main/java/org/apache/bcel/classfile/Synthetic.java
b/src/main/java/org/apache/bcel/classfile/Synthetic.java
index c27e4bf2..ac86f5b9 100644
--- a/src/main/java/org/apache/bcel/classfile/Synthetic.java
+++ b/src/main/java/org/apache/bcel/classfile/Synthetic.java
@@ -100,6 +100,8 @@ public final class Synthetic extends Attribute {
}
/**
+ * Gets data bytes.
+ *
* @return data bytes.
*/
public byte[] getBytes() {
@@ -107,7 +109,9 @@ public final class Synthetic extends Attribute {
}
/**
- * @param bytes.
+ * Sets data bytes.
+ *
+ * @param bytes data bytes.
*/
public void setBytes(final byte[] bytes) {
if (bytes != null) {
diff --git a/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
b/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
index 9d16d7fb..a2cf1980 100644
--- a/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/ConstantPushInstruction.java
@@ -28,9 +28,9 @@ package org.apache.bcel.generic;
public interface ConstantPushInstruction extends PushInstruction,
TypedInstruction {
/**
- * Gets the value to be pushed onto the stack.
+ * Gets the value to push onto the stack.
*
- * @return the value to be pushed onto the stack.
+ * @return the value to push onto the stack.
*/
Number getValue();
}
diff --git a/src/main/java/org/apache/bcel/generic/PUSH.java
b/src/main/java/org/apache/bcel/generic/PUSH.java
index 9608bbb5..b0e5a42f 100644
--- a/src/main/java/org/apache/bcel/generic/PUSH.java
+++ b/src/main/java/org/apache/bcel/generic/PUSH.java
@@ -33,7 +33,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
* Pushes an array type constant, for example {@code int[].class}, {@code
String[].class}, and so on.
*
* @param cp generated constant pool.
- * @param value to be pushed.
+ * @param value to push.
* @since 6.7.0
*/
public PUSH(final ConstantPoolGen cp, final ArrayType value) {
@@ -46,7 +46,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final boolean value) {
Objects.requireNonNull(cp, "cp");
@@ -55,7 +55,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final Boolean value) {
this(cp, value.booleanValue());
@@ -66,7 +66,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
* value parameter, as an alternative constructor will be called
*
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final Character value) {
this(cp, value.charValue());
@@ -74,7 +74,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final double value) {
if (value == 0.0) {
@@ -88,7 +88,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final float value) {
if (value == 0.0) {
@@ -106,7 +106,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
* This constructor also applies for values of type short, char, byte
*
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final int value) {
if (value >= -1 && value <= 5) {
@@ -122,7 +122,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final long value) {
if (value == 0) {
@@ -136,7 +136,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final Number value) {
if (value instanceof Integer || value instanceof Short || value
instanceof Byte) {
@@ -154,8 +154,8 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
*
- * @param cp.
- * @param value.
+ * @param cp The constant pool.
+ * @param value to push.
* @since 6.0
*/
public PUSH(final ConstantPoolGen cp, final ObjectType value) {
@@ -168,7 +168,7 @@ public final class PUSH implements CompoundInstruction,
VariableLengthInstructio
/**
* @param cp Constant pool.
- * @param value to be pushed.
+ * @param value to push.
*/
public PUSH(final ConstantPoolGen cp, final String value) {
if (value == null) {
