Improve comments around CEF UI thread

Author: amaitland

CefSharp.Core/Cef.h

@@ -51,7 +51,7 @@ namespace CefSharp
 
     public:
         /// <summary>
-        /// Called on the browser process UI thread immediately after the CEF context has been initialized.
+        /// Called on the CEF UI thread immediately after the CEF context has been initialized.
         /// You can now access the Global RequestContext through Cef.GetGlobalRequestContext() - this is the
         /// first place you can set Preferences (e.g. proxy settings, spell check dictionaries).
         /// </summary>

CefSharp/IDialogHandler.cs

@@ -7,7 +7,7 @@
 namespace CefSharp
 {
     /// <summary>
-    /// Implement this interface to handle dialog events. The methods of this class will be called on the browser process UI thread.
+    /// Implement this interface to handle dialog events. The methods of this class will be called on the CEF UI thread.
     /// </summary>
     public interface IDialogHandler
     {

CefSharp/IGeolocationHandler.cs

@@ -6,7 +6,7 @@ namespace CefSharp
 {
     /// <summary>
     /// Implement this interface to handle events related to geolocation permission requests.
-    /// The methods of this class will be called on the browser process UI thread. 
+    /// The methods of this class will be called on the CEF UI thread. 
     /// </summary>
     public interface IGeolocationHandler
     {

CefSharp/IPrintToPdfCallback.cs

@@ -6,7 +6,7 @@ namespace CefSharp
 {
     /// <summary>
     /// Callback interface for <see cref="IBrowserHost.PrintToPDF"/>. The methods of this interface
-    /// will be called on the browser process UI thread.
+    /// will be called on the CEF UI thread.
     /// </summary>
     public interface IPrintToPdfCallback
     {

CefSharp/IRequestContext.cs

@@ -71,30 +71,40 @@ public interface IRequestContext : IDisposable
 
         /// <summary>
         /// Tells all renderer processes associated with this context to throw away
-        /// their plugin list cache. If |reload_pages| is true they will also reload
+        /// their plugin list cache. If reloadPages is true they will also reload
         /// all pages with plugins. RequestContextHandler.OnBeforePluginLoad may
         /// be called to rebuild the plugin list cache.
         /// </summary>
         /// <param name="reloadPages">reload any pages with pluginst</param>
         void PurgePluginListCache(bool reloadPages);
 
         /// <summary>
-        /// Returns true if a preference with the specified |name| exists. This method
-        /// must be called on the browser process UI thread.
+        /// Returns true if a preference with the specified name exists. This method
+        /// must be called on the CEF UI thread.
         /// </summary>
-        /// <param name="name"></param>
-        /// <returns></returns>
+        /// <param name="name">name of preference</param>
+        /// <returns>bool if the preference exists</returns>
+        /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
+        /// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
+        /// executed on the CEF UI thread, so can be called directly.
+        /// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
+        /// application thread will be the CEF UI thread.</remarks>
         bool HasPreference(string name);
 
         /// <summary>
-        /// Returns the value for the preference with the specified |name|. Returns
+        /// Returns the value for the preference with the specified name. Returns
         /// NULL if the preference does not exist. The returned object contains a copy
         /// of the underlying preference value and modifications to the returned object
         /// will not modify the underlying preference value. This method must be called
-        /// on the browser process UI thread.
+        /// on the CEF UI thread.
         /// </summary>
-        /// <param name="name"></param>
-        /// <returns></returns>
+        /// <param name="name">preference name</param>
+        /// <returns>Returns the value for the preference with the specified name</returns>
+        /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
+        /// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
+        /// executed on the CEF UI thread, so can be called directly.
+        /// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
+        /// application thread will be the CEF UI thread.</remarks>
         object GetPreference(string name);
 
         /// <summary>
@@ -112,25 +122,34 @@ public interface IRequestContext : IDisposable
         /// <summary>
         /// Returns true if the preference with the specified name can be modified
         /// using SetPreference. As one example preferences set via the command-line
-        /// usually cannot be modified. This method must be called on the browser
-        /// process UI thread.
+        /// usually cannot be modified. This method must be called on the CEF UI thread.
         /// </summary>
         /// <param name="name">preference key</param>
         /// <returns>Returns true if the preference with the specified name can be modified
         /// using SetPreference</returns>
+        /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
+        /// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
+        /// executed on the CEF UI thread, so can be called directly.
+        /// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
+        /// application thread will be the CEF UI thread.</remarks>
         bool CanSetPreference(string name);
 
         /// <summary>
         /// Set the value associated with preference name. If value is null the
         /// preference will be restored to its default value. If setting the preference
         /// fails then error will be populated with a detailed description of the
-        /// problem. This method must be called on the browser process UI thread.
+        /// problem. This method must be called on the CEF UI thread.
         /// Preferences set via the command-line usually cannot be modified.
         /// </summary>
         /// <param name="name">preference key</param>
         /// <param name="value">preference value</param>
         /// <param name="error">out error</param>
         /// <returns>Returns true if the value is set successfully and false otherwise.</returns>
+        /// /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
+        /// Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
+        /// executed on the CEF UI thread, so can be called directly.
+        /// When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
+        /// application thread will be the CEF UI thread.</remarks>
         bool SetPreference(string name, object value, out string error);
 
         /// <summary>

CefSharp/IRequestHandler.cs

@@ -145,14 +145,13 @@ bool OnOpenUrlFromTab(IWebBrowser browserControl, IBrowser browser, IFrame frame
         bool OnProtocolExecution(IWebBrowser browserControl, IBrowser browser, string url);
 
         /// <summary>
-        /// Called on the browser process UI thread when the render view associated
+        /// Called on the CEF UI thread when the render view associated
         /// with browser is ready to receive/handle IPC messages in the render
         /// process.
         /// </summary>
         /// <param name="browserControl">The ChromiumWebBrowser control</param>
         /// <param name="browser">the browser object</param>
         void OnRenderViewReady(IWebBrowser browserControl, IBrowser browser);
-
 
         /// <summary>
         /// Called on the CEF IO thread when a resource response is received.