[ 
https://issues.apache.org/jira/browse/HBASE-1688?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12734436#action_12734436
 ] 

stack commented on HBASE-1688:
------------------------------

+1

Excellent doc.

We need client package-level doc. that talks broadly about the classes 
involved.  Thats a different issue though.  Commit.

> Improve javadocs in Result and KeyValue
> ---------------------------------------
>
>                 Key: HBASE-1688
>                 URL: https://issues.apache.org/jira/browse/HBASE-1688
>             Project: Hadoop HBase
>          Issue Type: Improvement
>          Components: client
>    Affects Versions: 0.20.0
>            Reporter: Jonathan Gray
>            Assignee: Jonathan Gray
>             Fix For: 0.20.0
>
>         Attachments: HBASE-1688-v1.patch
>
>
> Result has almost no class comment even though it is one of the most 
> user-facing classes, and is confusing because of exposure to KeyValue as well 
> as all the nasty looking Maps.
> KeyValue is also documented with a purely server-side focus.  Should add some 
> documentation in the class comment and around those methods that will 
> typically be used client-side.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to