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 30908b7e Normalize getter Javadoc
30908b7e is described below
commit 30908b7e3496c78cf3d59ea133d09e94122c5fa9
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Tue Oct 31 06:43:38 2023 -0400
Normalize getter Javadoc
---
src/examples/Mini/Environment.java | 2 +-
src/main/java/org/apache/bcel/classfile/JavaClass.java | 4 ++--
src/main/java/org/apache/bcel/generic/ARRAYLENGTH.java | 2 +-
src/main/java/org/apache/bcel/generic/CodeExceptionGen.java | 2 +-
src/main/java/org/apache/bcel/generic/FieldGen.java | 2 +-
src/main/java/org/apache/bcel/generic/InstructionConst.java | 2 +-
src/main/java/org/apache/bcel/generic/InstructionHandle.java | 2 +-
src/main/java/org/apache/bcel/generic/InstructionList.java | 6 +++---
src/main/java/org/apache/bcel/generic/LineNumberGen.java | 2 +-
src/main/java/org/apache/bcel/generic/MethodGen.java | 2 +-
src/main/java/org/apache/bcel/generic/TypedInstruction.java | 2 +-
11 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/src/examples/Mini/Environment.java
b/src/examples/Mini/Environment.java
index 0604850c..3913e0a5 100644
--- a/src/examples/Mini/Environment.java
+++ b/src/examples/Mini/Environment.java
@@ -110,7 +110,7 @@ public class Environment implements Cloneable {
}
/**
- * Get entry from hash table.
+ * Gets entry from hash table.
*/
public EnvEntry get(final String key) {
int hash;
diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java
b/src/main/java/org/apache/bcel/classfile/JavaClass.java
index d24062ed..80467e84 100644
--- a/src/main/java/org/apache/bcel/classfile/JavaClass.java
+++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java
@@ -435,7 +435,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
}
/**
- * Get all interfaces implemented by this JavaClass (transitively).
+ * Gets all interfaces implemented by this JavaClass (transitively).
*
* @throws ClassNotFoundException if any of the class's superclasses or
interfaces can't be found.
*/
@@ -542,7 +542,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
}
/**
- * Get interfaces directly implemented by this JavaClass.
+ * Gets interfaces directly implemented by this JavaClass.
*
* @throws ClassNotFoundException if any of the class's interfaces can't
be found.
*/
diff --git a/src/main/java/org/apache/bcel/generic/ARRAYLENGTH.java
b/src/main/java/org/apache/bcel/generic/ARRAYLENGTH.java
index b7fca1b0..4b277ec8 100644
--- a/src/main/java/org/apache/bcel/generic/ARRAYLENGTH.java
+++ b/src/main/java/org/apache/bcel/generic/ARRAYLENGTH.java
@@ -28,7 +28,7 @@ import org.apache.bcel.ExceptionConst;
public class ARRAYLENGTH extends Instruction implements ExceptionThrower,
StackProducer, StackConsumer /* since 6.0 */ {
/**
- * Get length of array
+ * Gets length of array
*/
public ARRAYLENGTH() {
super(org.apache.bcel.Const.ARRAYLENGTH, (short) 1);
diff --git a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
index 1320622f..e71fb146 100644
--- a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
+++ b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
@@ -77,7 +77,7 @@ public final class CodeExceptionGen implements
InstructionTargeter, Cloneable {
}
/**
- * Get CodeException object.<BR>
+ * Gets CodeException object.<BR>
*
* This relies on that the instruction list has already been dumped to
byte code or that the 'setPositions' methods
* has been called for the instruction list.
diff --git a/src/main/java/org/apache/bcel/generic/FieldGen.java
b/src/main/java/org/apache/bcel/generic/FieldGen.java
index 2f62570e..1c2ac265 100644
--- a/src/main/java/org/apache/bcel/generic/FieldGen.java
+++ b/src/main/java/org/apache/bcel/generic/FieldGen.java
@@ -187,7 +187,7 @@ public class FieldGen extends FieldGenOrMethodGen {
}
/**
- * Get field object after having set up all necessary values.
+ * Gets field object after having set up all necessary values.
*/
public Field getField() {
final String signature = getSignature();
diff --git a/src/main/java/org/apache/bcel/generic/InstructionConst.java
b/src/main/java/org/apache/bcel/generic/InstructionConst.java
index 8c9d9d74..9725ff8a 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionConst.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionConst.java
@@ -165,7 +165,7 @@ public final class InstructionConst {
public static final LocalVariableInstruction ISTORE_2 = new ISTORE(2);
/**
- * Get object via its opcode, for immutable instructions like branch
instructions entries are set to null.
+ * Gets object via its opcode, for immutable instructions like branch
instructions entries are set to null.
*/
static final Instruction[] INSTRUCTIONS = new Instruction[256];
diff --git a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
index 22a4476a..fe02b830 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
@@ -131,7 +131,7 @@ public class InstructionHandle {
}
/**
- * Get attribute of an instruction handle.
+ * Gets attribute of an instruction handle.
*
* @param key the key object to store/retrieve the attribute
*/
diff --git a/src/main/java/org/apache/bcel/generic/InstructionList.java
b/src/main/java/org/apache/bcel/generic/InstructionList.java
index 4dc9a634..c373e3b3 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionList.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionList.java
@@ -510,7 +510,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
}
/**
- * Get instruction handle for instruction at byte code position pos. This
only works properly, if the list is freshly
+ * Gets instruction handle for instruction at byte code position pos. This
only works properly, if the list is freshly
* initialized from a byte array or setPositions() has been called before
this method.
*
* @param pos byte code position to search for
@@ -602,7 +602,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
}
/**
- * Get positions (offsets) of all instructions in the list. This relies on
that the list has been freshly created from
+ * Gets positions (offsets) of all instructions in the list. This relies
on that the list has been freshly created from
* an byte code array, or that setPositions() has been called. Otherwise
this may be inaccurate.
*
* @return array containing all instruction's offset in byte code
@@ -1117,7 +1117,7 @@ public class InstructionList implements
Iterable<InstructionHandle> {
ih.setPosition(index);
pos[count++] = index;
/*
- * Get an estimate about how many additional bytes may be added,
because BranchInstructions may have variable length
+ * Gets an estimate about how many additional bytes may be added,
because BranchInstructions may have variable length
* depending on the target offset (short vs. int) or alignment
issues (TABLESWITCH and LOOKUPSWITCH).
*/
switch (i.getOpcode()) {
diff --git a/src/main/java/org/apache/bcel/generic/LineNumberGen.java
b/src/main/java/org/apache/bcel/generic/LineNumberGen.java
index d267f115..fc73aa42 100644
--- a/src/main/java/org/apache/bcel/generic/LineNumberGen.java
+++ b/src/main/java/org/apache/bcel/generic/LineNumberGen.java
@@ -66,7 +66,7 @@ public class LineNumberGen implements InstructionTargeter,
Cloneable {
}
/**
- * Get LineNumber attribute.
+ * Gets LineNumber attribute.
*
* This relies on that the instruction list has already been dumped to
byte code or that the 'setPositions' methods
* has been called for the instruction list.
diff --git a/src/main/java/org/apache/bcel/generic/MethodGen.java
b/src/main/java/org/apache/bcel/generic/MethodGen.java
index 9527b10d..9a70ad43 100644
--- a/src/main/java/org/apache/bcel/generic/MethodGen.java
+++ b/src/main/java/org/apache/bcel/generic/MethodGen.java
@@ -787,7 +787,7 @@ public class MethodGen extends FieldGenOrMethodGen {
}
/**
- * Get method object. Never forget to call setMaxStack() or
setMaxStack(max), respectively, before calling this method
+ * Gets method object. Never forget to call setMaxStack() or
setMaxStack(max), respectively, before calling this method
* (the same applies for max locals).
*
* @return method object
diff --git a/src/main/java/org/apache/bcel/generic/TypedInstruction.java
b/src/main/java/org/apache/bcel/generic/TypedInstruction.java
index d4290b2a..1c06851c 100644
--- a/src/main/java/org/apache/bcel/generic/TypedInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/TypedInstruction.java
@@ -17,7 +17,7 @@
package org.apache.bcel.generic;
/**
- * Get the type associated with an instruction, int for ILOAD, or the type of
the field of a PUTFIELD instruction, e.g..
+ * Gets the type associated with an instruction, int for ILOAD, or the type of
the field of a PUTFIELD instruction, e.g..
*/
public interface TypedInstruction {
