improve comments

xiazhvera · xiazhvera · commit 18cf8d00e8f4 · 2026-03-18T13:39:18.000-07:00
diff --git a/src/main/java/software/amazon/awssdk/crt/mqtt/MqttConnectionConfig.java b/src/main/java/software/amazon/awssdk/crt/mqtt/MqttConnectionConfig.java
@@ -542,7 +542,7 @@ public Consumer<WebsocketHandshakeTransformArgs> getWebsocketHandshakeTransform(
     }
 
     /**
-     * Enables or disables IoT Device SDK metrics collection
+     * Enables or disables IoT Device SDK metrics collection. The metrics includes SDK name, version, and platform.
      *
      * @param enabled true to enable metrics, false to disable
      */
diff --git a/src/main/java/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.java b/src/main/java/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.java
@@ -279,7 +279,7 @@ public boolean getMetricsEnabled() {
     }
 
     /**
-     * Enables or disables IoT Device SDK metrics collection
+     * Enables or disables IoT Device SDK metrics collection. The metrics includes SDK name, version, and platform.
      *
      * @param enabled true to enable metrics, false to disable
      */
@@ -878,9 +878,9 @@ public Mqtt5ClientOptionsBuilder withTopicAliasingOptions(TopicAliasingOptions o
         }
 
         /**
-         * Enables or disables IoT Device SDK metrics collection
+         * Enables or disables IoT Device SDK metrics collection. The metrics includes SDK name, version, and platform.
          *
-         * @param enabled true to enable metrics, false to disable
+         * @param enabled true to enable metrics, false to disable.
          * @return The Mqtt5ClientOptionsBuilder after setting the metrics option
          */
         public Mqtt5ClientOptionsBuilder withMetricsEnabled(boolean enabled) {

Original file line number	Diff line number	Diff line change
`@@ -542,7 +542,7 @@ public Consumer<WebsocketHandshakeTransformArgs> getWebsocketHandshakeTransform(`
`542`	`542`	`}`
`543`	`543`
`544`	`544`	`/**`
`545`		`- * Enables or disables IoT Device SDK metrics collection`
	`545`	`+ * Enables or disables IoT Device SDK metrics collection. The metrics includes SDK name, version, and platform.`
`546`	`546`	`*`
`547`	`547`	`* @param enabled true to enable metrics, false to disable`
`548`	`548`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -279,7 +279,7 @@ public boolean getMetricsEnabled() {`
`279`	`279`	`}`
`280`	`280`
`281`	`281`	`/**`
`282`		`- * Enables or disables IoT Device SDK metrics collection`
	`282`	`+ * Enables or disables IoT Device SDK metrics collection. The metrics includes SDK name, version, and platform.`
`283`	`283`	`*`
`284`	`284`	`* @param enabled true to enable metrics, false to disable`
`285`	`285`	`*/`
`@@ -878,9 +878,9 @@ public Mqtt5ClientOptionsBuilder withTopicAliasingOptions(TopicAliasingOptions o`
`878`	`878`	`}`
`879`	`879`
`880`	`880`	`/**`
`881`		`- * Enables or disables IoT Device SDK metrics collection`
	`881`	`+ * Enables or disables IoT Device SDK metrics collection. The metrics includes SDK name, version, and platform.`
`882`	`882`	`*`
`883`		`- * @param enabled true to enable metrics, false to disable`
	`883`	`+ * @param enabled true to enable metrics, false to disable.`
`884`	`884`	`* @return The Mqtt5ClientOptionsBuilder after setting the metrics option`
`885`	`885`	`*/`
`886`	`886`	`public Mqtt5ClientOptionsBuilder withMetricsEnabled(boolean enabled) {`