[ 
https://issues.apache.org/jira/browse/HADOOP-6668?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12852883#action_12852883
 ] 

Doug Cutting commented on HADOOP-6668:
--------------------------------------

> The annotations do appear in javadoc [ ... ]

I think they should be more prominent, like deprecation.  A bolded "Evolving" 
as the first word of the javadoc comment, that appears on the package summary 
page, like "Deprecated" would be ideal.  We want folks to be very aware that 
these APIs may change, so that, when they do, they won't scream at us for 
breaking things.

> Apply audience and stability annotations to classes in common
> -------------------------------------------------------------
>
>                 Key: HADOOP-6668
>                 URL: https://issues.apache.org/jira/browse/HADOOP-6668
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Tom White
>            Assignee: Tom White
>         Attachments: HADOOP-6668.patch
>
>
> Mark private implementation classes with the InterfaceAudience.Private or 
> InterfaceAudience.LimitedPrivate annotation to exclude them from user Javadoc 
> and JDiff.

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