Skip to content

Commit 4f88ad1

Browse files
committed
Fix some xml doc encoding issues
1 parent 23b905d commit 4f88ad1

File tree

2 files changed

+33
-34
lines changed

2 files changed

+33
-34
lines changed

CefSharp.Core/Cef.h

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -578,62 +578,61 @@ namespace CefSharp
578578
/// # Comments start with a hash character and must be on their own line.
579579
///
580580
/// [Config]
581-
/// ProductName=<Value of the "prod" crash key; defaults to "cef">
582-
/// ProductVersion=<Value of the "ver" crash key; defaults to the CEF version>
583-
/// AppName=<Windows only; App-specific folder name component for storing crash
584-
/// information; default to "CEF">
585-
/// ExternalHandler=<Windows only; Name of the external handler exe to use
581+
/// ProductName=&lt;Value of the &quot;prod&quot; crash key; defaults to &quot;cef&quot;&gt;
582+
/// ProductVersion=&lt;Value of the &quot;ver&quot; crash key; defaults to the CEF version&gt;
583+
/// AppName=&lt;Windows only; App-specific folder name component for storing crash
584+
/// information; default to &quot;CEF&quot;&gt;
585+
/// ExternalHandler=&lt;Windows only; Name of the external handler exe to use
586586
/// instead of re-launching the main exe; default to empty>
587-
/// ServerURL=<crash server URL; default to empty>
588-
/// RateLimitEnabled=<True if uploads should be rate limited; default to true>
589-
/// MaxUploadsPerDay=<Max uploads per 24 hours, used if rate limit is enabled;
590-
/// default to 5>
591-
/// MaxDatabaseSizeInMb=<Total crash report disk usage greater than this value
592-
/// will cause older reports to be deleted; default to 20>
593-
/// MaxDatabaseAgeInDays=<Crash reports older than this value will be deleted;
594-
/// default to 5>
587+
/// ServerURL=&lt;crash server URL; default to empty&gt;
588+
/// RateLimitEnabled=&lt;True if uploads should be rate limited; default to true&gt;
589+
/// MaxUploadsPerDay=&lt;Max uploads per 24 hours, used if rate limit is enabled;
590+
/// default to 5&gt;
591+
/// MaxDatabaseSizeInMb=&lt;Total crash report disk usage greater than this value
592+
/// will cause older reports to be deleted; default to 20&gt;
593+
/// MaxDatabaseAgeInDays=&lt;Crash reports older than this value will be deleted;
594+
/// default to 5&gt;
595595
///
596596
/// [CrashKeys]
597-
/// my_key1=<small|medium|large>
598-
/// my_key2=<small|medium|large>
597+
/// my_key1=&lt;small|medium|large&gt;
598+
/// my_key2=&lt;small|medium|large&gt;
599599
///
600600
/// Config section:
601601
///
602-
/// If "ProductName" and/or "ProductVersion" are set then the specified values
602+
/// If &quot;ProductName&quot; and/or &quot;ProductVersion&quot; are set then the specified values
603603
/// will be included in the crash dump metadata.
604604
///
605-
/// If "AppName" is set on Windows then crash report information (metrics,
605+
/// If &quot;AppName&quot; is set on Windows then crash report information (metrics,
606606
/// database and dumps) will be stored locally on disk under the
607-
/// "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. On other
608-
/// platforms the CefSettings.user_data_path value will be used.
607+
/// &quot;C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data&quot; folder.
609608
///
610-
/// If "ExternalHandler" is set on Windows then the specified exe will be
609+
/// If &quot;ExternalHandler&quot; is set on Windows then the specified exe will be
611610
/// launched as the crashpad-handler instead of re-launching the main process
612611
/// exe. The value can be an absolute path or a path relative to the main exe
613612
/// directory.
614613
///
615-
/// If "ServerURL" is set then crashes will be uploaded as a multi-part POST
614+
/// If &quot;ServerURL&quot; is set then crashes will be uploaded as a multi-part POST
616615
/// request to the specified URL. Otherwise, reports will only be stored locally
617616
/// on disk.
618617
///
619-
/// If "RateLimitEnabled" is set to true then crash report uploads will be rate
618+
/// If &quot;RateLimitEnabled&quot; is set to true then crash report uploads will be rate
620619
/// limited as follows:
621-
/// 1. If "MaxUploadsPerDay" is set to a positive value then at most the
620+
/// 1. If &quot;MaxUploadsPerDay&quot; is set to a positive value then at most the
622621
/// specified number of crashes will be uploaded in each 24 hour period.
623622
/// 2. If crash upload fails due to a network or server error then an
624623
/// incremental backoff delay up to a maximum of 24 hours will be applied for
625624
/// retries.
626-
/// 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the
627-
/// "MaxUploadsPerDay" value will be reduced to 1 until the client is
625+
/// 3. If a backoff delay is applied and &quot;MaxUploadsPerDay&quot; is > 1 then the
626+
/// &quot;MaxUploadsPerDay&quot; value will be reduced to 1 until the client is
628627
/// restarted. This helps to avoid an upload flood when the network or
629628
/// server error is resolved.
630629
///
631-
/// If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage
630+
/// If &quot;MaxDatabaseSizeInMb&quot; is set to a positive value then crash report storage
632631
/// on disk will be limited to that size in megabytes. For example, on Windows
633-
/// each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to
632+
/// each dump is about 600KB so a &quot;MaxDatabaseSizeInMb&quot; value of 20 equates to
634633
/// about 34 crash reports stored on disk.
635634
///
636-
/// If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older
635+
/// If &quot;MaxDatabaseAgeInDays&quot; is set to a positive value then crash reports older
637636
/// than the specified age in days will be deleted.
638637
///
639638
/// CrashKeys section:
@@ -644,10 +643,10 @@ namespace CefSharp
644643
/// from any thread or process using the Cef.SetCrashKeyValue function. These
645644
/// key/value pairs will be sent to the crash server along with the crash dump
646645
/// file. Medium and large values will be chunked for submission. For example,
647-
/// if your key is named "mykey" then the value will be broken into ordered
648-
/// chunks and submitted using keys named "mykey-1", "mykey-2", etc.
646+
/// if your key is named &quot;mykey&quot; then the value will be broken into ordered
647+
/// chunks and submitted using keys named &quot;mykey-1&quot;, &quot;mykey-2&quot;, etc.
649648
/// </summary>
650-
/// <returns>Returns the global request context or null.</returns>
649+
/// <returns>Returns true if crash reporting is enabled.</returns>
651650
static property bool CrashReportingEnabled
652651
{
653652
bool get()
@@ -670,7 +669,7 @@ namespace CefSharp
670669
/// The client application is responsible for downloading an appropriate
671670
/// platform-specific CDM binary distribution from Google, extracting the
672671
/// contents, and building the required directory structure on the local machine.
673-
/// The <see cref="IBrowserHost.StartDownload"/> method class can be used
672+
/// The <see cref="CefSharp.IBrowserHost.StartDownload"/> method class can be used
674673
/// to implement this functionality in CefSharp. Contact Google via
675674
/// https://www.widevine.com/contact.html for details on CDM download.
676675
///
@@ -684,7 +683,7 @@ namespace CefSharp
684683
///
685684
/// If any of these files are missing or if the manifest file has incorrect
686685
/// contents the registration will fail and callback will receive an ErrorCode
687-
/// value of <see cref="CdmRegistrationErrorCode.IncorrectContents"/>.
686+
/// value of <see cref="CefSharp.CdmRegistrationErrorCode.IncorrectContents"/>.
688687
///
689688
/// The manifest.json file must contain the following keys:
690689
/// A. "os": Supported OS (e.g. "mac", "win" or "linux").

CefSharp.OffScreen/IRenderHandler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public interface IRenderHandler : IDisposable
7575
bool StartDragging(IDragData dragData, DragOperationsMask mask, int x, int y);
7676

7777
/// <summary>
78-
/// Called when the web view wants to update the mouse cursor during a drag & drop operation.
78+
/// Called when the web view wants to update the mouse cursor during a drag &amp; drop operation.
7979
/// </summary>
8080
/// <param name="operation">describes the allowed operation (none, move, copy, link). </param>
8181
void UpdateDragCursor(DragOperationsMask operation);

0 commit comments

Comments
 (0)