Skip to content

Commit 899b46d

Browse files
committed
Documentation improvements.
1 parent 32c0a02 commit 899b46d

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

nanoFramework.Aws.IoTCore.Devices/MqttConnectionClient.cs

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,27 @@ namespace nanoFramework.Aws.IoTCore.Devices
1616
{
1717
/// <summary>
1818
/// AWS IoT Core MQTT Connection Client for .NET nanoFramework
19-
/// <seealso cref="https://github.com/aws/aws-sdk-net/blob/master/sdk/src/Services/IotData/Generated/_netstandard/AmazonIotDataClient.cs"/>
20-
/// <seealso cref="https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master/src"/>
21-
/// <seealso cref="https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html"/>
19+
/// <cref="https://github.com/aws/aws-sdk-net/blob/master/sdk/src/Services/IotData/Generated/_netstandard/AmazonIotDataClient.cs"/>
20+
/// <cref="https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master/src"/>
21+
/// <cref="https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html"/>
2222
/// </summary>
2323
public class MqttConnectionClient : IDisposable
2424
{
2525
/// <summary>
2626
/// The QoS Level
2727
/// </summary>
2828
/// <remarks>
29-
/// AWS Only supports levels:
30-
/// - AtMostOnce (0)
31-
/// - AtLeastOnce (1)
29+
/// AWS IoT Core only supports levels 0, and 1.
3230
/// </remarks>
3331
public enum QoSLevel
3432
{
33+
/// <summary>
34+
/// At Most Once (0)
35+
/// </summary>
3536
AtMostOnce = MqttQoSLevel.AtMostOnce,
37+
/// <summary>
38+
/// At Least Once (1)
39+
/// </summary>
3640
AtLeastOnce = MqttQoSLevel.AtLeastOnce
3741

3842
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ namespace nanoFramework.Aws.IoTCore.Devices.Shadows
88
{
99
/// <summary>
1010
/// Shadow Representation.
11+
/// <cref="https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-document.html"/>
1112
/// </summary>
12-
/// <remarks>As per: <see cref="https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-document.html"/></remarks>
1313
public class Shadow
1414
{
1515

0 commit comments

Comments
 (0)