hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tom White (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-6668) Apply audience and stability annotations to classes in common
Date Mon, 10 May 2010 22:48:31 GMT

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

Tom White commented on HADOOP-6668:
-----------------------------------

Sanjay> Similarly, from the point of view of the user of an interface - unless is it declared
as audience-public don't assume it is. 

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.

Do you have any comments on the notes I made in the attachment on classifications for particular
classes?

Doug> I don't fundamentally care what the default is. I do care what ends up in javadoc
and in releases.

In MAPREDUCE-1623 we have marked all the classes as Public/LimitedPrivate/Private, which has
the effect of controlling what appears in Javadoc, so should be sufficient for 0.21.


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


Mime
View raw message