[
https://issues.apache.org/jira/browse/HADOOP-8059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13402358#comment-13402358
]
Suresh Srinivas commented on HADOOP-8059:
-----------------------------------------
Brandon, I as thinking of capturing information along following lines:
We should add some of the following comments:
# InterfaceAudience
#* All public classes must have InterfaceAudience annotation. Public classes
that are not marked with this annotation must be considered by default as
InterfaceAudience#Private.
#* External applications must only use classes that are marked
InterfaceAudience#Public. Avoid using non public classes as these classes could
be removed or change in incompatible ways.
#* Internal projects must only use classes that are marked
InterfaceAudience#LimitedPrivate or InterfaceAudience#Public.
#* Methods may have a different annotation that it is more restrictive compared
to the audience classification of the class. Example: A class might be
InterfaceAudience#Publice, but a method may be InterfaceAudience#LimtedPrivate
# Interface stability
#* All classes that are annotated with InterfaceAudience#Public or
LimitedPrivate must have InterfaceStability annotation.
#* Classes that are InterfaceAudience#Private are to be considered unstable
unless a different InterfaceStability annotation states otherwise.
#* Incompatible changes must not be made to classes marked as stable.
> Add javadoc to InterfaceAudience and InterfaceStability
> -------------------------------------------------------
>
> Key: HADOOP-8059
> URL: https://issues.apache.org/jira/browse/HADOOP-8059
> Project: Hadoop Common
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.24.0
> Reporter: Suresh Srinivas
> Assignee: Brandon Li
> Attachments: HADOOP-8059.patch
>
>
> InterfaceAudience and InterfaceStability javadoc is incomplete. The details
> from HADOOP-5073.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
