[
https://issues.apache.org/jira/browse/HADOOP-5073?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jakob Homan updated HADOOP-5073:
--------------------------------
Attachment: 5073_demo.png
HADOOP-5073.patch
Did some work creating a test implementation of the above. Attached as a patch
as a prototype of what such a system could look like, along with a screenshot
of how the annotations end up looking in the Javadoc. Just a proof of concept,
don't ding me over file locations and such.
It turned out to be better to have separate annotations for each of the
possible labels: IDE integration was much better and the values show up more
clearly in the Javadoc and IDE integreated Javadoc viewer.
The biggest problem is that with the project split, these annotations are not
carried over and we still have the fact that @Inherited and @Documented don't
actually work correctly. So, for instance, even though I annotated FileSystem,
none of that carries over to DistributedFileSystem, since it's in a different
jar. Therefore, there would be a significant labeling initial and maintenance
effort to make sure everything was marked as it should be. Anyway, this is
what the above scheme could look like if implemented.
> 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, HADOOP-5073.patch
>
>
> This jira proposes an interface classification for hadoop interfaces.
> The discussion was started in email alias [email protected] in Nov
> 2008.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
