You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "Timothy Mann (JIRA)" <ji...@apache.org> on 2012/10/06 19:55:02 UTC

[jira] [Created] (HADOOP-8896) Javadoc points to Wrong Reader and Writer classes in SequenceFile

Timothy Mann created HADOOP-8896:
------------------------------------

             Summary: Javadoc points to Wrong Reader and Writer classes in SequenceFile
                 Key: HADOOP-8896
                 URL: https://issues.apache.org/jira/browse/HADOOP-8896
             Project: Hadoop Common
          Issue Type: Improvement
          Components: documentation
    Affects Versions: 2.0.1-alpha
            Reporter: Timothy Mann
            Priority: Trivial


Line 56 of org.apache.hadoop.io.SequenceFile refers to {@link Writer}, {@link Reader} in the javadoc comment describing the class SequenceFile. When the javadoc is built Reader and Writer link to java.io.Reader and java.io.Writer, respectively. However, they should instead refer to {@link SequenceFile.Reader} and {@link SequenceFile.Writer}.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-8896) Javadoc points to Wrong Reader and Writer classes in SequenceFile

Posted by "Harsh J (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-8896?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Harsh J updated HADOOP-8896:
----------------------------

    Tags:   (was: javadoc, SequenceFile, SequenceFile.Reader, SequenceFile.Writer)
    
> Javadoc points to Wrong Reader and Writer classes in SequenceFile
> -----------------------------------------------------------------
>
>                 Key: HADOOP-8896
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8896
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation, io
>    Affects Versions: 2.0.1-alpha
>            Reporter: Timothy Mann
>            Priority: Trivial
>              Labels: sequence-file
>   Original Estimate: 1m
>  Remaining Estimate: 1m
>
> Line 56 of org.apache.hadoop.io.SequenceFile refers to {@link Writer}, {@link Reader} in the javadoc comment describing the class SequenceFile. When the javadoc is built Reader and Writer link to java.io.Reader and java.io.Writer, respectively. However, they should instead refer to {@link SequenceFile.Reader} and {@link SequenceFile.Writer}.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-8896) Javadoc points to Wrong Reader and Writer classes in SequenceFile

Posted by "Harsh J (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-8896?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Harsh J updated HADOOP-8896:
----------------------------

    Component/s: io
    
> Javadoc points to Wrong Reader and Writer classes in SequenceFile
> -----------------------------------------------------------------
>
>                 Key: HADOOP-8896
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8896
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation, io
>    Affects Versions: 2.0.1-alpha
>            Reporter: Timothy Mann
>            Priority: Trivial
>              Labels: sequence-file
>   Original Estimate: 1m
>  Remaining Estimate: 1m
>
> Line 56 of org.apache.hadoop.io.SequenceFile refers to {@link Writer}, {@link Reader} in the javadoc comment describing the class SequenceFile. When the javadoc is built Reader and Writer link to java.io.Reader and java.io.Writer, respectively. However, they should instead refer to {@link SequenceFile.Reader} and {@link SequenceFile.Writer}.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (HADOOP-8896) Javadoc points to Wrong Reader and Writer classes in SequenceFile

Posted by "Harsh J (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-8896?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Harsh J updated HADOOP-8896:
----------------------------

    Labels: sequence-file  (was: )
    
> Javadoc points to Wrong Reader and Writer classes in SequenceFile
> -----------------------------------------------------------------
>
>                 Key: HADOOP-8896
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8896
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation, io
>    Affects Versions: 2.0.1-alpha
>            Reporter: Timothy Mann
>            Priority: Trivial
>              Labels: sequence-file
>   Original Estimate: 1m
>  Remaining Estimate: 1m
>
> Line 56 of org.apache.hadoop.io.SequenceFile refers to {@link Writer}, {@link Reader} in the javadoc comment describing the class SequenceFile. When the javadoc is built Reader and Writer link to java.io.Reader and java.io.Writer, respectively. However, they should instead refer to {@link SequenceFile.Reader} and {@link SequenceFile.Writer}.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-8896) Javadoc points to Wrong Reader and Writer classes in SequenceFile

Posted by "Harsh J (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-8896?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13471077#comment-13471077 ] 

Harsh J commented on HADOOP-8896:
---------------------------------

Noticed as well! Thanks for filing this! Will you be willing to provide a patch as well Timothy?
                
> Javadoc points to Wrong Reader and Writer classes in SequenceFile
> -----------------------------------------------------------------
>
>                 Key: HADOOP-8896
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8896
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation, io
>    Affects Versions: 2.0.1-alpha
>            Reporter: Timothy Mann
>            Priority: Trivial
>              Labels: sequence-file
>   Original Estimate: 1m
>  Remaining Estimate: 1m
>
> Line 56 of org.apache.hadoop.io.SequenceFile refers to {@link Writer}, {@link Reader} in the javadoc comment describing the class SequenceFile. When the javadoc is built Reader and Writer link to java.io.Reader and java.io.Writer, respectively. However, they should instead refer to {@link SequenceFile.Reader} and {@link SequenceFile.Writer}.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira