[commons-compress] branch master updated: Javadoc

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git


The following commit(s) were added to refs/heads/master by this push:
     new 1cb7fe2b Javadoc
1cb7fe2b is described below

commit 1cb7fe2b1c4a7ea38a00349bb53bc5fa5cb1cd23
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Dec 11 01:01:34 2022 -0500

    Javadoc
---
 .../apache/commons/compress/archivers/dump/DumpArchiveUtil.java   | 8 +++++---
 .../apache/commons/compress/archivers/dump/TapeInputStream.java   | 8 ++++++--
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java 
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
index 7647b504..516df050 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveUtil.java
@@ -38,7 +38,7 @@ class DumpArchiveUtil {
      * Calculate checksum for buffer.
      *
      * @param buffer buffer containing tape segment header
-     * @returns checksum
+     * @return checksum
      */
     public static int calculateChecksum(final byte[] buffer) {
         int calc = 0;
@@ -52,9 +52,10 @@ class DumpArchiveUtil {
     }
 
     /**
-     * Verify that the buffer contains a tape segment header.
+     * Verifies that the buffer contains a tape segment header.
      *
      * @param buffer
+     * @return Whether the buffer contains a tape segment header.
      */
     public static final boolean verify(final byte[] buffer) {
         // verify magic. for now only accept NFS_MAGIC.
@@ -71,9 +72,10 @@ class DumpArchiveUtil {
     }
 
     /**
-     * Get the ino associated with this buffer.
+     * Gets the ino associated with this buffer.
      *
      * @param buffer
+     * @return the ino associated with this buffer.
      */
     public static final int getIno(final byte[] buffer) {
         return convert32(buffer, 20);
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java 
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
index a0df524f..6e00db70 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
@@ -44,7 +44,9 @@ class TapeInputStream extends FilterInputStream {
     private long bytesRead;
 
     /**
-     * Constructor
+     * Constructs a new instance.
+     *
+     * @param in the underlying input stream.
      */
     public TapeInputStream(final InputStream in) {
         super(in);
@@ -363,7 +365,9 @@ class TapeInputStream extends FilterInputStream {
     }
 
     /**
-     * Get number of bytes read.
+     * Gets number of bytes read.
+     *
+     * @return number of bytes read.
      */
     public long getBytesRead() {
         return bytesRead;