Mailing-List: contact yarn-issues-help@hadoop.apache.org; run by ezmlm
Precedence: bulk
Date: Tue, 9 May 2017 16:43:04 +0000 (UTC)
From: "Daniel Templeton (JIRA)" <jira@apache.org>
To: yarn-issues@hadoop.apache.org
Message-ID: <JIRA.13070209.1494283378000.166192.1494348184493@Atlassian.JIRA>
In-Reply-To: <JIRA.13070209.1494283378000@Atlassian.JIRA>
References: <JIRA.13070209.1494283378000@Atlassian.JIRA> <JIRA.13070209.1494283378307@jira-lw-us.apache.org>
Subject: [jira] [Commented] (YARN-6571) Fix JavaDoc issues in
 SchedulingPolicy
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Tue, 09 May 2017 16:43:09 -0000


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

Daniel Templeton commented on YARN-6571:
----------------------------------------

Thanks for the patch, [~cheersyang]. Wanna add JavaDoc for the class as well?

> 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
>
>
> 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