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

Sanjay Radia commented on HADOOP-6668:
--------------------------------------

>An experienced Java user who was new to Hadoop might be surprised to learn 
>that they couldn't use an API that had public Java visibility.
There are two separate issues - what is the default and whether or not 
audience-private interfaces need to be
labelled. The default should be that if you don't label it as audience-public 
then it is *not*. Separately we can 
decided if ALL interfaces need to be labelled. If you want to label every 
interface then we need a way to enforce that for consistency.
But which every way we go, only audience-public interfaces will appear in the 
user-javadoc - I don't believe there was any disagreement on this at all in 
this or the other jiras.

> 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: Sub-task
>          Components: documentation
>            Reporter: Tom White
>            Assignee: Tom White
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: common.interface-tw-annotated.txt, HADOOP-6668.patch, 
> HADOOP-6668.patch, HADOOP-6668.patch, HADOOP-6668.patch, HADOOP-6668.patch, 
> 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