Skip to content

Commit e6653a9

Browse files
authored
MINOR: Fix Javadoc for ConfigCommand.java (#22101)
MINOR: Fix Javadoc for ConfigCommand.java Ref: checkstyle/checkstyle#19718 Reviewers: Ming-Yen Chung <mingyen066@gmail.com>, Roman Ivanov <ivanov-jr@mail.ru>, Chia-Ping Tsai <chia7712@gmail.com>
1 parent a310bcb commit e6653a9

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

tools/src/main/java/org/apache/kafka/tools/ConfigCommand.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,21 @@
9292
* This script can be used to change configs for topics/clients/users/brokers/ips/client-metrics/groups dynamically
9393
* An entity described or altered by the command may be one of:
9494
* <ul>
95-
* <li> topic: --topic <topic> OR --entity-type topics --entity-name <topic>
96-
* <li> client: --client <client> OR --entity-type clients --entity-name <client-id>
97-
* <li> user: --user <user-principal> OR --entity-type users --entity-name <user-principal>
98-
* <li> <user, client>: --user <user-principal> --client <client-id> OR
99-
* --entity-type users --entity-name <user-principal> --entity-type clients --entity-name <client-id>
100-
* <li> broker: --broker <broker-id> OR --entity-type brokers --entity-name <broker-id>
101-
* <li> broker-logger: --broker-logger <broker-id> OR --entity-type broker-loggers --entity-name <broker-id>
102-
* <li> ip: --ip <ip> OR --entity-type ips --entity-name <ip>
103-
* <li> client-metrics: --client-metrics <name> OR --entity-type client-metrics --entity-name <name>
104-
* <li> group: --group <group> OR --entity-type groups --entity-name <group>
95+
* <li> topic: {@code --topic <topic>} OR {@code --entity-type topics --entity-name <topic>}
96+
* <li> client: {@code --client <client>} OR {@code --entity-type clients --entity-name <client-id>}
97+
* <li> user: {@code --user <user-principal>} OR {@code --entity-type users --entity-name <user-principal>}
98+
* <li> {@code <user, client>}: {@code --user <user-principal> --client <client-id>} OR
99+
* {@code --entity-type users --entity-name <user-principal> --entity-type clients --entity-name <client-id>}
100+
* <li> broker: {@code --broker <broker-id>} OR {@code --entity-type brokers --entity-name <broker-id>}
101+
* <li> broker-logger: {@code --broker-logger <broker-id>} OR {@code --entity-type broker-loggers --entity-name <broker-id>}
102+
* <li> ip: {@code --ip <ip>} OR {@code --entity-type ips --entity-name <ip>}
103+
* <li> client-metrics: {@code --client-metrics <name>} OR {@code --entity-type client-metrics --entity-name <name>}
104+
* <li> group: {@code --group <group>} OR {@code --entity-type groups --entity-name <group>}
105105
* </ul>
106-
* --entity-type <users|clients|brokers|ips> --entity-default may be specified in place of --entity-type <users|clients|brokers|ips> --entity-name <entityName>
106+
* {@code --entity-type <users|clients|brokers|ips> --entity-default} may be specified in place of {@code --entity-type <users|clients|brokers|ips> --entity-name <entityName>}
107107
* when describing or altering default configuration for users, clients, brokers, or ips, respectively.
108-
* Alternatively, --user-defaults, --client-defaults, --broker-defaults, or --ip-defaults may be specified in place of
109-
* --entity-type <users|clients|brokers|ips> --entity-default, respectively.
108+
* Alternatively, {@code --user-defaults}, {@code --client-defaults}, {@code --broker-defaults}, or {@code --ip-defaults} may be specified in place of
109+
* {@code --entity-type <users|clients|brokers|ips> --entity-default}, respectively.
110110
*/
111111
public class ConfigCommand {
112112

0 commit comments

Comments
 (0)