Enable SA1643: Destructor summary documentation should begin with standard text

xtqqczze · xtqqczze · commit 1f296cbee904 · 2020-11-25T07:26:21.000Z
https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1643.md
diff --git a/.globalconfig b/.globalconfig
@@ -1531,7 +1531,7 @@ dotnet_diagnostic.SA1641.severity = none
 dotnet_diagnostic.SA1642.severity = none
 
 # SA1643: Destructor summary documentation should begin with standard text
-dotnet_diagnostic.SA1643.severity = none
+dotnet_diagnostic.SA1643.severity = warning
 
 # SA1648: inheritdoc should be used with inheriting class
 dotnet_diagnostic.SA1648.severity = none
diff --git a/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropVariant.cs b/src/Microsoft.PowerShell.ConsoleHost/WindowsTaskbarJumpList/PropVariant.cs
@@ -51,7 +51,7 @@ public void Dispose()
         }
 
         /// <summary>
-        /// Finalizer.
+        /// Finalizes an instance of the <see cref="PropVariant"/> class.
         /// </summary>
         ~PropVariant()
         {
diff --git a/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs b/src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs
@@ -1194,14 +1194,6 @@ private void UnhandledExceptionHandler(object sender, UnhandledExceptionEventArg
             ui.WriteLine();
         }
 
-        /// <summary>
-        /// Finalizes the instance.
-        /// </summary>
-        ~ConsoleHost()
-        {
-            Dispose(false);
-        }
-
         /// <summary>
         /// Disposes of this instance, per the IDisposable pattern.
         /// </summary>
@@ -1260,6 +1252,14 @@ private void Dispose(bool isDisposingNotFinalizing)
             _isDisposed = true;
         }
 
+        /// <summary>
+        /// Finalizes an instance of the <see cref="ConsoleHost"/> class.
+        /// </summary>
+        ~ConsoleHost()
+        {
+            Dispose(false);
+        }
+
         /// <summary>
         /// Indicates if the session should be terminated or not.  Typically set by the break handler for Close, Logoff, and
         /// Shutdown events.  Note that the only valid transition for this property is from false to true: it is not legal to
diff --git a/src/System.Management.Automation/engine/EventManager.cs b/src/System.Management.Automation/engine/EventManager.cs
@@ -1544,6 +1544,14 @@ public void Dispose(bool disposing)
                 }
             }
         }
+
+        /// <summary>
+        /// Finalizes an instance of the <see cref="PSLocalEventManager"/> class.
+        /// </summary>
+        ~PSLocalEventManager()
+        {
+            Dispose(false);
+        }
     }
 
     /// <summary>
diff --git a/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs b/src/System.Management.Automation/engine/hostifaces/LocalPipeline.cs
@@ -1251,7 +1251,7 @@ public void Dispose()
         }
 
         /// <summary>
-        /// Ensure we release the worker thread.
+        /// Finalizes an instance of the <see cref="PipelineThread"/> class.
         /// </summary>
         ~PipelineThread()
         {
diff --git a/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs b/src/System.Management.Automation/engine/remoting/fanin/BaseTransportManager.cs
@@ -972,7 +972,7 @@ internal virtual void PrepareForConnect()
         #region Clean up
 
         /// <summary>
-        /// Finalizer.
+        /// Finalizes an instance of the <see cref="BaseClientTransportManager"/> class.
         /// </summary>
         ~BaseClientTransportManager()
         {
diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManNativeAPI.cs
@@ -687,18 +687,6 @@ internal WSManData_ManToUn(string data)
                 Marshal.StructureToPtr(_internalData, _marshalledObject, false);
             }
 
-            /// <summary>
-            /// Finalizer
-            ///
-            /// Note: Do not depend on the finalizer! This object should be
-            /// properly disposed of when no longer needed via a direct call
-            /// to Dispose().
-            /// </summary>
-            ~WSManData_ManToUn()
-            {
-                Dispose(false);
-            }
-
             /// <summary>
             /// Gets the type of data.
             /// </summary>
@@ -747,6 +735,14 @@ private void Dispose(bool isDisposing)
                 }
             }
 
+            /// <summary>
+            /// Finalizes an instance of the <see cref="WSManData_ManToUn"/> class.
+            /// </summary>
+            ~WSManData_ManToUn()
+            {
+                Dispose(false);
+            }
+
             /// <summary>
             /// Implicit IntPtr conversion.
             /// </summary>
diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginFacade.cs
@@ -234,11 +234,7 @@ private void Dispose(bool disposing)
         }
 
         /// <summary>
-        /// Use C# destructor syntax for finalization code.
-        /// This destructor will run only if the Dispose method
-        /// does not get called.
-        /// It gives your base class the opportunity to finalize.
-        /// Do not provide destructors in types derived from this class.
+        /// Finalizes an instance of the <see cref="WSManPluginEntryDelegates"/> class.
         /// </summary>
         ~WSManPluginEntryDelegates()
         {
@@ -766,11 +762,7 @@ private void Dispose(bool disposing)
         }
 
         /// <summary>
-        /// Use C# destructor syntax for finalization code.
-        /// This destructor will run only if the Dispose method
-        /// does not get called.
-        /// It gives your base class the opportunity to finalize.
-        /// Do not provide destructors in types derived from this class.
+        /// Finalizes an instance of the <see cref="WSManPluginManagedEntryInstanceWrapper"/> class.
         /// </summary>
         ~WSManPluginManagedEntryInstanceWrapper()
         {
diff --git a/src/System.Management.Automation/engine/remoting/fanin/WSManPluginShellSession.cs b/src/System.Management.Automation/engine/remoting/fanin/WSManPluginShellSession.cs
@@ -111,11 +111,7 @@ protected virtual void Dispose(bool disposing)
         }
 
         /// <summary>
