(commons-compress) 01/21: Javadoc

[ggregory]

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-compress.git

commit 3decd0a7b6a0e094b976852ea8e25150dd6551f8
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Apr 11 09:28:43 2025 -0400

    Javadoc
---
 .../harmony/unpack200/bytecode/BCIRenumberedAttribute.java   | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/BCIRenumberedAttribute.java
 
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/BCIRenumberedAttribute.java
index 7f7f8befa..21d010f9d 100644
--- 
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/BCIRenumberedAttribute.java
+++ 
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/BCIRenumberedAttribute.java
@@ -26,10 +26,13 @@
 import org.apache.commons.compress.harmony.pack200.Pack200Exception;
 
 /**
- * Abstract superclass for attributes that have some part encoded with a BCI 
renumbering
+ * Abstract superclass for attributes that have some part encoded with Byte 
Code Injection (BCI) renumbering.
  */
 public abstract class BCIRenumberedAttribute extends Attribute {
 
+    /**
+     * Whether renumbering has occurred.
+     */
     protected boolean renumbered;
 
     /**
@@ -44,6 +47,11 @@ public BCIRenumberedAttribute(final CPUTF8 attributeName) {
     @Override
     protected abstract int getLength();
 
+    /**
+     * Gets the array of indices for the start of line numbers.
+     *
+     * @return the array of indices for the start of line numbers.
+     */
     protected abstract int[] getStartPCs();
 
     /*
@@ -60,7 +68,7 @@ public boolean hasBCIRenumbering() {
      * In Pack200, line number tables are BCI renumbered. This method takes 
the byteCodeOffsets (which is a List of Integers specifying the offset in the 
byte
      * code array of each instruction) and updates the start_pcs so that it 
points to the instruction index itself, not the BCI renumbering of the 
instruction.
      *
-     * @param byteCodeOffsets List of Integer offsets of the byte code array
+     * @param byteCodeOffsets List of Integer offsets of the byte code array.
      * @throws Pack200Exception Thrown from a subclass.
      */
     public void renumber(final List<Integer> byteCodeOffsets) throws 
Pack200Exception {