simbadzina commented on code in PR #5648:
URL: https://github.com/apache/hadoop/pull/5648#discussion_r1191935955
##########
hadoop-hdfs-project/hadoop-hdfs-rbf/src/main/java/org/apache/hadoop/hdfs/server/federation/resolver/MountTableResolver.java:
##########
@@ -370,7 +372,9 @@ public static String getTrashRoot() throws IOException {
/**
* Subtract a TrashCurrent to get a new path.
*
- * @param path A path.
+ * @param path a path.
+ * @return new path with subtracted trash current path.
+ * @throws IOException if retrieval of router user information fails.
Review Comment:
`router user information` sounds vague in this context. Only when I looked
into getTrashRoot did I see that `RouterRpcServer.getRemoteUser()` is the
function that would throw the IOException.
I think over here writing `if retrieving current user's trash directory
fails` may be more appropriate vs. describing the root cause. It's quite
subjective though.
##########
hadoop-hdfs-project/hadoop-hdfs-rbf/src/main/java/org/apache/hadoop/hdfs/server/federation/router/FederationUtil.java:
##########
@@ -274,9 +274,9 @@ public static RouterRpcFairnessPolicyController
newFairnessPolicyController(
/**
* Collect all configured nameservices.
*
- * @param conf
- * @return Set of name services in config
- * @throws IllegalArgumentException
+ * @param conf the configuration object.
+ * @return Set of name services in config.
+ * @throws IllegalArgumentException if monitor namenodes are not correctly
configured.
Review Comment:
Typo `monitored`
##########
hadoop-hdfs-project/hadoop-hdfs-rbf/src/main/java/org/apache/hadoop/hdfs/server/federation/router/security/token/DistributedSQLCounter.java:
##########
@@ -50,7 +50,9 @@ public DistributedSQLCounter(String field, String table,
/**
* Obtains the value of the counter.
+ *
* @return counter value.
+ * @throws SQLException if SQL connection errors occur.
Review Comment:
`@throws SQLException if SQL errors occur` is a tautology.
`@throws SQLException if querying the database fails` may be slightly
better, but it also doesn't say much.
This is a minor issue though. The forced annotations make the javadocs kinda
verbose so it is okay to use the form you have.
--
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-unsubscr...@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-issues-h...@hadoop.apache.org
