[jira] [Comment Edited] (YARN-6571) Fix JavaDoc issues in SchedulingPolicy

["Weiwei Yang (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/YARN-6571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16005062#comment-16005062 ] 

Weiwei Yang edited comment on YARN-6571 at 5/10/17 5:21 PM:
------------------------------------------------------------

Hi [~templedf]

I appreciate that, but I am not new to Yarn, do you think the doc I added for this class is not appropriate? I can do a better job than that if you let me know why? Thank you.


was (Author: cheersyang):
Hi [~templedf]

I am not new to Yarn, do you think the doc I added for this class is not appropriate? I can do a better job than that if you let me know why? Thank you.

> Fix JavaDoc issues in SchedulingPolicy
> --------------------------------------
>
>                 Key: YARN-6571
>                 URL: https://issues.apache.org/jira/browse/YARN-6571
>             Project: Hadoop YARN
>          Issue Type: Bug
>          Components: fairscheduler
>    Affects Versions: 2.8.0
>            Reporter: Daniel Templeton
>            Assignee: Weiwei Yang
>            Priority: Trivial
>              Labels: newbie
>         Attachments: YARN-6571.001.patch, YARN-6571.002.patch
>
>
> There are several javadoc issues:
> * Class JavaDoc is missing.
> * {{getInstance()}} is missing {{@return}} and {{@param}} tags.
> * {{parse()}} is missing {{@return}} tag and description for {{@throws}} tag.
> * {{checkIfUsageOverFairShare()}} is missing a period at the end of the first sentence.
> * {{getHeadroom()}} should use {code}{@code}{code} instead of {{<code>}} tags.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-issues-help@hadoop.apache.org