(commons-compress) branch master updated: Javadoc & in-line comment

[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


The following commit(s) were added to refs/heads/master by this push:
     new c1143e90a Javadoc & in-line comment
     new 98907c37c Merge branch 'master' of 
https://gitbox.apache.org/repos/asf/commons-compress.git
c1143e90a is described below

commit c1143e90a6cbf08189386e6ed9fd188bbaa81645
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Dec 6 17:33:06 2024 -0500

    Javadoc & in-line comment
---
 .../commons/compress/archivers/zip/UnixStat.java   | 26 +++++++++++++---------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/UnixStat.java 
b/src/main/java/org/apache/commons/compress/archivers/zip/UnixStat.java
index 098d89417..4fe464849 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/UnixStat.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnixStat.java
@@ -20,40 +20,46 @@ package org.apache.commons.compress.archivers.zip;
 
 /**
  * Constants from stat.h on UNIX systems.
+ * <p>
+ * TODO This will be an class in 2.0.
+ * </p>
  */
 // CheckStyle:InterfaceIsTypeCheck OFF - backward compatible
 public interface UnixStat {
 
     /**
-     * Bits used for permissions (and sticky bit)
+     * Masks permissions (and sticky bit)
      */
     int PERM_MASK = 07777;
+
     /**
-     * Bits used to indicate the file system object type.
+     * Masks the file system object type.
      *
      * @since 1.14
      */
     int FILE_TYPE_FLAG = 0170000;
+
     /**
-     * Indicates symbolic links.
+     * Masks symbolic links.
      */
     int LINK_FLAG = 0120000;
+
     /**
-     * Indicates plain files.
+     * Masks plain files.
      */
     int FILE_FLAG = 0100000;
+
     /**
-     * Indicates directories.
+     * Masks directories.
      */
     int DIR_FLAG = 040000;
 
-    // ----------------------------------------------------------
-    // somewhat arbitrary choices that are quite common for shared
-    // installations
-    // -----------------------------------------------------------
+    //
+    // Arbitrary choices that are quite common for shared installations.
+    //
 
     /**
-     * Default permissions for symbolic links.
+     * Default permissions for all permissions.
      */
     int DEFAULT_LINK_PERM = 0777;