[
https://issues.apache.org/jira/browse/MAPREDUCE-1623?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Chris Douglas updated MAPREDUCE-1623:
-------------------------------------
Attachment: M1623-1.patch
* The contents of the {{jobhistory}} package can probably be public evolving.
* Should the {{o.a.h.util}} package also be marked as Private?
* Should the {{mapreduce.filecache}} package also be marked as Private, if
javadoc were returned to {{o.a.h.filecache.DistributedCache}}?
* The warnings in javadoc are redundant with the annotations, particulary given
MAPREDUCE-1650 ("This class is internal only and not intended for users\!\!",
{{<FRAMEWORK-USE-ONLY>}}, "This is NOT a public interface!", etc.). Attached an
updated patch removing them.
Thanks, Tom.
> Apply audience and stability annotations to classes in mapred package
> ---------------------------------------------------------------------
>
> Key: MAPREDUCE-1623
> URL: https://issues.apache.org/jira/browse/MAPREDUCE-1623
> Project: Hadoop Map/Reduce
> Issue Type: Sub-task
> Components: documentation
> Reporter: Tom White
> Assignee: Tom White
> Attachments: M1623-1.patch, MAPREDUCE-1623.patch,
> MAPREDUCE-1623.patch, MAPREDUCE-1623.patch, MAPREDUCE-1623.patch
>
>
> There are lots of implementation classes in org.apache.hadoop.mapred which
> makes it difficult to see the user-level MapReduce API classes in the
> Javadoc. (See
> http://hadoop.apache.org/common/docs/r0.20.2/api/org/apache/hadoop/mapred/package-summary.html
> for example.) By marking these implementation classes with the
> InterfaceAudience.Private annotation we can exclude them from user Javadoc
> (using HADOOP-6658).
> Later work will move the implementation classes into o.a.h.mapreduce.server
> and related packages (see MAPREDUCE-561), but applying the annotations is a
> good first step.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
