update deprecation comments

awslabs · Nov 29, 2023 · fa38ec4 · fa38ec4
1 parent e3fbbc2
commit fa38ec4
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/include/aws/crt/mqtt/Mqtt5Client.h b/include/aws/crt/mqtt/Mqtt5Client.h
@@ -596,7 +596,7 @@ namespace Aws
                 Mqtt5ClientOptions &WithConnackTimeoutMs(uint32_t connackTimeoutMs) noexcept;
 
                 /**
-                 * @deprecated The function is deprecated, please use `WithAckTimeoutSec`
+                 * @deprecated The function is deprecated, please use `Mqtt5ClientOptions::WithAckTimeoutSec(uint32_t)`
                  *
                  * Sets Operation Timeout(Seconds). Time interval to wait for an ack after sending a QoS 1+ PUBLISH,
                  * SUBSCRIBE, or UNSUBSCRIBE before failing the operation.

diff --git a/include/aws/crt/mqtt/Mqtt5Packets.h b/include/aws/crt/mqtt/Mqtt5Packets.h
@@ -500,7 +500,8 @@ namespace Aws
                 uint16_t getReceiveMaximumFromServer() const noexcept;
 
                 /**
-                 * @deprecated the function is deprecated, please use `getMaximumPacketSizeToServer`
+                 * @deprecated the function is deprecated, please use
+                 * `NegotiatedSettings::getMaximumPacketSizeToServer()`
                  *
                  * @return The maximum packet size the server is willing to accept.
                  */
@@ -531,7 +532,7 @@ namespace Aws
                 uint16_t getServerKeepAliveSec() const noexcept;
 
                 /**
-                 * @deprecated The function is deprecated, please use `getServerKeepAliveSec()`
+                 * @deprecated The function is deprecated, please use `NegotiatedSettings::getServerKeepAliveSec()`
                  *
                  * The maximum amount of time in seconds between client packets. The client should use PINGREQs to
                  * ensure this limit is not breached.  The server will disconnect the client for inactivity if no MQTT
@@ -957,7 +958,7 @@ namespace Aws
                 const Crt::Optional<uint16_t> &getReceiveMaximum() const noexcept;
 
                 /**
-                 * @deprecated The function is deprecated, please use `getMaximumPacketSizeToServer`
+                 * @deprecated The function is deprecated, please use `ConnectPacket::getMaximumPacketSizeToServer()`
                  *
                  * Notifies the server of the maximum packet size the client is willing to handle.  If
                  * omitted or null, then no limit beyond the natural limits of MQTT packet size is requested.
@@ -1209,7 +1210,7 @@ namespace Aws
                 const Crt::Optional<uint32_t> &getSessionExpiryIntervalSec() const noexcept;
 
                 /**
-                 * @deprecated The function is deprecated, please use `getSessionExpiryIntervalSec`.
+                 * @deprecated The function is deprecated, please use `ConnAckPacket::getSessionExpiryIntervalSec()`.
                  *
                  * A time interval, in seconds, that the server will persist this connection's MQTT session state
                  * for.  If present, this value overrides any session expiry specified in the preceding CONNECT packet.
@@ -1352,7 +1353,7 @@ namespace Aws
                 const Crt::Optional<uint16_t> &getServerKeepAliveSec() const noexcept;
 
                 /**
-                 * @deprecated The function is deprecated, please use `getServerKeepAliveSec`.
+                 * @deprecated The function is deprecated, please use `ConnAckPacket::getServerKeepAliveSec()`.
                  * Server-requested override of the keep alive interval, in seconds.  If null, the keep alive value sent
                  * by the client should be used.
                  *
@@ -1940,7 +1941,7 @@ namespace Aws
                 Subscription &WithRetainAsPublished(bool retain) noexcept;
 
                 /**
-                 * @deprecated The function is deprecated, please use `WithRetainAsPublished`.
+                 * @deprecated The function is deprecated, please use `Subscription::WithRetainAsPublished(bool)`.
                  *
                  * Sets should the server not send publishes to a client when that client was the one who sent the
                  * publish? The value will be default to false.

diff --git a/include/aws/crt/mqtt/Mqtt5Types.h b/include/aws/crt/mqtt/Mqtt5Types.h
@@ -384,7 +384,7 @@ namespace Aws
                     aws_exponential_backoff_jitter_mode::AWS_EXPONENTIAL_BACKOFF_JITTER_DECORRELATED,
             };
 
-            /** @deprecated JitterMode is deprecated, please use ExponentialBackoffJitterMode */
+            /** @deprecated JitterMode is deprecated, please use  Aws::Crt::Mqtt5::ExponentialBackoffJitterMode */
             using JitterMode = ExponentialBackoffJitterMode;
 
             /**

diff --git a/include/aws/iot/Mqtt5Client.h b/include/aws/iot/Mqtt5Client.h
@@ -420,7 +420,7 @@ namespace Aws
             Mqtt5ClientBuilder &WithAckTimeoutSec(uint32_t ackTimeoutSec) noexcept;
 
             /**
-             * @deprecated the function is deprecated, please use `WithAckTimeoutSec`
+             * @deprecated the function is deprecated, please use `Mqtt5ClientBuilder::WithAckTimeoutSec(uint32_t)`
              *
              * Sets Operation Timeout(Seconds). Time interval to wait for an ack after sending a QoS 1+ PUBLISH,
              * SUBSCRIBE, or UNSUBSCRIBE before failing the operation.