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 06c24e19 Normalize setter Javadoc
06c24e19 is described below
commit 06c24e19205c9fe6ade1cef8d349bda4f36a52c2
Author: Gary David Gregory (Code signing key) <ggreg...@apache.org>
AuthorDate: Tue Oct 31 06:59:31 2023 -0400
Normalize setter Javadoc
---
src/examples/TransitiveHull.java | 2 +-
src/main/java/org/apache/bcel/classfile/AccessFlags.java | 4 ++--
src/main/java/org/apache/bcel/classfile/JavaClass.java | 4 ++--
src/main/java/org/apache/bcel/generic/BranchHandle.java | 2 +-
src/main/java/org/apache/bcel/generic/BranchInstruction.java | 2 +-
src/main/java/org/apache/bcel/generic/CPInstruction.java | 2 +-
src/main/java/org/apache/bcel/generic/ClassGen.java | 4 ++--
src/main/java/org/apache/bcel/generic/CodeExceptionGen.java | 6 +++---
src/main/java/org/apache/bcel/generic/FieldGen.java | 2 +-
src/main/java/org/apache/bcel/generic/InstructionHandle.java | 2 +-
src/main/java/org/apache/bcel/generic/LDC.java | 2 +-
src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java | 2 +-
src/main/java/org/apache/bcel/generic/MethodGen.java | 4 ++--
src/main/java/org/apache/bcel/generic/RET.java | 2 +-
src/main/java/org/apache/bcel/generic/Select.java | 2 +-
src/main/java/org/apache/bcel/util/CodeHTML.java | 2 +-
src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java | 2 +-
17 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/src/examples/TransitiveHull.java b/src/examples/TransitiveHull.java
index 5e51a138..719eb429 100644
--- a/src/examples/TransitiveHull.java
+++ b/src/examples/TransitiveHull.java
@@ -133,7 +133,7 @@ public class TransitiveHull extends
org.apache.bcel.classfile.EmptyVisitor {
}
/**
- * Set the value of ignored.
+ * Sets the value of ignored.
*
* @param v Value to assign to ignored.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/AccessFlags.java
b/src/main/java/org/apache/bcel/classfile/AccessFlags.java
index 153741e3..6310b7e3 100644
--- a/src/main/java/org/apache/bcel/classfile/AccessFlags.java
+++ b/src/main/java/org/apache/bcel/classfile/AccessFlags.java
@@ -182,7 +182,7 @@ public abstract class AccessFlags {
}
/**
- * Set access flags aka "modifiers".
+ * Sets access flags aka "modifiers".
*
* @param accessFlags Access flags of the object.
*/
@@ -201,7 +201,7 @@ public abstract class AccessFlags {
}
/**
- * Set access flags aka "modifiers".
+ * Sets access flags aka "modifiers".
*
* @param accessFlags Access flags of the object.
*/
diff --git a/src/main/java/org/apache/bcel/classfile/JavaClass.java
b/src/main/java/org/apache/bcel/classfile/JavaClass.java
index 80467e84..210441f9 100644
--- a/src/main/java/org/apache/bcel/classfile/JavaClass.java
+++ b/src/main/java/org/apache/bcel/classfile/JavaClass.java
@@ -785,7 +785,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
}
/**
- * Set File name of class, aka SourceFile attribute value
+ * Sets File name of class, aka SourceFile attribute value
*/
public void setFileName(final String fileName) {
this.fileName = fileName;
@@ -834,7 +834,7 @@ public class JavaClass extends AccessFlags implements
Cloneable, Node, Comparabl
}
/**
- * Set absolute path to file this class was read from.
+ * Sets absolute path to file this class was read from.
*/
public void setSourceFileName(final String sourceFileName) {
this.sourceFileName = sourceFileName;
diff --git a/src/main/java/org/apache/bcel/generic/BranchHandle.java
b/src/main/java/org/apache/bcel/generic/BranchHandle.java
index f09168dc..16c2d63f 100644
--- a/src/main/java/org/apache/bcel/generic/BranchHandle.java
+++ b/src/main/java/org/apache/bcel/generic/BranchHandle.java
@@ -59,7 +59,7 @@ public final class BranchHandle extends InstructionHandle {
}
/**
- * Set new contents. Old instruction is disposed and may not be used
anymore.
+ * Sets new contents. Old instruction is disposed and may not be used
anymore.
*/
@Override // This is only done in order to apply the additional type
check; could be merged with super impl.
public void setInstruction(final Instruction i) { // TODO could be
package-protected?
diff --git a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
index f67794ea..810608e1 100644
--- a/src/main/java/org/apache/bcel/generic/BranchInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/BranchInstruction.java
@@ -183,7 +183,7 @@ public abstract class BranchInstruction extends Instruction
implements Instructi
}
/**
- * Set branch target
+ * Sets branch target
*
* @param target branch target
*/
diff --git a/src/main/java/org/apache/bcel/generic/CPInstruction.java
b/src/main/java/org/apache/bcel/generic/CPInstruction.java
index c7b0e3ff..3db02839 100644
--- a/src/main/java/org/apache/bcel/generic/CPInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/CPInstruction.java
@@ -99,7 +99,7 @@ public abstract class CPInstruction extends Instruction
implements TypedInstruct
}
/**
- * Set the index to constant pool.
+ * Sets the index to constant pool.
*
* @param index in constant pool.
*/
diff --git a/src/main/java/org/apache/bcel/generic/ClassGen.java
b/src/main/java/org/apache/bcel/generic/ClassGen.java
index dbc61d18..93a7816c 100644
--- a/src/main/java/org/apache/bcel/generic/ClassGen.java
+++ b/src/main/java/org/apache/bcel/generic/ClassGen.java
@@ -475,7 +475,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
}
/**
- * Set major version number of class file, default value is 45 (JDK 1.1)
+ * Sets major version number of class file, default value is 45 (JDK 1.1)
*
* @param major major version number
*/
@@ -493,7 +493,7 @@ public class ClassGen extends AccessFlags implements
Cloneable {
}
/**
- * Set minor version number of class file, default value is 3 (JDK 1.1)
+ * Sets minor version number of class file, default value is 3 (JDK 1.1)
*
* @param minor minor version number
*/
diff --git a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
index e71fb146..b9b2c5c8 100644
--- a/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
+++ b/src/main/java/org/apache/bcel/generic/CodeExceptionGen.java
@@ -116,7 +116,7 @@ public final class CodeExceptionGen implements
InstructionTargeter, Cloneable {
}
/*
- * Set end of handler
+ * Sets end of handler
*
* @param endPc End of handled region (inclusive)
*/
@@ -126,7 +126,7 @@ public final class CodeExceptionGen implements
InstructionTargeter, Cloneable {
}
/*
- * Set handler code
+ * Sets handler code
*
* @param handlerPc Start of handler
*/
@@ -136,7 +136,7 @@ public final class CodeExceptionGen implements
InstructionTargeter, Cloneable {
}
/*
- * Set start of handler
+ * Sets start of handler
*
* @param startPc Start of handled region (inclusive)
*/
diff --git a/src/main/java/org/apache/bcel/generic/FieldGen.java
b/src/main/java/org/apache/bcel/generic/FieldGen.java
index 1c2ac265..052ab4c4 100644
--- a/src/main/java/org/apache/bcel/generic/FieldGen.java
+++ b/src/main/java/org/apache/bcel/generic/FieldGen.java
@@ -288,7 +288,7 @@ public class FieldGen extends FieldGenOrMethodGen {
}
/**
- * Set (optional) initial value of field, otherwise it will be set to
null/0/false by the JVM automatically.
+ * Sets (optional) initial value of field, otherwise it will be set to
null/0/false by the JVM automatically.
*/
public void setInitValue(final String str) {
checkType(ObjectType.getInstance("java.lang.String"));
diff --git a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
index fe02b830..ad25d6fe 100644
--- a/src/main/java/org/apache/bcel/generic/InstructionHandle.java
+++ b/src/main/java/org/apache/bcel/generic/InstructionHandle.java
@@ -240,7 +240,7 @@ public class InstructionHandle {
}
/**
- * Set the position, i.e., the byte code offset of the contained
instruction.
+ * Sets the position, i.e., the byte code offset of the contained
instruction.
*/
void setPosition(final int pos) {
i_position = pos;
diff --git a/src/main/java/org/apache/bcel/generic/LDC.java
b/src/main/java/org/apache/bcel/generic/LDC.java
index eba856e9..5969b157 100644
--- a/src/main/java/org/apache/bcel/generic/LDC.java
+++ b/src/main/java/org/apache/bcel/generic/LDC.java
@@ -124,7 +124,7 @@ public class LDC extends CPInstruction implements
PushInstruction, ExceptionThro
}
/**
- * Set the index to constant pool and adjust size.
+ * Sets the index to constant pool and adjust size.
*/
@Override
public final void setIndex(final int index) {
diff --git
a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
index 4b30b8c7..2ef0ff20 100644
--- a/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
+++ b/src/main/java/org/apache/bcel/generic/LocalVariableInstruction.java
@@ -157,7 +157,7 @@ public abstract class LocalVariableInstruction extends
Instruction implements Ty
}
/**
- * Set the local variable index. also updates opcode and length TODO Why?
+ * Sets the local variable index. also updates opcode and length TODO Why?
*
* @see #setIndexOnly(int)
*/
diff --git a/src/main/java/org/apache/bcel/generic/MethodGen.java
b/src/main/java/org/apache/bcel/generic/MethodGen.java
index 9a70ad43..3cf8f733 100644
--- a/src/main/java/org/apache/bcel/generic/MethodGen.java
+++ b/src/main/java/org/apache/bcel/generic/MethodGen.java
@@ -1083,7 +1083,7 @@ public class MethodGen extends FieldGenOrMethodGen {
}
/**
- * Set maximum number of local variables.
+ * Sets maximum number of local variables.
*/
public void setMaxLocals(final int m) {
maxLocals = m;
@@ -1101,7 +1101,7 @@ public class MethodGen extends FieldGenOrMethodGen {
}
/**
- * Set maximum stack size for this method.
+ * Sets maximum stack size for this method.
*/
public void setMaxStack(final int m) { // TODO could be package-protected?
maxStack = m;
diff --git a/src/main/java/org/apache/bcel/generic/RET.java
b/src/main/java/org/apache/bcel/generic/RET.java
index 433c31e1..408e5ce6 100644
--- a/src/main/java/org/apache/bcel/generic/RET.java
+++ b/src/main/java/org/apache/bcel/generic/RET.java
@@ -105,7 +105,7 @@ public class RET extends Instruction implements
IndexedInstruction, TypedInstruc
}
/**
- * Set index of local variable containg the return address
+ * Sets index of local variable containg the return address
*/
@Override
public final void setIndex(final int n) {
diff --git a/src/main/java/org/apache/bcel/generic/Select.java
b/src/main/java/org/apache/bcel/generic/Select.java
index 5cee7398..ce1efc3b 100644
--- a/src/main/java/org/apache/bcel/generic/Select.java
+++ b/src/main/java/org/apache/bcel/generic/Select.java
@@ -284,7 +284,7 @@ public abstract class Select extends BranchInstruction
implements VariableLength
}
/**
- * Set branch target for 'i'th case
+ * Sets branch target for 'i'th case
*/
public void setTarget(final int i, final InstructionHandle target) { //
TODO could be package-protected?
notifyTarget(targets[i], target, this);
diff --git a/src/main/java/org/apache/bcel/util/CodeHTML.java
b/src/main/java/org/apache/bcel/util/CodeHTML.java
index 22a3666c..0df21b03 100644
--- a/src/main/java/org/apache/bcel/util/CodeHTML.java
+++ b/src/main/java/org/apache/bcel/util/CodeHTML.java
@@ -537,7 +537,7 @@ final class CodeHTML {
final String str = codeToHTML(stream, methodNumber);
String anchor = "";
/*
- * Set an anchor mark if this line is targetted by a goto,
jsr, etc. Defining an anchor for every line is very
+ * Sets an anchor mark if this line is targetted by a
goto, jsr, etc. Defining an anchor for every line is very
* inefficient!
*/
if (gotoSet.get(offset)) {
diff --git a/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
b/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
index 425a167a..67f34a88 100644
--- a/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
+++ b/src/test/java/org/apache/bcel/generic/JdkGenericDumpTestCase.java
@@ -52,7 +52,7 @@ import org.junit.jupiter.params.provider.MethodSource;
* Test that the generic dump() methods work on the JDK classes Reads each
class into an instruction list and then dumps the instructions. The output bytes
* should be the same as the input.
* <p>
- * Set the property {@value JavaHome#EXTRA_JAVA_HOMES} to a {@link
File#pathSeparator}-separated list of JRE/JDK paths for additional testing.
+ * Sets the property {@value JavaHome#EXTRA_JAVA_HOMES} to a {@link
File#pathSeparator}-separated list of JRE/JDK paths for additional testing.
* </p>
* <p>
* For example:
