[jira] Updated: (HBASE-1688) Improve javadocs in Result and KeyValue

["Jonathan Gray (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/HBASE-1688?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jonathan Gray updated HBASE-1688:
---------------------------------

    Attachment: HBASE-1688-v1.patch

Changes as described.  Rewrote the Result javadoc twice after looking at Get... wanted to make it more consistent in style.. (yeah, i think i wrote the Get javadoc hehe, strange that didn't matter)

> 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.