diff --git a/CefSharp.Core/Cef.h b/CefSharp.Core/Cef.h index 56a297f909..46abf4bd2e 100644 --- a/CefSharp.Core/Cef.h +++ b/CefSharp.Core/Cef.h @@ -578,62 +578,61 @@ namespace CefSharp /// # Comments start with a hash character and must be on their own line. /// /// [Config] - /// ProductName= - /// ProductVersion= - /// AppName= - /// ExternalHandler= - /// ServerURL= - /// RateLimitEnabled= - /// MaxUploadsPerDay= - /// MaxDatabaseSizeInMb= - /// MaxDatabaseAgeInDays= + /// ServerURL=<crash server URL; default to empty> + /// RateLimitEnabled=<True if uploads should be rate limited; default to true> + /// MaxUploadsPerDay=<Max uploads per 24 hours, used if rate limit is enabled; + /// default to 5> + /// MaxDatabaseSizeInMb=<Total crash report disk usage greater than this value + /// will cause older reports to be deleted; default to 20> + /// MaxDatabaseAgeInDays=<Crash reports older than this value will be deleted; + /// default to 5> /// /// [CrashKeys] - /// my_key1= - /// my_key2= + /// my_key1=<small|medium|large> + /// my_key2=<small|medium|large> /// /// Config section: /// - /// If "ProductName" and/or "ProductVersion" are set then the specified values + /// If "ProductName" and/or "ProductVersion" are set then the specified values /// will be included in the crash dump metadata. /// - /// If "AppName" is set on Windows then crash report information (metrics, + /// If "AppName" is set on Windows then crash report information (metrics, /// database and dumps) will be stored locally on disk under the - /// "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. On other - /// platforms the CefSettings.user_data_path value will be used. + /// "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. /// - /// If "ExternalHandler" is set on Windows then the specified exe will be + /// If "ExternalHandler" is set on Windows then the specified exe will be /// launched as the crashpad-handler instead of re-launching the main process /// exe. The value can be an absolute path or a path relative to the main exe /// directory. /// - /// If "ServerURL" is set then crashes will be uploaded as a multi-part POST + /// If "ServerURL" is set then crashes will be uploaded as a multi-part POST /// request to the specified URL. Otherwise, reports will only be stored locally /// on disk. /// - /// If "RateLimitEnabled" is set to true then crash report uploads will be rate + /// If "RateLimitEnabled" is set to true then crash report uploads will be rate /// limited as follows: - /// 1. If "MaxUploadsPerDay" is set to a positive value then at most the + /// 1. If "MaxUploadsPerDay" is set to a positive value then at most the /// specified number of crashes will be uploaded in each 24 hour period. /// 2. If crash upload fails due to a network or server error then an /// incremental backoff delay up to a maximum of 24 hours will be applied for /// retries. - /// 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the - /// "MaxUploadsPerDay" value will be reduced to 1 until the client is + /// 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the + /// "MaxUploadsPerDay" value will be reduced to 1 until the client is /// restarted. This helps to avoid an upload flood when the network or /// server error is resolved. /// - /// If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage + /// If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage /// on disk will be limited to that size in megabytes. For example, on Windows - /// each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to + /// each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to /// about 34 crash reports stored on disk. /// - /// If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older + /// If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older /// than the specified age in days will be deleted. /// /// CrashKeys section: @@ -644,10 +643,10 @@ namespace CefSharp /// from any thread or process using the Cef.SetCrashKeyValue function. These /// key/value pairs will be sent to the crash server along with the crash dump /// file. Medium and large values will be chunked for submission. For example, - /// if your key is named "mykey" then the value will be broken into ordered - /// chunks and submitted using keys named "mykey-1", "mykey-2", etc. + /// if your key is named "mykey" then the value will be broken into ordered + /// chunks and submitted using keys named "mykey-1", "mykey-2", etc. /// - /// Returns the global request context or null. + /// Returns true if crash reporting is enabled. static property bool CrashReportingEnabled { bool get() @@ -670,7 +669,7 @@ namespace CefSharp /// The client application is responsible for downloading an appropriate /// platform-specific CDM binary distribution from Google, extracting the /// contents, and building the required directory structure on the local machine. - /// The method class can be used + /// The method class can be used /// to implement this functionality in CefSharp. Contact Google via /// https://www.widevine.com/contact.html for details on CDM download. /// @@ -684,7 +683,7 @@ namespace CefSharp /// /// If any of these files are missing or if the manifest file has incorrect /// contents the registration will fail and callback will receive an ErrorCode - /// value of . + /// value of . /// /// The manifest.json file must contain the following keys: /// A. "os": Supported OS (e.g. "mac", "win" or "linux"). diff --git a/CefSharp.OffScreen/IRenderHandler.cs b/CefSharp.OffScreen/IRenderHandler.cs index ee7f21195c..02dff3daac 100644 --- a/CefSharp.OffScreen/IRenderHandler.cs +++ b/CefSharp.OffScreen/IRenderHandler.cs @@ -75,7 +75,7 @@ public interface IRenderHandler : IDisposable bool StartDragging(IDragData dragData, DragOperationsMask mask, int x, int y); /// - /// Called when the web view wants to update the mouse cursor during a drag & drop operation. + /// Called when the web view wants to update the mouse cursor during a drag & drop operation. /// /// describes the allowed operation (none, move, copy, link). void UpdateDragCursor(DragOperationsMask operation);