This is an automated email from the ASF dual-hosted git repository. showuon pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push: new c90a08c37e7 MINOR: Fix the outdated comments of ConfigDef (#13710) c90a08c37e7 is described below commit c90a08c37e7568b6e348320450e76db291283edb Author: Aaron Ai <yangkun....@gmail.com> AuthorDate: Fri May 19 13:00:20 2023 +0800 MINOR: Fix the outdated comments of ConfigDef (#13710) Fix the outdated comments of ConfigDef since the signature of the corresponding method has been updated. Reviewers: Luke Chen <show...@gmail.com> --- .../java/org/apache/kafka/common/config/ConfigDef.java | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java index 150cdf4de19..5954cbf29c9 100644 --- a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java +++ b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java @@ -53,9 +53,12 @@ import java.util.stream.Collectors; * <pre> * ConfigDef defs = new ConfigDef(); * - * defs.define("config_with_default", Type.STRING, "default string value", "Configuration with default value."); - * defs.define("config_with_validator", Type.INT, 42, Range.atLeast(0), "Configuration with user provided validator."); - * defs.define("config_with_dependents", Type.INT, "Configuration with dependents.", "group", 1, "Config With Dependents", Arrays.asList("config_with_default","config_with_validator")); + * // check {@link #define(String, Type, Object, Importance, String)} for more details. + * defs.define("config_with_default", Type.STRING, "default string value", Importance.High, "Configuration with default value."); + * // check {@link #define(String, Type, Object, Validator, Importance, String)} for more details. + * defs.define("config_with_validator", Type.INT, 42, Range.atLeast(0), Importance.High, "Configuration with user provided validator."); + * // check {@link #define(String, Type, Importance, String, String, int, Width, String, List<String>)} for more details. + * defs.define("config_with_dependents", Type.INT, Importance.LOW, "Configuration with dependents.", "group", 1, Width.SHORT, "Config With Dependents", Arrays.asList("config_with_default","config_with_validator")); * * Map<String, String> props = new HashMap<>(); * props.put("config_with_default", "some value"); @@ -67,9 +70,9 @@ import java.util.stream.Collectors; * // will return default value of 42 * int anotherConfig = (Integer) configs.get("config_with_validator"); * - * To validate the full configuration, use: - * List<Config> configs = defs.validate(props); - * The {@link Config} contains updated configuration information given the current configuration values. + * // To validate the full configuration, use: + * List<ConfigValue> configValues = defs.validate(props); + * // The {@link ConfigValue} contains updated configuration information given the current configuration values. * </pre> * <p/> * This class can be used standalone or in combination with {@link AbstractConfig} which provides some additional