hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jakob Homan (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HADOOP-5073) Hadoop 1.0 Interface Classification - scope (visibility - public/private) and stability
Date Wed, 02 Sep 2009 20:16:32 GMT

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

Jakob Homan commented on HADOOP-5073:
-------------------------------------

@Bill
Absolutely, it may be a problem. That's why I consider the implementation of @Documented and
@Inherited that doesn't actually document the inherited annotations broken.  I don't know
what the right answer is to this: if we require every method to be thusly documented, maintaining
this metainfo becomes a burden and will be ignored by developers.  If we don't, end users
may end up in the situation Bill describes.  At the very least, we should have tooling to
either apply/update the documentation, or to warn users if they are using APIs that they probably
shouldn't be.   I don't believe our jars even ship with the javadoc included.

> Hadoop 1.0 Interface Classification - scope (visibility - public/private) and stability
> ---------------------------------------------------------------------------------------
>
>                 Key: HADOOP-5073
>                 URL: https://issues.apache.org/jira/browse/HADOOP-5073
>             Project: Hadoop Common
>          Issue Type: Sub-task
>            Reporter: Sanjay Radia
>            Assignee: Sanjay Radia
>         Attachments: 5073_demo.png, c5073_20090825.patch, c5073_20090825.png, HADOOP-5073.patch
>
>
> This jira proposes an interface classification for hadoop interfaces.
> The discussion was started in email alias core-dev@hadoop.apache.org in Nov 2008.

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