hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sanjay Radia (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-6668) Apply audience and stability annotations to classes in common
Date Wed, 05 May 2010 01:08:03 GMT

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

Sanjay Radia commented on HADOOP-6668:

> BTW the metrics themselves are also interfaces and they would have their own classification
(but we can't use 
the annotations).
Sorry I was little hasty here in my explanation. 
The metrics APIs are separate form the actual metrics.
You can consider  marking specific classes that implement metrics public or private - but
if you mark them as public then you are asserting that the actual implementation classes for
the specific metrics are public - ie the impl class API is public.
If your intension is to make specific sets of metrics (say for NN) public then you have to
document that in your documentation - the annotation mechanism cannot help here unless we
extend it. 

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

View raw message