Skip to content

Commit

Permalink
Normalize getter Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Oct 31, 2023
1 parent 834329a commit 30908b7
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion src/examples/Mini/Environment.java
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public void delete(final String key) {
}

/**
* Get entry from hash table.
* Gets entry from hash table.
*/
public EnvEntry get(final String key) {
int hash;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/bcel/classfile/JavaClass.java
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ public Field findField(final String fieldName, final Type fieldType) throws Clas
}

/**
* 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.
*/
Expand Down Expand Up @@ -542,7 +542,7 @@ public String[] getInterfaceNames() {
}

/**
* 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.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/bcel/generic/ARRAYLENGTH.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public ObjectType getCatchType() {
}

/**
* 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.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/bcel/generic/FieldGen.java
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ public boolean equals(final Object obj) {
}

/**
* 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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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];

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ void dispose() {
}

/**
* Get attribute of an instruction handle.
* Gets attribute of an instruction handle.
*
* @param key the key object to store/retrieve the attribute
*/
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/apache/bcel/generic/InstructionList.java
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ public void dispose() {
}

/**
* 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
Expand Down Expand Up @@ -602,7 +602,7 @@ public InstructionHandle[] getInstructionHandles() {
}

/**
* 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
Expand Down Expand Up @@ -1117,7 +1117,7 @@ public void setPositions(final boolean check) { // called by code in other packa
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()) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/bcel/generic/LineNumberGen.java
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public InstructionHandle getInstruction() {
}

/**
* 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.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/bcel/generic/MethodGen.java
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,7 @@ public int getMaxStack() {
}

/**
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down

0 comments on commit 30908b7

Please sign in to comment.