[
https://issues.apache.org/jira/browse/HADOOP-6668?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12874089#action_12874089
]
Sanjay Radia commented on HADOOP-6668:
--------------------------------------
> PositionedReadable, Seekable and Syncable:
The definitions of the methods are in the PositionedReadable, Seekable and
Syncable Java interfaces.
The definitions of the methods are needed in the user javadoc; only APis's
marked as audience public
appear in the user javadoc.
The user can reasonably expect to lookup an extended interfaces of an
audience-public API.
The only way to avoid this is to actually copy the method signatures but not
extend the interfaces.
Unless we are prepared to do that, I think we are stuck with making them
audience public.
Hairong is probably right that the originally these interfaces were targeted
for the implementor.
> 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, 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.
