(commons-bcel) 13/25: Javadoc

[gg...@apache.org]

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

commit bb87fc578ec50d3eee3ac71b9f90dc92a8c22725
Author: Gary David Gregory (Code signing key) <gg...@apache.org>
AuthorDate: Sat Jun 22 10:29:37 2024 -0400

    Javadoc
    
    Better parameter name
---
 .../apache/bcel/generic/TargetLostException.java   | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/src/main/java/org/apache/bcel/generic/TargetLostException.java b/src/main/java/org/apache/bcel/generic/TargetLostException.java
index 94abf594..1fb3bf80 100644
--- a/src/main/java/org/apache/bcel/generic/TargetLostException.java
+++ b/src/main/java/org/apache/bcel/generic/TargetLostException.java
@@ -17,16 +17,16 @@
 package org.apache.bcel.generic;
 
 /**
- * Thrown by InstructionList.remove() when one or multiple disposed instructions are still being referenced by an
- * InstructionTargeter object. I.e. the InstructionTargeter has to be notified that (one of) the InstructionHandle it is
- * referencing is being removed from the InstructionList and thus not valid anymore.
+ * Thrown by {@link InstructionList} when one or multiple disposed instructions are still being referenced by an {@link InstructionTargeter} object. I.e. the
+ * {@link InstructionTargeter} has to be notified that (one of) the {@link InstructionHandle} it is referencing is being removed from the
+ * {@link InstructionList} and thus not valid anymore.
  *
  * <p>
- * Making this an exception instead of a return value forces the user to handle these case explicitly in a try { ... }
- * catch. The following code illustrates how this may be done:
+ * Making this an exception instead of a return value forces the user to handle these case explicitly in a try { ... } catch. The following code illustrates how
+ * this may be done:
  * </p>
  *
- * <PRE>
+ * <pre>
  *     ...
  *     try {
  *         il.delete(start_ih, end_ih);
@@ -37,7 +37,7 @@ package org.apache.bcel.generic;
  *             }
  *         }
  *     }
- * </PRE>
+ * </pre>
  *
  * @see InstructionHandle
  * @see InstructionList
@@ -48,12 +48,14 @@ public final class TargetLostException extends Exception {
     private static final long serialVersionUID = -6857272667645328384L;
     private final InstructionHandle[] targets;
 
-    TargetLostException(final InstructionHandle[] t, final String mesg) {
-        super(mesg);
-        targets = t;
+    TargetLostException(final InstructionHandle[] targets, final String message) {
+        super(message);
+        this.targets = targets;
     }
 
     /**
+     * Gets the list of instructions still being targeted.
+     *
      * @return list of instructions still being targeted.
      */
     public InstructionHandle[] getTargets() {