adoroszlai commented on code in PR #5550:
URL: https://github.com/apache/ozone/pull/5550#discussion_r1382926349
##########
hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/client/ECReplicationConfig.java:
##########
@@ -82,14 +82,17 @@ public ECReplicationConfig(int data, int parity, EcCodec
codec,
}
/**
- * Create an ECReplicationConfig object from a string representing the
- * various parameters. Acceptable patterns are like:
+ * Create an {@link ECReplicationConfig} object from a string representing
Review Comment:
I don't think linking to `ECReplicationConfig` from the javadoc of
`ECReplicationConfig` (i.e. the same class) adds any value.
##########
hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/client/ECReplicationConfig.java:
##########
@@ -82,14 +82,17 @@ public ECReplicationConfig(int data, int parity, EcCodec
codec,
}
/**
- * Create an ECReplicationConfig object from a string representing the
- * various parameters. Acceptable patterns are like:
+ * Create an {@link ECReplicationConfig} object from a string representing
+ * the various parameters. Acceptable patterns are like:
* rs-3-2-1024k
* RS-3-2-2048k
* XOR-10-4-4096K
* IllegalArgumentException will be thrown if the passed string does not
* match the defined pattern.
- * @param string
+ * @param string This is a string parameter used to create an
+ * {@link ECReplicationConfig} instance. It must meet the
+ * requirements, otherwise {@link IllegalArgumentException} will be
+ * thrown.
Review Comment:
I think the same is already described in the existing javadoc. No need to
repeat it in different words.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
