Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm
Precedence: bulk
Reply-To: common-issues@hadoop.apache.org
Message-ID: <2052319870.662641270229787267.JavaMail.jira@brutus.apache.org>
Date: Fri, 2 Apr 2010 17:36:27 +0000 (UTC)
From: "Doug Cutting (JIRA)" <jira@apache.org>
To: common-issues@hadoop.apache.org
Subject: [jira] Commented: (HADOOP-6668) Apply audience and stability
 annotations to classes in common
In-Reply-To: <1543391482.614961270068327308.JavaMail.jira@brutus.apache.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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