hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Todd Lipcon (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-7316) Add public javadocs to FSDataInputStream and FSDataOutputStream
Date Fri, 03 Jun 2011 18:23:48 GMT

    [ https://issues.apache.org/jira/browse/HADOOP-7316?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13043937#comment-13043937

Todd Lipcon commented on HADOOP-7316:

Super nitty review on the javadoc:
- Javadoc style guide at http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
says the following about punctuation and capitalization for @param and @return:
The description begins with a lowercase letter if it is a phrase (contains no verb), or an
uppercase letter if it is a sentence. End the phrase with a period only if another phrase
or sentence follows it.
(ie the @param and @returns should start with lower case letters)

- following should read "the buffer *into* which data is read" in two places:
+   * @param buffer    The buffer in which data is read.

- for the readFully javadoc, @param length should say "the exact number of bytes to read"
or "the number of bytes" rather than "the maximum" given the contract of readFully.
- for readFully, we should also specify that, even if it throws an exception, it may modify
an undetermined number of bytes in the target buffer.
- typo: "altenate" should be "alternate"

> Add public javadocs to FSDataInputStream and FSDataOutputStream
> ---------------------------------------------------------------
>                 Key: HADOOP-7316
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7316
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Eli Collins
>             Fix For: 0.23.0
>         Attachments: hadoop-7316-1.patch, hadoop-7316-2.patch
> This is a method made public for testing.  In comments in HADOOP-7301 after commit, adding
javadoc comments was requested.  This is a follow up jira to address it.

This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

View raw message