Author: bodewig
Date: Sun Dec 22 07:03:43 2013
New Revision: 1552970
URL: http://svn.apache.org/r1552970
Log:
fix javadoc errors detected by Java8 EA b120
Not there are still 54 errors as the "unknown" JCIP tags cause trouble
but I neither want to remove them nor add a dependency just to make a
broken tool happy.
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/Charsets.java
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
Sun Dec 22 07:03:43 2013
@@ -43,11 +43,6 @@ import java.io.OutputStream;
* <li> optionally write additional data, provided format supports it,</li>
* <li>{@link #close()}.</li>
* </ul>
- *
- * <p>
- * Example usage:<br/>
- * TBA
- * </p>
*/
public abstract class ArchiveOutputStream extends OutputStream {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
Sun Dec 22 07:03:43 2013
@@ -26,7 +26,7 @@ import org.apache.commons.compress.archi
/**
* Represents an archive entry in the "ar" format.
*
- * Each AR archive starts with "!<arch>" followed by a LF. After these 8 bytes
+ * Each AR archive starts with "!<arch>" followed by a LF. After these 8
bytes
* the archive entries are listed. The format of an entry header is as it
follows:
*
* <pre>
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
Sun Dec 22 07:03:43 2013
@@ -264,7 +264,7 @@ public class ArArchiveInputStream extend
}
/**
- * Checks if the signature matches ASCII "!<arch>" followed by a single LF
+ * Checks if the signature matches ASCII "!<arch>" followed by a
single LF
* control character
*
* @param signature
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
Sun Dec 22 07:03:43 2013
@@ -54,7 +54,7 @@ public class ArArchiveOutputStream exten
/**
* Set the long file mode.
* This can be LONGFILE_ERROR(0) or LONGFILE_BSD(1).
- * This specifies the treatment of long file names (names >= 16).
+ * This specifies the treatment of long file names (names >= 16).
* Default is LONGFILE_ERROR.
* @param longFileMode the mode to use
* @since 1.3
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
Sun Dec 22 07:03:43 2013
@@ -141,7 +141,7 @@ import org.apache.commons.compress.archi
* N.B. does not handle the cpio "tar" format
* </p>
* @NotThreadSafe
- * @see "http://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt";
+ * @see <a
href="http://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt";>http://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt</a>
*/
public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
@@ -192,14 +192,14 @@ public class CpioArchiveEntry implements
*
* @param format
* The cpio format for this entry.
- * <br/>
- * Possible format values are:
* <p>
- * CpioConstants.FORMAT_NEW<br/>
- * CpioConstants.FORMAT_NEW_CRC<br/>
- * CpioConstants.FORMAT_OLD_BINARY<br/>
- * CpioConstants.FORMAT_OLD_ASCII<br/>
- *
+ * Possible format values are:
+ * <pre>
+ * CpioConstants.FORMAT_NEW
+ * CpioConstants.FORMAT_NEW_CRC
+ * CpioConstants.FORMAT_OLD_BINARY
+ * CpioConstants.FORMAT_OLD_ASCII
+ * </pre>
*/
public CpioArchiveEntry(final short format) {
switch (format) {
@@ -243,13 +243,14 @@ public class CpioArchiveEntry implements
* The cpio format for this entry.
* @param name
* The name of this entry.
- * <br/>
- * Possible format values are:
* <p>
- * CpioConstants.FORMAT_NEW<br/>
- * CpioConstants.FORMAT_NEW_CRC<br/>
- * CpioConstants.FORMAT_OLD_BINARY<br/>
- * CpioConstants.FORMAT_OLD_ASCII<br/>
+ * Possible format values are:
+ * <pre>
+ * CpioConstants.FORMAT_NEW
+ * CpioConstants.FORMAT_NEW_CRC
+ * CpioConstants.FORMAT_OLD_BINARY
+ * CpioConstants.FORMAT_OLD_ASCII
+ * </pre>
*
* @since 1.1
*/
@@ -281,13 +282,14 @@ public class CpioArchiveEntry implements
* The name of this entry.
* @param size
* The size of this entry
- * <br/>
- * Possible format values are:
* <p>
- * CpioConstants.FORMAT_NEW<br/>
- * CpioConstants.FORMAT_NEW_CRC<br/>
- * CpioConstants.FORMAT_OLD_BINARY<br/>
- * CpioConstants.FORMAT_OLD_ASCII<br/>
+ * Possible format values are:
+ * <pre>
+ * CpioConstants.FORMAT_NEW
+ * CpioConstants.FORMAT_NEW_CRC
+ * CpioConstants.FORMAT_OLD_BINARY
+ * CpioConstants.FORMAT_OLD_ASCII
+ * </pre>
*
* @since 1.1
*/
@@ -321,13 +323,14 @@ public class CpioArchiveEntry implements
* The file to gather information from.
* @param entryName
* The name of this entry.
- * <br/>
- * Possible format values are:
* <p>
- * CpioConstants.FORMAT_NEW<br/>
- * CpioConstants.FORMAT_NEW_CRC<br/>
- * CpioConstants.FORMAT_OLD_BINARY<br/>
- * CpioConstants.FORMAT_OLD_ASCII<br/>
+ * Possible format values are:
+ * <pre>
+ * CpioConstants.FORMAT_NEW
+ * CpioConstants.FORMAT_NEW_CRC
+ * CpioConstants.FORMAT_OLD_BINARY
+ * CpioConstants.FORMAT_OLD_ASCII
+ * </pre>
*
* @since 1.1
*/
@@ -664,7 +667,7 @@ public class CpioArchiveEntry implements
/**
* Set the checksum. The checksum is calculated by adding all bytes of a
- * file to transfer (crc += buf[pos] & 0xFF).
+ * file to transfer (crc += buf[pos] & 0xFF).
*
* @param chksum
* The checksum to set.
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
Sun Dec 22 07:03:43 2013
@@ -34,17 +34,17 @@ import org.apache.commons.compress.utils
* CPIOArchiveInputStream is a stream for reading cpio streams. All formats of
* cpio are supported (old ascii, old binary, new portable format and the new
* portable format with crc).
- * <p/>
- * <p/>
+ *
+ * <p>
* The stream can be read by extracting a cpio entry (containing all
* informations about a entry) and afterwards reading from the stream the file
* specified by the entry.
- * <p/>
- * <code><pre>
+ * </p>
+ * <pre>
* CPIOArchiveInputStream cpioIn = new CPIOArchiveInputStream(
* new FileInputStream(new File("test.cpio")));
* CPIOArchiveEntry cpioEntry;
- * <p/>
+ *
* while ((cpioEntry = cpioIn.getNextEntry()) != null) {
* System.out.println(cpioEntry.getName());
* int tmp;
@@ -55,13 +55,13 @@ import org.apache.commons.compress.utils
* System.out.println(buf.toString());
* }
* cpioIn.close();
- * </pre></code>
- * <p/>
+ * </pre>
+ * <p>
* Note: This implementation should be compatible to cpio 2.5
*
- * This class uses mutable fields and is not considered to be threadsafe.
+ * <p>This class uses mutable fields and is not considered to be threadsafe.
*
- * Based on code from the jRPM project (jrpm.sourceforge.net)
+ * <p>Based on code from the jRPM project (jrpm.sourceforge.net)
*/
public class CpioArchiveInputStream extends ArchiveInputStream implements
@@ -156,7 +156,7 @@ public class CpioArchiveInputStream exte
/**
* Returns 0 after EOF has reached for the current entry data, otherwise
* always return 1.
- * <p/>
+ * <p>
* Programs should not count on this method to return the actual number of
* bytes that could be read without blocking.
*
@@ -457,7 +457,7 @@ public class CpioArchiveInputStream exte
* @throws IOException
* if an I/O error has occurred
* @throws IllegalArgumentException
- * if n < 0
+ * if n < 0
*/
@Override
public long skip(final long n) throws IOException {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
Sun Dec 22 07:03:43 2013
@@ -35,14 +35,13 @@ import org.apache.commons.compress.utils
* CPIOArchiveOutputStream is a stream for writing CPIO streams. All formats of
* CPIO are supported (old ASCII, old binary, new portable format and the new
* portable format with CRC).
- * <p/>
- * <p/>
- * An entry can be written by creating an instance of CpioArchiveEntry and fill
+ *
+ * <p>An entry can be written by creating an instance of CpioArchiveEntry and
fill
* it with the necessary values and put it into the CPIO stream. Afterwards
* write the contents of the file into the CPIO stream. Either close the stream
- * by calling finish() or put a next entry into the cpio stream.
- * <p/>
- * <code><pre>
+ * by calling finish() or put a next entry into the cpio stream.</p>
+ *
+ * <pre>
* CpioArchiveOutputStream out = new CpioArchiveOutputStream(
* new FileOutputStream(new File("test.cpio")));
* CpioArchiveEntry entry = new CpioArchiveEntry();
@@ -54,13 +53,13 @@ import org.apache.commons.compress.utils
* out.putArchiveEntry(entry);
* out.write(testContents.getBytes());
* out.close();
- * </pre></code>
- * <p/>
- * Note: This implementation should be compatible to cpio 2.5
+ * </pre>
+ *
+ * <p>Note: This implementation should be compatible to cpio 2.5</p>
*
- * This class uses mutable fields and is not considered threadsafe.
+ * <p>This class uses mutable fields and is not considered threadsafe.</p>
*
- * based on code from the jRPM project (jrpm.sourceforge.net)
+ * <p>based on code from the jRPM project (jrpm.sourceforge.net)</p>
*/
public class CpioArchiveOutputStream extends ArchiveOutputStream implements
CpioConstants {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
Sun Dec 22 07:03:43 2013
@@ -114,6 +114,7 @@ import org.apache.commons.compress.archi
* #define EXT2_XATTR_MAGIC 0xEA020000 // block EA
* #define EXT2_XATTR_MAGIC2 0xEA020001 // in inode EA
* </pre>
+ * <p>
* The fields in <b>bold</b> are the same for all blocks. (This permitted
* multiple dumps to be written to a single tape.)
* </p>
@@ -131,7 +132,7 @@ import org.apache.commons.compress.archi
*
* //
* // This is the new (4.4) BSD inode structure
- * // copied from the FreeBSD 2.0 <ufs/ufs/dinode.h> include file
+ * // copied from the FreeBSD 2.0 <ufs/ufs/dinode.h> include file
* //
* struct new_bsd_inode {
* __u16 di_mode; // file type, standard Unix permissions
@@ -154,6 +155,7 @@ import org.apache.commons.compress.archi
* __s32 di_spare[2]; // unused
* };
* </pre>
+ * <p>
* It is important to note that the header DOES NOT have the name of the
* file. It can't since hard links mean that you may have multiple filenames
* for a single physical file. You must read the contents of the directory
@@ -163,16 +165,16 @@ import org.apache.commons.compress.archi
* <p>
* The C structure that indicates if a specific block is a real block
* that contains data or is a sparse block that is not persisted to the
- * disk is:
+ * disk is:</p>
* <pre>
* #define TP_BSIZE 1024
* #define TP_NINDIR (TP_BSIZE/2)
*
* union u_data {
- * char s_addrs[TP_NINDIR]; // 1 => data; 0 => hole in inode
+ * char s_addrs[TP_NINDIR]; // 1 => data; 0 => hole in inode
* int32_t s_inos[TP_NINOS]; // table of first inode on each volume
* } u_data;
- * </pre></p>
+ * </pre>
*
* @NotThreadSafe
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
Sun Dec 22 07:03:43 2013
@@ -161,7 +161,7 @@ public class TarArchiveOutputStream exte
/**
* Set the long file mode.
* This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2).
- * This specifies the treatment of long file names (names >=
TarConstants.NAMELEN).
+ * This specifies the treatment of long file names (names >=
TarConstants.NAMELEN).
* Default is LONGFILE_ERROR.
* @param longFileMode the mode to use
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
Sun Dec 22 07:03:43 2013
@@ -25,7 +25,7 @@ import java.util.zip.ZipException;
* Adds Unix file permission and UID/GID fields as well as symbolic
* link handling.
*
- * <p>This class uses the ASi extra field in the format:
+ * <p>This class uses the ASi extra field in the format:</p>
* <pre>
* Value Size Description
* ----- ---- -----------
@@ -38,9 +38,8 @@ import java.util.zip.ZipException;
* GID Short group ID
* (var.) variable symbolic link filename
* </pre>
- * taken from appnote.iz (Info-ZIP note, 981119) found at <a
+ * <p>taken from appnote.iz (Info-ZIP note, 981119) found at <a
*
href="ftp://ftp.uu.net/pub/archiving/zip/doc/";>ftp://ftp.uu.net/pub/archiving/zip/doc/</a></p>
-
*
* <p>Short is two bytes and Long is four bytes in big endian byte and
* word order, device numbers are currently not supported.</p>
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java
Sun Dec 22 07:03:43 2013
@@ -24,9 +24,8 @@ package org.apache.commons.compress.arch
* <p>Stores the UTF-8 version of the file comment as stored in the
* central directory header.</p>
*
- * <p>See {@link
- * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's
- * APPNOTE.TXT, section 4.6.8"}.</p>
+ * @see <a
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>PKWARE's
+ * APPNOTE.TXT, section 4.6.8</a>
*
* @NotThreadSafe super-class is not thread-safe
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java
Sun Dec 22 07:03:43 2013
@@ -24,9 +24,9 @@ package org.apache.commons.compress.arch
* <p>Stores the UTF-8 version of the file name field as stored in the
* local header and central directory header.</p>
*
- * <p>See {@link
- * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's
- * APPNOTE.TXT, section 4.6.9"}.</p>
+ * @see <a
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>PKWARE's
+ * APPNOTE.TXT, section 4.6.9</a>
+ *
* @NotThreadSafe super-class is not thread-safe
*/
public class UnicodePathExtraField extends AbstractUnicodeExtraField {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
Sun Dec 22 07:03:43 2013
@@ -21,10 +21,9 @@ package org.apache.commons.compress.arch
/**
* Wrapper for extra field data that doesn't conform to the recommended format
of header-tag + size + data.
*
- * <p>The header-id is artificial (and not listed as a known ID in
- * {@link <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>
- * APPNOTE.TXT</a>}). Since it isn't used anywhere except to satisfy the
- * ZipExtraField contract it shouldn't matter anyway.</p>
+ * <p>The header-id is artificial (and not listed as a known ID in <a
+ *
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>APPNOTE.TXT</a>).
Since it isn't used anywhere
+ * except to satisfy the ZipExtraField contract it shouldn't matter anyway.</p>
*
* @since 1.1
* @NotThreadSafe
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
Sun Dec 22 07:03:43 2013
@@ -31,7 +31,6 @@ import java.util.zip.ZipException;
* allows one to store additional timestamps, and, in addition, the timestamps
* are stored using per-second granularity (zip's default behaviour can only
store
* timestamps to the nearest <em>even</em> second).
- * <p/>
* </p><p>
* Unfortunately, 32 (unsigned) bits can only store dates up to the year 2106,
* and so this extra field will eventually be obsolete. Enjoy it while it
lasts!
@@ -148,10 +147,10 @@ public class X5455_ExtendedTimestamp imp
/**
* Length of the extra field in the local file data - without
* Header-ID or length specifier.
- * <p/>
- * For X5455 the central length is often smaller than the
+ *
+ * <p>For X5455 the central length is often smaller than the
* local length, because central cannot contain access or create
- * timestamps.
+ * timestamps.</p>
*
* @return a <code>ZipShort</code> for the length of the data of this
extra field
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
Sun Dec 22 07:03:43 2013
@@ -27,10 +27,10 @@ import static org.apache.commons.compres
import static
org.apache.commons.compress.archivers.zip.ZipUtil.unsignedIntToSignedByte;
/**
- * An extra field that stores UNIX UID/GID data (owner & group ownership) for
a given
+ * An extra field that stores UNIX UID/GID data (owner & group ownership)
for a given
* zip entry. We're using the field definition given in Info-Zip's source
archive:
* zip-3.0.tar.gz/proginfo/extrafld.txt
- * <p/>
+ *
* <pre>
* Value Size Description
* ----- ---- -----------
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
Sun Dec 22 07:03:43 2013
@@ -27,16 +27,16 @@ import static org.apache.commons.compres
* Holds size and other extended information for entries that use Zip64
* features.
*
- * <p>See {@link
- * "http://www.pkware.com/documents/casestudies/APPNOTE.TXT PKWARE's
- * APPNOTE.TXT, section 4.5.3"}.</p>
- *
* <p>Currently Commons Compress doesn't support encrypting the
- * central directory so the note about masking doesn't apply.</p>
+ * central directory so the note in APPNOTE.TXT about masking doesn't
+ * apply.</p>
*
* <p>The implementation relies on data being read from the local file
* header and assumes that both size values are always present.</p>
*
+ * @see <a
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>PKWARE's
+ * APPNOTE.TXT, section 4.5.3</a>
+ *
* @since 1.2
* @NotThreadSafe
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
Sun Dec 22 07:03:43 2013
@@ -32,8 +32,7 @@ import java.util.zip.ZipException;
* access to the internal and external file attributes.
*
* <p>The extra data is expected to follow the recommendation of
- * {@link <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>
- * APPNOTE.txt</a>}:</p>
+ * <a
href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>APPNOTE.TXT</a>:</p>
* <ul>
* <li>the extra byte array consists of a sequence of extra fields</li>
* <li>each extra fields starts by a two byte header id followed by
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
Sun Dec 22 07:03:43 2013
@@ -316,7 +316,7 @@ public class ZipFile implements Closeabl
* the archive's central directory.
*
* @param name name of the entry.
- * @return the Iterable<ZipArchiveEntry> corresponding to the
+ * @return the Iterable<ZipArchiveEntry> corresponding to the
* given name
* @since 1.6
*/
@@ -331,7 +331,7 @@ public class ZipFile implements Closeabl
* appear within the archive.
*
* @param name name of the entry.
- * @return the Iterable<ZipArchiveEntry> corresponding to the
+ * @return the Iterable<ZipArchiveEntry> corresponding to the
* given name
* @since 1.6
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
Sun Dec 22 07:03:43 2013
@@ -81,7 +81,7 @@ public final class ZipLong implements Cl
new ZipLong(0X30304B50L);
/**
- * Archive extra data record signature.</p>
+ * Archive extra data record signature.
* @since 1.5
*/
public static final ZipLong AED_SIG = new ZipLong(0X08064B50L);
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
Sun Dec 22 07:03:43 2013
@@ -105,29 +105,29 @@ public enum ZipMethod {
/**
* Compression Method 9 for enhanced deflate.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
ENHANCED_DEFLATED(9),
/**
* PKWARE Data Compression Library Imploding.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
PKWARE_IMPLODING(10),
/**
* Compression Method 12 for bzip2.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
BZIP2(12),
/**
* Compression Method 14 for LZMA.
*
- * @see "http://www.7-zip.org/sdk.html";
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.7-zip.org/sdk.html";>http://www.7-zip.org/sdk.html</a>
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
LZMA(14),
@@ -135,21 +135,21 @@ public enum ZipMethod {
/**
* Compression Method 96 for Jpeg compression.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
JPEG(96),
/**
* Compression Method 97 for WavPack.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
WAVPACK(97),
/**
* Compression Method 98 for PPMd.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
PPMD(98),
@@ -157,7 +157,7 @@ public enum ZipMethod {
/**
* Compression Method 99 for AES encryption.
*
- * @see "http://www.winzip.com/wz54.htm";
+ * @see <a
href="http://www.winzip.com/wz54.htm";>http://www.winzip.com/wz54.htm</a>
*/
AES_ENCRYPTED(99),
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
Sun Dec 22 07:03:43 2013
@@ -52,9 +52,7 @@ import org.apache.commons.compress.compr
* <code>65k + (5 * blocksize)</code>.
* </pre>
*
- * <table width="100%" border="1">
- * <colgroup> <col width="33%" /> <col width="33%" /> <col width="33%" />
- * </colgroup>
+ * <table width="100%" border="1" summary="Memory usage by blocksize">
* <tr>
* <th colspan="3">Memory usage by blocksize</th>
* </tr>
@@ -369,7 +367,7 @@ public class BZip2CompressorOutputStream
* @throws IOException
* if an I/O error occurs in the specified stream.
* @throws IllegalArgumentException
- * if <code>(blockSize < 1) || (blockSize > 9)</code>.
+ * if <code>(blockSize < 1) || (blockSize > 9)</code>.
* @throws NullPointerException
* if <code>out == null</code>.
*
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
Sun Dec 22 07:03:43 2013
@@ -34,9 +34,11 @@ public class ArchiveUtils {
/**
* Generates a string containing the name, isDirectory setting and size of
an entry.
* <p>
- * For example:<br/>
- * <tt>- 2000 main.c</tt><br/>
- * <tt>d 100 testfiles</tt><br/>
+ * For example:
+ * <pre>
+ * - 2000 main.c
+ * d 100 testfiles
+ * </pre>
*
* @return the representation of the entry
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/CharsetNames.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
Sun Dec 22 07:03:43 2013
@@ -29,24 +29,24 @@ package org.apache.commons.compress.util
* documentation for your implementation to see if any other encodings are
supported. </cite>
* </p>
*
- * <ul>
- * <li><code>US-ASCII</code><br/>
- * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
Unicode character set.</li>
- * <li><code>ISO-8859-1</code><br/>
- * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
- * <li><code>UTF-8</code><br/>
- * Eight-bit Unicode Transformation Format.</li>
- * <li><code>UTF-16BE</code><br/>
- * Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
- * <li><code>UTF-16LE</code><br/>
- * Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
- * <li><code>UTF-16</code><br/>
- * Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either order
- * accepted on input, big-endian used on output.)</li>
- * </ul>
+ * <dl>
+ * <dt><code>US-ASCII</code></dt>
+ * <dd>Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
Unicode character set.</dd>
+ * <dt><code>ISO-8859-1</code></dt>
+ * <dd>ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</dd>
+ * <dt><code>UTF-8</code></dt>
+ * <dd>Eight-bit Unicode Transformation Format.</dd>
+ * <dt><code>UTF-16BE</code></dt>
+ * <dd>Sixteen-bit Unicode Transformation Format, big-endian byte order.</dd>
+ * <dt><code>UTF-16LE</code></dt>
+ * <dd>Sixteen-bit Unicode Transformation Format, little-endian byte
order.</dd>
+ * <dt><code>UTF-16</code></dt>
+ * <dd>Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either order
+ * accepted on input, big-endian used on output.)</dd>
+ * </dl>
*
- * This perhaps would best belong in the [lang] project. Even if a similar
interface is defined in [lang], it is not
- * foreseen that [codec] would be made to depend on [lang].
+ * <p>This perhaps would best belong in the [lang] project. Even if a similar
interface is defined in [lang], it is not
+ * foreseen that [compress] would be made to depend on [lang].</p>
*
* @see <a
href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html";>Standard
charsets</a>
* @since 1.4
@@ -54,7 +54,7 @@ package org.apache.commons.compress.util
*/
public class CharsetNames {
/**
- * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. </p>
+ * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* <p>
* Every implementation of the Java platform is required to support this
character encoding.
* </p>
@@ -123,4 +123,4 @@ public class CharsetNames {
* @see <a
href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html";>Standard
charsets</a>
*/
public static final String UTF_8 = "UTF-8";
-}
\ No newline at end of file
+}
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/Charsets.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/Charsets.java?rev=1552970&r1=1552969&r2=1552970&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/Charsets.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/Charsets.java
Sun Dec 22 07:03:43 2013
@@ -31,24 +31,24 @@ import java.nio.charset.Charset;
* documentation for your implementation to see if any other encodings are
supported. </cite>
* </p>
*
- * <ul>
- * <li><code>US-ASCII</code><br/>
- * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
Unicode character set.</li>
- * <li><code>ISO-8859-1</code><br/>
- * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
- * <li><code>UTF-8</code><br/>
- * Eight-bit Unicode Transformation Format.</li>
- * <li><code>UTF-16BE</code><br/>
- * Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
- * <li><code>UTF-16LE</code><br/>
- * Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
- * <li><code>UTF-16</code><br/>
- * Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either order
- * accepted on input, big-endian used on output.)</li>
- * </ul>
+ * <dl>
+ * <dt><code>US-ASCII</code></dt>
+ * <dd>Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
Unicode character set.</dd>
+ * <dt><code>ISO-8859-1</code></dt>
+ * <dd>ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</dd>
+ * <dt><code>UTF-8</code></dt>
+ * <dd>Eight-bit Unicode Transformation Format.</dd>
+ * <dt><code>UTF-16BE</code></dt>
+ * <dd>Sixteen-bit Unicode Transformation Format, big-endian byte order.</dd>
+ * <dt><code>UTF-16LE</code></dt>
+ * <dd>Sixteen-bit Unicode Transformation Format, little-endian byte
order.</dd>
+ * <dt><code>UTF-16</code></dt>
+ * <dd>Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either order
+ * accepted on input, big-endian used on output.)</dd>
+ * </dl>
*
- * This class best belongs in the Commons Lang or IO project. Even if a
similar class is defined in another Commons component, it is
- * not foreseen that Commons Compress would be made to depend on another
Commons component.
+ * <p>This class best belongs in the Commons Lang or IO project. Even if a
similar class is defined in another Commons
+ * component, it is not foreseen that Commons Compress would be made to depend
on another Commons component.</p>
*
* @see <a
href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html";>Standard
charsets</a>
* @since 1.4
@@ -88,7 +88,7 @@ public class Charsets {
}
/**
- * CharsetNamesISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. </p>
+ * CharsetNamesISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* <p>
* Every implementation of the Java platform is required to support this
character encoding.
* </p>
