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 31da7a8b Javadoc
31da7a8b is described below
commit 31da7a8b0d87f81af8b7671d8fa6e83d971be384
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Wed Aug 21 08:55:39 2024 -0400
Javadoc
---
src/main/java/org/apache/bcel/classfile/Utility.java | 4 ++--
.../java/org/apache/bcel/generic/BranchInstruction.java | 4 ++--
src/main/java/org/apache/bcel/generic/ConstantPoolGen.java | 9 ++++-----
src/main/java/org/apache/bcel/generic/InstructionList.java | 13 ++++++-------
src/main/java/org/apache/bcel/util/CodeHTML.java | 2 +-
5 files changed, 15 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java
b/src/main/java/org/apache/bcel/classfile/Utility.java
index 69f5d9a7..00ff6284 100644
--- a/src/main/java/org/apache/bcel/classfile/Utility.java
+++ b/src/main/java/org/apache/bcel/classfile/Utility.java
@@ -138,7 +138,7 @@ public abstract class Utility {
/*
* The 'WIDE' instruction is used in the byte code to allow 16-bit wide
indices for local variables. This opcode
- * precedes an 'ILOAD', e.g.. The opcode immediately following takes an
extra byte which is combined with the following
+ * precedes an 'ILOAD', for example. The opcode immediately following
takes an extra byte which is combined with the following
* byte to form a 16-bit value.
*/
private static boolean wide;
@@ -547,7 +547,7 @@ public abstract class Utility {
}
/**
- * Shorten long class names, <em>java/lang/String</em> becomes
<em>java.lang.String</em>, e.g.. If <em>chopit</em> is
+ * Shorten long class names, <em>java/lang/String</em> becomes
<em>java.lang.String</em>, for example. If <em>chopit</em> is
* <em>true</em> the prefix <em>java.lang</em> is also removed.
*
* @param str The long class name
diff --git a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
index 810608e1..dc2b852c 100644
--- a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
@@ -22,8 +22,8 @@ import java.io.IOException;
import org.apache.bcel.util.ByteSequence;
/**
- * Abstract super class for branching instructions like GOTO, IFEQ, etc..
Branch instructions may have a variable
- * length, namely GOTO, JSR, LOOKUPSWITCH and TABLESWITCH.
+ * Abstract super class for branching instructions like GOTO, IFEQ, and so on.
Branch instructions may have a variable length, namely GOTO, JSR, LOOKUPSWITCH
+ * and TABLESWITCH.
*
* @see InstructionList
*/
diff --git a/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
b/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
index 0dc45781..9a07db7f 100644
--- a/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
+++ b/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
@@ -40,11 +40,10 @@ import org.apache.bcel.classfile.ConstantUtf8;
import org.apache.bcel.classfile.Utility;
/**
- * This class is used to build up a constant pool. The user adds constants via
'addXXX' methods, 'addString',
- * 'addClass', etc.. These methods return an index into the constant pool.
Finally, 'getFinalConstantPool()' returns the
- * constant pool built up. Intermediate versions of the constant pool can be
obtained with 'getConstantPool()'. A
- * constant pool has capacity for Constants.MAX_SHORT entries. Note that the
first (0) is used by the JVM and that
- * Double and Long constants need two slots.
+ * This class is used to build up a constant pool. The user adds constants via
'addXXX' methods, 'addString', 'addClass', and so on. These methods return an
+ * index into the constant pool. Finally, 'getFinalConstantPool()' returns the
constant pool built up. Intermediate versions of the constant pool can be
+ * obtained with 'getConstantPool()'. A constant pool has capacity for
Constants.MAX_SHORT entries. Note that the first (0) is used by the JVM and
that Double
+ * and Long constants need two slots.
*
* @see Constant
*/
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index 0f2eece9..cd5ba887 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -34,14 +34,13 @@ import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.stream.Streams;
/**
- * This class is a container for a list of <a
href="Instruction.html">Instruction</a> objects. Instructions can be
- * appended, inserted, moved, deleted, etc.. Instructions are being wrapped
into
- * <a href="InstructionHandle.html">InstructionHandles</a> objects that are
returned upon append/insert operations. They
- * give the user (read only) access to the list structure, such that it can be
traversed and manipulated in a controlled
- * way.
- *
+ * This class is a container for a list of <a
href="Instruction.html">Instruction</a> objects. Instructions can be appended,
inserted, moved, deleted, and so
+ * on. Instructions are being wrapped into <a
href="InstructionHandle.html">InstructionHandles</a> objects that are returned
upon append/insert operations. They
+ * give the user (read only) access to the list structure, such that it can be
traversed and manipulated in a controlled way.
+ * <p>
* A list is finally dumped to a byte code array with <a
href="#getByteCode()">getByteCode</a>.
- *
+ * </p>
+ *
* @see Instruction
* @see InstructionHandle
* @see BranchHandle
diff --git a/src/main/java/org/apache/bcel/util/CodeHTML.java
b/src/main/java/org/apache/bcel/util/CodeHTML.java
index 0df21b03..ad9cb979 100644
--- a/src/main/java/org/apache/bcel/util/CodeHTML.java
+++ b/src/main/java/org/apache/bcel/util/CodeHTML.java
@@ -372,7 +372,7 @@ final class CodeHTML {
gotoSet = new BitSet(bytes.available());
int opcode;
/*
- * First get Code attribute from method and the exceptions handled
(try .. catch) in this method. We only need the line
+ * First get Code attribute from method and the exceptions handled
(try-catch) in this method. We only need the line
* number here.
*/
if (code != null) {
