[commons-compress] branch master updated: address javadoc warnings

[bo...@apache.org]

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

bodewig 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 50bd693  address javadoc warnings
50bd693 is described below

commit 50bd693a5e8889617611c729cc3818b2b72e3cb3
Author: Stefan Bodewig <bo...@apache.org>
AuthorDate: Sat Jan 25 16:12:49 2020 +0100

    address javadoc warnings
---
 .../apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java   | 2 ++
 src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java  | 3 +++
 .../compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java    | 1 +
 .../commons/compress/utils/MultiReadOnlySeekableByteChannel.java       | 2 +-
 4 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
index 1d89fca..75325c3 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
@@ -77,7 +77,9 @@ public class TarArchiveSparseEntry implements TarConstants {
     }
 
     /**
+     * Obatains information about the configuration for the sparse entry.
      * @since 1.20
+     * @return information about the configuration for the sparse entry.
      */
     public List<TarArchiveStructSparse> getSparseHeaders() {
         return sparseHeaders;
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
index 860cd19..c231663 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
@@ -306,6 +306,9 @@ public class TarUtils {
     /**
      * Parses the content of a PAX 1.0 sparse block.
      * @since 1.20
+     * @param buffer The buffer from which to parse.
+     * @param offset The offset into the buffer from which to parse.
+     * @return a parsed sparse struct
      */
     public static TarArchiveStructSparse parseSparse(final byte[] buffer, final int offset) {
         long sparseOffset = parseOctalOrBinary(buffer, offset, SPARSE_OFFSET_LEN);
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
index 40a5129..edf8b7d 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
@@ -112,6 +112,7 @@ public class ZipSplitReadOnlySeekableByteChannel extends MultiReadOnlySeekableBy
      *                 and theses channels should be added in correct order (e.g. .z01, .z02... .z99, .zip)
      * @return SeekableByteChannel that concatenates all provided channels
      * @throws NullPointerException if channels is null
+     * @throws IOException if reading channels fails
      */
     public static SeekableByteChannel forOrderedSeekableByteChannels(SeekableByteChannel... channels) throws IOException {
         if (Objects.requireNonNull(channels, "channels must not be null").length == 1) {
diff --git a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
index f46e771..70e3add 100644
--- a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
+++ b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
@@ -135,7 +135,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
      * @param channelNumber  the channel number
      * @param relativeOffset the relative offset in the corresponding channel
      * @return global position of all channels as if they are a single channel
-     * @throws IOException
+     * @throws IOException if positioning fails
      */
     public synchronized SeekableByteChannel position(long channelNumber, long relativeOffset) throws IOException {
         if (!isOpen()) {