[commons-compress] branch master updated: 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


The following commit(s) were added to refs/heads/master by this push:
     new e1a9fc5f Javadoc
e1a9fc5f is described below

commit e1a9fc5fa19888649e4433914572d117eb846c59
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Nov 30 07:15:06 2022 -0500

    Javadoc
---
 .../compress/archivers/cpio/CpioConstants.java        | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java 
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
index 02508e3b..148a34f2 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
@@ -22,6 +22,8 @@ package org.apache.commons.compress.archivers.cpio;
  * All constants needed by CPIO.
  *
  * based on code from the jRPM project (jrpm.sourceforge.net)
+ * 
+ * http://www.opengroup.org/onlinepubs/9699919799/basedefs/cpio.h.html has a 
list of the C_xxx constants.
  *
  */
 public interface CpioConstants {
@@ -37,24 +39,22 @@ public interface CpioConstants {
     /** magic number of a cpio entry in the old binary format */
     int MAGIC_OLD_BINARY = 070707;
 
-    // These FORMAT_ constants are internal to the code
-
-    /** write/read a CpioArchiveEntry in the new format */
+    /** write/read a CpioArchiveEntry in the new format. FORMAT_ constants are 
internal. */
     short FORMAT_NEW = 1;
 
-    /** write/read a CpioArchiveEntry in the new format with crc */
+    /** write/read a CpioArchiveEntry in the new format with crc. FORMAT_ 
constants are internal. */
     short FORMAT_NEW_CRC = 2;
 
-    /** write/read a CpioArchiveEntry in the old ascii format */
+    /** write/read a CpioArchiveEntry in the old ascii format. FORMAT_ 
constants are internal. */
     short FORMAT_OLD_ASCII = 4;
 
-    /** write/read a CpioArchiveEntry in the old binary format */
+    /** write/read a CpioArchiveEntry in the old binary format. FORMAT_ 
constants are internal. */
     short FORMAT_OLD_BINARY = 8;
 
-    /** Mask for both new formats */
+    /** Mask for both new formats. FORMAT_ constants are internal. */
     short FORMAT_NEW_MASK = 3;
 
-    /** Mask for both old formats */
+    /** Mask for both old formats. FORMAT_ constants are internal. */
     short FORMAT_OLD_MASK = 12;
 
     /*
@@ -64,9 +64,6 @@ public interface CpioConstants {
     /** Mask for all file type bits. */
     int S_IFMT   = 0170000;
 
- // http://www.opengroup.org/onlinepubs/9699919799/basedefs/cpio.h.html
- // has a list of the C_xxx constants
-
     /** Defines a socket */
     int C_ISSOCK = 0140000;