You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2020/01/26 12:39:25 UTC
[commons-compress] branch master updated: one more javadoc warning
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 6883347 one more javadoc warning
6883347 is described below
commit 68833474b4e77d389611832a6ae99b8da0aeee89
Author: Stefan Bodewig <bo...@apache.org>
AuthorDate: Sun Jan 26 13:39:05 2020 +0100
one more javadoc warning
---
.../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 9a1ad41..e7550a5 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 & 0.1, as it may appear multi times,
* the sparse headers need to be stored in an array, not a map
- * @return
+ * @return the parsed PAX header
* @throws IOException
*/
Map<String, String> parsePaxHeaders(final InputStream inputStream, List<TarArchiveStructSparse> sparseHeaders)
Re: [commons-compress] branch master updated: one more javadoc warning
Posted by Gary Gregory <ga...@gmail.com>.
On Sun, Jan 26, 2020, 12:13 Stefan Bodewig <bo...@apache.org> wrote:
> On 2020-01-26, Gary Gregory wrote:
>
> > On Sun, Jan 26, 2020, 07:39 <bo...@apache.org> wrote:
>
> >>+ * @return the parsed PAX header
>
> > Plural?
>
> Not sure. I believe it is a single PAX header block holding multiple
> header variables - while the code calls those header variable headers to
> make things more confusing.
>
Right, which is why I was hoping for a clearer Javadoc ;-) it is confusing
as is.
Gary
>
> Stefan
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
Re: [commons-compress] branch master updated: one more javadoc warning
Posted by Stefan Bodewig <bo...@apache.org>.
On 2020-01-26, Gary Gregory wrote:
> On Sun, Jan 26, 2020, 07:39 <bo...@apache.org> wrote:
>>+ * @return the parsed PAX header
> Plural?
Not sure. I believe it is a single PAX header block holding multiple
header variables - while the code calls those header variable headers to
make things more confusing.
Stefan
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: [commons-compress] branch master updated: one more javadoc warning
Posted by Gary Gregory <ga...@gmail.com>.
On Sun, Jan 26, 2020, 07:39 <bo...@apache.org> wrote:
> 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 6883347 one more javadoc warning
> 6883347 is described below
>
> commit 68833474b4e77d389611832a6ae99b8da0aeee89
> Author: Stefan Bodewig <bo...@apache.org>
> AuthorDate: Sun Jan 26 13:39:05 2020 +0100
>
> one more javadoc warning
> ---
> .../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 9a1ad41..e7550a5 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 & 0.1, as it may
> appear multi times,
> * the sparse headers need to be stored in an
> array, not a map
> - * @return
> + * @return the parsed PAX header
>
Plural?
Gary
* @throws IOException
> */
> Map<String, String> parsePaxHeaders(final InputStream inputStream,
> List<TarArchiveStructSparse> sparseHeaders)
>
>