[HDFS-16803] Improve some annotations in hdfs module

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.9.2, 3.3.4
• Fix Version/s: 3.4.0
• Component/s: documentation, namenode
• Labels: pull-request-available
• Target Version/s: 3.4.0
• Hadoop Flags: Reviewed
• Assignee: JiangHua Zhu
• Reporter: JiangHua Zhu
• Created: 14/Oct/22 07:38
• Updated: 28/Jan/24 08:00
• Resolved: 20/Oct/22 02:59

Description

In hdfs module, some annotations are out of date. E.g:

  FSDirRenameOp: 
  /**
   * @see {@link #unprotectedRenameTo(FSDirectory, String, String, INodesInPath,
   * INodesInPath, long, BlocksMapUpdateInfo, Options.Rename...)}
   */
  static RenameResult renameTo(FSDirectory fsd, FSPermissionChecker pc,
      String src, String dst, BlocksMapUpdateInfo collectedBlocks,
      boolean logRetryCache,Options.Rename... options)
          throws IOException {

We should try to improve these annotations to make the documentation look more comfortable.

Issue Links

• links to: GitHub Pull Request #5031