hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lars Francke (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HBASE-2895) Use some annotations for documentation purposes
Date Mon, 02 Aug 2010 21:03:15 GMT

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

Lars Francke commented on HBASE-2895:
-------------------------------------

To be honest I'm not sure if there are others where it's relevant for now. HTablePool would
be one more.

I'd be satisfied with _any_ kind of documentation of these things at least for those few classes.
I guess it can always be added to more classes if needed. The annotations are nice to have
but a sentence in the Javadocs would suffice as well.

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


Mime
View raw message