Fix Az.IotHub XML Comments

Azure · Jun 10, 2022 · 2ec6281 · 2ec6281
1 parent 80ea23c
commit 2ec6281
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/src/IotHub/IotHub/IotHub.csproj b/src/IotHub/IotHub/IotHub.csproj
@@ -8,6 +8,15 @@
 
   <PropertyGroup>
     <RootNamespace>Commands.$(PsModuleName)</RootNamespace>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <NoWarn>1701;1702;1591</NoWarn>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <NoWarn>1701;1702;1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/IotHub/IotHub/IotHub/DataPlane/Models/PSDevice.cs b/src/IotHub/IotHub/IotHub/DataPlane/Models/PSDevice.cs
@@ -50,25 +50,25 @@ public class PSDevice
         public PSDeviceStatus Status { get; set; }
 
         /// <summary>
-        /// Reason, if any, for the Device to be in specified <see cref="StatusReason"/>
+        /// Reason, if any, for the Device to be in specified <see cref="Status"/>
         /// </summary>
         [JsonProperty(PropertyName = "statusReason")]
         public string StatusReason { get; set; }
 
         /// <summary>
-        /// Time when the <see cref="ConnectionStateUpdatedTime"/> was last updated
+        /// Time when the <see cref="ConnectionState"/> was last updated
         /// </summary>
         [JsonProperty(PropertyName = "connectionStateUpdatedTime")]
         public DateTime ConnectionStateUpdatedTime { get; set; }
 
         /// <summary>
-        /// Time when the <see cref="StatusUpdatedTime"/> was last updated
+        /// Time when the <see cref="Status"/> was last updated
         /// </summary>
         [JsonProperty(PropertyName = "statusUpdatedTime")]
         public DateTime StatusUpdatedTime { get; set; }
 
         /// <summary>
-        /// Time when the <see cref="LastActivityTime"/> was last active
+        /// Time when the <see cref="PSDevice"/> was last active
         /// </summary>
         [JsonProperty(PropertyName = "lastActivityTime")]
         public DateTime LastActivityTime { get; set; }

diff --git a/src/IotHub/IotHub/IotHub/DataPlane/Models/PSDeviceTwin.cs b/src/IotHub/IotHub/IotHub/DataPlane/Models/PSDeviceTwin.cs
@@ -81,7 +81,7 @@ public class PSDeviceTwin
         public DateTime StatusUpdatedTime { get; set; }
 
         /// <summary>
-        /// Time when the <see cref="LastActivityTime"/> was last active.
+        /// Time when the <see cref="PSDevice"/> was last active.
         /// </summary>
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         public DateTime LastActivityTime { get; set; }

diff --git a/src/IotHub/IotHub/IotHub/DataPlane/Models/PSModule.cs b/src/IotHub/IotHub/IotHub/DataPlane/Models/PSModule.cs
@@ -50,13 +50,13 @@ public class PSModule
         public PSDeviceConnectionState ConnectionState { get; set; }
 
         /// <summary>
-        /// Time when the <see cref="ConnectionStateUpdatedTime"/> was last updated
+        /// Time when the <see cref="ConnectionState"/> was last updated
         /// </summary>
         [JsonProperty(PropertyName = "connectionStateUpdatedTime")]
         public DateTime ConnectionStateUpdatedTime { get; set; }
 
         /// <summary>
-        /// Time when the <see cref="LastActivityTime"/> was last active
+        /// Time when the <see cref="PSDevice"/> was last active
         /// </summary>
         [JsonProperty(PropertyName = "lastActivityTime")]
         public DateTime LastActivityTime { get; set; }