Author: sebb
Date: Mon Aug 15 15:08:33 2011
New Revision: 1157877
URL: http://svn.apache.org/viewvc?rev=1157877&view=rev
Log:
Javadoc fixes
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.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/dump/DumpArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java?rev=1157877&r1=1157876&r2=1157877&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
Mon Aug 15 15:08:33 2011
@@ -45,7 +45,7 @@ public class Dirent {
/**
* Get ino.
- * @return
+ * @return the i-node
*/
public int getIno() {
return ino;
@@ -53,7 +53,7 @@ public class Dirent {
/**
* Get ino of parent directory.
- * @return
+ * @return the parent i-node
*/
public int getParentIno() {
return parentIno;
@@ -61,7 +61,7 @@ public class Dirent {
/**
* Get entry type.
- * @return
+ * @return the entry type
*/
public int getType() {
return type;
@@ -69,7 +69,7 @@ public class Dirent {
/**
* Get name of directory entry.
- * @return
+ * @return the directory name
*/
public String getName() {
return name;
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=1157877&r1=1157876&r2=1157877&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
Mon Aug 15 15:08:33 2011
@@ -242,7 +242,7 @@ public class DumpArchiveEntry implements
/**
* Returns the path of the entry.
- * @return
+ * @return the path of the entry.
*/
public String getSimpleName() {
return simpleName;
@@ -250,7 +250,6 @@ public class DumpArchiveEntry implements
/**
* Sets the path of the entry.
- * @return
*/
protected void setSimpleName(String simpleName) {
this.simpleName = simpleName;
@@ -551,7 +550,7 @@ public class DumpArchiveEntry implements
/**
* Returns the name of the entry.
- * @return
+ * @return the name of the entry.
*/
public String getName() {
return name;
@@ -559,7 +558,6 @@ public class DumpArchiveEntry implements
/**
* Sets the name of the entry.
- * @return
*/
public void setName(String name) {
this.name = name;
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java?rev=1157877&r1=1157876&r2=1157877&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
Mon Aug 15 15:08:33 2011
@@ -348,7 +348,7 @@ public class DumpArchiveInputStream exte
* Get full path for specified archive entry, or null if there's a gap.
*
* @param entry
- * @return
+ * @return full path for specified archive entry, or null if there's a
gap.
*/
public String getPath(DumpArchiveEntry entry) {
// build the stack of elements. It's possible that we're
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java?rev=1157877&r1=1157876&r2=1157877&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
Mon Aug 15 15:08:33 2011
@@ -85,7 +85,7 @@ public class DumpArchiveUtil {
*
* @param buffer
* @param offset
- * @return
+ * @return the 8-byte entry as a long
*/
public static final long convert64(byte[] buffer, int offset) {
long i = 0;
@@ -106,7 +106,7 @@ public class DumpArchiveUtil {
*
* @param buffer
* @param offset
- * @return
+ * @return the 4-byte entry as an int
*/
public static final int convert32(byte[] buffer, int offset) {
int i = 0;
@@ -123,7 +123,7 @@ public class DumpArchiveUtil {
*
* @param buffer
* @param offset
- * @return
+ * @return the 2-byte entry as an int
*/
public static final int convert16(byte[] buffer, int offset) {
int i = 0;
