[jira] Commented: (HBASE-2895) Use some annotations for documentation purposes

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

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

Jonathan Gray commented on HBASE-2895:
--------------------------------------

Is thread-safety relevant for anything besides HTable and HBaseAdmin?  (where the answer is sometimes yes sometimes no -> therefore we say no)

> Use some annotations for documentation purposes
> -----------------------------------------------
>
>                 Key: HBASE-2895
>                 URL: https://issues.apache.org/jira/browse/HBASE-2895
>             Project: HBase
>          Issue Type: Wish
>            Reporter: Lars Francke
>            Priority: Minor
>
> I'd love to use some annotations to document some common things. In particular I'd love to see @ThreadSafe and @NotThreadSafe. If not for all classes it would at least be nice to have this for all the client classes that a user might see.
> http://jcip.net/annotations/doc/index.html
> Those can be easily pulled in via Maven.
> Should we do it?
> Hadoop common also started using  InterfaceAudience and InterfaceStability annotations which might be nice.

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