[kafka] branch trunk updated: MINOR: Javadoc formatting for MetricsContext (#11419)

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tombentley 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 765e588  MINOR: Javadoc formatting for MetricsContext (#11419)
765e588 is described below

commit 765e588bdd29d9f971ad26c945a3436688be9f66
Author: Tom Bentley <to...@users.noreply.github.com>
AuthorDate: Wed Oct 20 14:14:45 2021 +0100

    MINOR: Javadoc formatting for MetricsContext (#11419)
    
    The Javadoc for MetricsContext wasn't correctly formatted for nice/readable
    HTML output.
    
    Reviewers: Mickael Maison <mi...@gmail.com>
---
 .../kafka/common/metrics/MetricsContext.java       | 23 ++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/clients/src/main/java/org/apache/kafka/common/metrics/MetricsContext.java b/clients/src/main/java/org/apache/kafka/common/metrics/MetricsContext.java
index dcac5c2..080aae6 100644
--- a/clients/src/main/java/org/apache/kafka/common/metrics/MetricsContext.java
+++ b/clients/src/main/java/org/apache/kafka/common/metrics/MetricsContext.java
@@ -24,16 +24,23 @@ import java.util.Map;
  * MetricsContext encapsulates additional contextLabels about metrics exposed via a
  * {@link org.apache.kafka.common.metrics.MetricsReporter}
  *
- * The contextLabels map provides following information:
- * - a <code>_namespace</node> field indicating the component exposing metrics
- *   e.g. kafka.server, kafka.consumer
- *   {@link JmxReporter} uses this as prefix for mbean names
+ * <p>The {@link #contextLabels()} map provides following information:
+ * <dl>
+ *   <dt>in all components</dt>
+ *   <dd>a {@code _namespace} field indicating the component exposing metrics
+ *   e.g. kafka.server, kafka.consumer.
+ *   The {@link JmxReporter} uses this as prefix for MBean names</dd>
  *
- * - for clients and streams libraries: any freeform fields passed in via
- *   client properties in the form of `metrics.context.<key>=<value>
+ *   <dt>for clients and streams libraries</dt>
+ *   <dd>any freeform fields passed in via
+ *   client properties in the form of {@code metrics.context.<key>=<value>}</dd>
  *
- * - for kafka brokers: kafka.broker.id, kafka.cluster.id
- * - for connect workers: connect.kafka.cluster.id, connect.group.id
+ *   <dt>for kafka brokers</dt>
+ *   <dd>kafka.broker.id, kafka.cluster.id</dd>
+ *
+ *   <dt>for connect workers</dt>
+ *   <dd>connect.kafka.cluster.id, connect.group.id</dd>
+ * </dl>
  */
 @InterfaceStability.Evolving
 public interface MetricsContext {