@since: Standardise on number only; drop redundant component name
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/compress/trunk@1455148 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
index f7f1577..1a9725e 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
@@ -75,32 +75,32 @@
/**
* Constant used to identify the AR archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String AR = "ar";
/**
* Constant used to identify the CPIO archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String CPIO = "cpio";
/**
* Constant used to identify the Unix DUMP archive format.
- * @since Commons Compress 1.3
+ * @since 1.3
*/
public static final String DUMP = "dump";
/**
* Constant used to identify the JAR archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String JAR = "jar";
/**
* Constant used to identify the TAR archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String TAR = "tar";
/**
* Constant used to identify the ZIP archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String ZIP = "zip";
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
index b127571..6ed6280 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
@@ -315,7 +315,7 @@
*
* @param headerBuf The header bytes from a tar archive entry.
* @param encoding encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @throws IllegalArgumentException if any of the numeric fields have an invalid format
*/
public TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding)
@@ -922,7 +922,7 @@
*
* @param header The tar entry header buffer to get information from.
* @param encoding encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @throws IllegalArgumentException if any of the numeric fields
* have an invalid format
*/
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
index 03aa12b..eb8cd70 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
@@ -71,7 +71,7 @@
* Constructor for TarInputStream.
* @param is the input stream to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveInputStream(InputStream is, String encoding) {
this(is, TarBuffer.DEFAULT_BLKSIZE, TarBuffer.DEFAULT_RCDSIZE, encoding);
@@ -91,7 +91,7 @@
* @param is the input stream to use
* @param blockSize the block size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveInputStream(InputStream is, int blockSize,
String encoding) {
@@ -114,7 +114,7 @@
* @param blockSize the block size to use
* @param recordSize the record size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveInputStream(InputStream is, int blockSize, int recordSize,
String encoding) {
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
index 3981998..3561484 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
@@ -99,7 +99,7 @@
* Constructor for TarInputStream.
* @param os the output stream to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveOutputStream(OutputStream os, String encoding) {
this(os, TarBuffer.DEFAULT_BLKSIZE, TarBuffer.DEFAULT_RCDSIZE, encoding);
@@ -119,7 +119,7 @@
* @param os the output stream to use
* @param blockSize the block size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveOutputStream(OutputStream os, int blockSize,
String encoding) {
@@ -142,7 +142,7 @@
* @param blockSize the block size to use
* @param recordSize the record size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveOutputStream(OutputStream os, int blockSize,
int recordSize, String encoding) {
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
index a9f2dbd..7590d5e 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
@@ -277,7 +277,7 @@
* @param offset The offset into the buffer from which to parse.
* @param length The maximum number of bytes to parse.
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @return The entry name.
*/
public static String parseName(byte[] buffer, final int offset,
@@ -342,7 +342,7 @@
* @param offset The starting offset into the buffer
* @param length The maximum number of header bytes to copy.
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @return The updated offset, i.e. offset + length
*/
public static int formatNameBytes(String name, byte[] buf, final int offset,
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
index 70522ff..b1aad77 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
@@ -23,7 +23,7 @@
/**
* Exception thrown when attempting to read or write data for a zip
* entry that uses ZIP features not supported by this library.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public class UnsupportedZipFeatureException extends ZipException {
@@ -88,7 +88,7 @@
/**
* ZIP Features that may or may not be supported.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static class Feature {
/**
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index d5c0697..ffdbb3b 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -284,7 +284,7 @@
*
* @return all entries as {@link ZipArchiveEntry} instances
*
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public Enumeration<ZipArchiveEntry> getEntriesInPhysicalOrder() {
ZipArchiveEntry[] allEntries =
@@ -992,7 +992,7 @@
* <p>Won't return any meaningful results if one of the entries
* isn't part of the archive at all.</p>
*
- * @since Commons Compress 1.1
+ * @since 1.1
*/
private final Comparator<ZipArchiveEntry> OFFSET_COMPARATOR =
new Comparator<ZipArchiveEntry>() {
diff --git a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
index 6c69bde..cb3bb40 100644
--- a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
+++ b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
@@ -62,24 +62,24 @@
/**
* Constant used to identify the BZIP2 compression algorithm.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String BZIP2 = "bzip2";
/**
* Constant used to identify the GZIP compression algorithm.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String GZIP = "gz";
/**
* Constant used to identify the PACK200 compression algorithm.
- * @since Commons Compress 1.3
+ * @since 1.3
*/
public static final String PACK200 = "pack200";
/**
* Constant used to identify the XZ compression method.
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public static final String XZ = "xz";
@@ -111,7 +111,7 @@
* @return the compressor input stream
* @throws CompressorException if the compressor name is not known
* @throws IllegalArgumentException if the stream is null or does not support mark
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public CompressorInputStream createCompressorInputStream(final InputStream in)
throws CompressorException {
diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
index bbed6ce..e562835 100644
--- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
+++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
@@ -25,7 +25,7 @@
/**
* Utility code for the BZip2 compression format.
* @ThreadSafe
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public abstract class BZip2Utils {
diff --git a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
index 44ebf5c..31953f8 100644
--- a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
@@ -28,7 +28,7 @@
/**
* XZ decompressor.
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public class XZCompressorInputStream extends CompressorInputStream {
private final InputStream in;
diff --git a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
index 0a73c82..858220a 100644
--- a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
@@ -27,7 +27,7 @@
/**
* XZ compressor.
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public class XZCompressorOutputStream extends CompressorOutputStream {
private final XZOutputStream out;
diff --git a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
index 18c2b83..49df67d 100644
--- a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
+++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
@@ -25,7 +25,7 @@
/**
* Utility code for the xz compression format.
* @ThreadSafe
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public class XZUtils {