(commons-compress) 11/15: 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 a8ca44408c5deb43964c1427046e753e48de7255
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Apr 9 16:35:40 2025 -0400

    Javadoc
---
 .../archivers/zip/ResourceAlignmentExtraField.java | 28 ++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/ResourceAlignmentExtraField.java
 
b/src/main/java/org/apache/commons/compress/archivers/zip/ResourceAlignmentExtraField.java
index 1ae4eca8a..155f95c5c 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/zip/ResourceAlignmentExtraField.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/zip/ResourceAlignmentExtraField.java
@@ -44,6 +44,9 @@ public class ResourceAlignmentExtraField implements 
ZipExtraField {
      */
     public static final ZipShort ID = new ZipShort(0xa11e);
 
+    /**
+     * Base field size.
+     */
     public static final int BASE_SIZE = 2;
 
     private static final int ALLOW_METHOD_MESSAGE_CHANGE_FLAG = 0x8000;
@@ -54,17 +57,38 @@ public class ResourceAlignmentExtraField implements 
ZipExtraField {
 
     private int padding;
 
+    /**
+     * Constructs a new instance.
+     */
     public ResourceAlignmentExtraField() {
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param alignment A positive alignment less than {@link Short#MAX_VALUE}.
+     */
     public ResourceAlignmentExtraField(final int alignment) {
         this(alignment, false);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param alignment A positive alignment less than {@link Short#MAX_VALUE}.
+     * @param allowMethodChange whether a method change is allowed when 
re-compressing the ZIP file.
+     */
     public ResourceAlignmentExtraField(final int alignment, final boolean 
allowMethodChange) {
         this(alignment, allowMethodChange, 0);
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @param alignment A positive alignment less than {@link Short#MAX_VALUE}.
+     * @param allowMethodChange whether a method change is allowed when 
re-compressing the ZIP file.
+     * @param padding padding.
+     */
     public ResourceAlignmentExtraField(final int alignment, final boolean 
allowMethodChange, final int padding) {
         if (alignment < 0 || alignment > MAX_ALIGNMENT) {
             throw new IllegalArgumentException("Alignment must be between 0 
and 0x7fff, was: " + alignment);
@@ -78,9 +102,9 @@ public ResourceAlignmentExtraField(final int alignment, 
final boolean allowMetho
     }
 
     /**
-     * Indicates whether method change is allowed when re-compressing the ZIP 
file.
+     * Indicates whether a method change is allowed when re-compressing the 
ZIP file.
      *
-     * @return true if method change is allowed, false otherwise.
+     * @return true if a method change is allowed, false otherwise.
      */
     public boolean allowMethodChange() {
         return allowMethodChange;