-        /// Use C# destructor syntax for finalization code.
-        /// This destructor will run only if the Dispose method
-        /// does not get called.
-        /// It gives your base class the opportunity to finalize.
-        /// Do not provide destructors in types derived from this class.
+        /// Finalizes an instance of the <see cref="WSManPluginServerSession"/> class.
         /// </summary>
         ~WSManPluginServerSession()
         {
diff --git a/src/System.Management.Automation/help/CabinetNativeApi.cs b/src/System.Management.Automation/help/CabinetNativeApi.cs
@@ -84,7 +84,7 @@ protected override void Dispose(bool disposing)
         }
 
         /// <summary>
-        /// Finalizer to ensure destruction of unmanaged resources.
+        /// Finalizes an instance of the <see cref="CabinetExtractor"/> class.
         /// </summary>
         ~CabinetExtractor()
         {

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public void Dispose()`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/// <summary>`
`54`		`- /// Finalizer.`
	`54`	`+ /// Finalizes an instance of the <see cref="PropVariant"/> class.`
`55`	`55`	`/// </summary>`
`56`	`56`	`~PropVariant()`
`57`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1544,6 +1544,14 @@ public void Dispose(bool disposing)`
`1544`	`1544`	`}`
`1545`	`1545`	`}`
`1546`	`1546`	`}`
	`1547`	`+`
	`1548`	`+ /// <summary>`
	`1549`	`+ /// Finalizes an instance of the <see cref="PSLocalEventManager"/> class.`
	`1550`	`+ /// </summary>`
	`1551`	`+ ~PSLocalEventManager()`
	`1552`	`+ {`
	`1553`	`+ Dispose(false);`
	`1554`	`+ }`
`1547`	`1555`	`}`
`1548`	`1556`
`1549`	`1557`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -1251,7 +1251,7 @@ public void Dispose()`
`1251`	`1251`	`}`
`1252`	`1252`
`1253`	`1253`	`/// <summary>`
`1254`		`- /// Ensure we release the worker thread.`
	`1254`	`+ /// Finalizes an instance of the <see cref="PipelineThread"/> class.`
`1255`	`1255`	`/// </summary>`
`1256`	`1256`	`~PipelineThread()`
`1257`	`1257`	`{`
Original file line number	Diff line number	Diff line change
`@@ -972,7 +972,7 @@ internal virtual void PrepareForConnect()`
`972`	`972`	`#region Clean up`
`973`	`973`
`974`	`974`	`/// <summary>`
`975`		`- /// Finalizer.`
	`975`	`+ /// Finalizes an instance of the <see cref="BaseClientTransportManager"/> class.`
`976`	`976`	`/// </summary>`
`977`	`977`	`~BaseClientTransportManager()`
`978`	`978`	`{`
Original file line number	Diff line number	Diff line change
`@@ -234,11 +234,7 @@ private void Dispose(bool disposing)`
`234`	`234`	`}`
`235`	`235`
`236`	`236`	`/// <summary>`
`237`		`- /// Use C# destructor syntax for finalization code.`
`238`		`- /// This destructor will run only if the Dispose method`
`239`		`- /// does not get called.`
`240`		`- /// It gives your base class the opportunity to finalize.`
`241`		`- /// Do not provide destructors in types derived from this class.`
	`237`	`+ /// Finalizes an instance of the <see cref="WSManPluginEntryDelegates"/> class.`
`242`	`238`	`/// </summary>`
`243`	`239`	`~WSManPluginEntryDelegates()`
`244`	`240`	`{`
`@@ -766,11 +762,7 @@ private void Dispose(bool disposing)`
`766`	`762`	`}`
`767`	`763`
`768`	`764`	`/// <summary>`
`769`		`- /// Use C# destructor syntax for finalization code.`
`770`		`- /// This destructor will run only if the Dispose method`
`771`		`- /// does not get called.`
`772`		`- /// It gives your base class the opportunity to finalize.`
`773`		`- /// Do not provide destructors in types derived from this class.`
	`765`	`+ /// Finalizes an instance of the <see cref="WSManPluginManagedEntryInstanceWrapper"/> class.`
`774`	`766`	`/// </summary>`
`775`	`767`	`~WSManPluginManagedEntryInstanceWrapper()`
`776`	`768`	`{`
Original file line number	Diff line number	Diff line change
`@@ -111,11 +111,7 @@ protected virtual void Dispose(bool disposing)`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`/// <summary>`
`114`		`- /// Use C# destructor syntax for finalization code.`
`115`		`- /// This destructor will run only if the Dispose method`
`116`		`- /// does not get called.`
`117`		`- /// It gives your base class the opportunity to finalize.`
`118`		`- /// Do not provide destructors in types derived from this class.`
	`114`	`+ /// Finalizes an instance of the <see cref="WSManPluginServerSession"/> class.`
`119`	`115`	`/// </summary>`
`120`	`116`	`~WSManPluginServerSession()`
`121`	`117`	`{`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ protected override void Dispose(bool disposing)`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`/// <summary>`
`87`		`- /// Finalizer to ensure destruction of unmanaged resources.`
	`87`	`+ /// Finalizes an instance of the <see cref="CabinetExtractor"/> class.`
`88`	`88`	`/// </summary>`
`89`	`89`	`~CabinetExtractor()`
`90`	`90`	`{`