commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1157886 - in /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump: DumpArchiveSummary.java TapeInputStream.java
Date Mon, 15 Aug 2011 15:23:31 GMT
Author: sebb
Date: Mon Aug 15 15:23:30 2011
New Revision: 1157886

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

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java?rev=1157886&r1=1157885&r2=1157886&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
(original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
Mon Aug 15 15:23:30 2011
@@ -59,7 +59,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get the date of this dump.
-     * @return
+     * @return the date of this dump.
      */
     public Date getDumpDate() {
         return dumpDate;
@@ -89,7 +89,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get volume (tape) number.
-     * @return
+     * @return volume (tape) number.
      */
     public int getVolume() {
         return volume;
@@ -108,7 +108,7 @@ public class DumpArchiveSummary {
      * 'n' this dump contains all files that have changed since the last dump
      * at this level or lower. This is used to support different levels of
      * incremental backups.
-     * @return
+     * @return dump level
      */
     public int getLevel() {
         return level;
@@ -124,7 +124,7 @@ public class DumpArchiveSummary {
     /**
      * Get dump label. This may be autogenerated or it may be specified
      * bu the user.
-     * @return
+     * @return dump label
      */
     public String getLabel() {
         return label;
@@ -140,7 +140,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get the last mountpoint, e.g., /home.
-     * @return
+     * @return last mountpoint
      */
     public String getFilesystem() {
         return filesys;
@@ -155,7 +155,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
-     * @return
+     * @return device name
      */
     public String getDevname() {
         return devname;
@@ -171,7 +171,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get the hostname of the system where the dump was performed.
-     * @return
+     * @return hostname
      */
     public String getHostname() {
         return hostname;
@@ -186,7 +186,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get the miscellaneous flags. See below.
-     * @return
+     * @return flags
      */
     public int getFlags() {
         return flags;
@@ -202,7 +202,7 @@ public class DumpArchiveSummary {
 
     /**
      * Get the inode of the first record on this volume.
-     * @return
+     * @return inode of the first record on this volume.
      */
     public int getFirstRecord() {
         return firstrec;
@@ -219,7 +219,7 @@ public class DumpArchiveSummary {
     /**
      * Get the number of records per tape block. This is typically
      * between 10 and 32.
-     * @return
+     * @return the number of records per tape block
      */
     public int getNTRec() {
         return ntrec;
@@ -236,7 +236,7 @@ public class DumpArchiveSummary {
      * Is this the new header format? (We do not currently support the
      * old format.)
      *
-     * @return
+     * @return true if using new header format
      */
     public boolean isNewHeader() {
         return (flags & 0x0001) == 0x0001;
@@ -245,7 +245,7 @@ public class DumpArchiveSummary {
     /**
      * Is this the new inode format? (We do not currently support the
      * old format.)
-     * @return
+     * @return true if using new inode format
      */
     public boolean isNewInode() {
         return (flags & 0x0002) == 0x0002;
@@ -254,7 +254,7 @@ public class DumpArchiveSummary {
     /**
      * Is this volume compressed? N.B., individual blocks may or may not be compressed.
      * The first block is never compressed.
-     * @return
+     * @return true if volume is compressed
      */
     public boolean isCompressed() {
         return (flags & 0x0080) == 0x0080;
@@ -262,7 +262,7 @@ public class DumpArchiveSummary {
 
     /**
      * Does this volume only contain metadata?
-     * @return
+     * @return true if volume only contains meta-data
      */
     public boolean isMetaDataOnly() {
         return (flags & 0x0100) == 0x0100;
@@ -270,14 +270,14 @@ public class DumpArchiveSummary {
 
     /**
      * Does this volume cotain extended attributes.
-     * @return
+     * @return true if volume cotains extended attributes.
      */
     public boolean isExtendedAttributes() {
         return (flags & 0x8000) == 0x8000;
     }
 
     /**
-     * @see java.lang.hashCode()
+     * @see java.lang.Object#hashCode()
      */
     @Override
     public int hashCode() {

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java?rev=1157886&r1=1157885&r2=1157886&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
(original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
Mon Aug 15 15:23:30 2011
@@ -54,8 +54,8 @@ public class TapeInputStream extends Fil
      * dump archive's actual block size since compression is handled at the
      * block level.
      *
-     * @param blockSize
-     *            actual blockSize according to dump archive
+     * @param recsPerBlock
+     *            records per block
      * @param isCompressed
      *            true if the archive is compressed
      * @throws IOException
@@ -82,7 +82,7 @@ public class TapeInputStream extends Fil
     }
 
     /**
-     * {@see java.io.InputStream#available}
+     * @see java.io.InputStream#available
      */
     @Override
     public int available() throws IOException {
@@ -94,7 +94,7 @@ public class TapeInputStream extends Fil
     }
 
     /**
-     * {@see java.io.InputStream#read()
+     * @see java.io.InputStream#read()
      */
     @Override
     public int read() throws IOException {
@@ -104,7 +104,7 @@ public class TapeInputStream extends Fil
     }
 
     /**
-     * {@see java.io.InputStream#read(byte[], int, int) }
+     * @see java.io.InputStream#read(byte[], int, int)
      */
     @Override
     public int read(byte[] b, int off, int len) throws IOException {
@@ -146,7 +146,7 @@ public class TapeInputStream extends Fil
 
     /**
      * Skip bytes. Same as read but without the arraycopy.
-     * {@see java.io.InputStream#read(byte[], int, int) }
+     * @see java.io.InputStream#read(byte[], int, int)
      */
     @Override
     public long skip(long len) throws IOException {



Mime
View raw message