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

Jim Kellerman resolved HBASE-465.
---------------------------------

       Resolution: Fixed
    Fix Version/s: 0.18.0

Not addressed by this patch:

org.apache.hadoop.hbase.mapred.IndexConfiguration - not enough documentation to 
know what all the constants did.

org.apache.hadoop.hbase.rest - unsure if this would be effected by HBASE-785
org.apache.hadoop.hbase.thrift - unsure if has been finalized yet.

Most of src/test - I'm far less concerned if test cases are missing javadoc for 
public declarations. Internally, they are well commented on what they are 
doing, and what do you put for TestFoo.testFoo ? 

{code}
/** the test */
{code}

???

However, the vast majority of missing javadoc has been fixed. We need to be 
diligent in the future to ensure that public declarations have javadoc. 

If it is not a part of the public API:
- does it really need to be public? Can it have default or protected visibility 
instead?
- use @Override where it is needed


> Fix javadoc for all public declarations
> ---------------------------------------
>
>                 Key: HBASE-465
>                 URL: https://issues.apache.org/jira/browse/HBASE-465
>             Project: Hadoop HBase
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 0.2.0
>            Reporter: Jim Kellerman
>            Assignee: Jim Kellerman
>            Priority: Minor
>             Fix For: 0.18.0
>
>
> Just as client, master and region server were refactored in subissues of 
> HBASE-75, create subtasks for fixing javadoc for *all* public declarations. 
> Some are missing, some are just incorrect. 
> See the hadoop code review checklist: 
> http://wiki.apache.org/hadoop/CodeReviewChecklist

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