(commons-compress) branch master updated: Javadoc: Use semantic tag instead of style tag

ggregory Fri, 15 Nov 2024 07:48:30 -0800

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 28c1441f6 Javadoc: Use semantic tag instead of style tag 28c1441f6 is described below commit 28c1441f6ecd50a658565f66970760391fb76adb Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri Nov 15 10:48:16 2024 -0500 Javadoc: Use semantic tag instead of style tag --- .../commons/compress/archivers/ArchiveInputStream.java | 5 +++-- .../compress/archivers/dump/DumpArchiveEntry.java | 18 +++++++++--------- .../compress/archivers/zip/PKWareExtraHeader.java | 4 ++-- .../archivers/zip/X0017_StrongEncryptionHeader.java | 4 ++-- .../archivers/zip/X5455_ExtendedTimestamp.java | 11 ++++++----- .../compress/archivers/zip/ZipArchiveEntry.java | 14 ++++++++------ 6 files changed, 30 insertions(+), 26 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java b/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java index 3b691a7ab..b1784fe2e 100644 --- a/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java +++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java @@ -31,14 +31,15 @@ import org.apache.commons.io.function.IOIterator; import org.apache.commons.io.input.NullInputStream; /** - * Archive input streams MUST override the {@link #read(byte[], int, int)} - or {@link #read()} - method so that reading from the stream generates EOF - * for the end of data in each entry as well as at the end of the file proper. + * Archive input streams MUST override the {@link #read(byte[], int, int)} - or {@link #read()} - method so that reading from the stream + * generates EOF for the end of data in each entry as well as at the end of the file proper. * * The {@link #getNextEntry()} method is used to reset the input stream ready for reading the data from the next entry. * * * The input stream classes must also implement a method with the signature: * + * * <pre> * public static boolean matches(byte[] signature, int length) * </pre> diff --git a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java index 149a3a72b..a720342ab 100644 --- a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java +++ b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java @@ -56,12 +56,12 @@ import org.apache.commons.compress.archivers.ArchiveEntry; * * struct s_spcl { * int32_t c_type; // record type (see below) - * int32_t c_date; // date of this dump - * int32_t c_ddate; // date of previous dump + * int32_t c_date; // date of this dump + * int32_t c_ddate; // date of previous dump * int32_t c_volume; // dump volume number * u_int32_t c_tapea; // logical block of this record * dump_ino_t c_ino; // number of inode - * int32_t c_magic; // magic number (see above) + * int32_t c_magic; // magic number (see above) * int32_t c_checksum; // record checksum * #ifdef __linux__ * struct new_bsd_inode c_dinode; @@ -74,11 +74,11 @@ import org.apache.commons.compress.archivers.ArchiveEntry; * #endif * int32_t c_count; // number of valid c_addr entries * union u_data c_data; // see above - * char c_label[LBLSIZE]; // dump label - * int32_t c_level; // level of this dump - * char c_filesys[NAMELEN]; // name of dumpped file system - * char c_dev[NAMELEN]; // name of dumpped device - * char c_host[NAMELEN]; // name of dumpped host + * char c_label[LBLSIZE]; // dump label + * int32_t c_level; // level of this dump + * char c_filesys[NAMELEN]; // name of dumpped file system + * char c_dev[NAMELEN]; // name of dumpped device + * char c_host[NAMELEN]; // name of dumpped host * int32_t c_flags; // additional information (see below) * int32_t c_firstrec; // first record on volume * int32_t c_ntrec; // blocksize on volume @@ -110,7 +110,7 @@ import org.apache.commons.compress.archivers.ArchiveEntry; * #define EXT2_XATTR_MAGIC2 0xEA020001 // in inode EA * </pre> * - * The fields in bold are the same for all blocks. (This permitted multiple dumps to be written to a single tape.) + * The fields in bold are the same for all blocks. (This permitted multiple dumps to be written to a single tape.) * * * diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java index 1c5a234d8..5a7be3977 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java @@ -32,7 +32,7 @@ import java.util.zip.ZipException; * strong encryption. * * - * Algorithm IDs - integer identifier of the encryption algorithm from the following range + * Algorithm IDs - integer identifier of the encryption algorithm from the following range * * <ul> * <li>0x6601 - DES</li> @@ -49,7 +49,7 @@ import java.util.zip.ZipException; * <li>0xFFFF - Unknown algorithm</li> * </ul> * - * Hash Algorithms - integer identifier of the hash algorithm from the following range + * Hash Algorithms - integer identifier of the hash algorithm from the following range * * <ul> * <li>0x0000 - none</li> diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java index 42c08a0dc..7746f2c14 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java @@ -93,7 +93,7 @@ import java.util.zip.ZipException; * </pre> * * - * Format - the data format identifier for this record. The only value allowed at this time is the integer value 2. + * Format - the data format identifier for this record. The only value allowed at this time is the integer value 2. * * * @@ -232,7 +232,7 @@ import java.util.zip.ZipException; * </pre> * * - * Flags - Processing flags needed for decryption + * Flags - Processing flags needed for decryption * * * <ul> diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java index 82c9db8a2..71018c154 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java @@ -39,11 +39,12 @@ import org.apache.commons.io.file.attribute.FileTimes; * Unfortunately, 32 (signed) bits can only store dates up to the year 2037, and so this extra field will eventually be obsolete. Enjoy it while it lasts! * * <ul> - * <li>modifyTime: most recent time of file/directory modification (or file/dir creation if the entry has not been modified since it was created).</li> - * <li>accessTime: most recent time file/directory was opened (e.g., read from disk). Many people disable their operating systems from updating this - * value using the NOATIME mount option to optimize disk behavior, and thus it's not always reliable. In those cases it's always equal to modifyTime.</li> - * <li>*createTime: modern Linux file systems (e.g., ext2 and newer) do not appear to store a value like this, and so it's usually omitted altogether in - * the ZIP extra field. Perhaps other UNIX systems track this.</li> + * <li>modifyTime: most recent time of file/directory modification (or file/dir creation if the entry has not been modified since it was + * created).</li> + * <li>accessTime: most recent time file/directory was opened (e.g., read from disk). Many people disable their operating systems from updating + * this value using the NOATIME mount option to optimize disk behavior, and thus it's not always reliable. In those cases it's always equal to modifyTime.</li> + * <li>*createTime: modern Linux file systems (e.g., ext2 and newer) do not appear to store a value like this, and so it's usually omitted + * altogether in the ZIP extra field. Perhaps other UNIX systems track this.</li> * </ul> * * We're using the field definition given in Info-Zip's source archive: zip-3.0.tar.gz/proginfo/extrafld.txt diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java index e3b822002..fcd21e909 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java @@ -662,7 +662,8 @@ public class ZipArchiveEntry extends ZipEntry implements ArchiveEntry, EntryStre * Retrieves the external file attributes. * * - * Note: {@link ZipArchiveInputStream} is unable to fill this field, you must use {@link ZipFile} if you want to read entries using this attribute. + * Note: {@link ZipArchiveInputStream} is unable to fill this field, you must use {@link ZipFile} if you want to read entries using this + * attribute. * * * @return the external file attributes @@ -692,8 +693,8 @@ public class ZipArchiveEntry extends ZipEntry implements ArchiveEntry, EntryStre * Gets all extra fields that have been parsed successfully. * * - * Note: The set of extra fields may be incomplete when {@link ZipArchiveInputStream} has been used as some extra fields use the central directory to - * store additional information. + * Note: The set of extra fields may be incomplete when {@link ZipArchiveInputStream} has been used as some extra fields use the central + * directory to store additional information. * * * @return an array of the extra fields @@ -769,7 +770,8 @@ public class ZipArchiveEntry extends ZipEntry implements ArchiveEntry, EntryStre * Gets the internal file attributes. * * - * Note: {@link ZipArchiveInputStream} is unable to fill this field, you must use {@link ZipFile} if you want to read entries using this attribute. + * Note: {@link ZipArchiveInputStream} is unable to fill this field, you must use {@link ZipFile} if you want to read entries using this + * attribute. * * * @return the internal file attributes @@ -905,8 +907,8 @@ public class ZipArchiveEntry extends ZipEntry implements ArchiveEntry, EntryStre * Gets the uncompressed size of the entry data. * * - * Note: {@link ZipArchiveInputStream} may create entries that return {@link #SIZE_UNKNOWN SIZE_UNKNOWN} as long as the entry hasn't been read - * completely. + * Note: {@link ZipArchiveInputStream} may create entries that return {@link #SIZE_UNKNOWN SIZE_UNKNOWN} as long as the entry hasn't been + * read completely. * * * @return the entry size

Previous message

View by thread

View by date

Next message

Reply via email to