[HDFS-16162] Improve DFSUtil#checkProtectedDescendants() related parameter comments

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.4.0
• Component/s: documentation
• Labels: pull-request-available
• Assignee: JiangHua Zhu
• Reporter: JiangHua Zhu
• Created: 11/Aug/21 09:29
• Updated: 17/Aug/21 08:47
• Resolved: 17/Aug/21 08:47

Description

Some parameter comments related to DFSUtil#checkProtectedDescendants() are missing, for example:
/**

• If the given directory has any non-empty protected descendants, throw
• (Including itself).
  *
• @param iip directory, to check its descendants.
• @throws AccessControlException if it is a non-empty protected descendant
• found.
• @throws ParentNotDirectoryException
• @throws UnresolvedLinkException
  */
  public static void checkProtectedDescendants(
  FSDirectory fsd, INodesInPath iip)
  Throw AccessControlException, UnresolvedLinkException,
  ParentNotDirectoryException {
  The description of fsd is missing here.

Issue Links

• links to: GitHub Pull Request #3295