doc(service-client): Added extra comments to clarify true and false i…

…n dispose (#1805)
Azure · Mar 22, 2021 · 9a9140c · 9a9140c
1 parent a6d21e6
commit 9a9140c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/iothub/device/src/DeviceClient.cs b/iothub/device/src/DeviceClient.cs
@@ -618,7 +618,8 @@ public void Dispose()
         /// Releases the unmanaged resources used by the DeviceClient and allows for any derived class to override and
         /// provide custom implementation.
         /// </summary>
-        /// <param name="disposing">Setting to true will release both managed and unmanaged resources.</param>
+        /// <param name="disposing">Setting to true will release both managed and unmanaged resources. Setting to
+        /// false will only release the unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)

diff --git a/iothub/device/src/ModuleClient.cs b/iothub/device/src/ModuleClient.cs
@@ -443,7 +443,8 @@ public void Dispose()
         /// Releases the unmanaged resources used by the ModuleClient and allows for any derived class to override and
         /// provide custom implementation.
         /// </summary>
-        /// <param name="disposing">Setting to true will release both managed and unmanaged resources.</param>
+        /// <param name="disposing">Setting to true will release both managed and unmanaged resources. Setting to
+        /// false will only release the unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)