[YARN-6571] Fix JavaDoc issues in SchedulingPolicy

• Type: Bug
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 2.8.0
• Fix Version/s: 2.9.0, 3.0.0-alpha4
• Component/s: fairscheduler
• Labels: newbie
• Hadoop Flags: Reviewed
• Assignee: Weiwei Yang
• Reporter: Daniel Templeton
• Created: 08/May/17 22:42
• Updated: 24/Apr/18 20:49
• Resolved: 10/May/17 21:40

Description

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}

  instead of <code> tags.