diff --git a/CefSharp.Core.Runtime/PostData.h b/CefSharp.Core.Runtime/PostData.h
index 18945b526f..437450f0a8 100644
--- a/CefSharp.Core.Runtime/PostData.h
+++ b/CefSharp.Core.Runtime/PostData.h
@@ -88,7 +88,7 @@ namespace CefSharp
public:
///
- /// Default constructor.
+ /// Initializes a new instance of the PostData class.
///
PostData()
{
diff --git a/CefSharp.Core.Runtime/RequestContextSettings.h b/CefSharp.Core.Runtime/RequestContextSettings.h
index 48dc15e225..fd7f22b556 100644
--- a/CefSharp.Core.Runtime/RequestContextSettings.h
+++ b/CefSharp.Core.Runtime/RequestContextSettings.h
@@ -28,7 +28,7 @@ namespace CefSharp
public:
///
- /// Default constructor
+ /// Initializes a new instance of the RequestContextSettings class.
///
RequestContextSettings() : _settings(new CefRequestContextSettings())
{
diff --git a/CefSharp/Callback/TaskCompletionCallback.cs b/CefSharp/Callback/TaskCompletionCallback.cs
index 842c76af4d..a6b8616838 100644
--- a/CefSharp/Callback/TaskCompletionCallback.cs
+++ b/CefSharp/Callback/TaskCompletionCallback.cs
@@ -18,7 +18,7 @@ public class TaskCompletionCallback : ICompletionCallback
private bool onComplete; //Only ever accessed on the same CEF thread, so no need for thread safety
///
- /// Default constructor
+ /// Initializes a new instance of the TaskCompletionCallback class.
///
public TaskCompletionCallback()
{
diff --git a/CefSharp/Callback/TaskDeleteCookiesCallback.cs b/CefSharp/Callback/TaskDeleteCookiesCallback.cs
index 32d4be8b9d..13545fdf9a 100644
--- a/CefSharp/Callback/TaskDeleteCookiesCallback.cs
+++ b/CefSharp/Callback/TaskDeleteCookiesCallback.cs
@@ -23,7 +23,7 @@ public class TaskDeleteCookiesCallback : IDeleteCookiesCallback
private bool onComplete; //Only ever accessed on the same CEF thread, so no need for thread safety
///
- /// Default constructor
+ /// Initializes a new instance of the TaskDeleteCookiesCallback class.
///
public TaskDeleteCookiesCallback()
{
diff --git a/CefSharp/Callback/TaskRegisterCdmCallback.cs b/CefSharp/Callback/TaskRegisterCdmCallback.cs
index d102fbcd69..3cc66cb440 100644
--- a/CefSharp/Callback/TaskRegisterCdmCallback.cs
+++ b/CefSharp/Callback/TaskRegisterCdmCallback.cs
@@ -18,7 +18,7 @@ public class TaskRegisterCdmCallback : IRegisterCdmCallback
private bool onComplete; //Only ever accessed on the same CEF thread, so no need for thread safety
///
- /// Default constructor
+ /// Initializes a new instance of the TaskRegisterCdmCallback class.
///
public TaskRegisterCdmCallback()
{
diff --git a/CefSharp/Callback/TaskResolveCallback.cs b/CefSharp/Callback/TaskResolveCallback.cs
index 49708cb2f1..59cc5edac1 100644
--- a/CefSharp/Callback/TaskResolveCallback.cs
+++ b/CefSharp/Callback/TaskResolveCallback.cs
@@ -19,7 +19,7 @@ public class TaskResolveCallback : IResolveCallback
private bool onComplete; //Only ever accessed on the same CEF thread, so no need for thread safety
///
- /// Default constructor
+ /// Initializes a new instance of the TaskResolveCallback class.
///
public TaskResolveCallback()
{
diff --git a/CefSharp/Callback/TaskSetCookieCallback.cs b/CefSharp/Callback/TaskSetCookieCallback.cs
index 41166c1296..2fe07e2cc3 100644
--- a/CefSharp/Callback/TaskSetCookieCallback.cs
+++ b/CefSharp/Callback/TaskSetCookieCallback.cs
@@ -18,7 +18,7 @@ public class TaskSetCookieCallback : ISetCookieCallback
private bool onComplete; //Only ever accessed on the same CEF thread, so no need for thread safety
///
- /// Default constructor
+ /// Initializes a new instance of the TaskSetCookieCallback class.
///
public TaskSetCookieCallback()
{
diff --git a/CefSharp/CefLibraryHandle.cs b/CefSharp/CefLibraryHandle.cs
index d0a6cb2916..20249fab62 100644
--- a/CefSharp/CefLibraryHandle.cs
+++ b/CefSharp/CefLibraryHandle.cs
@@ -33,7 +33,7 @@ private enum LoadLibraryFlags : uint
}
///
- /// Default constructor
+ /// Initializes a new instance of the CefLibraryHandle class.
///
/// libcef.dll full path.
public CefLibraryHandle(string path) : base(IntPtr.Zero, true)
diff --git a/CefSharp/DevTools/Headers.cs b/CefSharp/DevTools/Headers.cs
index 166b0cd9d4..d87935eaac 100644
--- a/CefSharp/DevTools/Headers.cs
+++ b/CefSharp/DevTools/Headers.cs
@@ -19,6 +19,9 @@ namespace CefSharp.DevTools.Network
/// Helper methods for dealing with comma separated header values based on https://github.com/dotnet/aspnetcore/blob/52eff90fbcfca39b7eb58baad597df6a99a542b0/src/Http/Http.Abstractions/src/Extensions/HeaderDictionaryExtensions.cs
public class Headers : Dictionary
{
+ ///
+ /// Initializes a new instance of the Headers class.
+ ///
public Headers() : base(StringComparer.OrdinalIgnoreCase)
{
}
diff --git a/CefSharp/Handler/ContextMenuHandler.cs b/CefSharp/Handler/ContextMenuHandler.cs
index 2b18324fa6..598ba69320 100644
--- a/CefSharp/Handler/ContextMenuHandler.cs
+++ b/CefSharp/Handler/ContextMenuHandler.cs
@@ -4,6 +4,7 @@
namespace CefSharp.Handler
{
+ ///
/// Inherit from this class to handle context menu events.
///
public class ContextMenuHandler : IContextMenuHandler
diff --git a/CefSharp/IResponse.cs b/CefSharp/IResponse.cs
index 798eefe18d..ada5a34aff 100644
--- a/CefSharp/IResponse.cs
+++ b/CefSharp/IResponse.cs
@@ -57,8 +57,7 @@ public interface IResponse : IDisposable
string GetHeaderByName(string name);
///
- /// Set the header name to value. The Referer value cannot be set using this method.
- /// Use instead.
+ /// Set the header name to value.
///
/// header name
/// new header value
diff --git a/CefSharp/IWebBrowser.cs b/CefSharp/IWebBrowser.cs
index 57a24a3c71..484dc4a4f8 100644
--- a/CefSharp/IWebBrowser.cs
+++ b/CefSharp/IWebBrowser.cs
@@ -92,7 +92,7 @@ public interface IWebBrowser : IDisposable
/// url to load
/// SynchronizationContext to execute the continuation on, if null then the ThreadPool will be used.
///
- /// A that can be awaited to load the and return the HttpStatusCode and .
+ /// A that can be awaited to load the and return the HttpStatusCode and .
/// A HttpStatusCode equal to 200 and is considered a success.
///
Task LoadUrlAsync(string url = null, SynchronizationContext ctx = null);
diff --git a/CefSharp/Internals/ParentProcessMonitor.cs b/CefSharp/Internals/ParentProcessMonitor.cs
index 61d5def837..8956894442 100644
--- a/CefSharp/Internals/ParentProcessMonitor.cs
+++ b/CefSharp/Internals/ParentProcessMonitor.cs
@@ -18,7 +18,7 @@ public static class ParentProcessMonitor
{
///
/// Starts a long running task (spawns new thread) used to monitor the parent process
- /// and calls if the parent exits unexpectedly (usually result of a crash).
+ /// and calls if the parent exits unexpectedly (usually result of a crash).
///
/// process Id of the parent application
public static void StartMonitorTask(int parentProcessId)
diff --git a/CefSharp/Internals/TaskExtensions.cs b/CefSharp/Internals/TaskExtensions.cs
index 25eb6ff30b..eea90763f4 100644
--- a/CefSharp/Internals/TaskExtensions.cs
+++ b/CefSharp/Internals/TaskExtensions.cs
@@ -111,7 +111,7 @@ public static void TrySetResultAsync(this TaskCompletionSource
///
/// Generic param
/// tcs
- /// result
+ /// exception
public static void TrySetExceptionAsync(this TaskCompletionSource taskCompletionSource, Exception ex)
{
Task.Factory.StartNew(delegate
diff --git a/CefSharp/JavascriptBinding/CamelCaseJavascriptNameConverter.cs b/CefSharp/JavascriptBinding/CamelCaseJavascriptNameConverter.cs
index c54e041191..f34f19ab23 100644
--- a/CefSharp/JavascriptBinding/CamelCaseJavascriptNameConverter.cs
+++ b/CefSharp/JavascriptBinding/CamelCaseJavascriptNameConverter.cs
@@ -39,7 +39,7 @@ string IJavascriptNameConverter.ConvertReturnedObjectPropertyAndFieldToNameJavas
/// only the bound methods/fields/properties were converted. Objects returned
/// from a method call were not translated. To preserve this functionality
/// for upgrading users we split this into two methods. Typically thie method
- /// would return the same result as
+ /// would return the same result as
/// Issue #2442
///
/// property/field/method
diff --git a/CefSharp/JavascriptBinding/IJavascriptNameConverter.cs b/CefSharp/JavascriptBinding/IJavascriptNameConverter.cs
index 0d7e1dda19..7255c2492f 100644
--- a/CefSharp/JavascriptBinding/IJavascriptNameConverter.cs
+++ b/CefSharp/JavascriptBinding/IJavascriptNameConverter.cs
@@ -25,7 +25,7 @@ public interface IJavascriptNameConverter
/// only the bound methods/fields/properties were converted. Objects returned
/// from a method call were not translated. To preserve this functionality
/// for upgrading users we split this into two methods. Typically thie method
- /// would return the same result as
+ /// would return the same result as
/// Issue #2442
///
/// property/field/method
diff --git a/CefSharp/LoadUrlAsyncResponse.cs b/CefSharp/LoadUrlAsyncResponse.cs
index b4ba19ae8f..e9414edfba 100644
--- a/CefSharp/LoadUrlAsyncResponse.cs
+++ b/CefSharp/LoadUrlAsyncResponse.cs
@@ -32,7 +32,7 @@ public bool Success
}
///
- /// Default constructor
+ /// Initializes a new instance of the LoadUrlAsyncResponse class.
///
/// CEF Error Code
/// Http Status Code
diff --git a/CefSharp/ModelBinding/DefaultBinder.cs b/CefSharp/ModelBinding/DefaultBinder.cs
index e7b2845008..c616cdbbfe 100644
--- a/CefSharp/ModelBinding/DefaultBinder.cs
+++ b/CefSharp/ModelBinding/DefaultBinder.cs
@@ -21,6 +21,10 @@ public class DefaultBinder : IBinder
private static readonly MethodInfo ToArrayMethodInfo = typeof(Enumerable).GetMethod("ToArray", BindingFlags.Public | BindingFlags.Static);
private readonly IJavascriptNameConverter javascriptNameConverter;
+ ///
+ /// Javascript Binder
+ ///
+ /// name converter
public DefaultBinder(IJavascriptNameConverter javascriptNameConverter = null)
{
this.javascriptNameConverter = javascriptNameConverter;
diff --git a/CefSharp/Preferences/SetPreferenceResponse.cs b/CefSharp/Preferences/SetPreferenceResponse.cs
index 58f646bf86..990595ae5f 100644
--- a/CefSharp/Preferences/SetPreferenceResponse.cs
+++ b/CefSharp/Preferences/SetPreferenceResponse.cs
@@ -21,7 +21,7 @@ public class SetPreferenceResponse
public string ErrorMessage { get; private set; }
///
- /// Default constructor
+ /// Initializes a new instance of the SetPreferenceResponse class.
///
/// success
/// error message
diff --git a/CefSharp/Preferences/SetProxyResponse.cs b/CefSharp/Preferences/SetProxyResponse.cs
index 2338d411e2..b293bf74fb 100644
--- a/CefSharp/Preferences/SetProxyResponse.cs
+++ b/CefSharp/Preferences/SetProxyResponse.cs
@@ -5,13 +5,13 @@
namespace CefSharp.Preferences
{
///
- /// Response when
- /// is called.
+ /// Response when either
+ /// or are called.
///
public class SetProxyResponse : SetPreferenceResponse
{
///
- /// Default constructor
+ /// Initializes a new instance of the SetProxyResponse class.
///
/// success
/// error message
diff --git a/CefSharp/RenderProcess/IV8Context.cs b/CefSharp/RenderProcess/IV8Context.cs
index 4733ce47e5..e18fb8f3a6 100644
--- a/CefSharp/RenderProcess/IV8Context.cs
+++ b/CefSharp/RenderProcess/IV8Context.cs
@@ -4,6 +4,15 @@
namespace CefSharp.RenderProcess
{
+ ///
+ /// V8 context handle.
+ /// V8 handles can only be accessed from the thread on which they are created.
+ /// Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads.
+ /// A task runner for posting tasks on the associated thread can be retrieved via the CefV8Context::GetTaskRunner() method.
+ ///
+ ///
+ /// V8 is Google’s open source high-performance JavaScript and WebAssembly engine.
+ ///
public interface IV8Context
{
///
diff --git a/CefSharp/RenderProcess/V8Exception.cs b/CefSharp/RenderProcess/V8Exception.cs
index 3f6641eb7f..d67cbd14da 100644
--- a/CefSharp/RenderProcess/V8Exception.cs
+++ b/CefSharp/RenderProcess/V8Exception.cs
@@ -7,6 +7,9 @@ namespace CefSharp.RenderProcess
///
/// Class representing a V8 exception.
///
+ ///
+ /// V8 is Google’s open source high-performance JavaScript and WebAssembly engine.
+ ///
public class V8Exception
{
///
@@ -57,6 +60,17 @@ public class V8Exception
/// Returns the index within the script of the first character where the error occurred.
public int StartPosition { get; private set; }
+ ///
+ /// V8 Exception
+ ///
+ /// index within the line of the last character where the error occurred.
+ /// index within the script of the last character where the error occurred.
+ /// 1-based number of the line where the error occurred or 0 if the line number is unknown.
+ /// exception message.
+ /// resource name for the script from where the function causing the error originates.
+ /// line of source code that the exception occurred within.
+ /// index within the line of the first character where the error occurred.
+ /// index within the script of the first character where the error occurred.
public V8Exception(int endColumn,
int endPosition,
int lineNumber,
diff --git a/CefSharp/RequestContextExtensions.cs b/CefSharp/RequestContextExtensions.cs
index 371ca1f117..78d8e694ef 100644
--- a/CefSharp/RequestContextExtensions.cs
+++ b/CefSharp/RequestContextExtensions.cs
@@ -69,7 +69,6 @@ public static void LoadExtensionsFromDirectory(this IRequestContext requestConte
/// request context
/// preference key
/// preference value
- /// out error
/// returns true if successfull, false otherwise.
/// Use Cef.UIThreadTaskFactory to execute this method if required,
/// and ChromiumWebBrowser.IsBrowserInitializedChanged are both
diff --git a/CefSharp/SchemeHandler/OwinResourceHandler.cs b/CefSharp/SchemeHandler/OwinResourceHandler.cs
index 94db05cd34..74732f1f51 100644
--- a/CefSharp/SchemeHandler/OwinResourceHandler.cs
+++ b/CefSharp/SchemeHandler/OwinResourceHandler.cs
@@ -34,6 +34,10 @@ public class OwinResourceHandler : ResourceHandler
private readonly AppFunc appFunc;
+ ///
+ /// OwinResourceHandler
+ ///
+ /// Owin pipeline func
public OwinResourceHandler(AppFunc appFunc)
{
this.appFunc = appFunc;
diff --git a/CefSharp/SchemeHandler/OwinSchemeHandlerFactory.cs b/CefSharp/SchemeHandler/OwinSchemeHandlerFactory.cs
index 8c8b0b1fc4..39f505d0f6 100644
--- a/CefSharp/SchemeHandler/OwinSchemeHandlerFactory.cs
+++ b/CefSharp/SchemeHandler/OwinSchemeHandlerFactory.cs
@@ -19,11 +19,16 @@ public class OwinSchemeHandlerFactory : ISchemeHandlerFactory
{
private readonly AppFunc appFunc;
+ ///
+ /// OwinSchemeHandlerFactory
+ ///
+ /// Owin pipeline func
public OwinSchemeHandlerFactory(AppFunc appFunc)
{
this.appFunc = appFunc;
}
+ ///
public IResourceHandler Create(IBrowser browser, IFrame frame, string schemeName, IRequest request)
{
return new OwinResourceHandler(appFunc);
diff --git a/CefSharp/Visitor/TaskCookieVisitor.cs b/CefSharp/Visitor/TaskCookieVisitor.cs
index e5abeab863..f1bd9cb8b8 100644
--- a/CefSharp/Visitor/TaskCookieVisitor.cs
+++ b/CefSharp/Visitor/TaskCookieVisitor.cs
@@ -19,7 +19,7 @@ public class TaskCookieVisitor : ICookieVisitor
private List list;
///
- /// Default constructor
+ /// Initializes a new instance of the TaskCookieVisitor class.
///
public TaskCookieVisitor()
{
@@ -27,6 +27,7 @@ public TaskCookieVisitor()
list = new List();
}
+ ///
bool ICookieVisitor.Visit(Cookie cookie, int count, int total, ref bool deleteCookie)
{
list.Add(cookie);
@@ -40,6 +41,7 @@ bool ICookieVisitor.Visit(Cookie cookie, int count, int total, ref bool deleteCo
return true;
}
+ ///
void IDisposable.Dispose()
{
if (list != null && list.Count == 0)
diff --git a/CefSharp/Visitor/TaskNavigationEntryVisitor.cs b/CefSharp/Visitor/TaskNavigationEntryVisitor.cs
index 8439c9f35c..c8088b8d35 100644
--- a/CefSharp/Visitor/TaskNavigationEntryVisitor.cs
+++ b/CefSharp/Visitor/TaskNavigationEntryVisitor.cs
@@ -10,8 +10,8 @@
namespace CefSharp
{
///
- /// A that uses a TaskCompletionSource
- /// to simplify things
+ /// A implementation that uses a
+ /// that allows you to call await/ContinueWith to get the list of NavigationEntries
///
public class TaskNavigationEntryVisitor : INavigationEntryVisitor
{
@@ -19,7 +19,7 @@ public class TaskNavigationEntryVisitor : INavigationEntryVisitor
private List list;
///
- /// Default constructor
+ /// Initializes a new instance of the TaskNavigationEntryVisitor class.
///
public TaskNavigationEntryVisitor()
{
@@ -27,6 +27,7 @@ public TaskNavigationEntryVisitor()
list = new List();
}
+ ///
bool INavigationEntryVisitor.Visit(NavigationEntry entry, bool current, int index, int total)
{
list.Add(entry);
@@ -34,6 +35,7 @@ bool INavigationEntryVisitor.Visit(NavigationEntry entry, bool current, int inde
return true;
}
+ ///
void IDisposable.Dispose()
{
if (list != null)
diff --git a/CefSharp/Visitor/TaskStringVisitor.cs b/CefSharp/Visitor/TaskStringVisitor.cs
index e1f02e2564..b82e565213 100644
--- a/CefSharp/Visitor/TaskStringVisitor.cs
+++ b/CefSharp/Visitor/TaskStringVisitor.cs
@@ -9,15 +9,15 @@
namespace CefSharp
{
///
- /// A that uses a TaskCompletionSource
- /// to simplify things
+ /// A that uses a
+ /// that allows you to call await/ContinueWith to get the result string.
///
public class TaskStringVisitor : IStringVisitor
{
private readonly TaskCompletionSource taskCompletionSource;
///
- /// Default constructor
+ /// Initializes a new instance of the TaskStringVisitor class.
///
public TaskStringVisitor()
{
diff --git a/CefSharp/Web/JsonString.cs b/CefSharp/Web/JsonString.cs
index cb55824370..01a0bcf4ac 100644
--- a/CefSharp/Web/JsonString.cs
+++ b/CefSharp/Web/JsonString.cs
@@ -15,6 +15,9 @@ namespace CefSharp.Web
///
public class JsonString
{
+ ///
+ /// JSON String
+ ///
public string Json { get; private set; }
///
@@ -31,6 +34,7 @@ public JsonString(string json)
Json = json;
}
+ ///
public override string ToString()
{
return Json;