hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Doug Cutting (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-6668) Apply audience and stability annotations to classes in common
Date Tue, 11 May 2010 18:01:48 GMT

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

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

> the assumption is that only interfaces marked as audience-public will appear in the user
javadoc.

That's not what's currently implemented.  But Tom tells me it would be relatively easy to
change that, so that only things explicitly marked @Public would be included in the javadoc.

If we declare that the default is @Private for Java-declared public things then I think we'll
need to add @Public not just to classes but also to methods too, no?  Or would you use a different
default for methods?  That's possible, but seems confusing.  The least confusing approach
would be to have defaults match Java declarations, and for the annotations only to be used
when things diverge from these.

> 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