Merge pull request #1591 from RussKie/fix_xmldoc

Fix xmldoc

pkg/Microsoft.Dotnet.WinForms.ProjectTemplates/content/WinFormsApplication-CSharp/Program.cs

@@ -9,7 +9,7 @@ namespace Company.WinFormsApplication1
     static class Program
     {
         /// <summary>
-        /// The main entry point for the application.
+        ///  The main entry point for the application.
         /// </summary>
         [STAThread]
         static void Main()

src/Common/src/ClientUtils.cs

@@ -303,10 +303,10 @@ public WeakRefCollection(int size)
             public ArrayList InnerList { get; }
 
             /// <summary>
-            /// Indicates the value where the collection should check its items to remove dead weakref left over.
-            /// Note: When GC collects weak refs from this collection the WeakRefObject identity changes since its
-            /// Target becomes null. This makes the item unrecognizable by the collection and cannot be
-            /// removed - Remove(item) and Contains(item) will not find it anymore.
+            ///  Indicates the value where the collection should check its items to remove dead weakref left over.
+            ///  Note: When GC collects weak refs from this collection the WeakRefObject identity changes since its
+            ///  Target becomes null. This makes the item unrecognizable by the collection and cannot be
+            ///  removed - Remove(item) and Contains(item) will not find it anymore.
             /// </summary>
             public int RefCheckThreshold { get; set; } = int.MaxValue; // this means this is disabled by default.
 
@@ -416,10 +416,10 @@ private static void Copy(WeakRefCollection sourceList, int sourceIndex, WeakRefC
             }
 
             /// <summary>
-            /// Removes the value using its hash code as its identity. This is needed because the
-            /// underlying item in the collection may have already been collected changing the
-            /// identity of the WeakRefObject making it impossible for the collection to identify
-            /// it. See WeakRefObject for more info.
+            ///  Removes the value using its hash code as its identity. This is needed because the
+            ///  underlying item in the collection may have already been collected changing the
+            ///  identity of the WeakRefObject making it impossible for the collection to identify
+            ///  it. See WeakRefObject for more info.
             /// </summary>
             public void RemoveByHashCode(object value)
             {
@@ -476,10 +476,10 @@ public int Add(object value)
             public IEnumerator GetEnumerator() => InnerList.GetEnumerator();
 
             /// <summary>
-            /// Wraps a weak ref object. WARNING: Use this class carefully!
-            /// When the weak ref is collected, this object looses its identity. This is bad when the object
-            /// has been added to a collection since Contains(WeakRef(item)) and Remove(WeakRef(item)) would
-            /// not be able to identify the item.
+            ///  Wraps a weak ref object. WARNING: Use this class carefully!
+            ///  When the weak ref is collected, this object looses its identity. This is bad when the object
+            ///  has been added to a collection since Contains(WeakRef(item)) and Remove(WeakRef(item)) would
+            ///  not be able to identify the item.
             /// </summary>
             internal class WeakRefObject
             {

src/Common/src/CommonUnsafeNativeMethods.cs

@@ -27,8 +27,8 @@ internal class CommonUnsafeNativeMethods
         internal static extern bool AreDpiAwarenessContextsEqual(DpiAwarenessContext dpiContextA, DpiAwarenessContext dpiContextB);
 
         /// <summary>
-        /// Tries to compare two DPIawareness context values. Return true if they were equal.
-        /// Return false when they are not equal or underlying OS does not support this API.
+        ///  Tries to compare two DPIawareness context values. Return true if they were equal.
+        ///  Return false when they are not equal or underlying OS does not support this API.
         /// </summary>
         /// <returns>true/false</returns>
         public static bool TryFindDpiAwarenessContextsEqual(DpiAwarenessContext dpiContextA, DpiAwarenessContext dpiContextB)
@@ -47,7 +47,7 @@ public static bool TryFindDpiAwarenessContextsEqual(DpiAwarenessContext dpiConte
         }
 
         /// <summary>
-        /// Tries to get thread dpi awareness context
+        ///  Tries to get thread dpi awareness context
         /// </summary>
         /// <returns> returns thread dpi awareness context if API is available in this version of OS. otherwise, return IntPtr.Zero.</returns>
         public static DpiAwarenessContext TryGetThreadDpiAwarenessContext()
@@ -64,7 +64,7 @@ public static DpiAwarenessContext TryGetThreadDpiAwarenessContext()
         }
 
         /// <summary>
-        /// Tries to set thread dpi awareness context
+        ///  Tries to set thread dpi awareness context
         /// </summary>
         /// <returns> returns old thread dpi awareness context if API is available in this version of OS. otherwise, return IntPtr.Zero.</returns>
         public static DpiAwarenessContext TrySetThreadDpiAwarenessContext(DpiAwarenessContext dpiContext)

src/Common/src/DpiHelper.DpiAwarenessContext.cs

@@ -5,17 +5,17 @@
 namespace System.Windows.Forms
 {
     /// <summary>
-    /// Partial DpiHelper class, with methods specific to thread DpiAwarenessContext
+    ///  Partial DpiHelper class, with methods specific to thread DpiAwarenessContext
     /// </summary>
     internal static partial class DpiHelper
     {
         /// <summary>
-        /// Enters a scope during which the current thread's DPI awareness context is set to
+        ///  Enters a scope during which the current thread's DPI awareness context is set to
         /// <paramref name="awareness"/>
         /// </summary>
         /// <param name="awareness">The new DPI awareness for the current thread</param>
         /// <returns>An object that, when disposed, will reset the current thread's
-        /// DPI awareness to the value it had when the object was created.</returns>
+        ///  DPI awareness to the value it had when the object was created.</returns>
         public static IDisposable EnterDpiAwarenessScope(DpiAwarenessContext awareness)
         {
             return new DpiAwarenessScope(awareness);
@@ -39,15 +39,15 @@ public static T CreateInstanceInSystemAwareContext<T>(Func<T> createInstance)
         #region Scoping DpiAwareness context helper class
 
         /// <summary>
-        /// Class that help setting Dpi awareness context scope
+        ///  Class that help setting Dpi awareness context scope
         /// </summary>
         private class DpiAwarenessScope : IDisposable
         {
             private bool dpiAwarenessScopeIsSet = false;
             private readonly DpiAwarenessContext originalAwareness = DpiAwarenessContext.DPI_AWARENESS_CONTEXT_UNSPECIFIED;
 
             /// <summary>
-            /// Enters given Dpi awareness scope
+            ///  Enters given Dpi awareness scope
             /// </summary>
             public DpiAwarenessScope(DpiAwarenessContext awareness)
             {
@@ -73,15 +73,15 @@ public DpiAwarenessScope(DpiAwarenessContext awareness)
             }
 
             /// <summary>
-            /// Dispose object and resources
+            ///  Dispose object and resources
             /// </summary>
             public void Dispose()
             {
                 ResetDpiAwarenessContextChanges();
             }
 
             /// <summary>
-            /// resetting dpiawareness of the thread.
+            ///  resetting dpiawareness of the thread.
             /// </summary>
             private void ResetDpiAwarenessContextChanges()
             {

src/Common/src/DpiHelper.cs

@@ -11,7 +11,7 @@
 namespace System.Windows.Forms
 {
     /// <summary>
-    /// Helper class for scaling coordinates and images according to current DPI scaling set in Windows for the primary screen.
+    ///  Helper class for scaling coordinates and images according to current DPI scaling set in Windows for the primary screen.
     /// </summary>
     internal static partial class DpiHelper
     {
@@ -20,7 +20,7 @@ internal static partial class DpiHelper
         private static bool s_isInitializeDpiHelperForWinforms = false;
 
         /// <summary>
-        /// The primary screen's (device) current DPI
+        ///  The primary screen's (device) current DPI
         /// </summary>
         private static double s_deviceDpi = LogicalDpi;
         private static double s_logicalToDeviceUnitsScalingFactor = 0.0;
@@ -79,7 +79,7 @@ internal static bool DoesCurrentContextRequireScaling
             => true;
 
         /// <summary>
-        /// Returns a boolean to specify if we should enable processing of WM_DPICHANGED and related messages
+        ///  Returns a boolean to specify if we should enable processing of WM_DPICHANGED and related messages
         /// </summary>
         internal static bool IsPerMonitorV2Awareness
         {
@@ -101,7 +101,7 @@ internal static bool IsPerMonitorV2Awareness
         }
 
         /// <summary>
-        /// Indicates, if rescaling becomes necessary, either because we are not 96 DPI or we're PerMonitorV2Aware.
+        ///  Indicates, if rescaling becomes necessary, either because we are not 96 DPI or we're PerMonitorV2Aware.
         /// </summary>
         internal static bool IsScalingRequirementMet
         {
@@ -197,8 +197,8 @@ private static Bitmap CreateScaledBitmap(Bitmap logicalImage, int deviceDpi = 0)
         }
 
         /// <summary>
-        /// Returns whether scaling is required when converting between logical-device units,
-        /// if the application opted in the automatic scaling in the .config file.
+        ///  Returns whether scaling is required when converting between logical-device units,
+        ///  if the application opted in the automatic scaling in the .config file.
         /// </summary>
         public static bool IsScalingRequired
         {
@@ -210,8 +210,8 @@ public static bool IsScalingRequired
         }
 
         /// <summary>
-        /// Transforms a horizontal or vertical integer coordinate from logical to device units
-        /// by scaling it up  for current DPI and rounding to nearest integer value
+        ///  Transforms a horizontal or vertical integer coordinate from logical to device units
+        ///  by scaling it up  for current DPI and rounding to nearest integer value
         /// </summary>
         /// <param name="value">value in logical units</param>
         /// <returns>value in device units</returns>
@@ -226,8 +226,8 @@ public static int LogicalToDeviceUnits(int value, int devicePixels = 0)
         }
 
         /// <summary>
-        /// Transforms a horizontal integer coordinate from logical to device units
-        /// by scaling it up  for current DPI and rounding to nearest integer value
+        ///  Transforms a horizontal integer coordinate from logical to device units
+        ///  by scaling it up  for current DPI and rounding to nearest integer value
         /// </summary>
         /// <param name="value">The horizontal value in logical units</param>
         /// <returns>The horizontal value in device units</returns>
@@ -237,8 +237,8 @@ public static int LogicalToDeviceUnitsX(int value)
         }
 
         /// <summary>
-        /// Transforms a vertical integer coordinate from logical to device units
-        /// by scaling it up  for current DPI and rounding to nearest integer value
+        ///  Transforms a vertical integer coordinate from logical to device units
+        ///  by scaling it up  for current DPI and rounding to nearest integer value
         /// </summary>
         /// <param name="value">The vertical value in logical units</param>
         /// <returns>The vertical value in device units</returns>
@@ -248,8 +248,8 @@ public static int LogicalToDeviceUnitsY(int value)
         }
 
         /// <summary>
-        /// Returns a new Size with the input's
-        /// dimensions converted from logical units to device units.
+        ///  Returns a new Size with the input's
+        ///  dimensions converted from logical units to device units.
         /// </summary>
         /// <param name="logicalSize">Size in logical units</param>
         /// <returns>Size in device units</returns>
@@ -260,7 +260,7 @@ public static Size LogicalToDeviceUnits(Size logicalSize, int deviceDpi = 0)
         }
 
         /// <summary>
-        /// Create and return a new bitmap scaled to the specified size.
+        ///  Create and return a new bitmap scaled to the specified size.
         /// </summary>
         /// <param name="logicalImage">The image to scale from logical units to device units</param>
         /// <param name="targetImageSize">The size to scale image to</param>
@@ -275,7 +275,7 @@ public static Bitmap CreateResizedBitmap(Bitmap logicalImage, Size targetImageSi
         }
 
         /// <summary>
-        /// Creating bitmap from Icon resource
+        ///  Creating bitmap from Icon resource
         /// </summary>
         public static Bitmap GetBitmapFromIcon(Type t, string name)
         {
@@ -286,8 +286,8 @@ public static Bitmap GetBitmapFromIcon(Type t, string name)
         }
 
         /// <summary>
-        /// Create a new bitmap scaled for the device units.
-        /// When displayed on the device, the scaled image will have same size as the original image would have when displayed at 96dpi.
+        ///  Create a new bitmap scaled for the device units.
+        ///  When displayed on the device, the scaled image will have same size as the original image would have when displayed at 96dpi.
         /// </summary>
         /// <param name="logicalBitmap">The image to scale from logical units to device units</param>
         public static void ScaleBitmapLogicalToDevice(ref Bitmap logicalBitmap, int deviceDpi = 0)
@@ -305,13 +305,13 @@ public static void ScaleBitmapLogicalToDevice(ref Bitmap logicalBitmap, int devi
         }
 
         /// <summary>
-        /// Set, when the first (Parking)Window has been created. From that moment on,
-        /// we will not be able nor allow to change the Process' DpiMode.
+        ///  Set, when the first (Parking)Window has been created. From that moment on,
+        ///  we will not be able nor allow to change the Process' DpiMode.
         /// </summary>
         internal static bool FirstParkingWindowCreated { get; set; }
 
         /// <summary>
-        /// Gets the DPI awareness.
+        ///  Gets the DPI awareness.
         /// </summary>
         /// <returns>The thread's/process' current HighDpi mode</returns>
         internal static HighDpiMode GetWinformsApplicationDpiAwareness()
@@ -372,7 +372,7 @@ internal static HighDpiMode GetWinformsApplicationDpiAwareness()
         }
 
         /// <summary>
-        /// Sets the DPI awareness. If not available on the current OS, it falls back to the next possible.
+        ///  Sets the DPI awareness. If not available on the current OS, it falls back to the next possible.
         /// </summary>
         /// <returns>true/false - If the process DPI awareness is successfully set, returns true. Otherwise false.</returns>
         internal static bool SetWinformsApplicationDpiAwareness(HighDpiMode highDpiMode)

src/Common/src/FileDialog_Vista_Interop.cs

@@ -39,7 +39,7 @@ public class FileSaveDialogRCW
         }
 
         /// <summary>
-        /// IID GUID strings for relevant COM interfaces
+        ///  IID GUID strings for relevant COM interfaces
         /// </summary>
         public static class IIDGuid
         {
@@ -71,17 +71,17 @@ public interface IModalWindow
         public enum SIATTRIBFLAGS
         {
             /// <summary>
-            /// Multiple items and the attributes together.
+            ///  Multiple items and the attributes together.
             /// </summary>
             SIATTRIBFLAGS_AND = 0x00000001,
 
             /// <summary>
-            /// Multiple items or the attributes together.
+            ///  Multiple items or the attributes together.
             /// </summary>
             SIATTRIBFLAGS_OR = 0x00000002, 
 
             /// <summary>
-            /// Call GetAttributes directly on the ShellFolder for multiple attributes
+            ///  Call GetAttributes directly on the ShellFolder for multiple attributes
             /// <summary>
             SIATTRIBFLAGS_APPCOMPAT = 0x00000003
         }
@@ -297,9 +297,9 @@ public interface IFileSaveDialog : IFileDialog
 #pragma warning restore 108
 
         /// <remarks>
-        /// Some of these callbacks are cancelable - returning S_FALSE means that the dialog should
-        /// not proceed (e.g. with closing, changing folder); to support this, we need to use the
-        /// PreserveSig attribute to enable us to return the proper HRESULT
+        ///  Some of these callbacks are cancelable - returning S_FALSE means that the dialog should
+        ///  not proceed (e.g. with closing, changing folder); to support this, we need to use the
+        ///  PreserveSig attribute to enable us to return the proper HRESULT
         /// </remarks>
         [ComImport]
         [Guid(IIDGuid.IFileDialogEvents)]

src/Common/src/Interop/Interop.BOOL.cs

@@ -5,13 +5,13 @@
 internal partial class Interop
 {
     /// <summary>
-    /// Blittable version of Windows BOOL type. It is convenient in situations where
-    /// manual marshalling is required, or to avoid overhead of regular bool marshalling.
+    ///  Blittable version of Windows BOOL type. It is convenient in situations where
+    ///  manual marshalling is required, or to avoid overhead of regular bool marshalling.
     /// </summary>
     /// <remarks>
-    /// Some Windows APIs return arbitrary integer values although the return type is defined
-    /// as BOOL. It is best to never compare BOOL to TRUE. Always use bResult != BOOL.FALSE
-    /// or bResult == BOOL.FALSE .
+    ///  Some Windows APIs return arbitrary integer values although the return type is defined
+    ///  as BOOL. It is best to never compare BOOL to TRUE. Always use bResult != BOOL.FALSE
+    ///  or bResult == BOOL.FALSE .
     /// </remarks>
     internal enum BOOL : int
     {

src/Common/src/Interop/Interop.EditMessages.cs

@@ -5,8 +5,8 @@
 internal static partial class Interop
 {
     /// <summary>
-    /// Edit Control Messages.
-    /// Copied form winuser.h
+    ///  Edit Control Messages.
+    ///  Copied form winuser.h
     /// </summary>
     public static class EditMessages
     {

src/Common/src/Interop/Interop.RichEditMessages.cs

@@ -5,8 +5,8 @@
 internal static partial class Interop
 {
     /// <summary>
-    /// RichTextBox Control Messages. Note that some messages have the same name but different value compared to normal Edit Control Messages.
-    /// Copied form richedit.h
+    ///  RichTextBox Control Messages. Note that some messages have the same name but different value compared to normal Edit Control Messages.
+    ///  Copied form richedit.h
     /// </summary>
     public static class RichEditMessages
     {