svn commit: r758704 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java

[sebb]

Author: sebb
Date: Thu Mar 26 15:56:48 2009
New Revision: 758704

URL: http://svn.apache.org/viewvc?rev=758704&view=rev
Log:
Javadoc

Modified:
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java

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=758704&r1=758703&r2=758704&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
 Thu Mar 26 15:56:48 2009
@@ -134,7 +134,10 @@
 
     private long chksum = 0;
 
-    private short fileFormat = -1;
+    /**
+     * See {...@link CpioArchiveEntry#setFormat(short)} for possible values.
+     */
+   private short fileFormat = -1;
 
     private long filesize = 0;
 
@@ -533,8 +536,11 @@
 
     /**
      * Set the format for this entry. Possible values are:
-     * CPIOConstants.FORMAT_NEW, CPIOConstants.FORMAT_NEW_CRC,
-     * CPIOConstants.FORMAT_OLD_BINARY, CPIOConstants.FORMAT_OLD_ASCII
+     * <p>
+     * {...@link CPIOConstants.FORMAT_NEW}<br/>
+     * {...@link CPIOConstants.FORMAT_NEW_CRC}<br/>
+     * {...@link CPIOConstants.FORMAT_OLD_BINARY}<br/>
+     * {...@link CPIOConstants.FORMAT_OLD_ASCII}<br/>
      * 
      * @param format
      *            The format to set.