[
https://issues.apache.org/jira/browse/YARN-825?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13684883#comment-13684883
]
Siddharth Seth commented on YARN-825:
-------------------------------------
bq. Overall, I felt that it isn't enough to just mark the package as private
where applicable, so I went ahead and added annotations for individual classes.
Agree.
A lot of the public classes need Javadoc. I think a follow-up jira can be used
for this, which shouldn't block 2.1.0 (assuming 2.1.1 will be soon after).
Also, there's a bunch of non-annotated classes in yarn-api as well -
YarnException, YarnRuntimeException, YarnConfiguration, RecordFactory* being
some of the important ones. Separate jira for this as well I think. Unrelated,
should the PBImpls be moved from yarn-api to yarn-common (They're private
anyway).
Some stuff which may need to be changed
- AggregatedLogsDeletionService - Private to LimitedPrivate. Used in the MR
history server since a Yarn log/app history server does not exist. I don't mind
leaving this as Private as well though - since it's use in MR is temporary.
- Should ClientToAMTokenSecretManager be final, or do you think there's use
cases where users may want to extend this.
- Should ServiceStateModel be private
- ApplicaionClassLoader - leave as Unstable ?
- Until Apps, ConverterUtils etc are cleaned up - mark them as private ?
Apps.addToEnvironment should be public though.
- ResourceCalculatorPlugin and related classes - public Unstable or
LimitedPrivate. This is already used in MapReduce
- Similarly for RackResolver
- Unrelated, should ApplcaitionTokenIdentifer be renamed to something like
AMTokenIdentifier ?
> Fix yarn-common javadoc annotations
> -----------------------------------
>
> Key: YARN-825
> URL: https://issues.apache.org/jira/browse/YARN-825
> Project: Hadoop YARN
> Issue Type: Sub-task
> Reporter: Vinod Kumar Vavilapalli
> Assignee: Vinod Kumar Vavilapalli
> Priority: Blocker
> Attachments: YARN-825-20130615.1.txt, YARN-825-20130615.txt
>
>
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
