Xml Doc - Add more comments and fixes

Author: amaitland

CefSharp.Core/Cef.h

@@ -156,10 +156,10 @@ namespace CefSharp
             {
                 // NOTE: Can only initialize Cef once, to make this explicitly clear throw exception on subsiquent attempts
                 throw gcnew Exception("CEF can only be initialized once per process. This is a limitation of the underlying " + 
-					"CEF/Chromium framework. You can change many (not all) settings at runtime through RequestContext.SetPreference. " + 
-					"See https://github.com/cefsharp/CefSharp/wiki/General-Usage#request-context-browser-isolation " +
-					"Use Cef.IsInitialized to guard against this exception. If you are seeing this unexpectedly then you are likely " +
-					"calling Cef.Initialize after you've created an instance of ChromiumWebBrowser, it must be before the first instance is created.");
+                    "CEF/Chromium framework. You can change many (not all) settings at runtime through RequestContext.SetPreference. " + 
+                    "See https://github.com/cefsharp/CefSharp/wiki/General-Usage#request-context-browser-isolation " +
+                    "Use Cef.IsInitialized to guard against this exception. If you are seeing this unexpectedly then you are likely " +
+                    "calling Cef.Initialize after you've created an instance of ChromiumWebBrowser, it must be before the first instance is created.");
             }
 
             if (cefSettings->BrowserSubprocessPath == nullptr)
@@ -277,6 +277,7 @@ namespace CefSharp
         /// <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the 
         ///     <paramref name="targetDomain"/> was set to example.com
         /// </param>
+        /// <returns>Returns false if is invalid or the whitelist cannot be accessed.</returns>
         /// <remarks>
         /// The same-origin policy restricts how scripts hosted from different origins
         /// (scheme + domain + port) can communicate. By default, scripts can only access
@@ -361,6 +362,7 @@ namespace CefSharp
         /// <summary>
         /// Returns the global cookie manager.
         /// </summary>
