Skip to content

Commit 86fc5cd

Browse files
committed
Fix comments.
1 parent e571f75 commit 86fc5cd

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

nanoFramework.Aws.IoTCore.Devices/MqttConnectionClient.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,8 +255,10 @@ public void Close()
255255
/// <param name="cancellationToken">A cancellation token</param>
256256
/// <param name="namedShadow">A named shadow</param>
257257
/// <returns>The shadow.</returns>
258-
/// <remarks>It is strongly recommended to use a cancellation token that can be canceled and manage this on the
259-
/// caller code level. A reasonable time of few seconds is recommended with a retry mechanism.</remarks>
258+
/// <remarks>
259+
/// It is strongly recommended to use a cancellation token that can be canceled and manage this on the
260+
/// caller code level. A reasonable time of few seconds is recommended with a retry mechanism.
261+
/// </remarks>
260262
public Shadow GetShadow(CancellationToken cancellationToken = default, string namedShadow = "")
261263
{
262264
_shadowReceived = false;
@@ -280,8 +282,9 @@ public Shadow GetShadow(CancellationToken cancellationToken = default, string na
280282
/// <summary>
281283
/// Update the device shadow reported state.
282284
/// </summary>
283-
/// <param name="reported">The reported properties.</param>
285+
/// <param name="shadowToSend">The Shadow to send.</param>
284286
/// <param name="cancellationToken">A cancellation token. If you use the default one, the confirmation of delivery will not be awaited.</param>
287+
/// <param name="namedShadow">The suplementry Shadow name.</param>
285288
/// <returns>True for successful message delivery.</returns>
286289
public bool UpdateReportedState(Shadow shadowToSend, CancellationToken cancellationToken = default, string namedShadow = "") //was ShadowCollection
287290
{

nanoFramework.Aws.IoTCore.Devices/Shadows/Shadow.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public Shadow(string shadowJsonString) //TODO: Perhaps included client token / u
8686
/// <summary>
8787
/// Gets the Shadow as a JSON string.
8888
/// </summary>
89-
/// <param name="fullJsonString"> Optional: Only returns a partial json string for use with updates. unless specified.</param>
89+
/// <param name="updateShadow"> Optional: Only returns a partial json string for use with updates. unless specified.</param>
9090
/// <returns>JSON string</returns>
9191
public string ToJson(bool updateShadow = true)
9292
{

0 commit comments

Comments
 (0)