From a323d7c685c3fd7eb4dba5eeb369edea9bcbbd71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20B=C5=82a=C5=BCejewicz?= Date: Sun, 8 Dec 2024 20:17:26 +0100 Subject: [PATCH] docs: fix errors with params documentation - remove white space from param name (obvious typos) showing as errors in some IDEs setups. Thanks! --- .../src/Authentication/AuthenticationWithTokenRefresh.cs | 2 +- .../Authentication/DeviceAuthenticationWithTokenRefresh.cs | 6 +++--- .../src/Authentication/DeviceAuthenticationWithTpm.cs | 2 +- .../Authentication/ModuleAuthenticationWithTokenRefresh.cs | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/iothub/device/src/Authentication/AuthenticationWithTokenRefresh.cs b/iothub/device/src/Authentication/AuthenticationWithTokenRefresh.cs index fdadf99485..38d5df8fb6 100644 --- a/iothub/device/src/Authentication/AuthenticationWithTokenRefresh.cs +++ b/iothub/device/src/Authentication/AuthenticationWithTokenRefresh.cs @@ -49,7 +49,7 @@ public AuthenticationWithTokenRefresh( /// may choose to ignore this value. /// Time buffer before expiry when the token should be renewed expressed as /// a percentage of the time to live. - /// true if the authentication method should be disposed of by the client + /// true if the authentication method should be disposed of by the client /// when the client using this instance is itself disposed; false if you intend to reuse the authentication method. public AuthenticationWithTokenRefresh( int suggestedTimeToLiveSeconds, diff --git a/iothub/device/src/Authentication/DeviceAuthenticationWithTokenRefresh.cs b/iothub/device/src/Authentication/DeviceAuthenticationWithTokenRefresh.cs index ba01dd380a..9bcd81ec97 100644 --- a/iothub/device/src/Authentication/DeviceAuthenticationWithTokenRefresh.cs +++ b/iothub/device/src/Authentication/DeviceAuthenticationWithTokenRefresh.cs @@ -65,9 +65,9 @@ public DeviceAuthenticationWithTokenRefresh( /// /// The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live. /// The default behavior is that the token will be renewed when it has 15% or less of its lifespan left. - /// - /// - ///true if the authentication method should be disposed of by the client + /// + /// + /// true if the authentication method should be disposed of by the client /// when the client using this instance is itself disposed; false if you intend to reuse the authentication method. /// public DeviceAuthenticationWithTokenRefresh( diff --git a/iothub/device/src/Authentication/DeviceAuthenticationWithTpm.cs b/iothub/device/src/Authentication/DeviceAuthenticationWithTpm.cs index d831873b6b..dcfa5e33fd 100644 --- a/iothub/device/src/Authentication/DeviceAuthenticationWithTpm.cs +++ b/iothub/device/src/Authentication/DeviceAuthenticationWithTpm.cs @@ -62,7 +62,7 @@ public DeviceAuthenticationWithTpm( /// Token time to live suggested value. /// Time buffer before expiry when the token should be renewed expressed as percentage of /// the time to live. EX: If you want a SAS token to live for 85% of life before proactive renewal, this value should be 15. - /// true if the authentication method should be disposed of by the client + /// true if the authentication method should be disposed of by the client /// when the client using this instance is itself disposed; false if you intend to reuse the authentication method. public DeviceAuthenticationWithTpm( string deviceId, diff --git a/iothub/device/src/Authentication/ModuleAuthenticationWithTokenRefresh.cs b/iothub/device/src/Authentication/ModuleAuthenticationWithTokenRefresh.cs index a1e5f7bff6..3da22d04c1 100644 --- a/iothub/device/src/Authentication/ModuleAuthenticationWithTokenRefresh.cs +++ b/iothub/device/src/Authentication/ModuleAuthenticationWithTokenRefresh.cs @@ -71,9 +71,9 @@ public ModuleAuthenticationWithTokenRefresh( /// /// The time buffer before expiry when the token should be renewed, expressed as a percentage of the time to live. /// The default behavior is that the token will be renewed when it has 15% or less of its lifespan left. - /// - /// - ///true if the authentication method should be disposed of by the client + /// + /// + /// true if the authentication method should be disposed of by the client /// when the client using this instance is itself disposed; false if you intend to reuse the authentication method. /// public ModuleAuthenticationWithTokenRefresh(