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

Daniel Templeton commented on YARN-9358:
----------------------------------------

I just did a super quick pass.  There are a couple issues in basic formatting.  
The descriptions must all end in a period.  Otherwise it's a javadoc error.  
Also, the param and returns tag descriptions should not start with a capital 
letter nor end with a period (I don't remember seeing extraneous periods, but 
just in case...)

> Add javadoc to new methods introduced in FSQueueMetrics with YARN-9322
> ----------------------------------------------------------------------
>
>                 Key: YARN-9358
>                 URL: https://issues.apache.org/jira/browse/YARN-9358
>             Project: Hadoop YARN
>          Issue Type: Improvement
>            Reporter: Szilard Nemeth
>            Assignee: Zoltan Siegl
>            Priority: Major
>         Attachments: YARN-9358.001.patch, YARN-9358.002.patch, 
> YARN-9358.003.patch, YARN-9358.004.patch
>
>
> This is a follow-up for YARN-9322, covering javadoc changes as discussed with 
> [~templedf] earlier.
> As discussed with Daniel, we need to add javadoc for the new methods 
> introduced with YARN-9322 and also for the modified methods. 
> The javadoc should refer to the fact that Resource Types are also included in 
> the Resource object in case of get/set as well.
> The methods are: 
> 1. getFairShare / setFairShare
> 2. getSteadyFairShare / setSteadyFairShare
> 3. getMinShare / setMinShare
> 4. getMaxShare / setMaxShare
> 5. getMaxAMShare / setMaxAMShare
> 6. getAMResourceUsage / setAMResourceUsage
> Moreover, a javadoc could be added to the constructor of FSQueueMetrics as 
> well.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to