[GitHub] [hadoop] steveloughran commented on a diff in pull request #4965: HADOOP-18156. Address JavaDoc warnings in classes like MarkerTool, S3ObjectAttributes, etc

[GitBox <gi...@apache.org>]

steveloughran commented on code in PR #4965:
URL: https://github.com/apache/hadoop/pull/4965#discussion_r992156904


##########
hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:
##########
@@ -34,20 +34,20 @@
  * Tracks directory markers which have been reported in object listings.
  * This is needed for auditing and cleanup, including during rename
  * operations.
- * <p></p>
+ *

Review Comment:
   these should actually be <p> without the closing element, but retained. 
   
   if you set your IDE to format javadocs, it will then preserve the line break



##########
hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:
##########
@@ -718,10 +725,14 @@ private boolean scanDirectoryTree(
    */
   public static final class MarkerPurgeSummary {
 
-    /** Number of markers deleted. */
+    /**
+     * Number of markers deleted.
+     */

Review Comment:
   no need to do this for fields; leave as is



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org