[commons-compress] 01/02: COMPRESS-231 javadocs

[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

commit 0cc082068c25419ea41133978dfb405bb058e48c
Author: Stefan Bodewig <bo...@apache.org>
AuthorDate: Sun Aug 18 17:10:06 2019 +0200

    COMPRESS-231 javadocs
---
 .../apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java | 2 ++
 1 file changed, 2 insertions(+)

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 221294b..203d9f3 100644
--- a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
+++ b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
@@ -193,6 +193,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
      *
      * @param channels the channels to concatenate
      * @throws NullPointerException if channels is null
+     * @return SeekableByteChannel that concatenates all provided channels
      */
     public static SeekableByteChannel forSeekableByteChannels(SeekableByteChannel... channels) {
         if (Objects.requireNonNull(channels, "channels must not be null").length == 1) {
@@ -207,6 +208,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
      * @param files the files to concatenate
      * @throws NullPointerException if files is null
      * @throws IOException if opening a channel for one of the files fails
+     * @return SeekableByteChannel that concatenates all provided files
      */
     public static SeekableByteChannel forFiles(File... files) throws IOException {
         List<SeekableByteChannel> channels = new ArrayList<>();