This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 5d817469 Javadoc
5d817469 is described below
commit 5d817469efa624b37d487f7e4080801017d0114f
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:07 2026 -0400
Javadoc
---
.../org/apache/bcel/classfile/AnnotationEntry.java | 2 +-
.../java/org/apache/bcel/classfile/ConstantUtf8.java | 6 +++---
.../java/org/apache/bcel/classfile/ElementValue.java | 10 +++++-----
.../org/apache/bcel/classfile/ElementValuePair.java | 2 +-
src/main/java/org/apache/bcel/classfile/Record.java | 2 +-
.../org/apache/bcel/classfile/RecordComponentInfo.java | 2 +-
src/main/java/org/apache/bcel/classfile/Utility.java | 2 +-
.../apache/bcel/generic/AnnotationElementValueGen.java | 2 +-
.../org/apache/bcel/generic/AnnotationEntryGen.java | 4 ++--
src/main/java/org/apache/bcel/generic/ArrayType.java | 2 +-
src/main/java/org/apache/bcel/generic/BasicType.java | 2 +-
.../java/org/apache/bcel/generic/ConstantPoolGen.java | 2 +-
.../java/org/apache/bcel/generic/ElementValueGen.java | 6 +++---
.../org/apache/bcel/generic/ElementValuePairGen.java | 2 +-
.../java/org/apache/bcel/generic/FieldOrMethod.java | 2 +-
.../java/org/apache/bcel/generic/INVOKEDYNAMIC.java | 2 +-
.../org/apache/bcel/generic/InstructionFactory.java | 4 ++--
.../org/apache/bcel/generic/InstructionHandle.java | 4 ++--
.../java/org/apache/bcel/generic/InstructionList.java | 2 +-
.../java/org/apache/bcel/generic/JsrInstruction.java | 2 +-
src/main/java/org/apache/bcel/generic/ObjectType.java | 4 ++--
.../org/apache/bcel/generic/ReturnaddressType.java | 2 +-
src/main/java/org/apache/bcel/util/ClassSet.java | 2 +-
src/main/java/org/apache/bcel/util/ClassVector.java | 2 +-
.../java/org/apache/bcel/util/ModularRuntimeImage.java | 8 ++++----
.../java/org/apache/bcel/verifier/PassVerifier.java | 2 +-
.../org/apache/bcel/verifier/VerificationResult.java | 2 +-
.../org/apache/bcel/verifier/structurals/Frame.java | 6 +++---
.../bcel/verifier/structurals/LocalVariables.java | 4 ++--
.../apache/bcel/verifier/structurals/OperandStack.java | 4 ++--
.../verifier/structurals/UninitializedObjectType.java | 2 +-
src/test/java/org/apache/bcel/generic/JavaHome.java | 18 +++++++++---------
.../org/apache/bcel/verifier/VerifyBadClassesTest.java | 2 +-
33 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
index 4ad94058..db4a9fb7 100644
--- a/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/AnnotationEntry.java
@@ -194,7 +194,7 @@ public class AnnotationEntry implements Node {
/**
* Gets a short string representation of this annotation.
*
- * @return a short string representation of this annotation.
+ * @return A short string representation of this annotation.
*/
public String toShortString() {
final StringBuilder result = new StringBuilder();
diff --git a/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
b/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
index 856f44fe..0134613b 100644
--- a/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
+++ b/src/main/java/org/apache/bcel/classfile/ConstantUtf8.java
@@ -126,7 +126,7 @@ public final class ConstantUtf8 extends Constant {
* </p>
*
* @param value the value.
- * @return a new or cached instance of the given value.
+ * @return A new or cached instance of the given value.
* @since 6.0
*/
public static synchronized ConstantUtf8 getCachedInstance(final String
value) {
@@ -154,7 +154,7 @@ public final class ConstantUtf8 extends Constant {
* </p>
*
* @param dataInput the value.
- * @return a new or cached instance of the given value.
+ * @return A new or cached instance of the given value.
* @throws IOException if an I/O error occurs.
* @since 6.0
*/
@@ -169,7 +169,7 @@ public final class ConstantUtf8 extends Constant {
* </p>
*
* @param value the value.
- * @return a new or cached instance of the given value.
+ * @return A new or cached instance of the given value.
* @since 6.0
*/
public static ConstantUtf8 getInstance(final String value) {
diff --git a/src/main/java/org/apache/bcel/classfile/ElementValue.java
b/src/main/java/org/apache/bcel/classfile/ElementValue.java
index 3eb9f79a..d60a4f3d 100644
--- a/src/main/java/org/apache/bcel/classfile/ElementValue.java
+++ b/src/main/java/org/apache/bcel/classfile/ElementValue.java
@@ -100,7 +100,7 @@ public abstract class ElementValue {
*
* @param input Raw data input.
* @param cpool Constant pool.
- * @return a new ElementValue.
+ * @return A new ElementValue.
* @throws IOException if an I/O error occurs.
*/
public static ElementValue readElementValue(final DataInput input, final
ConstantPool cpool) throws IOException {
@@ -155,7 +155,7 @@ public abstract class ElementValue {
* @param input Raw data input.
* @param cpool Constant pool.
* @param arrayNesting level of current array nesting.
- * @return a new ElementValue.
+ * @return A new ElementValue.
* @throws IOException if an I/O error occurs.
* @since 6.7.0
*/
@@ -226,14 +226,14 @@ public abstract class ElementValue {
/**
* Returns a string representation of the element value.
*
- * @return a string representation of the element value.
+ * @return A string representation of the element value.
*/
public abstract String stringifyValue();
/**
* Returns a short string representation of the element value.
*
- * @return a short string representation of the element value.
+ * @return A short string representation of the element value.
*/
public String toShortString() {
return stringifyValue();
@@ -242,7 +242,7 @@ public abstract class ElementValue {
/**
* Returns a string representation of the element value.
*
- * @return a string representation of the element value.
+ * @return A string representation of the element value.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
b/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
index 6881db86..29d3d34e 100644
--- a/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
+++ b/src/main/java/org/apache/bcel/classfile/ElementValuePair.java
@@ -90,7 +90,7 @@ public class ElementValuePair {
/**
* Gets a short string representation.
*
- * @return a short string representation.
+ * @return A short string representation.
*/
public String toShortString() {
final StringBuilder result = new StringBuilder();
diff --git a/src/main/java/org/apache/bcel/classfile/Record.java
b/src/main/java/org/apache/bcel/classfile/Record.java
index a54b79bf..ed567505 100644
--- a/src/main/java/org/apache/bcel/classfile/Record.java
+++ b/src/main/java/org/apache/bcel/classfile/Record.java
@@ -95,7 +95,7 @@ public final class Record extends Attribute {
/**
* Copies this instance and its components.
*
- * @return a deep copy of this instance and its components.
+ * @return A deep copy of this instance and its components.
*/
@Override
public Attribute copy(final ConstantPool constantPool) {
diff --git a/src/main/java/org/apache/bcel/classfile/RecordComponentInfo.java
b/src/main/java/org/apache/bcel/classfile/RecordComponentInfo.java
index 9d3f6562..3812eb72 100644
--- a/src/main/java/org/apache/bcel/classfile/RecordComponentInfo.java
+++ b/src/main/java/org/apache/bcel/classfile/RecordComponentInfo.java
@@ -135,7 +135,7 @@ public class RecordComponentInfo implements Node {
/**
* Converts this instance to a String suitable for debugging.
*
- * @return a String suitable for debugging.
+ * @return A String suitable for debugging.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/bcel/classfile/Utility.java
b/src/main/java/org/apache/bcel/classfile/Utility.java
index 3a8f7515..8ec0cb9e 100644
--- a/src/main/java/org/apache/bcel/classfile/Utility.java
+++ b/src/main/java/org/apache/bcel/classfile/Utility.java
@@ -1062,7 +1062,7 @@ public abstract class Utility {
* Converts a path to a package name.
*
* @param str the source path.
- * @return a package name.
+ * @return A package name.
* @since 6.6.0
*/
public static String pathToPackage(final String str) {
diff --git
a/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
b/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
index 3bd1258d..a14d77e3 100644
--- a/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/AnnotationElementValueGen.java
@@ -89,7 +89,7 @@ public class AnnotationElementValueGen extends
ElementValueGen {
/**
* Returns an immutable variant of this AnnotationElementValueGen.
*
- * @return an immutable variant of this AnnotationElementValueGen.
+ * @return An immutable variant of this AnnotationElementValueGen.
*/
@Override
public ElementValue getElementValue() {
diff --git a/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
b/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
index 7c41b982..d80e9156 100644
--- a/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
+++ b/src/main/java/org/apache/bcel/generic/AnnotationEntryGen.java
@@ -303,7 +303,7 @@ public class AnnotationEntryGen {
/**
* Retrieves an immutable version of this AnnotationGen.
*
- * @return an immutable version of this AnnotationGen.
+ * @return An immutable version of this AnnotationGen.
*/
public AnnotationEntry getAnnotation() {
final AnnotationEntry a = new AnnotationEntry(typeIndex,
cpool.getConstantPool(), isRuntimeVisible);
@@ -368,7 +368,7 @@ public class AnnotationEntryGen {
/**
* Returns a short string representation of this annotation.
*
- * @return a short string representation of this annotation.
+ * @return A short string representation of this annotation.
*/
public String toShortString() {
final StringBuilder s = new StringBuilder();
diff --git a/src/main/java/org/apache/bcel/generic/ArrayType.java
b/src/main/java/org/apache/bcel/generic/ArrayType.java
index 353bf4cb..93627173 100644
--- a/src/main/java/org/apache/bcel/generic/ArrayType.java
+++ b/src/main/java/org/apache/bcel/generic/ArrayType.java
@@ -134,7 +134,7 @@ public final class ArrayType extends ReferenceType {
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git a/src/main/java/org/apache/bcel/generic/BasicType.java
b/src/main/java/org/apache/bcel/generic/BasicType.java
index 847d8678..f60d14b0 100644
--- a/src/main/java/org/apache/bcel/generic/BasicType.java
+++ b/src/main/java/org/apache/bcel/generic/BasicType.java
@@ -80,7 +80,7 @@ public final class BasicType extends Type {
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git a/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
b/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
index 0c3b490e..6121d57a 100644
--- a/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
+++ b/src/main/java/org/apache/bcel/generic/ConstantPoolGen.java
@@ -66,7 +66,7 @@ public class ConstantPoolGen {
* to keep distinct triples distinct.
*
* @param parts the key parts.
- * @return a collision-free key.
+ * @return A collision-free key.
*/
private static String toKey(final String... parts) {
final StringBuilder buf = new StringBuilder();
diff --git a/src/main/java/org/apache/bcel/generic/ElementValueGen.java
b/src/main/java/org/apache/bcel/generic/ElementValueGen.java
index dd3e438f..47360bb3 100644
--- a/src/main/java/org/apache/bcel/generic/ElementValueGen.java
+++ b/src/main/java/org/apache/bcel/generic/ElementValueGen.java
@@ -82,7 +82,7 @@ public abstract class ElementValueGen {
* @param value the element value to copy.
* @param cpool the constant pool generator.
* @param copyPoolEntries whether to copy pool entries.
- * @return a copy of the element value.
+ * @return A copy of the element value.
*/
public static ElementValueGen copy(final ElementValue value, final
ConstantPoolGen cpool, final boolean copyPoolEntries) {
switch (value.getElementValueType()) {
@@ -202,7 +202,7 @@ public abstract class ElementValueGen {
/**
* Subtypes return an immutable variant of the ElementValueGen.
*
- * @return an immutable variant of the ElementValueGen.
+ * @return An immutable variant of the ElementValueGen.
*/
public abstract ElementValue getElementValue();
@@ -218,7 +218,7 @@ public abstract class ElementValueGen {
/**
* Returns a string representation of the element value.
*
- * @return a string representation of the element value.
+ * @return A string representation of the element value.
*/
public abstract String stringifyValue();
}
diff --git a/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
b/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
index d234c05e..f46a7f68 100644
--- a/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
+++ b/src/main/java/org/apache/bcel/generic/ElementValuePairGen.java
@@ -102,7 +102,7 @@ public class ElementValuePairGen {
/**
* Retrieves an immutable version of this ElementValuePairGen.
*
- * @return an immutable ElementValuePair.
+ * @return An immutable ElementValuePair.
*/
public ElementValuePair getElementNameValuePair() {
final ElementValue immutableValue = value.getElementValue();
diff --git a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
index 2bc963ab..24ce3fc1 100644
--- a/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
+++ b/src/main/java/org/apache/bcel/generic/FieldOrMethod.java
@@ -118,7 +118,7 @@ public abstract class FieldOrMethod extends CPInstruction
implements LoadClass {
* Gets the reference type representing the class, interface, or array
class referenced by the instruction.
*
* @param cpg the ConstantPoolGen used to create the instruction.
- * @return an ObjectType (if the referenced class type is a class or
interface), or an ArrayType (if the referenced
+ * @return An ObjectType (if the referenced class type is a class or
interface), or an ArrayType (if the referenced
* class type is an array class)
*/
public ReferenceType getReferenceType(final ConstantPoolGen cpg) {
diff --git a/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
b/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
index 3028ccc6..bdbcfa1b 100644
--- a/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
+++ b/src/main/java/org/apache/bcel/generic/INVOKEDYNAMIC.java
@@ -109,7 +109,7 @@ public class INVOKEDYNAMIC extends InvokeInstruction {
* say for sure the reference will be.
*
* @param cpg the ConstantPoolGen used to create the instruction.
- * @return an ObjectType for {@link Object}.
+ * @return An ObjectType for {@link Object}.
* @since 6.1
*/
@Override
diff --git a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
index ca59cce5..b63e4d9b 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionFactory.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionFactory.java
@@ -635,7 +635,7 @@ public class InstructionFactory implements
InstructionConstants {
* @param name name of the referenced field.
* @param type type of field.
* @param kind how to access, that is, GETFIELD, PUTFIELD, GETSTATIC,
PUTSTATIC.
- * @return a field instruction.
+ * @return A field instruction.
* @see Const
*/
public FieldInstruction createFieldAccess(final String className, final
String name, final Type type, final short kind) {
@@ -784,7 +784,7 @@ public class InstructionFactory implements
InstructionConstants {
*
* @param t the array element type.
* @param dim the array dimensions.
- * @return an instruction that creates the corresponding array at runtime,
for example is an AllocationInstruction.
+ * @return An instruction that creates the corresponding array at runtime,
for example is an AllocationInstruction.
*/
public Instruction createNewArray(final Type t, final short dim) {
if (dim == 1) {
diff --git a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
index 74d6252d..22ffceab 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
@@ -324,7 +324,7 @@ public class InstructionHandle {
/**
* Gets a string representation of the contained instruction.
*
- * @return a string representation of the contained instruction.
+ * @return A string representation of the contained instruction.
*/
@Override
public String toString() {
@@ -335,7 +335,7 @@ public class InstructionHandle {
* Gets a verbose string representation of the contained instruction.
*
* @param verbose whether to be verbose.
- * @return a (verbose) string representation of the contained instruction.
+ * @return A (verbose) string representation of the contained instruction.
*/
public String toString(final boolean verbose) {
return Utility.format(i_position, 4, false, ' ') + ": " +
instruction.toString(verbose);
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index 3056602a..180aa404 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -642,7 +642,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
/**
* Gets an array of instructions without target information for branch
instructions.
*
- * @return an array of instructions without target information for branch
instructions.
+ * @return An array of instructions without target information for branch
instructions.
*/
public Instruction[] getInstructions() {
final List<Instruction> instructions = new ArrayList<>();
diff --git a/src/main/java/org/apache/bcel/generic/JsrInstruction.java
b/src/main/java/org/apache/bcel/generic/JsrInstruction.java
index 4c3c79ab..eed0b3dc 100644
--- a/src/main/java/org/apache/bcel/generic/JsrInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/JsrInstruction.java
@@ -46,7 +46,7 @@ public abstract class JsrInstruction extends
BranchInstruction implements Uncond
* JsrInstruction object must not be shared between multiple
InstructionHandle objects!</B> Formally, there must not be
* InstructionHandle objects i, j where i != j and i.getInstruction() ==
this == j.getInstruction().
*
- * @return an InstructionHandle to the "next" instruction that will be
executed when RETurned from a subroutine.
+ * @return An InstructionHandle to the "next" instruction that will be
executed when RETurned from a subroutine.
*/
public InstructionHandle physicalSuccessor() {
InstructionHandle ih = super.getTarget();
diff --git a/src/main/java/org/apache/bcel/generic/ObjectType.java
b/src/main/java/org/apache/bcel/generic/ObjectType.java
index aff11edb..baa5ff46 100644
--- a/src/main/java/org/apache/bcel/generic/ObjectType.java
+++ b/src/main/java/org/apache/bcel/generic/ObjectType.java
@@ -32,7 +32,7 @@ public class ObjectType extends ReferenceType {
* Constructs a new instance.
*
* @param className fully qualified class name, for example {@link String}.
- * @return a new instance.
+ * @return A new instance.
* @since 6.0
*/
public static ObjectType getInstance(final String className) {
@@ -86,7 +86,7 @@ public class ObjectType extends ReferenceType {
/**
* Gets the hash code.
*
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git a/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
b/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
index 95fa8eb8..036715c0 100644
--- a/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
+++ b/src/main/java/org/apache/bcel/generic/ReturnaddressType.java
@@ -76,7 +76,7 @@ public class ReturnaddressType extends Type {
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git a/src/main/java/org/apache/bcel/util/ClassSet.java
b/src/main/java/org/apache/bcel/util/ClassSet.java
index 084e204b..2b9b7c0e 100644
--- a/src/main/java/org/apache/bcel/util/ClassSet.java
+++ b/src/main/java/org/apache/bcel/util/ClassSet.java
@@ -79,7 +79,7 @@ public class ClassSet {
/**
* Converts the set to an array.
*
- * @return an array of JavaClass objects.
+ * @return An array of JavaClass objects.
*/
public JavaClass[] toArray() {
return map.values().toArray(JavaClass.EMPTY_ARRAY);
diff --git a/src/main/java/org/apache/bcel/util/ClassVector.java
b/src/main/java/org/apache/bcel/util/ClassVector.java
index d91f899b..0a9a8cf1 100644
--- a/src/main/java/org/apache/bcel/util/ClassVector.java
+++ b/src/main/java/org/apache/bcel/util/ClassVector.java
@@ -88,7 +88,7 @@ public class ClassVector implements Serializable {
/**
* Converts the vector to an array.
*
- * @return an array of JavaClass objects.
+ * @return An array of JavaClass objects.
*/
public JavaClass[] toArray() {
return vec.toArray(JavaClass.EMPTY_ARRAY);
diff --git a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
index 5d05b05b..21b88d4d 100644
--- a/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
+++ b/src/main/java/org/apache/bcel/util/ModularRuntimeImage.java
@@ -102,7 +102,7 @@ public class ModularRuntimeImage implements Closeable {
* Lists all entries in the given directory.
*
* @param dirPath directory path.
- * @return a list of dir entries if an I/O error occurs.
+ * @return A list of dir entries if an I/O error occurs.
* @throws IOException an I/O error occurs accessing the file system
*/
public List<Path> list(final Path dirPath) throws IOException {
@@ -117,7 +117,7 @@ public class ModularRuntimeImage implements Closeable {
* Lists all entries in the given directory.
*
* @param dirName directory path.
- * @return a list of dir entries if an I/O error occurs.
+ * @return A list of dir entries if an I/O error occurs.
* @throws IOException an I/O error occurs accessing the file system
*/
public List<Path> list(final String dirName) throws IOException {
@@ -127,7 +127,7 @@ public class ModularRuntimeImage implements Closeable {
/**
* Lists all modules.
*
- * @return a list of modules.
+ * @return A list of modules.
* @throws IOException an I/O error occurs accessing the file system
*/
public List<Path> modules() throws IOException {
@@ -137,7 +137,7 @@ public class ModularRuntimeImage implements Closeable {
/**
* Lists all packages.
*
- * @return a list of modules.
+ * @return A list of modules.
* @throws IOException an I/O error occurs accessing the file system
*/
public List<Path> packages() throws IOException {
diff --git a/src/main/java/org/apache/bcel/verifier/PassVerifier.java
b/src/main/java/org/apache/bcel/verifier/PassVerifier.java
index be9662fb..8016daf0 100644
--- a/src/main/java/org/apache/bcel/verifier/PassVerifier.java
+++ b/src/main/java/org/apache/bcel/verifier/PassVerifier.java
@@ -100,7 +100,7 @@ public abstract class PassVerifier {
* this result may be returned after every invocation of this method
instead of running the verification pass anew;
* likewise with the result of getMessages().
*
- * @return a VerificationResult.
+ * @return A VerificationResult.
* @see #getMessages()
* @see #addMessage(String)
*/
diff --git a/src/main/java/org/apache/bcel/verifier/VerificationResult.java
b/src/main/java/org/apache/bcel/verifier/VerificationResult.java
index ac0b8a87..ac5efeff 100644
--- a/src/main/java/org/apache/bcel/verifier/VerificationResult.java
+++ b/src/main/java/org/apache/bcel/verifier/VerificationResult.java
@@ -104,7 +104,7 @@ public class VerificationResult {
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git a/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
b/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
index 97e2e2cf..4be17145 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/Frame.java
@@ -88,7 +88,7 @@ public class Frame {
/**
* Creates a clone of this frame.
*
- * @return a clone of this frame.
+ * @return A clone of this frame.
*/
@Override
protected Object clone() {
@@ -113,7 +113,7 @@ public class Frame {
/**
* Gets a clone of this frame.
*
- * @return a clone of this frame.
+ * @return A clone of this frame.
*/
public Frame getClone() {
return (Frame) clone();
@@ -138,7 +138,7 @@ public class Frame {
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
b/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
index 874f23ba..e7eec6dd 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/LocalVariables.java
@@ -86,14 +86,14 @@ public class LocalVariables implements Cloneable {
/**
* Returns a (correctly typed) clone of this object. This is equivalent to
((LocalVariables) this.clone()).
*
- * @return a (correctly typed) clone of this object.
+ * @return A (correctly typed) clone of this object.
*/
public LocalVariables getClone() {
return (LocalVariables) clone();
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
b/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
index 84eb7095..c8c57c5f 100644
--- a/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
+++ b/src/main/java/org/apache/bcel/verifier/structurals/OperandStack.java
@@ -93,7 +93,7 @@ public class OperandStack implements Cloneable {
/**
* Returns a (typed!) clone of this.
*
- * @return a clone of this operand stack.
+ * @return A clone of this operand stack.
* @see #clone()
*/
public OperandStack getClone() {
@@ -103,7 +103,7 @@ public class OperandStack implements Cloneable {
/**
* Gets the hash code.
*
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git
a/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
b/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
index 9f447daf..2fc6cf17 100644
---
a/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
+++
b/src/main/java/org/apache/bcel/verifier/structurals/UninitializedObjectType.java
@@ -65,7 +65,7 @@ public class UninitializedObjectType extends ReferenceType
implements Constants
}
/**
- * @return a hash code value for the object.
+ * @return A hash code value for the object.
*/
@Override
public int hashCode() {
diff --git a/src/test/java/org/apache/bcel/generic/JavaHome.java
b/src/test/java/org/apache/bcel/generic/JavaHome.java
index 6e40bf99..d1a1bfae 100644
--- a/src/test/java/org/apache/bcel/generic/JavaHome.java
+++ b/src/test/java/org/apache/bcel/generic/JavaHome.java
@@ -97,7 +97,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of JarFile.
+ * @return A stream of JarFile.
*/
public static Stream<JarEntry> streamJarEntry() {
return streamJavaHome().flatMap(JavaHome::streamJarEntryByExt);
@@ -106,7 +106,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of JarFile.
+ * @return A stream of JarFile.
*/
public static Stream<JarEntry> streamJarEntryClass() {
return streamJavaHome().flatMap(JavaHome::streamJarEntryByExtClass);
@@ -115,7 +115,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of JarFile.
+ * @return A stream of JarFile.
*/
public static Stream<String> streamJarEntryClassName() {
return
streamJavaHome().flatMap(JavaHome::streamJarEntryByExtClassName);
@@ -124,7 +124,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of JarFile.
+ * @return A stream of JarFile.
*/
public static Stream<JarFile> streamJarFile() {
return streamJavaHome().flatMap(JavaHome::streamJarFileByExt);
@@ -133,7 +133,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of Java jar paths.
+ * @return A stream of Java jar paths.
*/
public static Stream<Path> streamJarPath() {
return streamJavaHome().flatMap(JavaHome::streamJarPathByExt);
@@ -142,7 +142,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of Java homes.
+ * @return A stream of Java homes.
*/
public static Stream<JavaHome> streamJavaHome() {
return streamJavaHomeString().map(JavaHome::from);
@@ -151,7 +151,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of Java homes.
+ * @return A stream of Java homes.
*/
public static Stream<String> streamJavaHomeString() {
final Stream<String> streamW = SystemUtils.IS_OS_WINDOWS ?
streamWindowsStrings() : Stream.empty();
@@ -163,7 +163,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of Java jar paths.
+ * @return A stream of Java jar paths.
*/
public static Stream<ModularRuntimeImage> streamModularRuntimeImage() {
return streamJavaHome().map(JavaHome::getModularRuntimeImage);
@@ -172,7 +172,7 @@ public class JavaHome {
/**
* Used from {@code @MethodSource} for tests.
*
- * @return a stream of Java jar paths.
+ * @return A stream of Java jar paths.
*/
public static Stream<Path> streamModulePath() {
return streamJavaHome().flatMap(JavaHome::streamModuleByExt);
diff --git a/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
b/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
index 61d38dab..0c14f1b2 100644
--- a/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
+++ b/src/test/java/org/apache/bcel/verifier/VerifyBadClassesTest.java
@@ -65,7 +65,7 @@ class VerifyBadClassesTest {
* {@link Status} object capturing the command, exit status, and output
from the process.
*
* @param command the command to be run in the process.
- * @return a String capturing the error output of executing the command.
+ * @return A String capturing the error output of executing the command.
* @throws ExecuteException if executor fails
* @throws IOException if executor fails
*/
