[commons-compress] branch master updated: be more precise in 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


The following commit(s) were added to refs/heads/master by this push:
     new 4b464e1  be more precise in javadocs
4b464e1 is described below

commit 4b464e1ba60aa6a94b5aa650b333988d9ba73ce2
Author: Stefan Bodewig <bo...@apache.org>
AuthorDate: Sun Feb 2 14:53:58 2020 +0100

    be more precise in javadocs
---
 .../apache/commons/compress/archivers/tar/TarArchiveInputStream.java    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
index e7550a5..aee7919 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
@@ -672,7 +672,7 @@ public class TarArchiveInputStream extends ArchiveInputStream {
      * @param inputstream inputstream to read keys and values
      * @param sparseHeaders used in PAX Format 0.0 &amp; 0.1, as it may appear multi times,
      *                      the sparse headers need to be stored in an array, not a map
-     * @return the parsed PAX header
+     * @return map of PAX headers values found inside of the current (local or global) PAX headers tar entry.
      * @throws IOException
      */
     Map<String, String> parsePaxHeaders(final InputStream inputStream, List<TarArchiveStructSparse> sparseHeaders)