+        /// <returns>A the global cookie manager</returns>
         static ICookieManager^ GetGlobalCookieManager()
         {
             auto cookieManager = CefCookieManager::GetGlobalManager(NULL);
@@ -379,6 +381,7 @@ namespace CefSharp
         /// wish to only block cookies sent via the network use the IRequestHandler
         /// CanGetCookies and CanSetCookie methods instead.
         /// </summary>
+        /// <returns>A blocking cookie manager</returns>
         static ICookieManager^ GetBlockingCookieManager()
         {
             auto cookieManager = CefCookieManager::GetBlockingManager();
@@ -408,9 +411,9 @@ namespace CefSharp
                     if (_initializedThreadId != Thread::CurrentThread->ManagedThreadId)
                     {
                         throw gcnew Exception("Cef.Shutdown must be called on the same thread that Cef.Initialize was called - typically your UI thread." +
-							"If you called Cef.Initialize on a Thread other than the UI thread then you will need to call Cef.Shutdown on the same thread." +
-							"Cef.Initialize was called on ManagedThreadId: " + _initializedThreadId + "where Cef.Shutdown is being called on" +
-							"ManagedThreadId:" + Thread::CurrentThread->ManagedThreadId);
+                            "If you called Cef.Initialize on a Thread other than the UI thread then you will need to call Cef.Shutdown on the same thread." +
+                            "Cef.Initialize was called on ManagedThreadId: " + _initializedThreadId + "where Cef.Shutdown is being called on" +
+                            "ManagedThreadId:" + Thread::CurrentThread->ManagedThreadId);
                     }
 
                     UIThreadTaskFactory = nullptr;

CefSharp.WinForms/ChromiumWebBrowser.cs

@@ -582,6 +582,9 @@ public void RegisterAsyncJsObject(string name, object objectToBind, BindingOptio
             objectRepository.Register(name, objectToBind, true, options);
         }
 
+        /// <summary>
+        /// The javascript object repository, one repository per ChromiumWebBrowser instance.
+        /// </summary>
         public IJavascriptObjectRepository JavascriptObjectRepository
         {
             get { return managedCefBrowserAdapter == null ? null : managedCefBrowserAdapter.JavascriptObjectRepository; }

CefSharp.WinForms/ChromiumWebBrowserDesigner.cs

@@ -3,57 +3,65 @@
 // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
 
 using System.Collections;
-using System.ComponentModel;
 using System.Drawing;
-using System.Reflection;
-using System.Resources;
 using System.Windows.Forms.Design;
 
 namespace CefSharp.WinForms
 {
-	public class ChromiumWebBrowserDesigner : ControlDesigner
-	{
-		protected override void OnPaintAdornments(System.Windows.Forms.PaintEventArgs pe)
-		{
-			//NOTE: Removed until a better image can be found, add image as Embedded Resource and update name below
-			//var assembly = Assembly.GetAssembly(typeof(ChromiumWebBrowserDesigner));
-
-			//using (var logo = assembly.GetManifestResourceStream("CefSharp.WinForms.CefSharpLogo.png"))
-			//using (var img = Image.FromStream(logo))
-			//{
-			//	pe.Graphics.DrawImage(img, 0, 0);
-			//}
-
-			using(var font = new Font("Arial", 16))
-			using (var stringFormat = new StringFormat
-			{
-				// Create a StringFormat object with the each line of text, and the block
-				// of text centered on the page.
-				Alignment = StringAlignment.Center,
-				LineAlignment = StringAlignment.Center 
-			})
-			{		
-				pe.Graphics.DrawString("ChromiumWebBrowser", font, Brushes.Black, pe.ClipRectangle, stringFormat);
-			}
-
-			base.OnPaintAdornments(pe);
-		}
-
-		protected override void PreFilterProperties(IDictionary properties)
-		{
-			//Remove some of the default properties from the designer
-			//they don't have much meaning for the browser
-			//Probably more that can be removed/tweaked
-			properties.Remove("BackgroundImage");
-			properties.Remove("BackgroundImageLayout");
-			properties.Remove("Text");
-
-			properties.Remove("Font");
-			properties.Remove("ForeColor");
-			properties.Remove("BackColor");
-			properties.Remove("RightToLeft");
-
-			base.PreFilterProperties(properties);
-		}
-	}
+    /// <summary>
+    /// ChromiumWebBrowser Control Designer
+    /// </summary>
+    public class ChromiumWebBrowserDesigner : ControlDesigner
+    {
+        /// <summary>
+        /// Receives a call when the control that the designer is managing has painted its surface so the designer can paint any additional adornments on top of the control.
+        /// </summary>
+        /// <param name="pe">args</param>
+        protected override void OnPaintAdornments(System.Windows.Forms.PaintEventArgs pe)
+        {
+            //NOTE: Removed until a better image can be found, add image as Embedded Resource and update name below
+            //var assembly = Assembly.GetAssembly(typeof(ChromiumWebBrowserDesigner));
+
+            //using (var logo = assembly.GetManifestResourceStream("CefSharp.WinForms.CefSharpLogo.png"))
+            //using (var img = Image.FromStream(logo))
+            //{
+            //	pe.Graphics.DrawImage(img, 0, 0);
+            //}
+
+            using(var font = new Font("Arial", 16))
+            using (var stringFormat = new StringFormat
+            {
+                // Create a StringFormat object with the each line of text, and the block
+                // of text centered on the page.
+                Alignment = StringAlignment.Center,
+                LineAlignment = StringAlignment.Center 
+            })
+            {		
+                pe.Graphics.DrawString("ChromiumWebBrowser", font, Brushes.Black, pe.ClipRectangle, stringFormat);
+            }
+
+            base.OnPaintAdornments(pe);
+        }
+
+        /// <summary>
+        /// Adjusts the set of properties the component exposes through a TypeDescriptor.
+        /// </summary>
+        /// <param name="properties">properties</param>
+        protected override void PreFilterProperties(IDictionary properties)
+        {
+            //Remove some of the default properties from the designer
+            //they don't have much meaning for the browser
+            //Probably more that can be removed/tweaked
+            properties.Remove("BackgroundImage");
+            properties.Remove("BackgroundImageLayout");
+            properties.Remove("Text");
+
+            properties.Remove("Font");
+            properties.Remove("ForeColor");
+            properties.Remove("BackColor");
+            properties.Remove("RightToLeft");
+
+            base.PreFilterProperties(properties);
+        }
+    }
 }

CefSharp.Wpf/ChromiumWebBrowser.cs

@@ -756,6 +756,10 @@ void IRenderWebBrowser.UpdateDragCursor(DragOperationsMask operation)
             UpdateDragCursor(operation);
         }
 
+        /// <summary>
+        /// Called when the web view wants to update the mouse cursor during a drag &amp; drop operation.
+        /// </summary>
+        /// <param name="operation">describes the allowed operation (none, move, copy, link). </param>
         protected virtual void UpdateDragCursor(DragOperationsMask operation)
         {
             //TODO: Someone should implement this
@@ -780,7 +784,7 @@ void IRenderWebBrowser.OnPaint(PaintElementType type, Rect dirtyRect, IntPtr buf
         /// override this method or implement your own <see cref="IRenderHandler"/> and assign to <see cref="RenderHandler"/>
         /// Called on the CEF UI Thread
         /// </summary>
-        /// <param name="type">indicates whether the element is the view or the popup widget.</param>
+        /// <param name="isPopup">indicates whether the element is the view or the popup widget.</param>
         /// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
         /// <param name="buffer">The bitmap will be will be  width * height *4 bytes in size and represents a BGRA image with an upper-left origin</param>
         /// <param name="width">width</param>
@@ -808,10 +812,7 @@ protected virtual void OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int
         /// <summary>
         /// Sets the popup size and position.
         /// </summary>
-        /// <param name="width">The width.</param>
-        /// <param name="height">The height.</param>
-        /// <param name="x">The x.</param>
-        /// <param name="y">The y.</param>
+        /// <param name="rect">The popup rectangle (size and position).</param>
         void IRenderWebBrowser.OnPopupSize(Rect rect)
         {
             UiThreadRunAsync(() => SetPopupSizeAndPositionImpl(rect));
@@ -831,6 +832,7 @@ void IRenderWebBrowser.OnPopupShow(bool isOpen)
         /// </summary>
         /// <param name="handle">The handle.</param>
         /// <param name="type">The type.</param>
+        /// <param name="customCursorInfo">custom cursor information</param>
         void IRenderWebBrowser.OnCursorChange(IntPtr handle, CursorType type, CursorInfo customCursorInfo)
         {
             //Custom cursors are handled differently, for now keep standard ones executing
@@ -860,6 +862,11 @@ void IRenderWebBrowser.OnImeCompositionRangeChanged(Range selectedRange, Rect[]
             OnImeCompositionRangeChanged(selectedRange, characterBounds);
         }
 
+        /// <summary>
+        /// Called when the IME composition range has changed.
+        /// </summary>
+        /// <param name="selectedRange">is the range of characters that have been selected</param>
+        /// <param name="characterBounds">is the bounds of each character in view coordinates.</param>
         protected virtual void OnImeCompositionRangeChanged(Range selectedRange, Rect[] characterBounds)
         {
             //TODO: Implement this
@@ -1908,6 +1915,7 @@ private Popup CreatePopup()
             return newPopup;
         }
 
+        /// <summary>
         /// Converts a .NET Drag event to a CefSharp MouseEvent
         /// </summary>
         /// <param name="e">The <see cref="DragEventArgs"/> instance containing the event data.</param>
@@ -1922,10 +1930,7 @@ private MouseEvent GetMouseEvent(DragEventArgs e)
         /// <summary>
         /// Sets the popup size and position implementation.
         /// </summary>
-        /// <param name="width">The width.</param>
-        /// <param name="height">The height.</param>
-        /// <param name="x">The x.</param>
-        /// <param name="y">The y.</param>
+        /// <param name="rect">The popup rectangle (size and position).</param>
         private void SetPopupSizeAndPositionImpl(Rect rect)
         {
             popup.Width = rect.Width ;
@@ -2360,6 +2365,9 @@ public void RegisterAsyncJsObject(string name, object objectToBind, BindingOptio
             objectRepository.Register(name, objectToBind, true, options);
         }
 
+        /// <summary>
+        /// The javascript object repository, one repository per ChromiumWebBrowser instance.
+        /// </summary>
         public IJavascriptObjectRepository JavascriptObjectRepository
         {
             get { return managedCefBrowserAdapter?.JavascriptObjectRepository; }

CefSharp.Wpf/IRenderHandler.cs

@@ -15,6 +15,15 @@ namespace CefSharp.Wpf
     /// </summary>
     public interface IRenderHandler : IDisposable
     {
+        /// <summary>
+        /// Called when an element should be painted. (Invoked from CefRenderHandler.OnPaint)
+        /// </summary>
+        /// <param name="isPopup">indicates whether the element is the view or the popup widget.</param>
+        /// <param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
+        /// <param name="buffer">The bitmap will be will be  width * height *4 bytes in size and represents a BGRA image with an upper-left origin</param>
+        /// <param name="width">width</param>
+        /// <param name="height">height</param>
+        /// <param name="image">image used as parent for rendered bitmap</param>
         void OnPaint(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height, Image image);
     }
 }

CefSharp.Wpf/PaintEventArgs.cs

@@ -46,7 +46,11 @@ public class PaintEventArgs : EventArgs
         /// <summary>
         /// Initializes a new instance of the <see cref="PaintEventArgs"/> class.
         /// </summary>
-        /// <param name="bitmapInfo">The bitmap information.</param>
+        /// <param name="isPopup">is popup</param>
+        /// <param name="dirtyRect">direct rectangle</param>
+        /// <param name="buffer">buffer</param>
+        /// <param name="width">width</param>
+        /// <param name="height">height</param>
         public PaintEventArgs(bool isPopup, Rect dirtyRect, IntPtr buffer, int width, int height)
         {
             IsPopup = isPopup;

CefSharp.Wpf/Rendering/Experimental/IncreaseBufferInteropRenderHandler.cs

@@ -52,6 +52,9 @@ public IncreaseBufferInteropRenderHandler(DispatcherPriority dispatcherPriority
             this.dispatcherPriority = dispatcherPriority;
         }
 
+        /// <summary>
+        /// Dispose
+        /// </summary>
         public void Dispose()
         {
             ReleaseMemoryMappedView(ref popupMemoryMappedFile, ref popupMemoryMappedViewAccessor);

CefSharp.Wpf/Rendering/InteropBitmapRenderHandler.cs

@@ -52,6 +52,9 @@ public InteropBitmapRenderHandler(DispatcherPriority dispatcherPriority = Dispat
             this.dispatcherPriority = dispatcherPriority;
         }
 
+        /// <summary>
+        /// Dispose
+        /// </summary>
         public void Dispose()
         {
             ReleaseMemoryMappedView(ref popupMemoryMappedFile, ref popupMemoryMappedViewAccessor);

CefSharp.Wpf/Rendering/WritableBitmapRenderHandler.cs

@@ -61,6 +61,9 @@ public WritableBitmapRenderHandler(double dpiX, double dpiY, bool invalidateDirt
             this.dispatcherPriority = dispatcherPriority;
         }
 
+        /// <summary>
+        /// Dispose
+        /// </summary>
         public void Dispose()
         {
             ReleaseMemoryMappedView(ref popupMemoryMappedFile, ref popupMemoryMappedViewAccessor);

CefSharp.Wpf/WM.cs

@@ -1,6 +1,9 @@
 namespace CefSharp.Wpf
 {
-    // Gratiously based on http://www.pinvoke.net/default.aspx/Enums/WindowsMessages.html
+    /// <summary>
+    /// Windows Message Enums
+    /// Gratiosly based on http://www.pinvoke.net/default.aspx/Enums/WindowsMessages.html
+    /// </summary>
     public enum WM : uint
     {
         /// <summary>